Account

Update an API key

Updates a key's metadata, scope and permissions, expiry, activation time, or IP allowlist. Secrets are immutable; create a new key to rotate them.

patch/v1/api-keys/{apiKeyId}

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/api-keys/{apiKeyId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: teams:create)

Path parameters

apiKeyIdstring required

API key id.

Request body

namestring nullable

Replacement name.

permissionsstring[]

Replacement finite permission set. Must be supplied together with scope.

metadataobject

Replacement caller-supplied metadata.

ipAllowliststring[] nullable

Replacement CIDR/IP allowlist.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

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