Rename an org API key

PATCH

/orgs/{orgId}/api-keys/{id}

Name-only. Admin+ only. Audited as api_token.renamed.

Authorizations

bearer

Type

HTTP (bearer)

Parameters

Path Parameters

orgId*

Type

string

Required

id*

Type

string

Required

Request Body

application/json

{

  

"name": "string"

}

Responses

The renamed key.

Content-Type

application/json

{

  

"id": "018f0a5e-1c2b-7e3a-9b4c-0000000f0001",

  

"name": "CLI · device login",

  

"kind": "string",

  

"prefix": "ptl_u_0727c24e…",

  

"read_only": true,

  

"created_at": "string",

  

"last_used_at": "string"

}

PATCH

/orgs/{orgId}/api-keys/{id}

Playground

Authorization

bearer

Variables

Key

Value

orgId*

id*

Body

Samples

Powered by VitePress OpenAPI