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.
| 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",
- "contentBusId": "helix-content-bu/h3-theblog-123ab123ab12ab123a12b3a/live/en/2021/blog.md",
- "permissions": [
- "read"
]
}, - "preview": {
- "status": 200,
- "lastModified": "2021-05-31T23:00:00Z",
- "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 a combination of |
{- "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. If a path ends with /*, it is assume to be folder and is recursively published.
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 |
{- "forceUpdate": true,
- "paths": [
- "/en",
- "/en/*",
- "/metadata.json",
- "/blog/"
]
}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": [
- {
- "prefix": "/en/"
}, - {
- "path": "/en"
}, - {
- "path": "/blog/"
}, - {
- "path": "/metadata.json"
}
]
}
}, - "links": {
}
}Removes live resources specified in the paths property in the payload. If a path ends with /*, it is assume to be folder and is recursively removed.
Note that configuration files, like /.helix/config or redirects.json, are always ignored during bulk remove.
Note that the bulk remove 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. |
| paths required | Array of strings paths to filter the bulk remove live |
{- "paths": [
- "/en",
- "/en/*",
- "/metadata.json",
- "/blog/"
]
}Success response.
{- "status": 202,
- "messageId": "37e92eec-020c-4eae-8f80-3db444c25056",
- "job": {
- "topic": "remove-live",
- "name": "job-123",
- "state": "created",
- "startTime": "2021-05-31T23:00:00Z",
- "data": {
- "paths": [
- "/documents"
]
}
}, - "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. content-proxy) and storing it in the preview content-bus partition.
| 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 |
{- "forceUpdate": true,
- "paths": [
- "/en",
- "/en/*",
- "/metadata.json",
- "/blog/"
]
}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": {
}
}Removes preview resources specified in the paths property in the payload. If a path ends with /*, it is assume to be folder and is recursively removed.
Note that configuration files, like /.helix/config or redirects.json, are always ignored during bulk remove.
Note that the bulk remove 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. |
| paths required | Array of strings paths to filter the bulk remove preview |
{- "paths": [
- "/en",
- "/en/*",
- "/metadata.json",
- "/blog/"
]
}Success response.
{- "status": 202,
- "messageId": "37e92eec-020c-4eae-8f80-3db444c25056",
- "job": {
- "topic": "remove-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 (todo).
| 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
}
}Success response.
{- "links": {
}
}Success response.
{- "profile": {
- "iss": "urn:example:issuer",
- "email": "test@example.com",
- "name": "Test User",
- "ttl": 7200
},
}Prepares a sheet for data ingestion. Creates the necessary tables/headers to ingest the form data contained in the post body. A sheet named 'incoming' must be manually created (and previewed) in the target workbook before calling this API, doing so signals to the forms service that you approve this sheet to be used to intake data. If the workbook does not contain a shared-default or a slack sheet then they are also created. The path to the sheet must contain the .json extension.
| 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 |
object or Array of arrays A data structure representing the form fields. Can be in the form of a key/value object, an array of name/value pair objects. |
Key/value object request body
{- "data": {
- "firstName": "Bruce",
- "lastName": "Banner"
}
}Success response.
{- "rowCount": 1,
- "columns": [
- "header1",
- "header2"
]
}Generates 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"
]
}Start a video conversion job.
| owner required | string Repository owner. |
| repo required | string Name of the repository |
| ref required | string Ref (branch) of repository. |
| url required | string URL of video to convert |
Success response.
{- "id": "69985ac8-fc98-4f69-8972-0168cfe7bbe6"
}Returns the current status of a convert job
| owner required | string Repository owner. |
| repo required | string Name of the repository |
| ref required | string Ref (branch) of repository. |
| id required | string conversion job Id |
Success response of a job status.
{- "next": "s3Upload",
- "state": "STARTED"
}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"
]
},
}Returns logs for a project
| 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. |
| 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": 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"
}
]
}