API docs by Redocly

AEM Admin API Service (1.61.0)

Download OpenAPI specification:

License: Apache 2.0

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

status

Status operations

General status

Returns the overall status of the respective resource.

Authorizations:
NoneAuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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.

{}

preview

Preview operations

Preview status

Returns the preview status of the respective resource.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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. sharepoint, google docs, BYOM) and storing it in preview.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

query Parameters
forceUpdateRedirects
boolean

Forces an update of the redirect table. Only applies when updating or publishing redirects.json.

Responses

Response samples

Content type
application/json

Success response.

{}

Delete preview

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

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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 assumed to be a folder and is recursively previewed.
By default, only new and modified resources are updated, unless the forceUpdate property is set to true.
Note that the bulk preview is performed asynchronously and this request will return information to the created job.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Request Body schema: application/json
forceUpdate
boolean

forces an update of the resources during bulk-preview

forceAsync
boolean

forces the job to be executed asynchronous, even for a small number of given paths.

paths
required
Array of strings

paths to filter the bulk preview

delete
boolean
Default: false

delete the resources from preview

Responses

Request samples

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

Response samples

Content type
application/json

Success response.

{}

publish

Publish operations

Publish Status

Returns the publish status of the respective resource.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

query Parameters
forceUpdateRedirects
boolean

Forces an update of the redirect table. Only applies when updating or publishing redirects.json.

disableNotifications
boolean

When set to true, suppresses change 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 the live content-bus partition. It additionally purges the live cdn and the byo cdn, if configured.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

query Parameters
disableNotifications
boolean

When set to true, suppresses change notifications for affected resources.

Responses

Start a bulk publish job

Publishes 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 the bulk publish is performed asynchronously and this request will return information to the created job.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Request Body schema: application/json
forceUpdate
boolean

forces an update of the resources during bulk-publish

forceAsync
boolean

forces the job to be executed asynchronous, even for a small number of given paths.

paths
required
Array of strings

paths to filter the bulk publish

delete
boolean
Default: false

delete the resources from publish

Responses

Request samples

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

Response samples

Content type
application/json

Success response.

{}

source

Source document management operations

Get document

Returns the source document content and metadata.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Get document headers only

Obtain headers for the document.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Create document

Creates a document in the source bus. External images are interned in the media bus and references to these images are updated. The document is also pretty-printed.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Request Body schema: */*
required

The raw content of the document to create, its format must be indicated by the Content-Type request header (e.g. text/html for documents, application/json, application/pdf, image/jpeg, etc.).

string <binary>

Responses

Replace, copy, or move a document

Creates or replaces a document in the content bus. The document is assumed to not have external images. If external images are present, they are rejected with a 400 error. In that case the document should be created using the POST method instead to have those images interned.
When the source query parameter is provided, copies (or moves) the document from the source path to the specified path. Set move=true to move instead of copy. The collision parameter controls behavior when the destination already exists.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

query Parameters
source
string

Source path for copy/move operations. When provided, the document at this path is copied (or moved) to the destination path. The value is specified rooted as an absolute path from the site root.

move
boolean
Default: false

When set to true together with source, moves the resource instead of copying it.

collision
string
Enum: "overwrite" "unique"

Collision handling strategy when the destination already exists. Set to overwrite to replace the existing resource. Set to unique to append a (base-36) encoded timestamp to the destination name to make it unique. These timestamps are alphabetically sortable.

Request Body schema: */*
optional

The raw content of the document to create. Only required when the source query parameter is not provided; for copy/move operations the body is omitted and the destination is populated from source instead. When a body is provided, its format must be indicated by the Content-Type request header (e.g. text/html for documents, application/json, application/pdf, image/jpeg, etc.).

string <binary>

Responses

Response samples

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

Delete document

Deletes a document by moving it to the .trash folder.
If the document is already in the trash, it is deleted permanently.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

List folder

Lists the contents of a folder (path ending with /).
Returns an array of files and subfolders sorted by name.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create folder

Creates a folder in the content source (path ending with /) by placing a marker file in the folder. If the folder already exists, this operation has no effect.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Copy or move folder

