Adobe Experience Manager (AEM) API

Base URL: /, Version: 1.2.1

Swagger AEM is an OpenAPI specification for Adobe Experience Manager (AEM) API

Schemes: http, https

Summary

Tag: cq

Operation Description
GET /libs/granite/core/content/login.html
POST /.cqactions.html

Tag: sling

Operation Description
POST /{path}/
GET /{path}/{name}
DELETE /{path}/{name}
POST /{path}/{name}.rw.html
POST /apps/system/config.{runmode}/org.apache.felix.http
POST /apps/system/config.{runmode}/org.apache.sling.servlets.get.DefaultGetServlet
POST /apps/system/config.{runmode}/org.apache.sling.security.impl.ReferrerFilter
POST /apps/system/config.{runmode}/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet
GET /bin/querybuilder.json
POST /bin/querybuilder.json
GET /etc/packages/{group}/{name}-{version}.zip
GET /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json
GET /etc/replication/agents.{runmode}.-1.json
GET /etc/replication/agents.{runmode}/{name}
DELETE /etc/replication/agents.{runmode}/{name}
POST /etc/replication/agents.{runmode}/{name}
POST /etc/replication/treeactivation.html
POST /libs/granite/security/post/authorizables

Tag: custom

Operation Description
POST /apps/system/config.{runmode}/com.shinesolutions.aem.passwordreset.Activator
POST /apps/system/config.{runmode}/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck
GET /system/health

Tag: crx

Operation Description
POST /crx/explorer/ui/setpassword.jsp
GET /crx/packmgr/installstatus.jsp
POST /crx/packmgr/service.jsp
POST /crx/packmgr/update.jsp
POST /crx/packmgr/service/.json/{path}

Tag: console

Operation Description
POST /system/console/bundles/{name}
POST /system/console/jmx/com.adobe.granite:type=Repository/op/{action}

Security

aemAuth

Type: basic

Paths

POST /.cqactions.html

Tags: cq
authorizableId query string
changelog query string

text/plain

default

Default response

POST /apps/system/config.{runmode}/com.shinesolutions.aem.passwordreset.Activator

Tags: custom
runmode path string
pwdreset.authorizables query string[] , multiple parameters (pwdreset.authorizables=aaa&pwdreset.authorizables=bbb)
pwdreset.authorizables@TypeHint query string

text/plain

default

Default response

POST /apps/system/config.{runmode}/com.shinesolutions.healthcheck.hc.impl.ActiveBundleHealthCheck

Tags: custom
runmode path string
bundles.ignored query string[] , multiple parameters (bundles.ignored=aaa&bundles.ignored=bbb)
bundles.ignored@TypeHint query string

text/plain

default

Default response

POST /apps/system/config.{runmode}/org.apache.felix.http

Tags: sling
runmode path string
org.apache.felix.https.nio query boolean
org.apache.felix.https.nio@TypeHint query string
org.apache.felix.https.keystore query string
org.apache.felix.https.keystore@TypeHint query string
org.apache.felix.https.keystore.password query string
org.apache.felix.https.keystore.password@TypeHint query string
org.apache.felix.https.keystore.key query string
org.apache.felix.https.keystore.key@TypeHint query string
org.apache.felix.https.keystore.key.password query string
org.apache.felix.https.keystore.key.password@TypeHint query string
org.apache.felix.https.truststore query string
org.apache.felix.https.truststore@TypeHint query string
org.apache.felix.https.truststore.password query string
org.apache.felix.https.truststore.password@TypeHint query string
org.apache.felix.https.clientcertificate query string
org.apache.felix.https.clientcertificate@TypeHint query string
org.apache.felix.https.enable query boolean
org.apache.felix.https.enable@TypeHint query string
org.osgi.service.http.port.secure query string
org.osgi.service.http.port.secure@TypeHint query string

text/plain

default

Default response

POST /apps/system/config.{runmode}/org.apache.sling.jcr.davex.impl.servlets.SlingDavExServlet

Tags: sling
runmode path string
alias query string
alias@TypeHint query string
dav.create-absolute-uri query boolean
dav.create-absolute-uri@TypeHint query string

text/plain

default

Default response

POST /apps/system/config.{runmode}/org.apache.sling.security.impl.ReferrerFilter

Tags: sling
runmode path string
allow.empty query boolean
allow.empty@TypeHint query string
allow.hosts query string
allow.hosts@TypeHint query string
allow.hosts.regexp query string
allow.hosts.regexp@TypeHint query string

text/plain

default

Default response

POST /apps/system/config.{runmode}/org.apache.sling.servlets.get.DefaultGetServlet

Tags: sling
runmode path string
json.maximumresults query string
json.maximumresults@TypeHint query string
enable.html query boolean
enable.html@TypeHint query string
enable.txt query boolean
enable.txt@TypeHint query string
enable.xml query boolean
enable.xml@TypeHint query string

text/plain

default

Default response

GET /bin/querybuilder.json

Tags: sling
path query string
p.limit query number
1_property query string
1_property.value query string

application/json

default

Default response

POST /bin/querybuilder.json

Tags: sling
path query string
p.limit query number
1_property query string
1_property.value query string

