Get an alias
GET
/v1/aliases/{name}
curl -H "X-Api-Key: $KEY" http://localhost:9027/v1/aliases/letterconst response = await fetch('http://localhost:9027/v1/aliases/letter', { headers: { 'X-Api-Key': process.env.KEY },});if (!response.ok) throw new Error(await response.text());console.log(await response.json());import os
import requests
response = requests.get( "http://localhost:9027/v1/aliases/letter", headers={"X-Api-Key": os.environ["KEY"]},)response.raise_for_status()print(response.json())package main
import ( "io" "log" "net/http" "os")
func main() { request, err := http.NewRequest("GET", "http://localhost:9027/v1/aliases/letter", nil) if err != nil { log.Fatal(err) } request.Header.Set("X-Api-Key", os.Getenv("KEY"))
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) }}An alias, the template it names now, and its history: every version since it was last deleted, oldest first.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
The alias
Responses
Section titled “Responses”The alias and its versions
Media typeapplication/json
An alias, the template it names now, and every version, oldest first.
object
name
required
string
setAt
required
string
templateId
required
string
version
required
integer
versions
required
Array<object>
One version of an alias.
object
setAt
required
RFC 3339.
string
templateId
required
string
version
required
integer
Example generated
{ "name": "example", "setAt": "example", "templateId": "example", "version": 1, "versions": [ { "setAt": "example", "templateId": "example", "version": 1 } ]}This caller has no such alias
Media typeapplication/json
The JSON body of every error response.
object
error
required
A stable, machine-readable kind.
string
message
required
What went wrong, for a person.
string
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}RUSTICDOC_STORE is not set
Media typeapplication/json
The JSON body of every error response.
object
error
required
A stable, machine-readable kind.
string
message
required
What went wrong, for a person.
string
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}The store cannot be reached
Media typeapplication/json
The JSON body of every error response.
object
error
required
A stable, machine-readable kind.
string
message
required
What went wrong, for a person.
string
Example
{ "error": "invalid_request", "message": "unknown step 'teleport'"}