authed

Update Steep Key

Change a key's settings. Capture changes reach pages on their next config fetch; a retention change applies to journeys already stored. A revoked key takes only retention and label changes.

patch/api/v1/steep-keys/{key_id}

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/steep-keys/{key_id}
Auth
none declared

Path parameters

key_idstring uuid required

Request body

allowed_originsstring[]

Every web origin to capture journeys on.

labelstring nullable

A name to tell keys apart; null clears it.

capture_outlinesboolean

Keep an outline of each page's structure.

capture_typed_valuesboolean

Keep what users type into fields.

capture_address_idsboolean

Keep ids in page, link and request addresses; secret-looking segments stay masked.

capture_query_valuesboolean

Keep the query values of the addresses your app requests, after redaction. Needs typed values.

capture_request_bodiesboolean

Keep what your app sends with a request (JSON, form or text, up to 2 KB), after redaction. Needs typed values.

capture_response_bodiesboolean

Keep what the server answers to requests users start, writes, failures and slow calls (JSON or text, up to 2 KB), after redaction. Needs page outlines.

respect_privacy_signalsboolean

Leave browsers sending Global Privacy Control uncaptured.

signed_in_onlyboolean

Capture only signed-in users' journeys.

retention_daysinteger

How many days to keep journeys, including those already stored.

ignore_selectorsstring[]

CSS selectors whose elements are never captured.

Response

Successful Response

idstring uuid required

The key's id; rotation keeps it.

labelstring nullable required

A name to tell keys apart, if given.

keystring required

The full Steep key, safe in page source: it names the workspace and grants nothing on its own.

key_prefixstring required

The key's first characters, to recognize it.

mode'live' | 'test' required

status'active' | 'revoked' required

allowed_originsstring[] required

The only web origins the key captures journeys from.

capture_outlinesboolean required

Whether journeys keep an outline of each page's structure.

capture_typed_valuesboolean required

Whether journeys keep what users typed into fields.

capture_address_idsboolean required

Whether journeys keep ids in page, link and request addresses; secret-looking segments stay masked.

capture_query_valuesboolean required

Whether journeys keep the query values of the addresses the app requests, after redaction; needs typed values.

capture_request_bodiesboolean required

Whether journeys keep what the app sends with a request (JSON, form or text, up to 2 KB), after redaction; needs typed values.

capture_response_bodiesboolean required

Whether journeys keep what the server answers to requests users start, writes, failures and slow calls (JSON or text, up to 2 KB), after redaction; needs page outlines.

respect_privacy_signalsboolean required

Whether a browser sending Global Privacy Control is left uncaptured.

signed_in_onlyboolean required

Whether only signed-in users' journeys are captured.

retention_daysinteger required

How many days journeys are kept.

ignore_selectorsstring[] required

CSS selectors whose elements are never captured.

capture_versioninteger required

Moves whenever a capture setting changes, so pages pick up the new settings.

created_atstring date-time required

When the key was created.

rotated_atstring date-time nullable required

When the key was last rotated; null if never.

revoked_atstring date-time nullable required

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

last_event_atstring date-time nullable required

When the key last delivered an event; null until then.

rich_capture_availableboolean

Whether this workspace can turn on keeping ids, request query values and request and response bodies.

Changes

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