application/json

default

Default response

POST /crx/explorer/ui/setpassword.jsp

Tags: crx
old query string
plain query string
verify query string

text/plain

default

Default response

GET /crx/packmgr/installstatus.jsp

Tags: crx

application/json

200 OK

Retrieved CRX package manager install status

default

Default response

POST /crx/packmgr/service.jsp

Tags: crx
cmd query string

text/xml

default

Default response

POST /crx/packmgr/service/.json/{path}

Tags: crx

multipart/form-data

path path string
cmd query string
groupName query string
packageName query string
packageVersion query string
_charset_ query string
force query boolean
recursive query boolean
package formData file

application/json

default

Default response

POST /crx/packmgr/update.jsp

Tags: crx
groupName query string
packageName query string
version query string
path query string
filter query string
_charset_ query string

application/json

default

Default response

GET /etc/packages/{group}/{name}-{version}.zip

Tags: sling
group path string
name path string
version path string

application/octet-stream

default

Default response

GET /etc/packages/{group}/{name}-{version}.zip/jcr:content/vlt:definition/filter.tidy.2.json

Tags: sling
group path string
name path string
version path string

application/json

default

Default response

GET /etc/replication/agents.{runmode}.-1.json

Tags: sling
runmode path string

application/json

default

Default response

DELETE /etc/replication/agents.{runmode}/{name}

Tags: sling
runmode path string
name path string

text/plain

default

Default response

GET /etc/replication/agents.{runmode}/{name}

Tags: sling
runmode path string
name path string

text/plain

default

Default response

POST /etc/replication/agents.{runmode}/{name}

Tags: sling
runmode path string
name path string
jcr:content/cq:distribute query boolean
jcr:content/cq:distribute@TypeHint query string
jcr:content/cq:name query string
jcr:content/cq:template query string
jcr:content/enabled query boolean
jcr:content/jcr:description query string
jcr:content/jcr:lastModified query string
jcr:content/jcr:lastModifiedBy query string
jcr:content/jcr:mixinTypes query string
jcr:content/jcr:title query string
jcr:content/logLevel query string
jcr:content/noStatusUpdate query boolean
jcr:content/noVersioning query boolean
jcr:content/protocolConnectTimeout query number
jcr:content/protocolHTTPConnectionClosed query boolean
jcr:content/protocolHTTPExpired query string
jcr:content/protocolHTTPHeaders query string[] , multiple parameters (jcr:content/protocolHTTPHeaders=aaa&jcr:content/protocolHTTPHeaders=bbb)
jcr:content/protocolHTTPHeaders@TypeHint query string
jcr:content/protocolHTTPMethod query string
jcr:content/protocolHTTPSRelaxed query boolean
jcr:content/protocolInterface query string
jcr:content/protocolSocketTimeout query number
jcr:content/protocolVersion query string
jcr:content/proxyNTLMDomain query string
jcr:content/proxyNTLMHost query string
jcr:content/proxyHost query string
jcr:content/proxyPassword query string
jcr:content/proxyPort query number
jcr:content/proxyUser query string
jcr:content/queueBatchMaxSize query number
jcr:content/queueBatchMode query string
jcr:content/queueBatchWaitTime query number
jcr:content/retryDelay query string
jcr:content/reverseReplication query boolean
jcr:content/serializationType query string
jcr:content/sling:resourceType query string
jcr:content/ssl query string
jcr:content/transportNTLMDomain query string
jcr:content/transportNTLMHost query string
jcr:content/transportPassword query string
jcr:content/transportUri query string
jcr:content/transportUser query string
jcr:content/triggerDistribute query boolean
jcr:content/triggerModified query boolean
jcr:content/triggerOnOffTime query boolean
jcr:content/triggerReceive query boolean
jcr:content/triggerSpecific query boolean
jcr:content/userId query string
jcr:primaryType query string
:operation query string

text/plain

default

Default response

POST /etc/replication/treeactivation.html

Tags: sling
ignoredeactivated query boolean
onlymodified query boolean
path query string

text/plain

default

Default response

GET /libs/granite/core/content/login.html

Tags: cq

text/html

default

Default response

POST /libs/granite/security/post/authorizables

Tags: sling
authorizableId query string
intermediatePath query string
createUser query string
createGroup query string
rep:password query string
profile/givenName query string

text/html

default

Default response

POST /system/console/bundles/{name}

Tags: console
name path string
action query string

text/plain

default

Default response

POST /system/console/jmx/com.adobe.granite:type=Repository/op/{action}

Tags: console
action path string

text/plain

default

Default response

GET /system/health

Tags: custom
tags query string
combineTagsOr query boolean

application/json

default

Default response

POST /{path}/

Tags: sling
path path string
jcr:primaryType query string
:name query string

text/plain

default

Default response

DELETE /{path}/{name}

Tags: sling
path path string
name path string

text/plain

default

Default response

GET /{path}/{name}

Tags: sling
path path string
name path string

text/plain

default

Default response

POST /{path}/{name}.rw.html

Tags: sling
path path string
name path string
addMembers query string

text/plain

default

Default response

Schema definitions

InstallStatus: object

status: object
finished: boolean
itemCount: integer