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:

RequestResponse
https://edge.sitecorecloud.io/api/apikey/v1

Authentication

All endpoints use bearer authorization.

Headers

The following header is required:

Name

Format

Description

Authorization

Bearer token

A JSON web token obtained from Auth0.

Endpoints

All the following routes are relative to the base URL:

Endpoint

Method

URL

Description

Returns

Create

POST

/

Creates a new API key.

The API key token.

ListAll

GET

/

Lists all the API keys.

A list of API keys (info/hash).

GetApiKeyByHash

GET

/<hash>

Retrieves a single API key identified by its hash.

A single API key (info/hash).

GetApiKeyByToken

GET

/token

Retrieves a single API key identified by its token.

A single API key (info/token).

RenameByHash

PUT

/renamebyhash/<hash>

Renames an API key identified by its hash.

A boolean indicating whether the key was successfully renamed.

RenameByToken

PUT

/renamebytoken

Renames an API key identified by its token.

A boolean indicating whether the key was successfully renamed.

RevokeByHash

PUT

/revokebyhash/<hash>

Revokes an API key identified by its hash.

A boolean indicating whether the key was successfully revoked.

RevokeByToken

PUT

/revokebytoken

Revokes an API key identified by its token.

A boolean indicating whether the key was successfully revoked.

Do you have some feedback for us?

If you have suggestions for improving this article,