Copies or moves a folder (path ending with /) and all of its contents recursively from the location given by the source query parameter to the specified path. Set move=true to move instead of copy. The collision parameter controls behaviour when the destination already exists.
The source query parameter is required and must itself reference a folder (path ending with /); copying a file onto a folder path (or vice versa) is rejected with a 400.
No request body is accepted on this operation.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

query Parameters
source
required
string

Source folder path (must end with /) to copy or move from. Specified as an absolute path from the site root.

move
boolean
Default: false

When set to true, moves the folder instead of copying it.

collision
string
Enum: "overwrite" "unique"

Collision handling strategy when the destination already exists. Set to overwrite to replace existing resources. Set to unique to append a (base-36) encoded timestamp to colliding destination names to make them unique. These timestamps are alphabetically sortable.

Responses

Response samples

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

Delete folder

Deletes a folder and all its contents recursively (path ending with /). All the contents of the folder and subfolders are moved to the .trash folder.
If the folder is already in the trash, it is deleted permanently.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Create version

Creates a new version of a document. The version is created by copying the document to the version storage.
Optional query parameters operation and comment can be provided to annotate the version.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

query Parameters
operation
string

Operation that triggered the version creation (e.g. preview, version).

comment
string

Comment to annotate the version.

Responses

List versions

Lists all versions of a document, ordered from oldest to newest.
To retrieve a specific version, append the version id to the path: /{org}/sites/{site}/source/{path}/.versions/{versionId}.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get version

Retrieves the content of a specific version of a document. The body is returned as-is and its format is indicated by the Content-Type response header (the same format the document had when the version was created).

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

versionId
required
string

Version identifier returned from the version listing.

Responses

authentication

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, use the Site Config Property API to create one.

Login Selection

Provides a selection of available IDP logins

Authorizations:
None

Responses

Response samples

Content type
application/json
Example

Success response.

{}

Logout

Logs out the current session and redirects to the login screen

Authorizations:
None

Responses

Profile information

Display profile information

Authorizations:
NoneAuthCookie
query Parameters
org
string

Organisation name (optional filter for profile).

site
string

Site identifier (optional filter for profile).

Responses

Response samples

Content type
application/json

Success response.

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

Auto login

Redirects to IDP corresponding to the project setup

Authorizations:
None
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Responses

log

Log operations

Returns logs

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.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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.

since
string
Example: since=5m

Indicates the time span to retrieve logs for, as a number and a unit in short notation (s, m, h or d). Not usable in combination with either from or to.

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==",
  • "links": {}
}

Add logs

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

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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

entries to add to the logs

Responses

Request samples

Content type
application/json

Posts one entry to the audit log.

{
  • "entries": [
    ]
}

job

Job operations

Job List

Returns the list of jobs for a topic

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

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:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

topic
required
string

Topic of a job

jobName
required
string

Name of a job

Responses

Job Report

Returns the detailed job report

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

topic
required
string

Topic of a job

jobName
required
string

Name of a job

Responses

Response samples

Content type
application/json

Success response.

{}

Org Config

Org Config operations

OrgConfig

version
required
integer
Default: 1
created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

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)
Array
id
required
string^[a-zA-Z0-9-_=]+$
email
required
string
name
string
roles
required
Array of strings
Items Enum: "admin" "author" "publish" "develop" "basic_author" "basic_publish" "config" "config_admin"
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (apikeys)

Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.

pattern property
object
id
required
string^[a-zA-Z0-9-_/+]+$

the API token id (jti)

created
required
string <date-time>
expiration
required
string <date-time>
roles
required
Array of strings
subject
required
string

the subject of the API token (sub)

description
string
object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (org-access)
object
apiKeyId
Array of strings

the id of the API key(s) that are allowed to access this org (admin).

registry
string
Enum: "github" "custom"
{
  • "version": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "users": [
    ],
  • "groups": { },
  • "secrets": { },
  • "apiKeys": { },
  • "tokens": { },
  • "access": {
    },
  • "registry": "github"
}

GroupsConfig

pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
Array
email
required
string
name
string
{ }

