AEM Admin API (10.87.20)

Download OpenAPI specification:Download

License: Apache 2.0

AEM Admin API is used to manage the lifecycle of content and code.

status

Status operations

General status

Returns the overall status of the respective resource.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
string or string

Optional URL of the edit (authoring) document

Responses

Response samples

Content type
application/json

Success response of a preview document.

{}

Start a bulk status job

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.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Request Body schema: application/json
paths
required
Array of strings

paths to filter the bulk status

select
Array of strings

a combination of edit, preview and live. The default is ['preview','live'].

Responses

Request samples

Content type
application/json
{
  • "select": [
    ],
  • "paths": [
    ]
}

Response samples

Content type
application/json

Success response.

{}

publish

Publish operations

Publish Status

Returns the publish status of the respective resource.

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of a published document.

{}

Publish a resource.

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.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
forceUpdateRedirects
boolean

forces an update of the redirects (only applies when updating/publishing redirects.json)

disableNotifications
boolean

disables notifications for affected resources

Responses

Response samples

Content type
application/json

Success response of the published document.

{}

Un-publish a resource.

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.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
disableNotifications
boolean

disables notifications for affected resources

Responses

Start a bulk publish job

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.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Request Body schema: application/json
forceUpdate
boolean

forces an update of the resources during bulk-publish

paths
required
Array of strings

paths to filter the bulk publish

Responses

Request samples

Content type
application/json
{
  • "forceUpdate": true,
  • "paths": [
    ]
}

Response samples

Content type
application/json

Success response.

{}

Start a bulk remove live job

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.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Request Body schema: application/json
paths
required
Array of strings

paths to filter the bulk remove live

Responses

Request samples

Content type
application/json
{
  • "paths": [
    ]
}

Response samples

Content type
application/json

Success response.

{}

preview

Preview operations

Preview status

Returns the preview status of the respective resource.

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of a preview document.

{}

Update preview

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.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
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.

Responses

Response samples

Content type
application/json

Success response.

{}

Delete preview

Deletes a preview resource from the preview partition in the content-bus..

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Start a bulk preview job

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.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

query Parameters
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.

Request Body schema: application/json
forceUpdate
boolean

forces an update of the resources during bulk-preview

paths
required
Array of strings

paths to filter the bulk preview

Responses

Request samples

Content type
application/json
{
  • "forceUpdate": true,
  • "paths": [
    ]
}

Response samples

Content type
application/json

Success response.

{}

Start a bulk remove preview job

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.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Request Body schema: application/json
paths
required
Array of strings

paths to filter the bulk remove preview

Responses

Request samples

Content type
application/json
{
  • "paths": [
    ]
}

Response samples

Content type
application/json

Success response.

{}

code

Code bus operations

Code bus status

Returns the code bus status of the respective resource.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
string or string

Optional branch specifier in case the branch name contains slashes or uppercase characters.

Responses

Response samples

Content type
application/json

Success response of a code document.

{}

Update code

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.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
string or string

Optional branch specifier in case the branch name contains slashes or uppercase characters.

Responses

Response samples

Content type
application/json

Success response.

[]

Delete code

Deletes a code resource from the code-bus It additionally purges the live cdn and the byo cdn, if configured.

Authorizations:
NoneAuthCookie
path Parameters
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

query Parameters
string or string

Optional branch specifier in case the branch name contains slashes or uppercase characters.

Responses

Batch update code

Processes a change event and updates the code-bus accordingly. It additionally purges the live cdn and the byo cdn, if configured.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Request Body schema: application/json
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

Responses

Request samples

Content type
application/json
{
  • "type": "github",
  • "baseRef": "",
  • "installationId": 995843,
  • "changes": [
    ]
}

Response samples

Content type
application/json

Success response.

[]

cache

Cache operations

Purge live cache

Purges the resource from the respective live cdn. It optionally invokes the byo cdn purging hook, if configured (todo).

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

index

Index operations

Index Status

Returns the index status of the respective resource.

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of an index document.

{}

Re-index a resource.

Index a resource. If the last path segment is a *, it will recursively reindex all published resources below that sub tree.

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of indexing a resource.

{}

Remove a resource from the index.

Removes a resource from the index.

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of removing a resource from the index.

{
  • "webPath": "/en/2021/blog",
  • "resourcePath": "/en/2021/blog.md",
  • "index": {
    }
}

authentication

Authentication operations

Login Selection

Provides a selection of available IDP logins

Authorizations:
None

Responses

Response samples

Content type
application/json
Example

Success response.

{}

Auto login

Redirects to IDP corresponding the project setup

Authorizations:
None
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Responses

Logout

Logs out the current session and redirects to the login screen

Authorizations:
None

Responses

Profile information

Display profile information

Authorizations:
NoneAuthCookie

Responses

Response samples

Content type
application/json

Success response.

{
  • "profile": {
    },
  • "links": {}
}

form

Form operations

Create form

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.

Authorizations:
NoneAuthCookie
path Parameters
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

Request Body schema:
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.

Responses

Request samples

Content type
Example

Key/value object request body

{
  • "data": {
    }
}

Response samples

Content type
application/json

Success response.

{
  • "rowCount": 1,
  • "columns": [
    ]
}

sitemap

Sitemap operations

Generates a sitemap

Generates a sitemap

Authorizations:
None
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of generating a sitemap

{
  • "paths": [
    ]
}

convert

Convert operations

Start convert

Start a video conversion job.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

query Parameters
url
required
string

URL of video to convert

Responses

Response samples

Content type
application/json

Success response.

{
  • "id": "69985ac8-fc98-4f69-8972-0168cfe7bbe6"
}

Convert status

Returns the current status of a convert job

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of a job status.

{
  • "next": "s3Upload",
  • "state": "STARTED"
}

job

Job operations

Job List

Returns the job list of jobs

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response of a job list.

{}

Job Status

Returns the job status

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response.

{}

Stop job

Stops a job.

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Job Status Details

Returns the job status

Authorizations:
NoneAuthCookie
path Parameters
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

Responses

Response samples

Content type
application/json

Success response.

{}

log

Log operations

Returns logs

Returns logs for a project

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

query Parameters
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

Responses

Response samples

Content type
application/json

Success response of a log request.

{
  • "from": "2023-11-07T14:00:00.000Z",
  • "to": "2023-11-07T16:15:12.454Z",
  • "entries": [
    ],
  • "nextToken": "ABAB=="
}

Add logs

Add logs to a project. The body should be in JSON format and contain an array called entries.

Authorizations:
NoneAuthCookie
path Parameters
owner
required
string

Repository owner.

repo
required
string

Name of the repository

ref
required
string

Ref (branch) of repository.

Request Body schema: application/json
entries
required
Array of objects

entries to add to the logs

Responses

Request samples

Content type
application/json

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": [
    ]
}