Keys endpoints

Generated from the central API contract. Availability and permissions are checked by the connected service.

POST /v1/keys

Create

Authorization: keys:write Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Request body: application/json — KeyCreate. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/keys"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

GET /v1/keys

Listing

Authorization: keys:write Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

view

query

No

string

include_revoked

query

No

boolean

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X GET \
  -H "Authorization: Bearer $GD_API_KEY" \
  "$GD_API_BASE/v1/keys"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

POST /v1/keys/{key_id}/revoke

Revoke

Authorization: keys:write Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

key_id

path

Yes

string (uuid)

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X POST \
  -H "Authorization: Bearer $GD_API_KEY" \
  "$GD_API_BASE/v1/keys/REPLACE_KEY_ID/revoke"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.

PATCH /v1/keys/{key_id}

Update

Authorization: keys:write Current resource access and role checks also apply.

MCP: No dedicated tool in the current catalogue; use REST with the required permissions.

Parameter

Location

Required

Type / values

key_id

path

Yes

string (uuid)

Request body: application/json — KeyUpdate. Required.

HTTP request pattern: replace path/query placeholders and prepare any body from the linked model. Run mutations only for your intended action; session-only endpoints need their application authentication context.

curl --fail-with-body --silent --show-error -X PATCH \
  -H "Authorization: Bearer $GD_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json \
  "$GD_API_BASE/v1/keys/REPLACE_KEY_ID"

These are the response shapes declared by OpenAPI. Permission, validation, budget and service errors can also occur; see errors and recovery. An unconstrained JSON response is not a guarantee of undocumented fields.