Admin API

Base URL

Here's the Admin REST API base URL:

https://edge.sitecorecloud.io/api/admin/v1

Authorization

All endpoints use bearer authorization. To authorize your API requests:

1. Create an Edge administration client for an environment. This generates a client ID and client secret.
2. Create a JSON web token (JWT) using the client ID and client secret. This generates a JSON web token (JWT). You must include the JWT in the Authorization header of every API request you make.

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 REST 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.

"contentCacheTtl": "04:00:00",
"contentCacheAutoClear": true,
"mediaCacheTtl": "04:00:00",
"mediaCacheAutoClear": true,
"tenantCacheAutoClear": true

"contentCacheTtl": "04:00:00",
"contentCacheAutoClear": true,
"mediaCacheTtl": "04:00:00",
"mediaCacheAutoClear": true,
"tenantCacheAutoClear": true

{
    "op":"replace",
    "path":"/contentcacheautoclear",
    "value":true
},
{
    "op":"replace",
    "path":"/contentcachettl",
    "value":"00:15:00"
}

"x-header": "bar"

"x-header": "bar"

  "id": "1234",
  "tenantId": "test-tenant",
  "label": "webhook 92",
  "uri": "https://localhost/",
  "method": "POST",
  "body": "This is my optional body content",
  "created": "2021-03-26T10:44:04.6107312+00:00"

  "id": "1234",
  "tenantId": "test-tenant",
  "label": "webhook 92",
  "uri": "https://localhost/",
  "method": "POST",
  "headers": {
      "x-header": "foo"
  },
  "body": "Optional body content",
  "createdBy": "adn",
  "created": "2021-03-26T10:44:04.6107312+00:00"
  "executionMode": "OnEnd"