Namespace

Read a namespace

Changed on

Read a specific namespace by ID.

get/namespace/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/namespace/{id}
  • Auth
    HTTP bearer

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

    • breaking

      the response property became optional for the status

    • breaking

      the response property became optional for the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property message deprecated

    • info

      response property message deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status