All REST Endpoints

Sort by

Task Path Method

Group by API

admin

APIs for administrative operations.

Execute HA switchover

Method: post

Path: /rest/{version}/admin/switchover

Get the status of last asynchronous request

Method: get

Path: /rest/{version}/admin/asyncstatus

Reboot the system

Method: post

Path: /rest/{version}/admin/reboot

api

APIs to retrieve information about the REST API itself.

Get supported REST API versions

Method: get

Path: /rest/api/supportedversions

auth

API for authorization. In this release, the only operation supported is the request (or re-request) of an authorization token, which the client must supply in all subsequent requests.

Request an access token

Method: post

Path: /rest/{version}/auth/token

configuration

APIs affecting configuration elements. GET requests can be made by a client without the configuration lock, but any configuration request that changes the system configuration in any way—including saving, restoring, or activating it, plus POST, PUT, and DELETE—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: post

Path: /rest/{version}/configuration/configElements

Delete a single configuration element instance

Method: delete

Path: /rest/{version}/configuration/configElements

Get a list of all supported configuration element types

Method: get

Path: /rest/{version}/configuration/elementTypes

Get a template instance for a configuration element or sub-element type

Method: get

Path: /rest/{version}/configuration/elementTypes/template

Get one or more configuration element instances

Method: get

Path: /rest/{version}/configuration/configElements

Get the boot parameters

Method: get

Path: /rest/{version}/configuration/bootparams

Get the metadata for a configuration element type

Method: get

Path: /rest/{version}/configuration/elementTypes/metadata

Lock the configuration

Method: post

Path: /rest/{version}/configuration/lock

Unlock the configuration

Method: post

Path: /rest/{version}/configuration/unlock

Update a single configuration element instance

Method: put

Path: /rest/{version}/configuration/configElements

Update the boot parameters

Method: put

Path: /rest/{version}/configuration/bootparams

configuration management

APIs related to management of configuration and configuration files.

Back up or activate a configuration

Method: post

Path: /rest/{version}/configuration/management

Delete saved backup configuration files

Method: delete

Path: /rest/{version}/configuration/management/files

Get current and running configuration versions

Method: get

Path: /rest/{version}/configuration/versions

Get list of saved backup configuration files

Method: get

Path: /rest/{version}/configuration/management/files

Save, verify or restore a configuration

Method: put

Path: /rest/{version}/configuration/management

statistics

APIs related to statistics, KPIs, and metrics.

Discover available KPI types or get the KPI schema for a type.

Method: get

Path: /rest/{version}/statistics/kpiTypes

Get KPI data

Method: get

Path: /rest/{version}/statistics/kpis

system

System level APIs.

Get file system storage space information

Method: get

Path: /rest/{version}/system/storage

Get system information

Method: get

Path: /rest/{version}/system/information

Get system status information

Method: get

Path: /rest/{version}/system/status

Get system version information

Method: get

Path: /rest/{version}/system/version