Sign in
Namespace

Read a namespace

Read a specific namespace by ID.

get/namespace/{id}

Path parameters

idinteger required

The ID of the namespace.

Query parameters

metadata_includestring

Comma-separated list of metadata properties to include in the response. Available values [schemas, tags].

Response

The operation was successful.

idinteger required

A system-wide unique ID for the namespace.

namestring required

The name of the namespace.

status'active' | 'inactive' required

The status of the namespace.

slugstring required

An account-wide unique slug for the namespace.

account_idinteger required

The ID of the account that owns this namespace.

Example response

{
  "id": 234,
  "name": "Crypto Kong Billing",
  "status": "active",
  "slug": "crypto-kong-billing",
  "account_id": 123,
  "metadata": {
    "key": "value"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.