SecretsConfig

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
{ }

Read Organisation Config

Returns the organisation level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

Responses

Response samples

Content type
application/json
{
  • "version": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "users": [
    ],
  • "groups": { },
  • "secrets": { },
  • "apiKeys": { },
  • "tokens": { },
  • "access": {
    },
  • "registry": "github"
}

Update Organisation Config

Stores updated organisation level configuration. Creates a new version if versionName is specified.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

query Parameters
versionName
string

Optional label to attach to the config version created by this operation.

Request Body schema: application/json
version
required
integer
Default: 1
created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

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)
Array
id
required
string^[a-zA-Z0-9-_=]+$
email
required
string
name
string
roles
required
Array of strings
Items Enum: "admin" "author" "publish" "develop" "basic_author" "basic_publish" "config" "config_admin"
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (apikeys)

Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.

pattern property
object
id
required
string^[a-zA-Z0-9-_/+]+$

the API token id (jti)

created
required
string <date-time>
expiration
required
string <date-time>
roles
required
Array of strings
subject
required
string

the subject of the API token (sub)

description
string
object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (org-access)
object
apiKeyId
Array of strings

the id of the API key(s) that are allowed to access this org (admin).

registry
string
Enum: "github" "custom"

Responses

Request samples

Content type
application/json
{
  • "version": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "users": [
    ],
  • "groups": { },
  • "secrets": { },
  • "apiKeys": { },
  • "tokens": { },
  • "access": {
    },
  • "registry": "github"
}

Response samples

Content type
application/json
{ }

Create Organisation Config

Creates the organisation level configuration. Returns 409 if a configuration already exists.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

Request Body schema: application/json
version
required
integer
Default: 1
created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

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)
Array
id
required
string^[a-zA-Z0-9-_=]+$
email
required
string
name
string
roles
required
Array of strings
Items Enum: "admin" "author" "publish" "develop" "basic_author" "basic_publish" "config" "config_admin"
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (apikeys)

Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.

pattern property
object
id
required
string^[a-zA-Z0-9-_/+]+$

the API token id (jti)

created
required
string <date-time>
expiration
required
string <date-time>
roles
required
Array of strings
subject
required
string

the subject of the API token (sub)

description
string
object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (org-access)
object
apiKeyId
Array of strings

the id of the API key(s) that are allowed to access this org (admin).

registry
string
Enum: "github" "custom"

Responses

Request samples

Content type
application/json
{
  • "version": 1,
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "users": [
    ],
  • "groups": { },
  • "secrets": { },
  • "apiKeys": { },
  • "tokens": { },
  • "access": {
    },
  • "registry": "github"
}

Delete Organisation Config

Permanently deletes the organisation level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

Responses

Read Organisation Config Property

Returns a sub-property of the organisation level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }

Update Organisation Config Property

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }

Delete Organisation Config Property

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

path
required
string

Relative path of the resource

Responses

List Profiles

Returns the profile names for this organisation.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

query Parameters
details
boolean

Show detailed information about the resources in the list

Responses

Response samples

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

List Sites

Returns the site names for this organisation.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

query Parameters
details
boolean

Show detailed information about the resources in the list

Responses

Response samples

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

Site Config

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 /{org}/sites/{site}/config/cdn/prod.json endpoint.

SiteConfig

version
required
integer
Default: 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.

created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

required
object (content)

Defines the content bus location and source.

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
required
object (code)

Defines the code bus location and source.

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
object (folders)
^/[a-zA-Z0-9-_/.]*$
pattern property
string
object (headers)
pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
object (cdn)
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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

object (access)
object (access-admin)
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (apikeys)

Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.

pattern property
object
id
required
string^[a-zA-Z0-9-_/+]+$

the API token id (jti)

created
required
string <date-time>
expiration
required
string <date-time>
roles
required
Array of strings
subject
required
string

the subject of the API token (sub)

description
string
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (sidekick)
editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

object (metadata-source)
source
Array of strings
object (robots)
txt
string
public
object (public)

Public configuration

object (events)
required
object
target
required
string^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$
object (features)

Features configuration

