Guides API docs Source docs Source code

API docs

The documentation for app developers

Content

insert

Inserts a content resource at a specified sort order

POST /api/${project}/${environment}/content/${id}/insert?parentId=XXX&position=XXX

republish

Republishes all content

POST /api/${project}/${environment}/content/republish

Media

renameFolder

Renames a folder

POST /api/${project}/environment/media/renameFolder?from=XXX&to=XXX { from: XXX, to: XXX }

Project

backup

Modifies a backup

GET|DELETE /api/projects/{project}/backups/${timestamp}

environment

Modifies an environment

GET|POST|DELETE /api/projects/${project}/environments/${environment}

environments

Lists all environments of a project

GET /api/projects/${project}/environments

migrateEnvironment

Migrates resources between environments

POST /api/projects/${project}/migrate?from=XXX&to=XXX { from: XXX, to: XXX }

new

Creates a new project

POST /api/projects/new?name=XXX&id=XXX { name: XXX, id: XXX }

newBackup

Creates a new backup

POST /api/projects/{project}/backups/new

newEnvironment

Creates a new environment

POST /api/projects/${project}/environments/new?name=XXX&from=XXX { name: XXX, from: XXX }

project

Modifies a project

GET|POST /api/projects/${project}

projectIds

Lists all project ids

GET /api/projects/ids

projects

Lists all projects

GET /api/projects

restoreBackup

Restores a backup

POST /api/projects/{project}/backups/${timestamp}/restore

settings

Modifies the settings of a project

GET|POST /api/projects/${project}/settings[/${section}] { ... }

syncToken

Gets a new sync token

POST /api/projects/${project}/sync/token?username=XXX&password=XXX&url=XXX { username: XXX, password: XXX, url: XXX }

uploadBackup

Uploads a new backup

POST /api/projects/{project}/backups/upload

users

Lists all users for a project

GET /api/projects/{project}/users

Publication

query

Queries this publication for content

GET /api/${project}/${environment}/publications/${id}/query[?key=value]

Resource

new

Creates a new resource

POST /api/${project}/${environment}/${library}/new

pull

Pulls a resource from a synced instance

POST /api/${project}/${environment}/${library}/{$id}/pull

push

Pushes a resource to a synced instance

POST /api/${project}/${environment}/{library}/${id}/push

resource

Modifies a single resource

GET|POST|DELETE /api/${project}/${environment}/${library}/${id}?create=true|false

resources

Lists all resources

GET /api/${project}/${environment}/${library}

Schema

icons

Gets all schema icons in a map

GET /api/${project}/${environment}/schemas/icons

User

current

Get the current user

GET /api/user

first

Creates the first user

POST /api/users/first?username=XXX&password=XXX { username: XXX, password: XXX }

login

Logs in a user

POST /api/user/login?username=XXX&password=XXX&persist=true|false { username: XXX, password: XXX, persist: true|false }

new

Creates a new user

/api/users/new { username: XXX, password: XXX }

scopes

Gets the scopes of the current user

GET /api/user/scopes

user

Modifies a user

GET|POST|DELETE /api/users/${id}

users

Lists all users

GET /api/users