Skip to content

REST API Specification

tobami edited this page Dec 9, 2010 · 12 revisions
Resource Operation HTTP Method URL Query string HTTP Payload returned
Providers List all providers GET /api/providers/ JSON list containing all provider ids
List providers of a given type GET /api/providers/ provider_type=PROV_TYPE JSON list containing provider ids for PROVIDER_TYPE
Retrieve attributes for specific provider by ID GET /api/providers/PROVIDER_ID JSON dict with all attributes of the specific provider
Retrieve attributes for specific provider by name GET /api/providers/ name=PROVIDER_NAME JSON dict with all attributes of the specific provider
Create provider POST /api/providers/ provider_type=PROV_TYPE JSON dict with id of provider created (generated on the server side) and all other attributes of the provider
access_key=ACCESS_KEY
secret_key=SECRET_KEY
Update attributes for a specific provider PUT /api/providers/PROVIDER_ID name=PROVIDER_NAME JSON dict with all attributes of the provider that was updated
access_key=ACCESS_KEY
secret_key=SECRET_KEY
Delete a specific provider DELETE /api/providers/PROVIDER_ID JSON dict with all attributes of the provider that was deleted
Images List all images from a particular provider GET /api/providers/PROVIDER_ID/images/ JSON list containing all image ids
Retrieve attributes for specific image by ID GET /api/providers/PROVIDER_ID/images/ID JSON dict with all attributes of a specific image by id
Retrieve attributes for specific image by the provider’s own image_id GET /api/providers/PROVIDER_ID/images/ image_id=IMAGE_ID JSON dict with all attributes of a specific image by image_id
Retrieve attributes for specific image by name GET /api/providers/PROVIDER_ID/images/ name=IMAGE_NAME JSON dict with all attributes of a specific image by name
Nodes List all nodes GET /api/nodes/ JSON list of non-decommissioned nodes with their associated detailed info
List nodes for a given provider GET /api/nodes/ provider_id=PROVIDER_ID JSON list of non-decommissioned nodes with their associated detailed info for PROVIDER_ID
List nodes, including Decommissioned GET /api/nodes/ show_decommissioned=true JSON list of all nodes with their associated detailed info
List specific node by ID GET /api/nodes/NODE_ID JSON dict with all attributes of the specific node
List specific node by name GET /api/nodes/ name=NODE_NAME JSON dict with all attributes of the specific node
Create node for a specific provider POST /api/nodes/ provider_id=PROVIDER_ID JSON dict with id of node created (generated on the server side) and all other attributes of the node
name=NODE_NAME
realm=REALM_ID
flavor=FLAVOR_ID
image=IMAGE_ID
Update node name PUT /api/nodes/NODE_ID name=NODE_NAME JSON dict with all attributes of the node that was updated
Delete node DELETE /api/nodes/NODE_ID JSON dict with all attributes of the node that was deleted