...
Operation | Method | URL | Response | Example | ||
---|---|---|---|---|---|---|
Get Nodes | GET | http://host/en/omk/admin/api/v2/nodes.json | uburnto athena.opmantek.net/en/omk/admin/api/v2/nodes.json? requestData=undefined&25See Query Parameters | |||
Get Node | GET | http://host/en/omk/admin/api/v2/nodes/{node_uuid}.json | http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes/86a82b4c-6ef6-4691-8c8c-1fc8da334d6f.json | |||
Create Node | POST | http://host/en/omk/admin/api/v2/nodes.json To create a remote node in an opHA cluster see below. | The node in json from the recently created node, including the UUID | http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes.json
| ||
Update Node | PUT | http://host/en/omk/admin/api/v2/nodes/{node_uuid}.json To update a remote node in an opHA cluster see below. | http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes/b56ba595-69e7-4702-9fe5-49512e1340b0.json
| |||
Delete Node | DELETE | http://host/en/omk/admin/api/v2/nodes/{node_uuid}.json | http://uburnto.opmantek.net/en/omk/admin/api/v2/nodes/b56ba595-69e7-4702-9fe5-49512e1340b0.json |
Request Modifiers (query parameters)
Not all requests will use all request modifiers.
Query Parameter | Possible Values |
---|---|
| Array of property names. If provided only the properties specified will be returned (instead of the whole document). eg: By default all properties if no fields_hash is specified. |
| Which page of the requested document to be returned, from 1 .. n, defaults to no pagination. |
| How many results are returned per page, defaults to 25 |
| List of For a string, if it starts with regex: or iregex: then a case-sensitive or case-insensitive regular expression match is used. |
| Property to sort by. eg: sort_by=name to sort by node name |
| Sort order. asc | desc : sort the response by sort_by ascending or descending. |
By example, the queries will look something like this:
Authentication
Important: All these methods are authenticated.
...