Rotate an API key's secret · SocialTap API reference

Issues a new secret for the same key (same ID, settings and spend), shown once: store it now. The current secret keeps working for previous_secret_expires_in seconds, so you can deploy the new one without downtime, but only for calls that need no admin scope (others: forbidden, reason previous_secret). 0 stops it, and rotating again ends the oldest secret, within a minute everywhere: at most two secrets work. A rotation keeps the key, its jobs and every key it made: after a leak, revoke the key instead. A key may rotate itself, or a key it could have created; rotating another key puts that key below it. In the dashboard, a rotation frees the key from any key above it. Free.

Auth: an API key with the admin scope, or the dashboard session.

Send an idempotency-key header to retry safely: the same key and body within 1 day never repeat the work.

Example

cURL

curl -X POST 'https://socialtap.dev/v1/api_keys/<id>/rotate_secret' \
  -H "x-api-key: $SOCIALTAP_API_KEY" \
  -H "content-type: application/json" \
  -d '{
  "previous_secret_expires_in": 0
}'

Authorizations

x-api-keystringheaderrequired

Your API key, with the admin scope. Authentication

Path parameters

idstringrequired

Key ID (key_…).

Headers

idempotency-keystringmax 255 chars

On any POST: your unique key for the request (1–255 printable ASCII characters; a UUID is ideal), kept 24 hours. Retrying with the same key and body never repeats the work: the answer is the first request's result, in its current state.

Body

application/json

JSON. Fields marked nullable may be null; optional ones may be left out.

previous_secret_expires_in?integernullable

Seconds the key's current secret keeps working after the new one is issued, at most 7 days; 0 stops it now. Default: 1 day.

Response

application/json

200

Rotate an API key's secret

dataobject

Show 17 child fields

created_atstring date-time

When the key was created, RFC 3339 UTC.

created_by_keystringnullable

The API key (key_…) that last created this key, gave it the admin scope or rotated it: revoking that key also revokes this one if this one has admin. Null when none did, or a person has rotated it in the dashboard since.

created_by_userstringnullable

The person (GET /v1/members user_id) who created this key in the dashboard, or whose key created it. They may have left the account since. Null when no person did (an operator, or a key from before this was recorded).

dashboardboolean

true for the account's built-in dashboard key: the dashboard's playground runs as it (so its requests are logged, counted and billed like any key's). Nobody holds its secret, so it works only from the signed-in dashboard. Only its spend_limit can be changed (to cap what the playground spends live); renaming, rescoping, restricting, rotating or revoking it is forbidden (details.reason dashboard_key). It is made on first use and revoked with the account.

expires_atstring date-timenullable

When the key stops working, RFC 3339 UTC; null when it never expires.

idstring

Key ID (key_…): manage the key with it. It is not the secret.

ip_allowliststring[]

IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; [] = any.

last_used_atstring date-timenullable

About when the key was last used (updated at most hourly); null when never.

namestring

Your label for the key.

objectstring

Always api_key.

One ofapi_key

prefixstring

The secret's first characters, to recognize it.

previous_secret_expires_atstring date-timenullable

Until then the secret this key had before its last rotation works too (rotate_secret), RFC 3339 UTC; null when none does.

revoked_atstring date-timenullable

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

scopesstring[]

What the key may call: endpoints (data endpoints), jobs (create, read and cancel jobs; includes jobs:read), jobs:read (read jobs and their results), account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read).

One ofendpointsjobsjobs:readaccount:readadmin

secretstring

The key itself: send it in the x-api-key header. Shown only once: store it now.

spend_limitobjectnullable

The key's spend limit and what it used this interval; null when the key has none.

Show 4 child fields

amountinteger

Most credits the key may spend per interval.

intervalstring

Calendar day or month, UTC.

One ofdaymonth

resets_atstring date-time

Start of the next interval, RFC 3339 UTC.

usedinteger

Credits the key spent this interval, plus what its requests in flight hold.

statusstring

pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET /v1/account). expired: past expires_at.

One ofactivependingexpiredrevoked

metaobject

The shared route meta (see the API reference introduction).

400

400 Bad Request.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

401

401 Unauthorized.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

403

403 Forbidden.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

404

404 Not Found.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

409

409 Conflict.

idempotency_key_in_progressYes, later

A request with this Idempotency-Key is still running.

Retry after the seconds in the retry-after header to get that request's result.

422

422 Unprocessable.

idempotency_key_reusedNo retry

This Idempotency-Key was already used for a different request (another route or body). Or it was used for this same request, which ran and returned a secret we no longer keep (details.reason answer_expired): running it again would create another.

Use a new Idempotency-Key for a different request, and reuse a key only to retry the identical request. With reason answer_expired, check what the first request created (GET /v1/api_keys, GET /v1/webhook_endpoints) before sending it again under a new key.

429

429 Too Many Requests.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

operationId api_keys.rotate_secret