Endpoints
Revoke an Endpoint API Key
Permanently revokes the given API key by hard-deleting it. Any client still using the revoked key will start failing immediately on the next inbound webhook request (subject to cache propagation).
delete/v2.0/endpoints/{endpointId}/apikeys/{keyId}
Request
- Base URLhttps://api-trial.cognigy.ai/testing
- Auth
- API key in header X-API-Key
- or API key in query parameter api_key
- or API key in header x-cxone-authorization
- or OAuth 2Authorization code/auth/oauth2/authorizePasswordToken URL/auth/oauth2/token
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
endpointIdstring required
The Id of the Endpoint
keyIdstring required
The Id of the Endpoint API Key
Headers
Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
Response
The Endpoint API Key was revoked successfully.
Changes
No recorded changes to this operation across all 1 revision of this API.