Update a scoped API key's scopes/name (project ADMIN)

Invalidates the KV cache entry so scope changes take effect immediately. Revoked keys cannot be modified.

Authorizations

• SessionCookie

Parameters

Path Parameters

projectId

required

string

id

required

string

Request Body^required

Media typeapplication/json

object

>= 1 properties

scopes

Array<string>

>= 1 items

Allowed values: ingest:write decision:read coupon:redeem coupon:read metrics:read metrics:write profile:write decision:call tracking:ingest mcp:events_read mcp:events_write mcp:links_write mcp:attribution_read

name

string

>= 1 characters <= 120 characters

Responses

200

Updated

Media typeapplication/json

object

key

object

id

string

projectId

string

name

string | null

scopes

Array<string>

Allowed values: ingest:write decision:read coupon:redeem coupon:read metrics:read metrics:write profile:write decision:call tracking:ingest mcp:events_read mcp:events_write mcp:links_write mcp:attribution_read

revoked

boolean

createdAt

string

revokedAt

string | null

keyMasked

string

400

Missing projectId

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

401

Not authorized

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

403

Needs project ADMIN

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

404

Key not found

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

409

Key already revoked

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

422

Validation failed

Media typeapplication/json

object

error

required

string

issues

Array<object>

object

path

string

message

string

details

Array<object>

object

key

additional properties

any

key

additional properties

any

Example

json

{
  "error": "参数校验失败"
}