API keys

Update an API key

PATCH/v1/workspaces/{workspaceId}/api-keys/{keyId}

Edits name, role, or storage bucket access. Does not replace the secret. Cannot change kind.

Authentication

Send your Spark API key with every request. The value is the full bearer token Spark returned when you created the key. See Authentication.

Authorization: Bearer <SPARK_API_KEY>

workspaceId

string

The workspace id.

keyId

string

The API key id.

name

string (optional)

Display name.

role

string (optional)

New role. Cannot exceed the owner or caller. Cannot change kind. One of: viewer, editor, admin.

bucketScope

object (optional)

Storage keys only. Replaces the complete bucket list.