List aliases

GET

/v1/aliases

curl -H "X-Api-Key: $KEY" http://localhost:9027/v1/aliases

const response = await fetch('http://localhost:9027/v1/aliases', {
  headers: { 'X-Api-Key': process.env.KEY },
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

package main

import (
  "io"
  "log"
  "net/http"
  "os"
)

func main() {
  request, err := http.NewRequest("GET", "http://localhost:9027/v1/aliases", 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)
  }
}

Lists this caller’s aliases by name, each with the template it names now.

Authorizations

api_key
bearer
basic

Parameters

Query Parameters

limit

integer | null

How many to return, up to 200. Default 50.

cursor

string | null

nextCursor from the page before.

Responses

200

A page of aliases

application/json

One page of aliases.

object

aliases

required

Array<object>

An alias and the template it names now.

object

name

required

string

setAt

required

RFC 3339: when it was pointed at this template.

string

templateId

required

string

version

required

1 for the first template it named, counted since it was last deleted. Render an earlier one as name@version.

integer

nextCursor

Pass as cursor for the next page. Absent on the last.

string | null

Example

{
  "aliases": [
    {
      "name": "invoice"
    }
  ]
}

501

RUSTICDOC_STORE is not set

application/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'"
}

503

The store cannot be reached

application/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'"
}