Skip to content

REST API Specification

griggheo edited this page Oct 14, 2010 · 12 revisions
Resource Operation HTTP Method URL Query string HTTP Payload returned
Providers List all providers GET GET /api/providers/ None JSON list containing all provider ids
List providers of a given type GET GET /api/providers/ provider_type=PROVIDER_TYPE JSON list containing provider ids for PROVIDER_TYPE
Retrieve attributes for specific provider by ID GET GET /api/providers/PROVIDER_ID JSON dict with all attributes of the specific provider
Retrieve attributes for specific provider by name GET GET /api/providers/ name=PROVIDER_NAME JSON dict with all attributes of the specific provider
Create provider POST POST /api/providers/ provider_type=PROVIDER_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 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 DELETE /api/providers/PROVIDER_ID JSON dict with all attributes of the provider that was deleted
Nodes List all nodes GET GET /api/nodes/ JSON list of non-decommissioned nodes with their associated detailed info
List nodes for a given provider GET 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 GET /api/nodes/ show_decommissioned=true JSON list of all nodes with their associated detailed info
List specific node by ID GET GET /api/nodes/NODE_ID JSON dict with all attributes of the specific node
List specific node by name GET GET /api/nodes/ name=NODE_NAME JSON dict with all attributes of the specific node
Create node for a specific provider POST 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
Clone this wiki locally