Get namespace

Read a namespace and its current usage counters.

GET/namespaces/{namespace}

PermissionCluster key, or a scoped key with read (write includes read). Key scopes and actions.

A resource outside the key’s namespace or collection scope returns 404, even when that resource exists.
A collection key with read may inspect its containing namespace.

Request

https://engine.example.com/namespaces/acme

GET /namespaces/acme HTTP/1.1
Host: engine.example.com
Authorization: Bearer <GRAPHON_ENGINE_API_KEY>

Replace engine.example.com with your cluster host. Examples use a key placeholder.

Response

200

The requested resource or result.

{
  "id": "ns_01K6Q6N7D8E9F0G1H2J3K4M5N6",
  "name": "acme",
  "display_name": "Acme",
  "usage": {
    "collections": 1,
    "files": 1,
    "source_bytes": "77",
    "index_bytes": "0"
  },
  "created_at": "2026-10-06T10:00:00Z",
  "updated_at": "2026-10-06T10:00:00Z"
}

Path parameters

namespacestringrequired

Namespace name or ns_ ID. It must be visible to this key.

Responses

200Success

The requested resource or result.

application/json

Response headers

x-engine-request-idstringrequired

The Engine request ID. Retain it when investigating a failed or unexpected request.

x-request-idstringrequired

The X-Request-Id you sent, echoed when it is a valid ID. Otherwise, the Engine request ID.

created_atstring (date-time)required

Time the resource was created, as an ISO 8601 UTC timestamp.

display_namestringrequiredaccepts null

Human-readable label. This label does not change the resource name used in URLs.

idstringrequired

Immutable namespace ID with the ns_ prefix.

namestringrequired

URL name. Use 1–63 lowercase letters, digits, underscores, or hyphens. Start with a letter or digit. A name cannot match its resource ID format.

updated_atstring (date-time)required

Time the resource last changed, as an ISO 8601 UTC timestamp.

usageobjectrequired

Current resource counts and storage usage. These are measurements, not tenant plan quotas.

Errors

Select an error in the response example to see its JSON body. See error handling for the common error format.

400invalid_request

A field, path, parameter, or conditional request rule is invalid.

What to do: Correct the request. Unknown fields are rejected.

401unauthenticated

The API key is missing, invalid, or revoked.

What to do: Send an active key in Authorization: Bearer or X-API-Key.

403forbidden

The key can see the resource but lacks permission for this operation.

What to do: Use a key with the required action or scope kind.

404not_found

The resource is absent, deleted, or outside this key’s scope.

What to do: Check the identifier and the key’s namespace and collection scope.

503temporarily_unavailable

A dependency, cluster readiness condition, or capacity limit prevents this operation.

What to do: Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write.

500internal_error

An unexpected server failure prevented this request from completing.

What to do: Retain request_id for investigation. Follow retryable before retrying a write.

Was this page helpful?

View as Markdown