pattern property
object
property name*
additional property
any
object (limits)

Features configuration

pattern property
object
description
string
property name*
additional property
any
object
profile
string^[0-9a-zA-Z-_]+$
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

SiteConfigList

required
Array of objects
Array
name
required
string
{
  • "sites": [
    ]
}

AdminAccessConfig

object (Role)
^[a-z-_]+$
pattern property
Array of strings

The email glob of the users or a group reference for the respective 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'.

One of
boolean
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 basic_publish for unauthenticated setups.

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

SiteAccessConfig

allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

{
  • "allow": [
    ],
  • "secretId": [
    ],
  • "apiKeyId": [
    ]
}

AccessConfig

object (access-admin)
object (Role)
^[a-z-_]+$
pattern property
Array of strings

The email glob of the users or a group reference for the respective 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'.

One of
boolean
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

{
  • "admin": {
    },
  • "site": {
    },
  • "preview": {
    },
  • "live": {
    }
}

CDNConfig

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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

{
  • "prod": {
    },
  • "live": {
    },
  • "preview": {
    },
  • "review": {
    }
}

CodeConfig

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
{
  • "title": "string",
  • "description": "string",
  • "owner": "string",
  • "repo": "string",
  • "source": {}
}

ContentConfig

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
{
  • "title": "string",
  • "description": "string",
  • "contentBusId": "string",
  • "source": {},
  • "overlay": {}
}

FoldersConfig

^/[a-zA-Z0-9-_/.]*$
pattern property
string
{ }

HeadersConfig

pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
{ }

MetadataConfig

source
Array of strings
{
  • "source": [
    ]
}

PublicConfig

object (PublicConfig)

Public configuration

{ }

GroupsConfig

pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
Array
email
required
string
name
string
{ }

RobotsConfig

txt
string
{
  • "txt": "string"
}

SidekickConfig

editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

{
  • "editUrlLabel": "string",
  • "editUrlPattern": "string",
  • "host": "example.com",
  • "liveHost": "example.com",
  • "plugins": [
    ],
  • "previewHost": "example.com",
  • "project": "string",
  • "reviewHost": "example.com",
  • "specialViews": [
    ],
  • "trustedHosts": [
    ],
  • "wordSaveDelay": 0
}

TokensConfig

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
{ }

SecretsConfig

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
{ }

Read Site Config

Returns the site level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Responses

Response samples

Content type
application/json
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

Update Site Config

Stores new site configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

query Parameters
versionName
string

Optional label to attach to the config version created by this operation.

Request Body schema: application/json
version
required
integer
Default: 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.

created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

required
object (content)

Defines the content bus location and source.

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
required
object (code)

Defines the code bus location and source.

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
object (folders)
^/[a-zA-Z0-9-_/.]*$
pattern property
string
object (headers)
pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
object (cdn)
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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

object (access)
object (access-admin)
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (apikeys)

Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.

pattern property
object
id
required
string^[a-zA-Z0-9-_/+]+$

the API token id (jti)

created
required
string <date-time>
expiration
required
string <date-time>
roles
required
Array of strings
subject
required
string

the subject of the API token (sub)

description
string
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (sidekick)
editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

object (metadata-source)
source
Array of strings
object (robots)
txt
string
public
object (public)

Public configuration

object (events)
required
object
target
required
string^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$
object (features)

Features configuration

pattern property
object
property name*
additional property
any
object (limits)

Features configuration

pattern property
object
description
string
property name*
additional property
any
object
profile
string^[0-9a-zA-Z-_]+$

Responses

Request samples

Content type
application/json
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

Response samples

Content type
application/json
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

Create Site Config

Creates the site level configuration. Returns 409 if a configuration already exists.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Request Body schema: application/json
version
required
integer
Default: 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.

created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

required
object (content)

Defines the content bus location and source.

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
required
object (code)

Defines the code bus location and source.

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
object (folders)
^/[a-zA-Z0-9-_/.]*$
pattern property
string
object (headers)
pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
object (cdn)
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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

object (access)
object (access-admin)
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (apikeys)

