Download OpenAPI specification:Download
AEM Admin API is used to manage the lifecycle of content and code.
Returns the overall status of the respective resource. (If the ?edit=auto
query param is set, this requires a call to your content source see https://www.aem.live/docs/limits#rate-limits-number-of-preview-operations-per-time)
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
string or string Optional URL of the edit (authoring) document |
Success response of a preview document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "live": {
- "status": 200,
- "lastModified": "2021-05-29T22:00:00Z",
- "lastModifiedBy": "foo@adobe.com",
- "contentBusId": "helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md",
- "permissions": [
- "read"
]
}, - "preview": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "lastModifiedBy": "anonymous",
- "contentBusId": "helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md",
- "permissions": [
- "read",
- "write"
]
}, - "edit": {
- "status": 200,
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "lastModified": "2021-05-29T21:00:00Z"
}, - "code": {
- "status": 404,
- "codeBusId": "helix-code-bus/adobe/blog/main/blog.md",
- "permissions": [
- "read"
]
}, - "links": {
}
}
Fetches the status of all resources specified in the paths
property in the payload. If a path ends with /*
, it is assumed to be a folder and is recursively processed.
The response will contain the folliowing information about a resource: path
, sourceLastModified
, previewLastModified
and publishLastModified
. It is possible to filter the information returned, by passing a combination of edit
, preview
and live
in the select
property in the payload.
Note that the bulk status is performed asynchronously and the response will contain information about the created job.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
paths required | Array of strings paths to filter the bulk status |
select | Array of strings Items Enum: "edit" "preview" "live" a combination of |
pathsOnly | boolean Default: false only return paths |
{- "select": [
- "edit",
- "preview",
- "live"
], - "paths": [
- "/en",
- "/en/*",
- "/blog/"
]
}
Success response.
{- "status": 202,
- "messageId": "37e92eec-020c-4eae-8f80-3db444c25056",
- "job": {
- "topic": "status",
- "name": "job-123",
- "state": "created",
- "startTime": "2021-05-31T23:00:00Z",
- "data": {
- "paths": [
- {
- "prefix": "/en/"
}, - {
- "path": "/en"
}, - {
- "path": "/blog/"
}
]
}
}, - "links": {
}
}
Returns the publish status of the respective resource.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Success response of a published document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "live": {
- "status": 200,
- "lastModified": "2021-05-29T22:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md",
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "permissions": [
- "read"
]
}, - "links": {
}
}
Publish a resource by copying the resource content from the preview
content-bus partition to the live
content-bus partition. It additionally purges the live cdn and the byo cdn, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
forceUpdateRedirects | boolean forces an update of the redirects (only applies when updating/publishing redirects.json) |
disableNotifications | boolean disables notifications for affected resources |
Success response of the published document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "live": {
- "status": 200,
- "lastModified": "2021-05-29T22:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md",
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "permissions": [
- "read",
- "write"
]
}, - "links": {
}
}
Un-publish a resource by deleting the content from from the live
content-bus partition. It additionally purges the live cdn and the byo cdn, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
disableNotifications | boolean disables notifications for affected resources |
Updates live resources specified in the paths
property in the payload.
By default, only new and modified resources are updated, unless the forceUpdate
property is set to true
.
Note that configuration files, like /.helix/config
or redirects.json
, are always ignored during bulk publish.
Note that the bulk publish is performed asynchronously and this request will return information to the created job.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
forceUpdate | boolean forces an update of the resources during bulk-publish |
paths required | Array of strings paths to filter the bulk publish |
delete | boolean Default: false delete the resources from publish |
{- "forceUpdate": true,
- "paths": [
- "/en",
- "/metadata.json",
- "/blog/"
], - "delete": false
}
Success response.
{- "status": 202,
- "messageId": "37e92eec-020c-4eae-8f80-3db444c25056",
- "job": {
- "topic": "publish",
- "name": "job-123",
- "state": "created",
- "startTime": "2021-05-31T23:00:00Z",
- "data": {
- "paths": [
- {
- "path": "/en"
}, - {
- "path": "/blog/"
}, - {
- "path": "/metadata.json"
}
]
}
}, - "links": {
}
}
Returns the preview status of the respective resource.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Success response of a preview document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "preview": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md",
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "permissions": [
- "read"
]
}, - "links": {
}
}
Updates the preview resource by fetching the latest content from the content providers (e.g. sharepoint, google docs, BYOM) and storing it in preview
.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
forceUpdateRedirects | boolean forces an update of the redirects (only applies when updating/publishing redirects.json) |
hlx-word2md-version | string selects the version to use when invoking the word2md service. |
hlx-gdocs2md-version | string selects the version to use when invoking the gdocs2md service. |
hlx-html2md-version | string selects the version to use when invoking the html2md service. |
Success response.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "preview": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/preview/en/2021/blog.md",
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "permissions": [
- "read",
- "write"
]
}, - "links": {
}
}
Deletes a preview resource from the preview
partition in the content-bus..
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Updates preview resources specified in the paths
property in the payload. If a path ends with /*
, it is assume to be folder and is recursively previewed.
By default, only new and modified resources are updated, unless the forceUpdate
property is set to true
.
Note that configuration files, like /.helix/config
or redirects.json
, are always ignored during bulk preview.
Note that the bulk preview is performed asynchronously and this request will return information to the created job.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
hlx-word2md-version | string selects the version to use when invoking the word2md service. |
hlx-gdocs2md-version | string selects the version to use when invoking the gdocs2md service. |
hlx-html2md-version | string selects the version to use when invoking the html2md service. |
forceUpdate | boolean forces an update of the resources during bulk-preview |
paths required | Array of strings paths to filter the bulk preview |
delete | boolean Default: false delete the resources from preview |
{- "forceUpdate": true,
- "paths": [
- "/en",
- "/en/*",
- "/metadata.json",
- "/blog/"
], - "delete": false
}
Success response.
{- "status": 202,
- "messageId": "37e92eec-020c-4eae-8f80-3db444c25056",
- "job": {
- "topic": "preview",
- "name": "job-123",
- "state": "created",
- "startTime": "2021-05-31T23:00:00Z",
- "data": {
- "paths": [
- "/documents"
]
}
}, - "links": {
}
}
Returns the code bus status of the respective resource.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
string or string Optional branch specifier in case the branch name contains slashes or uppercase characters. |
Success response of a code document.
{- "webPath": "/scripts.js",
- "resourcePath": "/scripts.js",
- "code": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "codeBusId": "helix-code-bus/owner/repo/main/scripts.js",
- "permissions": [
- "read"
]
}, - "links": {
}
}
Updates the code-bus resource by fetching the latest content from github and storing it in the code-bus. If the last path segment is a *
, it will recursively update the code-bus with the respective github tree (directory). It additionally purges the live cdn and the byo cdn, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
string or string Optional branch specifier in case the branch name contains slashes or uppercase characters. |
Success response.
[- {
- "code": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "codeBusId": "helix-code-bus/owner/repo/main/scripts.js",
- "permissions": [
- "read",
- "write"
]
}
}
]
Deletes a code resource from the code-bus It additionally purges the live cdn and the byo cdn, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
string or string Optional branch specifier in case the branch name contains slashes or uppercase characters. |
Processes a change event and updates the code-bus accordingly. It additionally purges the live cdn and the byo cdn, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
source | string event source, eg: 'github' |
baseRef | string base ref for branch operations |
required | Array of objects (changeEntry) array of changes |
property name* additional property | any |
{- "type": "github",
- "baseRef": "",
- "installationId": 995843,
- "changes": [
- {
- "path": "new-file.txt",
- "time": "2021-05-04T13:40:15+09:00",
- "type": "added",
- "contentType": "text/plain; charset=utf-8",
- "commit": "5edf98811d50b5b948f6f890f0c4367095490dbd"
}, - {
- "path": "src/html.htl",
- "time": "2021-05-04T13:40:15+09:00",
- "type": "deleted",
- "contentType": "application/octet-stream",
- "commit": "5edf98811d50b5b948f6f890f0c4367095490dbd"
}, - {
- "path": "README.md",
- "time": "2021-05-04T13:40:15+09:00",
- "type": "modified",
- "contentType": "text/markdown; charset=utf-8",
- "commit": "5edf98811d50b5b948f6f890f0c4367095490dbd"
}, - {
- "path": "fail.md",
- "time": "2021-05-04T13:40:15+09:00",
- "type": "modified",
- "contentType": "text/markdown; charset=utf-8",
- "commit": "5edf98811d50b5b948f6f890f0c4367095490dbd"
}
]
}
Success response.
[- {
- "code": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "codeBusId": "helix-code-bus/owner/repo/main/scripts.js",
- "permissions": [
- "read",
- "write"
]
}
}
]
Purges the resource from the respective live cdn. It optionally invokes the byo cdn purging hook, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Returns the index status of the respective resource.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Success response of an index document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "index": {
- "name": "blog",
- "lastModified": "Tue, 01 Mar 2022 08:32:01 GMT"
}
}
Index a resource. If the last path segment is a *
, it will recursively reindex all published resources below that sub tree.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Success response of indexing a resource.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "index": {
- "name": "blog",
- "lastModified": "Tue, 01 Mar 2022 08:32:01 GMT"
}
}
Removes a resource from the index.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Success response of removing a resource from the index.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "index": {
- "name": "blog",
- "status": 202
}
}
Generates a sitemap. The path specified should be the destination path of a sitemap.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
path required | string Relative path of the resource |
Success response of generating a sitemap
{- "paths": [
- "/sitemap.xml"
]
}
Returns the snapshot manifest
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
Success response of a snapshot manifest.
{- "manifest": {
- "id": "12345",
- "title": "Test Review",
- "description": "ignore this review",
- "created": "2021-04-31T23:00:00Z",
- "lastModified": "2021-05-31T23:00:00Z",
- "lastUpdated": "2021-05-31T23:00:00Z",
- "resources": [
- {
- "path": "/foo"
}, - {
- "path": "/bar"
}
]
},
}
Updates the Snapshot manifest and allows to lock or unlock the snapshot. Note that in order to lock the snapshot, the request role also needs to include the preview:write
permission, and in order to unlock the snapshot, the live:write
permission is needed.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
locked | boolean |
title | string |
description | string |
object |
{- "locked": true,
- "title": "string",
- "description": "string",
- "metadata": { }
}
Success response of a snapshot manifest.
{- "manifest": {
- "title": "December release",
- "id": "12345",
- "created": "2021-04-31T23:00:00Z",
- "lastModified": "2021-05-31T23:00:00Z",
- "lastUpdated": "2021-05-31T23:00:00Z",
- "resources": [
- {
- "path": "/foo"
}, - {
- "path": "/bar"
}
]
},
}
Returns the snapshot status of the respective resource.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
path required | string Relative path of the resource |
Success response of a snapshot document.
{- "webPath": "/.snapshot/12345/en/2021/blog",
- "resourcePath": "/.snapshot/12345/en/2021/blog.md",
- "preview": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/.snapshot/12345/preview/en/2021/blog.md",
- "permissions": [
- "read",
- "write"
]
}, - "snapshot": {
- "id": "12345",
- "locked": "2021-05-31T23:00:00Z"
}, - "links": {
}
}
Creates a snapshot of the specified resource and stores it in the preview partition below the .snapshot/snapshotId
folder. If the path param ends with a *
, a snapshot of the entire subtree is created. If the snapshot is locked, a 409
response is returned.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
path required | string Relative path of the resource |
filter | any Default: "all" Enum: "all" "modified" Filters the resources that are selected for snapshot. If set to |
Deletes a snapshot resource from the preview
partition in the content-bus. If the path param ends with a *
, the entire subtree is deleted. If the snapshot is locked, a 409
response is returned.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
path required | string Relative path of the resource |
Publish snapshot resources by copying the resource content from the snapshot location to the live
content-bus partition. It additionally purges the live cdn and the byo cdn, if configured. If the path param ends with a *
the resources of the path's entire subtree is published.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
path required | string Relative path of the resource |
publish | any Value: "true" Indicates that the snapshot should be published. |
Success response of the published document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "live": {
- "status": 200,
- "lastModified": "2021-05-29T22:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md",
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "permissions": [
- "read",
- "write"
]
}, - "links": {
}
}
Publish a snapshot by copying all resources from the snapshot location to the live
content-bus partition. It additionally purges the live cdn and the byo cdn, if configured.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
publish | any Value: "true" Indicates that the snapshot should be published. |
Success response of the published document.
{- "webPath": "/en/2021/blog",
- "resourcePath": "/en/2021/blog.md",
- "live": {
- "status": 200,
- "lastModified": "2021-05-29T22:00:00Z",
- "contentBusId": "h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md",
- "sourceLocation": "onedrive:/drives/b!DyVXacYnlkm_17hZL307Me9vzRzaKwZCpVMBYbPOKaVT_gD5WmlHRbC-PCpiwGPx/items/012VWERI4JFIU56LICZNBZA4MYHF6Z4AKJ",
- "sourceLastModified": "2021-05-29T21:00:00Z",
- "permissions": [
- "read",
- "write"
]
}, - "links": {
}
}
Performs a review operation on the snapshot. request
locks the snapshot; approve
publishes all resources, clears, and unlocks the snapshot; reject
unlocks the snapshot. All operations can contain an optional message
parameter which will be included in logs and events.
owner required | string Repository owner. |
repo required | string Name of the repository |
snapshotId required | string Id of the snapshot |
review | any Enum: "request" "approve" "reject" State to move the snapshot into. |
message | string Message of the review action, included in logs and events. |
The API uses your existing Identity Provider (IDP) to authenticate users with administrative access. The general flow is that you open /login
in a browser, select the IDP you want to use, and then are redirected to the IDP login page. After successful login, you are redirected back to the Admin API with an auth token in the response cookie (auth_token
). This token is then used to authenticate all subsequent requests.
Alternatively, you can provide an authorization: token $API_KEY
header. In order to obtain an API_KEY, talk to your AEM project lead.
Success response.
{- "links": {
}
}
Success response.
{- "profile": {
- "iss": "urn:example:issuer",
- "email": "test@example.com",
- "name": "Test User",
- "ttl": 7200
},
}
Returns logs for a project. If there are more logs for the timespan specified, there will be a next
link in the response to load the next batch.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
from | string Indicates the starting date to get logs from. If not specified, uses the current date minus 15 minutes. |
to | string Indicates the ending date to get logs from. If not specified, uses the current date. |
since | string Example: since=5m Indicates the time span to retrieve logs for, as a number and a unit in short notation ( |
nextToken | string Token returned from a previous call to continue |
Success response of a log request.
{- "from": "2023-11-07T14:00:00.000Z",
- "to": "2023-11-07T16:15:12.454Z",
- "entries": [
- {
- "timestamp": 1699368094644,
- "duration": 467,
- "status": 201,
- "method": "POST,",
- "route": "preview",
- "path": "/my-page",
- "contentBusId": "xyz",
- "owner": "owner",
- "repo": "repo",
- "ref": "ref"
}, - {
- "timestamp": 1699368094645,
- "duration": 1005,
- "status": 202,
- "method": "POST",
- "route": "live",
- "snapshotId": "default",
- "user": "foo@example.com",
- "paths": [
- "/",
- "/docs/howto/",
- "/docs/howto/one",
- "/docs/howto/two"
], - "contentBusId": "abc",
- "owner": "owner",
- "repo": "repo",
- "ref": "ref"
}, - {
- "timestamp": 1699372505155,
- "event": "dinner is ready",
- "contentBusId": "xyz",
- "owner": "owner",
- "repo": "repo",
- "ref": "ref"
}
], - "nextToken": "ABAB==",
}
Add logs to a project. The body should be in JSON format and contain an array called entries
.
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
entries required | Array of objects entries to add to the logs |
This posts one entry to the audit log. To see what the added entry would look like, see the second entry in the getLog example.
{- "entries": [
- {
- "event": "dinner is ready"
}
]
}
Returns the job list of jobs
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
topic required | string Topic of a job |
Success response of a job list.
{- "topic": "preview",
- "jobs": [
- {
- "name": "job-123",
- "state": "created",
- "time": "2021-05-31T23:00:00Z",
}, - {
- "name": "job-124",
- "state": "running",
- "time": "2021-04-31T23:00:00Z",
}
],
}
Returns the job status
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
topic required | string Topic of a job |
jobName required | string Name of a job |
Success response.
{- "topic": "preview",
- "name": "job-123",
- "state": "created",
- "startTime": "2021-05-31T23:00:00Z",
- "progress": {
- "total": 10,
- "processed": 0,
- "failed": 0
}, - "links": {
}
}
Returns the job status
owner required | string Repository owner. |
repo required | string Name of the repository |
ref required | string Ref (branch) of repository. |
topic required | string Topic of a job |
jobName required | string Name of a job |
Success response.
{- "topic": "preview",
- "name": "job-123",
- "state": "created",
- "startTime": "2021-05-31T23:00:00Z",
- "progress": {
- "total": 10,
- "processed": 6,
- "failed": 4
}, - "data": {
- "paths": [
- "/documents"
]
},
}
version required | integer Default: 1 Value: 1 |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
Array of objects (users) | |
object (groups) | |
object (tokens) |
{- "version": 1,
- "title": "string",
- "description": "string",
- "users": [
- {
- "id": "string",
- "email": "user@example.com",
- "name": "string",
- "roles": [
- "admin"
]
}
], - "groups": { },
- "tokens": { }
}
pattern property | object (Group) A group of members. Can be referenced in access.admin.role. |
{ }
Returns the organisation level configuration.
org required | string organisation name. |
{- "version": 1,
- "title": "string",
- "description": "string",
- "users": [
- {
- "id": "string",
- "email": "user@example.com",
- "name": "string",
- "roles": [
- "admin"
]
}
], - "groups": { },
- "tokens": { }
}
org required | string organisation name. |
version required | integer Default: 1 Value: 1 |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
Array of objects (users) | |
object (groups) | |
object (tokens) |
{- "version": 1,
- "title": "string",
- "description": "string",
- "users": [
- {
- "id": "string",
- "email": "user@example.com",
- "name": "string",
- "roles": [
- "admin"
]
}
], - "groups": { },
- "tokens": { }
}
{ }
org required | string organisation name. |
version required | integer Default: 1 Value: 1 |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
Array of objects (users) | |
object (groups) | |
object (tokens) |
{- "version": 1,
- "title": "string",
- "description": "string",
- "users": [
- {
- "id": "string",
- "email": "user@example.com",
- "name": "string",
- "roles": [
- "admin"
]
}
], - "groups": { },
- "tokens": { }
}
org required | string organisation name. |
email required | string email of the user |
roles required | Array of strings Items Enum: "admin" "author" "publish" "develop" "basic_author" "basic_publish" "config" "config_admin" role of the user |
{- "email": "string",
- "roles": [
- "admin"
]
}
{- "id": "string",
- "email": "user@example.com",
- "name": "string",
- "roles": [
- "admin"
]
}
Please note that most of the configuration objects that have an explicit schema can also be addressed directly, even if not listed in this documentation.
For example the production CDN configuration can be managed via the /config/{org}/sites/{site}/cdn/prod.json
endpoint.
version required | integer Default: 1 Value: 1 |
name | string^[a-z0-9]+(?:-[a-z0-9]+)*$ Site name; part of the hostname |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
required | object (content) Defines the content bus location and source. |
required | object (code) Defines the code bus location and source. |
object (folders) | |
object (headers) | |
object (cdn) | |
object (access) | |
object (tokens) | |
object (groups) | |
object (sidekick) | |
object (metadata-source) | |
object (robots) | |
public | object (public) Public configuration |
object |
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
object (Role) | |
boolean or string Default: "auto" Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'. | |
defaultRole | Array of strings Items Enum: "admin" "author" "publish" "develop" "basic_author" "basic_publish" "config" "config_admin" the default roles assigned to the users. defaults to |
apiKeyId | Array of strings the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them. |
{- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}
apiKeyId | Array of strings IDs of the api keys (tokens) that are allowed. |
clientCertDN | Array of strings the DNs of the client certificates that are allowed. |
{- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
object (access-admin) | |
object (access-site) | |
object (access-site) | |
object (access-site) |
{- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}
Fastly CDN Config (object) or Cloudflare CDN Config (object) or Akamai CDN Config (object) or Managed CDN Config (object) or Cloudfront CDN Config (object) or EmptyConfig (object) | |
object | |
object |
{- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
owner required | string[a-zA-Z0-9_-]+ |
repo required | string[a-zA-Z0-9_-]+ |
required | object |
{- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
contentBusId required | string |
required | Google Content Source (object) or Onedrive Content Source (object) or Markup Content Source (object) |
Markup Content Source (object) |
{- "title": "string",
- "description": "string",
- "contentBusId": "string",
}
pattern property | object (Group) A group of members. Can be referenced in access.admin.role. |
{ }
Array of objects (sidekickPlugin) |
{- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}
Returns the site level configuration. If migrate
is set to true
, the configuration will be aggregated based on the legacy config (fstab, .helix/config.xlsx, etc).
org required | string organisation name. |
site required | string site id. |
migrate | boolean indicates to migrate the config. |
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
Stores new site configuration. If migrate
is set to true
, the configuration will be aggregated based on the legacy config (fstab, .helix/config.xlsx, etc) and will overwrite the existing configuration.
org required | string organisation name. |
site required | string site id. |
migrate | boolean indicates to migrate the config. |
version required | integer Default: 1 Value: 1 |
name | string^[a-z0-9]+(?:-[a-z0-9]+)*$ Site name; part of the hostname |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
required | object (content) Defines the content bus location and source. |
required | object (code) Defines the code bus location and source. |
object (folders) | |
object (headers) | |
object (cdn) | |
object (access) | |
object (tokens) | |
object (groups) | |
object (sidekick) | |
object (metadata-source) | |
object (robots) | |
public | object (public) Public configuration |
object |
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
org required | string organisation name. |
site required | string site id. |
version required | integer Default: 1 Value: 1 |
name | string^[a-z0-9]+(?:-[a-z0-9]+)*$ Site name; part of the hostname |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
required | object (content) Defines the content bus location and source. |
required | object (code) Defines the code bus location and source. |
object (folders) | |
object (headers) | |
object (cdn) | |
object (access) | |
object (tokens) | |
object (groups) | |
object (sidekick) | |
object (metadata-source) | |
object (robots) | |
public | object (public) Public configuration |
object |
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
Returns the aggregated site level configuration. This includes the inherited values from the profile.
org required | string organisation name. |
site required | string site id. |
{- "version": 1,
- "name": "string",
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { },
- "extends": {
- "profile": "string"
}
}
Please note that most of the configuration objects that have an explicit schema can also be addressed directly, even if not listed in this documentation.
For example the production CDN configuration can be managed via the /config/{org}/profiles/default-profile/cdn/prod.json
endpoint.
version required | integer Default: 1 Value: 1 |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
object (content) Defines the content bus location and source. | |
object (code) Defines the code bus location and source. | |
object (folders) | |
object (headers) | |
object (cdn) | |
object (access) | |
object (tokens) | |
object (groups) | |
object (sidekick) | |
object (metadata-source) | |
object (robots) | |
public | object (public) Public configuration |
{- "version": 1,
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { }
}
object (Role) | |
boolean or string Default: "auto" Enforce authentication if set to true. If set to 'auto' it will enforce authentication if a role mapping is defined. defaults to 'auto'. | |
defaultRole | Array of strings Items Enum: "admin" "author" "publish" "develop" "basic_author" "basic_publish" "config" "config_admin" the default roles assigned to the users. defaults to |
apiKeyId | Array of strings the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them. |
{- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}
apiKeyId | Array of strings IDs of the api keys (tokens) that are allowed. |
clientCertDN | Array of strings the DNs of the client certificates that are allowed. |
{- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
object (access-admin) | |
object (access-site) | |
object (access-site) | |
object (access-site) |
{- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}
Fastly CDN Config (object) or Cloudflare CDN Config (object) or Akamai CDN Config (object) or Managed CDN Config (object) or Cloudfront CDN Config (object) or EmptyConfig (object) | |
object | |
object |
{- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
owner required | string[a-zA-Z0-9_-]+ |
repo required | string[a-zA-Z0-9_-]+ |
required | object |
{- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
contentBusId required | string |
required | Google Content Source (object) or Onedrive Content Source (object) or Markup Content Source (object) |
Markup Content Source (object) |
{- "title": "string",
- "description": "string",
- "contentBusId": "string",
}
Array of objects (sidekickPlugin) |
{- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}
Returns the Profile level configuration.
org required | string organisation name. |
profile required | string profile name. |
{- "version": 1,
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { }
}
org required | string organisation name. |
profile required | string profile name. |
version required | integer Default: 1 Value: 1 |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
object (content) Defines the content bus location and source. | |
object (code) Defines the code bus location and source. | |
object (folders) | |
object (headers) | |
object (cdn) | |
object (access) | |
object (tokens) | |
object (groups) | |
object (sidekick) | |
object (metadata-source) | |
object (robots) | |
public | object (public) Public configuration |
{- "version": 1,
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { }
}
{- "version": 1,
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { }
}
org required | string organisation name. |
profile required | string profile name. |
version required | integer Default: 1 Value: 1 |
title | string (title) human readable title. has no influence on the configuration. |
description | string (description) description for clarity. has no influence on the configuration. |
object (content) Defines the content bus location and source. | |
object (code) Defines the code bus location and source. | |
object (folders) | |
object (headers) | |
object (cdn) | |
object (access) | |
object (tokens) | |
object (groups) | |
object (sidekick) | |
object (metadata-source) | |
object (robots) | |
public | object (public) Public configuration |
{- "version": 1,
- "title": "string",
- "description": "string",
- "content": {
- "title": "string",
- "description": "string",
- "contentBusId": "string",
}, - "code": {
- "title": "string",
- "description": "string",
- "owner": "string",
- "repo": "string",
}, - "folders": { },
- "headers": { },
- "cdn": {
- "prod": {
- "type": "fastly",
- "host": "string",
- "route": [
- "string"
], - "serviceId": "string",
- "authToken": "string"
}, - "live": {
- "host": "main--$repo--page.example.com"
}, - "preview": {
- "host": "main--$repo--live.example.com\""
}
}, - "access": {
- "admin": {
- "role": { },
- "requireAuth": "auto",
- "defaultRole": [
- "admin"
], - "apiKeyId": [
- "string"
]
}, - "site": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "preview": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}, - "live": {
- "apiKeyId": [
- "string"
], - "clientCertDN": [
- "string"
]
}
}, - "tokens": { },
- "groups": { },
- "sidekick": {
- "plugins": [
- {
- "id": "string",
- "title": "string",
- "url": "string",
- "containerId": "string",
- "environments": "any",
- "event": "string",
- "excludePaths": "/foo/**",
- "includePaths": "/foo/bar/**",
- "isContainer": true,
- "isPalette": true,
- "paletteRect": "string",
- "titleI18n": { },
- "passConfig": true,
- "passReferrer": true
}
]
}, - "metadata": {
- "source": [
- "string"
]
}, - "robots": {
- "txt": "string"
}, - "public": { }
}
org required | string organisation name. |
site required | string site id. |
Success response of reading an index configuration
version: 1 indices: default: include: - '/**' target: /query-index.json properties: lastModified: select: none value: parseTimestamp(headers["last-modified"], "ddd, DD MMM YYYY hh:mm:ss GMT")
org required | string organisation name. |
site required | string site id. |
Success response of reading a sitemap configuration
version: 1 sitemaps: default: source: /sitemap-index.json destination: /sitemap.xml lastmod: YYYY-MM-DD