API Keys
Revoke an API key for the authenticated customer
Revoke an API key belonging to your organization. Revocation is a soft delete: the key keeps appearing in GET /v1/api-keys/ with status revoked, but any request using it is rejected with 401 from that point on. A key can revoke itself. Revocation cannot be undone — create a new key instead.
Requires the api-keys:write scope.
delete/v1/api-keys/{key_id}
Request
- Base URLhttps://api.platform.soax.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
key_idstring required
The API key ID to revoke
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.