namespaces

Get a namespace

Retrieve details about a specific namespace by its name.

get/namespaces/{namespace_id}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/namespaces/{namespace_id}
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

namespace_idstring required

The name of the namespace.

Response

Successfully retrieved the namespace.

namestring

The unique name of the namespace.

home_nodestring

The cluster node where this namespace's shards are placed. Set at create time and updatable later. Updating it only affects future placement decisions; existing live shards are not moved.

state'active' | 'suspended' | 'resuming' | 'deleting'

Lifecycle state. "active" namespaces accept all operations. "suspended" namespaces reject new classes, aliases, users, roles, and role assignments, and their users can no longer authenticate; everything the namespace already owns is retained. "resuming" namespaces are on their way back to "active" and are still restricted the same way. "deleting" namespaces are being removed: new classes, aliases, and users can no longer be created in the namespace, and the namespace itself disappears once removal completes.

Changes

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