Set an alias
curl -X PUT -H "X-Api-Key: $KEY" -F "templateId=$ID" \ http://localhost:9027/v1/aliases/letterconst form = new FormData();form.append('templateId', process.env.ID);
const response = await fetch('http://localhost:9027/v1/aliases/letter', { method: 'PUT', headers: { 'X-Api-Key': process.env.KEY }, body: form,});if (!response.ok) throw new Error(await response.text());console.log(await response.json());import os
import requests
# A (None, value) pair sends a plain field in a multipart form.response = requests.put( "http://localhost:9027/v1/aliases/letter", headers={"X-Api-Key": os.environ["KEY"]}, files={"templateId": (None, os.environ["ID"])},)response.raise_for_status()print(response.json())package main
import ( "bytes" "io" "log" "mime/multipart" "net/http" "os")
func main() { var body bytes.Buffer form := multipart.NewWriter(&body) form.WriteField("templateId", os.Getenv("ID")) form.Close()
request, err := http.NewRequest("PUT", "http://localhost:9027/v1/aliases/letter", &body) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY")) request.Header.Set("Content-Type", form.FormDataContentType())
response, err := http.DefaultClient.Do(request) if err != nil { log.Fatal(err) } defer response.Body.Close() if response.StatusCode >= 300 { message, _ := io.ReadAll(response.Body) log.Fatalf("%s: %s", response.Status, message) } if _, err := io.Copy(os.Stdout, response.Body); err != nil { log.Fatal(err) }}curl -X PUT -H "X-Api-Key: $KEY" -H "Content-Type: application/json" \ -d @alias.json http://localhost:9027/v1/aliases/letterimport { readFile } from 'node:fs/promises';
const response = await fetch('http://localhost:9027/v1/aliases/letter', { method: 'PUT', headers: { 'X-Api-Key': process.env.KEY, 'Content-Type': 'application/json', }, body: await readFile('alias.json'),});if (!response.ok) throw new Error(await response.text());console.log(await response.json());import osfrom pathlib import Path
import requests
response = requests.put( "http://localhost:9027/v1/aliases/letter", headers={"X-Api-Key": os.environ["KEY"], "Content-Type": "application/json"}, data=Path("alias.json").read_bytes(),)response.raise_for_status()print(response.json())package main
import ( "io" "log" "net/http" "os")
func main() { body, err := os.Open("alias.json") if err != nil { log.Fatal(err) } defer body.Close()
request, err := http.NewRequest("PUT", "http://localhost:9027/v1/aliases/letter", body) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY")) request.Header.Set("Content-Type", "application/json")
response, err := http.DefaultClient.Do(request) if err != nil { log.Fatal(err) } defer response.Body.Close() if response.StatusCode >= 300 { message, _ := io.ReadAll(response.Body) log.Fatalf("%s: %s", response.Status, message) } if _, err := io.Copy(os.Stdout, response.Body); err != nil { log.Fatal(err) }}Points an alias at a template. A new alias starts at version 1; pointing an existing one elsewhere adds a version, and the earlier ones stay. Every replica sees the change at once.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The alias, such as invoice
Request Bodyrequired
Section titled “Request Bodyrequired”What PUT /v1/aliases/{name} takes, as JSON or a multipart form.
object
The template the alias names from now on: an id, or another alias.
Example
01966f3e-7c1a-7d3c-9a44-1d2f5a6b7c8dWhat PUT /v1/aliases/{name} takes, as JSON or a multipart form.
object
The template the alias names from now on: an id, or another alias.
Example
01966f3e-7c1a-7d3c-9a44-1d2f5a6b7c8dResponses
Section titled “Responses”A new version of an alias
An alias and the template it names now.
object
RFC 3339: when it was pointed at this template.
1 for the first template it named, counted since it was last deleted.
Render an earlier one as name@version.
Example
{ "name": "invoice"}A new alias
An alias and the template it names now.
object
RFC 3339: when it was pointed at this template.
1 for the first template it named, counted since it was last deleted.
Render an earlier one as name@version.
Example
{ "name": "invoice"}Not a usable name, or no template named
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}Too many aliases, or versions of this one
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}This caller has no such template
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}RUSTICDOC_STORE is not set
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}The store cannot be reached
The JSON body of every error response.
object
A stable, machine-readable kind.
What went wrong, for a person.
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}