Skip to main content

API Reference

{appName}: string

{environmentName}: string

{token}: string

{entityName}: string

Every request has to have token={token} query parameter.

GET /{appName}/{environmentName}​

Get environment details.

{
  "name": "string",
  "entities": [
    "object-1",
    "object-1/sub-object-1",
    "object1/sub-object-1/sub-object2",
    "object-2",
    "object-2/sub-object-2"
  ],
  "description": "string"
}

GET /{appName}/{environmentName}/{entityName}​

GET /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}​

Get list of entities or sub-entities.

[
  {
    "id": "string",
    "prop1": "value1",
    "prop2": 2,
    "prop3": true
  }
]

GET /{appName}/{environmentName}/{entityName}/{entityId}​

GET /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}/{entity-N-Id}​

Get single entity or sub-entity.

{
  "id": "string",
  "prop1": "value1",
  "prop2": 2,
  "prop3": true
}

POST /{appName}/{environmentName}/{entityName}​

POST /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}​

Create new entities and sub-entities.

Affects the /{appName}/{environmentName} path. If new entity name is created, it will be added to the entities property.

Body:

[
  {
    "prop1": "value1",
    "prop2": "value2"
  }
]

On sucess: 201

PUT /{appName}/{environmentName}/{entityName}​

PUT /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}​

Replace entities and sub-entities with the body object.

Body:

[
  {
    "id": "12345678",
    "prop1": "value1",
    "prop2": "value2"
  }
]

On sucess: 201

PATCH /{appName}/{environmentName}/{entityName}​

PATCH /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}​

Update or merge entities and sub-entities with the body object.

Body:

[
  {
    "id": "12345678",
    "prop1": "value1",
    "prop2": "value2"
  }
]

On sucess: 201

DELETE /{appName}/{environmentName}/{entityName}​

DELETE /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}​

Delete all entities under entityName or sub-entities under entity-N-Name.

DELETE /{appName}/{environmentName}/{entityName}/{entityId}​

DELETE /{appName}/{environmentName}/{entity-1-Name}/{entity-1-Id}/.../{entity-N-Name}/{entity-N-Id}​

Delete a single entity with id entityId or a single sub-entity with id entity-N-Id.

Affects the /{appName}/{environmentName} path. Any entity name deleted will be removed from the entities property. And, last entity deleted from any entityName will affect the entities property.

On success: 200

GET /{appName}/{environmentName}/configs​

Get all configs.

GET /{appName}/{environmentName}/configs/{configProp}/.../{configPropN}​

Get deeply nested config property.

POST /{appName}/{environmentName}/configs​

Create new config.

PUT /{appName}/{environmentName}/configs/{configProp}/.../{configPropN}​

Replace config property with body payload.

PATCH /{appName}/{environmentName}/configs/{configProp}/.../{configPropN}​

Update or merge config property with body payload.

DELETE /{appName}/{environmentName}/configs​

Delete all configs.

DELETE /{appName}/{environmentName}/configs/{configProp}/.../{configPropN}​

Delete config property.