Stores information about generated admin API keys. The keys listed here have no operational meaning, but are used to track the keys that have been generated.

pattern property
object
id
required
string^[a-zA-Z0-9-_/+]+$

the API token id (jti)

created
required
string <date-time>
expiration
required
string <date-time>
roles
required
Array of strings
subject
required
string

the subject of the API token (sub)

description
string
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (sidekick)
editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

object (metadata-source)
source
Array of strings
object (robots)
txt
string
public
object (public)

Public configuration

object (events)
required
object
target
required
string^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$
object (features)

Features configuration

pattern property
object
property name*
additional property
any
object (limits)

Features configuration

pattern property
object
description
string
property name*
additional property
any
object
profile
string^[0-9a-zA-Z-_]+$

Responses

Request samples

Content type
application/json
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

Response samples

Content type
application/json
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

Delete Site Config

Permanently deletes the site level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Responses

Read Site Config Property

Returns a sub-property of the site level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }

Update Site Config Property

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }

Delete Site Config Property

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Profile Config

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 /{org}/profiles/{profile}/config/cdn/prod.json endpoint.

ProfileConfig

version
required
integer
Default: 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.

created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

object (content)

Defines the content bus location and source.

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
object (code)

Defines the code bus location and source.

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
object (folders)
^/[a-zA-Z0-9-_/.]*$
pattern property
string
object (headers)
pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
object (cdn)
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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

object (access)
object (access-admin)
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (sidekick)
editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

object (metadata-source)
source
Array of strings
object (robots)
txt
string
public
object (public)

Public configuration

object (events)
required
object
target
required
string^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$
object (features)

Features configuration

pattern property
object
property name*
additional property
any
object (limits)

Features configuration

pattern property
object
description
string
property name*
additional property
any
{
  • "version": 1,
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { }
}

ProfileConfigList

required
Array of objects
Array
name
required
string
{
  • "profiles": [
    ]
}

AdminAccessConfig

object (Role)
^[a-z-_]+$
pattern property
Array of strings

The email glob of the users or a group reference for the respective 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'.

One of
boolean
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 basic_publish for unauthenticated setups.

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

SiteAccessConfig

allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

{
  • "allow": [
    ],
  • "secretId": [
    ],
  • "apiKeyId": [
    ]
}

AccessConfig

object (access-admin)
object (Role)
^[a-z-_]+$
pattern property
Array of strings

The email glob of the users or a group reference for the respective 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'.

One of
boolean
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

{
  • "admin": {
    },
  • "site": {
    },
  • "preview": {
    },
  • "live": {
    }
}

CDNConfig

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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

{
  • "prod": {
    },
  • "live": {
    },
  • "preview": {
    },
  • "review": {
    }
}

CodeConfig

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
{
  • "title": "string",
  • "description": "string",
  • "owner": "string",
  • "repo": "string",
  • "source": {}
}

ContentConfig

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
{
  • "title": "string",
  • "description": "string",
  • "contentBusId": "string",
  • "source": {},
  • "overlay": {}
}

FoldersConfig

^/[a-zA-Z0-9-_/.]*$
pattern property
string
{ }

HeadersConfig

pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
{ }

MetadataConfig

source
Array of strings
{
  • "source": [
    ]
}

PublicConfig

object (PublicConfig)

Public configuration

{ }

RobotsConfig

txt
string
{
  • "txt": "string"
}

SidekickConfig

editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

{
  • "editUrlLabel": "string",
  • "editUrlPattern": "string",
  • "host": "example.com",
  • "liveHost": "example.com",
  • "plugins": [
    ],
  • "previewHost": "example.com",
  • "project": "string",
  • "reviewHost": "example.com",
  • "specialViews": [
    ],
  • "trustedHosts": [
    ],
  • "wordSaveDelay": 0
}

TokensConfig

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
{ }

SecretsConfig

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
{ }

Read Profile Config

Returns the profile level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

Responses

Response samples

Content type
application/json
{
  • "version": 1,
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { }
}

Update Profile Config

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

query Parameters
versionName
string

Optional label to attach to the config version created by this operation.

