Skip to main content
DELETE
/
auth
/
api-key
Revoke API key
curl --request DELETE \
  --url https://clob.forka.st/auth/api-key \
  --header 'FORKAST_ADDRESS: <forkast_address>' \
  --header 'FORKAST_API_KEY: <forkast_api_key>' \
  --header 'FORKAST_PASSPHRASE: <forkast_passphrase>' \
  --header 'FORKAST_SIGNATURE: <forkast_signature>' \
  --header 'FORKAST_TIMESTAMP: <forkast_timestamp>'
{
  "revoked": true
}
Invalidate a Forkast API key so it can no longer authenticate L2 requests.
This endpoint requires the L2 header. Provide FORKAST_ADDRESS, FORKAST_SIGNATURE, FORKAST_TIMESTAMP, FORKAST_API_KEY, and FORKAST_PASSPHRASE.

​
Required headers

HeaderDescription
FORKAST_ADDRESSPolygon address that owns the credentials.
FORKAST_SIGNATUREHMAC signature generated with the API secret.
FORKAST_TIMESTAMPCurrent Unix timestamp (seconds).
FORKAST_API_KEYAPI key being revoked.
FORKAST_PASSPHRASEPassphrase associated with the API key.

​
Response fields

FieldTypeDescription
revokedbooleanIndicates whether the provided API key was successfully revoked.
After revoking, rerun GET /auth/api-keys to confirm it no longer appears. Need a fresh credential later? See POST /auth/api-key.

Headers

​
FORKAST_ADDRESS
string
required

Polygon address that owns the key.

​
FORKAST_SIGNATURE
string
required

HMAC signature derived from the API secret.

​
FORKAST_TIMESTAMP
string
required

Unix timestamp (seconds) used for signing.

​
FORKAST_API_KEY
string
required

API key to revoke.

​
FORKAST_PASSPHRASE
string
required

Passphrase corresponding to the API key.

Response

Revocation status

​
revoked
boolean
required

Indicates whether the provided API key was revoked.

Example:

true