API Documentation

Donabe API Documentation

This document describes the Donabe API used for the creation, querying, deployment and destruction of application containers.

All requests are to be made by HTTP REST, and must include the users OpenStack X-Auth-Token in the message header.

Containers

Creation

Via POST

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/containers.json

The message body must then contain a JSON object as described in the Container Schema.

Querying

Return a given container:

Via GET

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/container/<container_id>.json

The returned message body will contain a JSON object as described in the Container Schema.

Return a list of containers:

Via GET

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/containers.json

The returned message body will contain a list of JSON objects as described in the Container Schema.

Deletion

Via DELETE

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/<container_id>.json

Deployment

Via GET

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/containers/deploy/<container_id>.json

Deployed Containers

Querying

Return a given deployed container:

Via GET

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/deployed_container/<container_id>.json

The returned message body will contain a JSON object as described in the Deployed Container Schema.

Return a list of containers:

Via GET

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/deployed_containers.json

The returned message body will contain a list of JSON objects as described in the Deployed Container Schema.

Destruction

Via GET

http://<Donabe_IP>:<Donabe_Port>/<tenant_id>/deployed_containers/destroy_deployed/<container_id>.json