Request Body schema: application/json
version
required
integer
Default: 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.

created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

object (content)

Defines the content bus location and source.

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
object (code)

Defines the code bus location and source.

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
object (folders)
^/[a-zA-Z0-9-_/.]*$
pattern property
string
object (headers)
pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
object (cdn)
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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

object (access)
object (access-admin)
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (sidekick)
editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

object (metadata-source)
source
Array of strings
object (robots)
txt
string
public
object (public)

Public configuration

object (events)
required
object
target
required
string^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$
object (features)

Features configuration

pattern property
object
property name*
additional property
any
object (limits)

Features configuration

pattern property
object
description
string
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "version": 1,
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { }
}

Response samples

Content type
application/json
{
  • "version": 1,
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { }
}

Create Profile Config

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

Request Body schema: application/json
version
required
integer
Default: 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.

created
required
string <date-time> (created)

the date and time this configuration was created.

lastModified
required
string <date-time> (lastModified)

the date and time this configuration was modified last.

object (content)

Defines the content bus location and source.

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)
One of
type
required
any
Value: "google"
url
required
string <uri>
id
required
string

Google drive ID of the root folder; updated automatically when updating the url.

Markup Content Source (object)

Overlay from a BYOM source. Previewing resources will try the overlay source first. Please note, that the overlay config is tied to the base content and not to the site config. I.e. it's not possible to have multiple sites with different overlays on the same base content.

One of
type
required
any
Value: "markup"
url
required
string <uri>
suffix
string
object (code)

