namespaces

Lists namespaces in name order, or looks up one namespace by name. Requires the admin token.

Changed on
get/namespaces

Request

  • Base URL
    https://api.rivet.dev
  • URL
    https://api.rivet.dev/namespaces
  • Auth
    • HTTP bearer
    • or API key in header x-rivet-token

Query parameters

namestring

Only return the namespace with this name. The response then holds zero or one namespace, pagination.cursor is null, and limit and cursor are ignored.

cursorstring

Name of the last namespace on the previous page. Pass the pagination.cursor value from the previous response.

limitinteger

Maximum number of namespaces to return, from 1 to 100. Defaults to 100.

Response

A page of namespaces.

Example response

{
  "namespaces": [
    {
      "name": "my-namespace"
    }
  ]
}

Changes

    • breaking

      for the query request parameter limit, default value 100 was added

    • breaking

      for the query request parameter limit, the min was increased from 0.00 to 1.00

    • breaking

      added the pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ to the query request parameter name

    • breaking

      for the query request parameter limit, the format changed from no format to int32

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • warning

      for the query request parameter name, the maxLength was set to 63

    • warning

      for the query request parameter limit, the max was set to 100.00

    • warning

      deleted the query request parameter namespace_id

    • warning

      deleted the query request parameter namespace_ids

    • info

      the endpoint scheme security rivet_token_header was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response property / became required for the status

    • info

      added the new optional query request parameter namespace_id