| List all resources | |
|---|---|
| GET | /resources[/TYPE]/list |
| Returns | for each resource, a list of TYPE RESOURCE |
| Get single resource info | ||
|---|---|---|
| GET | /resources/TYPE/RESOURCE/info | |
| Returns | KEY VALUE pairs: | |
| name | Resource name | |
| type | resource type (‘ip’, ‘vlan’, etc.) | |
| resource | resource identifier | |
| user | owner of the resource | |
| netmask | netmask to be used with a static IP | |
| gateway | gateway to be used with a static IP | |
| nameserver | name server to be used with a static IP | |
| tags | optional, space-separated list of tags | |
| user:* | optional, user-defined KEY VALUE pairs | |
| Get all resources info | |
|---|---|
| GET | /resources/info |
| Returns | for each resource, KEY VALUE pairs as resource info |
| Create a resource | ||
|---|---|---|
| POST | /resources/TYPE/create | |
| Expects | KEY VALUE pairs: | |
| name | Resource name | |
| tags | optional, space-separated list of tags | |
| user:* | optional, user-defined KEY VALUE pairs | |
| Returns | KEY VALUE pairs as resource info | |
| Set extra resource data | ||
|---|---|---|
| POST | /resources/TYPE/RESOURCE/set | |
| Expects | KEY VALUE pairs: | |
| name | Resource name | |
| tags | optional, space-separated list of tags | |
| user:* | optional, user-defined KEY VALUE pairs | |
| Returns | KEY VALUE pairs as resource info | |
| Destroy a resource | |
|---|---|
| POST | /resources/TYPE/RESOURCE/destroy |
| Expects | Empty POST |
| Returns | HTTP 204 No Content |
0 Comments