logo
logo

Token API

You use the Token API to manage API keys used to access the Preview and Delivery APIs.

Base URL

The base URL for all the Token API requests is: https://edge.sitecorecloud.io/api/apikey/v1

Authentication

All endpoints use bearer authorization.

Headers

The following header is required:

NameFormatPurpose
AuthorizationBearer tokenA JSON web token obtained from Auth0.

Endpoints

All the following routes are relative to the base URL:

EndpointMethodURLUsageReturns
CreatePOST/Creates a new API key.The API key token.
ListAllGET/Lists all the API keys.A list of API keys (info/hash).
GetApiKeyByHashGET/{hash}Retrieves a single API key identified by its hash.A single API key (info/hash).
GetApiKeyByTokenGET/tokenRetrieves a single API key identified by its token.A single API key (info/token).
RenameByHashPUT/renamebyhash/{hash}Renames an API key identified by its hash.A boolean indicating whether the key was successfully renamed.
RenameByTokenPUT/renamebytokenRenames an API key identified by its token.A boolean indicating whether the key was successfully renamed.
RevokeByHashPUT/revokebyhash/{hash}Revokes an API key identified by its hash.A boolean indicating whether the key was successfully revoked.
RevokeByTokenPUT/revokebytokenRevokes an API key identified by its token.A boolean indicating whether the key was successfully revoked.

Can we improve this article ? Provide feedback