API: REST documentation

All API calls must be authenticated. Use the /api/user/login endpoint to get a token and then append it to every request like so: /api/endpoint?token=12345678

Connection

getDeployers

GET /api/:project/:environment/connections/deployers

Parameters

project
String
environment
String

Returns

Array
Deployers

getProcessors

GET /api/:project/:environment/connections/processors

Parameters

project
String
environment
String

Returns

Array
Processors

getConnections

GET /api/:project/:environment/connections

Parameters

project
String
environment
String

Returns

Array
Connections

postConnection

POST /api/:project/:environment/connections/:id

Parameters

project
String
environment
String
id
String

Returns

Connection
Connection

pullConnection

POST /api/:project/:environment/connections/pull/:id

Parameters

project
String
environment
String
id
String

Returns

String
Connection id

pushConnection

POST /api/:project/:environment/connections/push/:id

Parameters

project
String
environment
String
id
String

Returns

String
Connection id

getConnection

GET /api/:project/:environment/connections/:id

Parameters

project
String
environment
String
id
String

Returns

Connection
Connection

createConnection

POST /api/:project/:environment/connections/new

Parameters

project
String
environment
String

Returns

Connection
Connection

deleteConnection

DELETE /api/:project/:environment/connections/:id

Parameters

project
String
environment
String
id
String

Returns

Connection
Connection

Content

createExampleContent

POST /api/:project/:environment/content/example

Parameters

project
String
environment
String

Returns

String
OK

getAllContents

GET /api/:project/:environment/content

Parameters

project
String
environment
String

Returns

Array
Content nodes

getContent

GET /api/:project/:environment/content/:id

Parameters

project
String
environment
String
id
String

Returns

Content
Content

previewContent

POST /api/:project/:environment/content/preview

Parameters

project
String
environment
String
content
Content
The Content model to preview

Returns

String
Preview URL

createContent

POST /api/:project/:environment/content/new/:schemaId

Parameters

project
String
environment
String
schemaId
String
sort
String
A sorting index (optional)
parent
String
A parent id (optional)
content
Content
The Content model to create (optional)

Returns

Content
The created Content node

postContent

POST /api/:project/:environment/content/:id

Parameters

project
String
environment
String
id
String
content
Content
The Content model to update

Returns

Content
The created Content node

pullContent

POST /api/:project/:environment/content/pull/:id

Parameters

project
String
environment
String
id
String

Returns

Content
The pulled Content node

pushContent

POST /api/:project/:environment/content/push/:id

Parameters

project
String
environment
String
id
String

Returns

String
The pushed Content id

publishContent

POST /api/:project/:environment/content/publish

Parameters

project
String
environment
String
content
Content
the Content model to publish

Returns

String
The published Content

unpublishContent

POST /api/:project/:environment/content/unpublish

Parameters

project
String
environment
String
content
Content
the Content model to unpublish

Returns

String
The unpublished Content

deleteContent

DELETE /api/:project/:environment/content/:id

Parameters

project
String
environment
String
id
String

Returns

String
The deleted Content id

Debug

Forms

getAllForms

GET /api/:project/:environment/forms

Parameters

project
String
environment
String

Returns

Array
Forms

deleteForm

DELETE /api/:project/:environment/forms/:id

Parameters

project
String
environment
String
id
String

pullForm

POST /api/:project/:environment/forms/pull/:id

Parameters

project
String
environment
String
id
String

Returns

Form
The pulled Form

pushForm

POST /api/:project/:environment/forms/push/:id

Parameters

project
String
environment
String
id
String

Returns

Form
The pushed Form id

getForm

GET /api/:project/:environment/forms/:id

Parameters

project
String
environment
String
id
String

Returns

Form
Form

getAllEntries

GET /api/:project/:environment/forms/:id/entries

Parameters

project
String
environment
String
id
String

Returns

String
CSV string

postForm

POST /api/:project/:environment/forms/:id

Parameters

project
String
environment
String
id
String
The
Form
Form model to update

Returns

Form
Form

postNew

POST /api/:project/:environment/forms/new

Parameters

project
String
environment
String

Returns

String
The created Form id

postSubmit

POST /api/:project/:environment/forms/:id/submit

Parameters

project
String
environment
String
id
String
entries
Object
The submitted entries

postClearAllEntries

POST /api/:project/:environment/forms/clear/:id

Parameters

project
String
environment
String
id
String

Media

getMediaTree

GET /api/:project/:environment/media/tree

Parameters

project
String
environment
String

Returns

Object
Media tree

setMediaTreeItem

POST /api/:project/:environment/media/tree/:id

Parameters

project
String
environment
String
id
String
item
Object

Returns

Object
Media tree item

getMedia

GET /api/:project/:environment/media

Parameters

project
String
environment
String

Returns

Array
All Media nodes

getSingleMedia

GET /api/:project/:environment/media/:id

Parameters

project
String
environment
String
id
String

Returns

Media
Media

deleteMedia

DELETE /api/:project/:environment/media/:id

Parameters

project
String
environment
String
id
String

setMedia

GET /api/:project/:environment/media/:id

Parameters

project
String
environment
String
id
String
files
FileData
Binary Media data

createMedia

GET /api/:project/:environment/media/new

Parameters

project
String
environment
String
files
FileData
Binary Media data

Returns

String
Created Media id

Plugin

Schedule

getTasks

GET /api/:project/:environment/schedule/:contentId

Parameters

project
String
environment
String
contentId
String

Returns

Array
Tasks

Schema

getSchemas

GET /api/:project/:environment/schemas

Parameters

project
String
environment
String

Returns

Array
Schemas

getSchema

GET /api/:project/:environment/schemas/:id

Parameters

project
String
environment
String
id
String

Returns

Schema
Schema

setSchema

POST /api/:project/:environment/schemas/:id

Parameters

project
String
environment
String
id
String
schema
Schema
The Schema model to update

Returns

Schema
Schema

pullSchema

POST /api/:project/:environment/schemas/pull/:id

Parameters

project
String
environment
String
id
String

Returns

Schema
The pulled Schema

pushSchema

POST /api/:project/:environment/schemas/push/:id

Parameters

project
String
environment
String
id
String

Returns

Schema
The pushed Schema

createSchema

POST /api/:project/:environment/schemas/new

Parameters

project
String
environment
String

Returns

Schema
The created Schema

deleteSchema

DELETE /api/:project/:environment/schemas/:id

Parameters

project
String
environment
String
id
String

Server

Settings

Sync

Template

Test

User

login

POST /api/user/login

Parameters

credentials
Object
{ username: String, password: String }
persist
String
"true"/"false"

Returns

String
Session token

View