All REST Endpoints
admin
Administrative operations. In this release, the only administrative operations supported are rebooting the system and requesting the status of the last asynchronous REST request.
- Get status of last asynchronous request
- Method: getPath:
/rest/{version}/admin/asyncstatus
- Reboot the system
- Method: postPath:
/rest/{version}/admin/reboot
auth
Authorization operations. In this release, the only operation supported is the request (or re-request) of an access token, which the client must supply in all subsequent requests.
- Request an access token
- Method: postPath:
/rest/{version}/auth/token
configuration
Operations affecting system configuration elements. GET requests can be made by a client without the configuration lock, but any configuration request that changes the system configruation in any way - including saving, restoring, or activating it - requires the REST client to first possess the configuration lock. Acquiring and releasing the lock are themselves both considered configuration operations.
- Add a single configuration element instance
- Method: postPath:
/rest/{version}/configuration/configElements
- Delete a single configuration element instance
- Method: deletePath:
/rest/{version}/configuration/configElements
- Get a list of all supported configuration element types
- Method: getPath:
/rest/{version}/configuration/elementTypes
- Get a template instance for a configuration element or sub-element type
- Method: getPath:
/rest/{version}/configuration/elementTypes/template
- Get one or more configuration element instances
- Method: getPath:
/rest/{version}/configuration/configElements
- Get the boot parameters
- Method: getPath:
/rest/{version}/configuration/bootparams
- Get the metadata for a configuration element type
- Method: getPath:
/rest/{version}/configuration/elementTypes/metadata
- Lock the configuration
- Method: postPath:
/rest/{version}/configuration/lock
- Unlock the configuration
- Method: postPath:
/rest/{version}/configuration/unlock
- Update a single configuration element instance
- Method: putPath:
/rest/{version}/configuration/configElements
- Update the boot parameters
- Method: putPath:
/rest/{version}/configuration/bootparams
configuration management
Operations related to management of configuration and configuration files.
- Activate a configuration
- Method: postPath:
/rest/{version}/configuration/management
- Save, verify or restore a configuration
- Method: putPath:
/rest/{version}/configuration/management