System REST API v0

The /system/ REST API exposes information about the content currently being displayed by a cluster of cadmium instances. It also provides the ability to change the content being displayed.

This document contains the v0 version of this API. It will be restructured in the future to be more like a true REST API and less like collection of service endpoints built on HTTP.

The Standard Resources

/system/status

{
  "groupName" : value,
  "contentDir" : value,
  "environment" : value,
  "repo" : value,
  "branch" : value,
  "revision" : value,
  "source" : value,
  "maintPageState" : value,
  "members" : [ ... ],
  "configDir" : value,
  "configRepo" : value,
  "configBranch" : value,
  "configRevision" : value
}

The Deployer Resources

/system/deployment/list

Lists the currently deployed WARs.

[
  "domain1.war",
  "domain2.war"
]

/system/deployment/details/{warName}

Provides details for the specified WAR.

/system/deploy

Deploys a new WAR to the container.

Request POST:

{
  'domain': "",
  'branch': "",
  'repo': "",
  'configBranch': "",
  'configRepo': "",
  'context': "",
  'artifact': "",
  'secure': ""
}

Response 200 text/plain

ok

/system/undeploy

Undeploys a WAR from the container.

Request POST:

{
  'warName':""
}

Response 200 text/plain:

ok