Admin API
The Admin
API is a REST API that enables you to administer your Experience Edge for XM tenants.
Base URL
The base URL for the Admin
API is https://edge.sitecorecloud.io/api/admin/v1
.
Authentication
All endpoints use bearer authorization.
Headers
The following header is required:
Name |
Format |
Purpose |
---|---|---|
|
|
A JSON web token (JWT). Request a JWT for Experience Edge XM using OAuth. |
Time-to-live
The time-to-live (TTL) determines the maximum time that content and media items are retained in the cache, which might be purged before that time expires. The TTL values for content (contentCacheTtl
) and media items (mediaCacheTtl
) are included as response parameters returned by several Admin API endpoints. The default value of both parameters is four hours:
{
"contentCacheTtl": "04:00:00",
"contentCacheAutoClear": true,
"mediaCacheTtl": "04:00:00",
"mediaCacheAutoClear": true,
"tenantCacheAutoClear": true
}
To set or update TTL values, use a string with the following notation:
{days}.{hours}:(minutes}:{seconds}
For example, "720.00:00:00"
sets the value to 720 days, and "00:15:00"
sets the value to 15 minutes.
Endpoints
The Admin API has the following endpoints:
-
ClearCacheForTenant
- clears the entire cache for a given tenant. -
DeleteContent
- removes tenant data from the data storage. -
GetSettings
- lists all available settings for a tenant. -
UpdateSettings
- updates all available settings for a tenant. -
PatchSettings
- updates a setting for a tenant using one or more Patch operations. -
CreateWebhook
- creates a new webhook. -
UpdateWebhook
- updates an existing webhook. -
DeleteWebhook
- deletes a specific webhook. -
ListWebhooks
- lists all webhooks for a tenant. -
GetWebhookById
- gets a specific tenant webhook.
ClearCacheForTenant
Clears the entire cache for a given tenant.
Relative route |
|
HTTP verb |
|
Response format |
Accepted status code (202) |
DeleteContent
Removes tenant data from the data storage.
Relative route |
|
HTTP verb |
|
Example |
|
Response format |
Accepted status code (202) |
GetSettings
Lists all available settings for a tenant.
Relative route |
|
HTTP verb |
|
Example |
|
Response format |
The settings for the tenant. RequestResponse
|
UpdateSettings
Updates all available settings for a tenant.
Relative route |
|
HTTP verb |
|
Example |
|
Body format |
RequestResponse
|
Response status code |
Accepted (202) |
PatchSettings
Updates a setting using a patch operation or multiple patch operations. It uses the JSON patch format for operations and content-type headers as specified in https://tools.ietf.org/html/rfc6902.
Relative route |
|
HTTP verb |
|
Example |
|
Headers |
Content-Type: |
Body format |
A settings operation. Only RequestResponse
|
Response format |
The settings for the tenant. RequestResponse
|
Response status code |
OK (200) |
CreateWebhook
Creates a new webhook.
When creating a webhook, you must use an HTTPS URI, and not HTTP.
Relative route |
|
HTTP verb |
|
Body format |
A webhook structure. Refer to Webhook objects to learn more about the various JSON objects used within the webhooks endpoint of the Edge Admin API. RequestResponse
|
Response format |
A webhook structure. Refer to Webhook objects to learn more about the various JSON objects used within the webhooks endpoint of the Edge Admin API. RequestResponse
|
Response header |
Returns the location of the new webhook. For example: Location: |
Response status code |
Created (201) |
UpdateWebhook
Updates an existing webhook.
Relative route |
|
HTTP verb |
|
Body format |
A webhook structure. Refer to Webhook objects to learn more about the various JSON objects used within the webhooks endpoint of the Edge Admin API. RequestResponse
|
Response status code |
No content (204) |
DeleteWebhook
Deletes a specific webhook.
Relative route |
|
HTTP verb |
|
Example |
|
Response status |
No content (204) |
ListWebhooks
Lists all webhooks for a tenant.
Relative route |
|
HTTP verb |
|
Example |
|
Response format |
An array of webhooks. Refer to Webhook objects to learn more about the various JSON objects used within the webhooks endpoint of the Edge Admin API. RequestResponse
|
GetWebhookById
Gets a specific tenant webhook by ID.
Relative route |
|
HTTP verb |
|
Example |
|
Response format |
RequestResponse
|