TEteaflask
authed

Revoke Publishable Key

Revoke a key, immediately: visitor tokens it minted stop working on their next request, not at expiry. Revoking twice is not an error.

post/api/v1/serving-identity/keys/{key_id}/revoke

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/serving-identity/keys/{key_id}/revoke
  • Auth
    none declared

Path parameters

key_idstring uuid required

Response

Successful Response

idstring uuid required

The key's id.

key_prefixstring required

The key's first characters, to recognize it.

keystring nullable required

The full publishable key, safe in page source: it names the organization and agent, and grants nothing on its own. Null only for keys too old to show again.

mode'live' | 'test' required
allowed_originsstring[] required

The only web origins the key answers requests from. Fixed when the key is created.

status'active' | 'revoked' required
revoked_atstring date-time nullable required

When the key was revoked; null while it is active.

last_used_atstring date-time nullable required

When a visitor last started a session with the key; null until the assistant is first opened with it.

created_atstring date-time required

When the key was created.

agent_definition_idstring uuid nullable required

The agent this key serves: conversations started with it run that agent's published version.

Changes

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