--- title: Update namespace description: Change a namespace’s display label. doc_version: 0.1.0-preview last_updated: 2026-09-14 --- # Update namespace `PATCH /namespaces/{namespace}` Change a namespace’s display label. **Permission:** Cluster key. [API key types and authentication](/engine/reference/authentication.md). The name and ID are immutable. Send display_name: null to clear the label. ## Example request ```http PATCH /namespaces/acme HTTP/1.1 Host: engine.example.com Authorization: Bearer Content-Type: application/json { "display_name": "Acme Inc" } ``` ## Path parameters ### `namespace` **string · required** Namespace name or ns_ ID. It must be visible to this key. ## Request body ### `display_name` **string · required · nullable** New display label, or null to clear it. The namespace name remains unchanged. ## Responses ### 200 · Success The namespace with its updated display label. Content type: `application/json`. #### Response headers ##### `x-request-id` **string · required** Request correlation ID. Retain it when investigating a failed or unexpected request. ```json { "id": "ns_01K6Q6N7D8E9F0G1H2J3K4M5N6", "name": "acme", "display_name": "Acme Inc", "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" } ``` #### Response fields ##### `created_at` **string (date-time) · required** Time the resource was created, as an ISO 8601 UTC timestamp. ##### `display_name` **string · required · nullable** Human-readable label. This label does not change the resource name used in URLs. ##### `id` **string · required** Immutable namespace ID with the ns_ prefix. ##### `name` **string · required** 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_at` **string (date-time) · required** Time the resource last changed, as an ISO 8601 UTC timestamp. ##### `usage` **object · required** Current resource counts and storage usage. These are measurements, not tenant plan quotas. ###### `usage.collections` **integer · required** Number of collections in this namespace. ###### `usage.files` **integer · required** Number of living files in this namespace. ###### `usage.index_bytes` **string · required** Bytes of derived index data, as a decimal string. May be "0" when the cluster does not report a measurement. ###### `usage.source_bytes` **string · required** Sum of declared source bytes for living files, as a decimal string. Files without a declared size count as zero. ## Errors [Error format and retry guidance](/engine/reference/errors.md). ### 400 · `invalid_request` A field, path, parameter, or conditional request rule is invalid. Correct the request. Unknown fields are rejected. ```json { "error": { "code": "invalid_request", "message": "A field, path, parameter, or conditional request rule is invalid.", "request_id": "req_example", "retryable": false, "details": {} } } ``` ### 401 · `unauthenticated` The API key is missing, invalid, or revoked. Send an active key in Authorization: Bearer or X-API-Key. ```json { "error": { "code": "unauthenticated", "message": "The API key is missing, invalid, or revoked.", "request_id": "req_example", "retryable": false, "details": {} } } ``` ### 403 · `forbidden` The key can see the resource but lacks permission for this operation. Use a key with the required action or scope kind. ```json { "error": { "code": "forbidden", "message": "The key can see the resource but lacks permission for this operation.", "request_id": "req_example", "retryable": false, "details": {} } } ``` ### 404 · `not_found` The resource is absent, deleted, or outside this key’s scope. Check the identifier and the key’s namespace and collection scope. ```json { "error": { "code": "not_found", "message": "The resource is absent, deleted, or outside this key’s scope.", "request_id": "req_example", "retryable": false, "details": {} } } ``` ### 413 · `request_too_large` The JSON request body exceeds 1,048,576 bytes. Reduce the JSON body. Use upload or a URI source for larger file content. ```json { "error": { "code": "request_too_large", "message": "The JSON request body exceeds 1,048,576 bytes.", "request_id": "req_example", "retryable": false, "details": {} } } ``` ### 503 · `temporarily_unavailable` A dependency, cluster readiness condition, or capacity limit prevents this operation. Inspect retryable and details. Retry only when permitted, preserving the idempotency key for the same write. ```json { "error": { "code": "temporarily_unavailable", "message": "A dependency, cluster readiness condition, or capacity limit prevents this operation.", "request_id": "req_example", "retryable": true, "details": {} } } ``` ### 500 · `internal_error` An unexpected server failure prevented this request from completing. Retain x-request-id for investigation. Follow retryable before retrying a write. ```json { "error": { "code": "internal_error", "message": "An unexpected server failure prevented this request from completing.", "request_id": "req_example", "retryable": false, "details": {} } } ``` ## Other request languages ### cURL ```bash curl -sS -X PATCH "$GRAPHON_ENGINE_URL/namespaces/acme" \ -H "Authorization: Bearer $GRAPHON_ENGINE_API_KEY" \ -H 'Content-Type: application/json' \ --data-raw '{ "display_name": "Acme Inc" }' ``` ### Python ```python import json import os import urllib.request request = urllib.request.Request( os.environ["GRAPHON_ENGINE_URL"] + "/namespaces/acme", data=json.dumps({"display_name": "Acme Inc"}).encode("utf-8"), headers={ "Authorization": "Bearer " + os.environ["GRAPHON_ENGINE_API_KEY"], "Content-Type": "application/json", }, method="PATCH", ) with urllib.request.urlopen(request) as response: print(response.read().decode()) ``` ### JavaScript ```javascript const response = await fetch(process.env.GRAPHON_ENGINE_URL + "/namespaces/acme", { method: "PATCH", headers: { "Authorization": `Bearer ${process.env.GRAPHON_ENGINE_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({"display_name":"Acme Inc"}), }); console.log(response.status, await response.text()); ``` ## Sitemap See the full [sitemap](/sitemap.md) for all pages.