Defines the code bus location and source.

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
type
required
any
Value: "github"
url
required
string <uri>
raw_url
string <uri>
secretId
string^[a-zA-Z0-9-_=]+$
owner
string^[a-zA-Z0-9_-]+$
repo
string^[a-zA-Z0-9_-]+$
object (folders)
^/[a-zA-Z0-9-_/.]*$
pattern property
string
object (headers)
pattern property
Array of objects (keyValuePair)
Array
key
required
string
value
required
string
object (cdn)
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)
One of
type
required
string
Value: "fastly"
host
required
string^$|^([a-zA-Z0-9]([a-zA-Z0-9-]{0,61}[a-zA-Z0-9...

production host

route
Array of strings

Routes on the CDN that are rendered with Franklin

serviceId
required
string

The Fastly Service ID

authToken
required
string

A Fastly token for purging

object
host
required
string

Sidekick config to override the default liveHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default previewHost. it supports parameters $owner and $repo

object
host
required
string

Sidekick config to override the default reviewHost. it supports parameters $owner and $repo

object (access)
object (access-admin)
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 basic_publish for unauthenticated setups.

apiKeyId
Array of strings

the id of the API key(s). this is used to validate the API KEYS and allows to invalidate them.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (access-site)
allow
Array of strings

The email glob of the users or a group reference that are allowed access

secretId
Array of strings[ items^[a-zA-Z0-9-_=+/]+$ ]

IDs of the hashed secrets that are allowed.

apiKeyId
Array of strings
Deprecated

IDs of the api keys that are allowed. This is deprecated. use secretId instead.

object (tokens)
Deprecated

site tokens. deprecated: use the org secrets instead.

pattern property
object
id
string^[a-zA-Z0-9-_=]+$
hash
string^[a-zA-Z0-9-_=]+$
created
string <date-time>
object (secrets)

Defines organization level secrets.

pattern property
object or object
One of
hash
required
string^[a-zA-Z0-9-_=]+$
id
required
string^[a-zA-Z0-9-_=]+$
type
required
string
Enum: "hashed" "key"
created
required
string <date-time>
lastModified
required
string <date-time>
description
string
object (groups)
pattern property
object (Group)

A group of members. Can be referenced in access.admin.role.

required
Array of objects
object (sidekick)
editUrlLabel
string

The label of the custom editing environment.

editUrlPattern
string

The URL pattern for the custom editing environment. Supports placeholders like {{contentSourceUrl}} or {{pathname}}.

host
string <hostname>

The host name of the production website (overrides cdn.prod.host)

liveHost
string <hostname>

The host name of the live environment (overrides cdn.live.host, defaults to *.aem.live)

Array of objects (sidekickPlugin)
Array
badgeVariant
string
Enum: "gray" "red" "orange" "yellow" "chartreuse" "celery" "green" "seafoam" "cyan" "blue" "indigo" "purple" "fuchsia" "magenta"

The variant of the badge following the Adobe Spectrum badge variants

containerId
string

The ID of the container to add this plugin to

environments
Array of strings
Default: "any"
Items Enum: "any" "dev" "admin" "edit" "preview" "review" "live" "prod"

The environments to display this plugin in

event
string

The name of a custom event to fire when the button is clicked (defaults to id)

excludePaths
Array of strings

Excludes the plugin from these paths

id
required
string

The unique plugin ID

includePaths
Array of strings

Includes the plugin on these paths (overrides excludePaths)

isBadge
boolean

Renders the plugin as a badge

isContainer
boolean

Renders the plugin as a container for other plugins

isPalette
boolean

Opens the URL in a palette instead of a new tab

isPopover
boolean

Opens the URL in a popover instead of a new tab

paletteRect
string

The dimensions and position of the palette (top, left, bottom, right, width, height)

passConfig
boolean

Append ref, repo, owner, host, and project as query params to the URL

passReferrer
boolean

Append the referrer URL as a query param to the URL

pinned
boolean

Renders the plugin in the bar (true, default) or the menu (false)

popoverRect
string

The dimensions of the popover (width, height)

title
string

The button text

object non-empty

The button text in other supported languages

url
string

The URL to open when the button is clicked

property name*
additional property
any
previewHost
string <hostname>

The host name of the preview environment (overrides cdn.preview.host, defaults to *.aem.page)

project
string

The name of the project to display in the sidekick

reviewHost
string <hostname>

The host name of the review environment (overrides cdn.review.host, defaults to *.aem.reviews)

Array of objects (sidekickSpecialView)
Array
id
required
string

The unique view ID

path
required
string

Open the special view on this path

title
string

Title of the special view

viewer
required
string

The URL of the special view. The resource path will be passed to it via 'path' parameter

property name*
additional property
any
trustedHosts
Array of strings

Additional hosts that are trusted to use the sidekick authentication

wordSaveDelay
number

The delay to wait for Word to save the document before previewing (defaults to 1500)

object (metadata-source)
source
Array of strings
object (robots)
txt
string
public
object (public)

Public configuration

object (events)
required
object
target
required
string^[a-zA-Z0-9_-]+/[a-zA-Z0-9_-]+$
object (features)

Features configuration

pattern property
object
property name*
additional property
any
object (limits)

Features configuration

pattern property
object
description
string
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "version": 1,
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { }
}

Delete Profile Config

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

Responses

Read Profile Config Property

Returns a sub-property of the profile level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }

Update Profile Config Property

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }

Delete Profile Config Property

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

profile
required
string

Profile name.

path
required
string

Relative path of the resource

Responses

Aggregated Config

Aggregated configuration combines site configuration with inherited values from the profile.

Read Aggregated Site Config

Returns the aggregated site level configuration. This includes the inherited values from the profile.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

Responses

Response samples

Content type
application/json
{
  • "version": 1,
  • "name": "string",
  • "title": "string",
  • "description": "string",
  • "created": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "content": {
    },
  • "code": {
    },
  • "folders": { },
  • "headers": { },
  • "cdn": {
    },
  • "access": {
    },
  • "tokens": { },
  • "secrets": { },
  • "apiKeys": { },
  • "groups": { },
  • "sidekick": {
    },
  • "metadata": {
    },
  • "robots": {
    },
  • "public": { },
  • "events": {
    },
  • "features": { },
  • "limits": { },
  • "extends": {
    }
}

Read Aggregated Site Config Property

Returns a sub-property of the aggregated site level configuration.

Authorizations:
AuthCookie
path Parameters
org
required
string

Organisation name.

site
required
string

Site identifier.

path
required
string

Relative path of the resource

Responses

Response samples

Content type
application/json
{ }