REST endpoints: Configurations and settings

REST

These ~~endpoints:~~endpoints mirror the CLI commands described in Configurations, Settings, Anomaly Detection. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

`GET /configurations/list`

List configuration history.

CLI command: configurations list

Query parameters

Name Type Required Description pending boolean No Include pending configurations. If no state flag is set, all states are included. inProgress boolean No Include in-progress configurations. success boolean No Include successful configurations. failure boolean No Include failed configurations. top integer No Limit the number of results returned. descendingOrder boolean No Sort results by start time, newest first.

Response: a list of ConfigurationElement objects in Result.Configurations, each with: AggregatedCommandGuid (string), Id (integer), System (string), PlatformVersion (integer), ServiceConfigId (integer), State (string: Unknown / Running / Pending / Failed / Success), Type (string: UnversionedConfig / VersionedConfig), User (string), Description (string), StartTime (date-time), EndTime (date-time), Message (string), Async (boolean).

`GET /configurations/session/list`

View current session configurations.

CLI command: configurations session list

Query parameters

Name Type Required Description jobids array of integer No Filter by job ID. sync boolean No Show only synchronous configurations. async boolean No Show only asynchronous configurations. top integer No Limit the number of results returned. descendingOrder boolean No Sort results by job ID, newest first.

Response: a list of ConfigurationElement objects in Result, each with: AggregatedCommandGuid (string), Id (integer), System (string), PlatformVersion (integer), ServiceConfigId (integer), State (string: Unknown / Running / Pending / Failed / Success), Type (string: UnversionedConfig / VersionedConfig), User (string), Description (string), StartTime (date-time), EndTime (date-time), Message (string), Async (boolean).

`PUT /settings/anomaly_detection/edit`

Update anomaly detection settings.

CLI command: settings anomaly_detection edit

Body fields (JSON)

Name Type Required Description Timeframe_days integer Yes Number of days to consider for historic statistics (1-60 days). Setting 0 disables the anomaly detection. Change integer Yes Percentage of capacity change to consider as 'abnormal' for notification. e.g. 300 means today's change is 3 times (or 300%) above the max or below the min in the timeframe. Setting 0 disables the anomaly detection.

`GET /settings/anomaly_detection/show`

Display anomaly detection settings.

CLI command: settings anomaly_detection show

This endpoint takes no parameters.

Response: an object of type AnomalyDetectionSettingsResult in Result, with: TimeframeDays (integer), AbnormalChangePercentage (number).

`PUT /settings/capacity_units`

Change the capacity units used for drives, volumes, and statistics.

CLI command: settings capacity_units

Body fields (JSON)

Name Type Required Description BinaryUnits boolean No Use binary (base-1024) units: mebibyte, gibibyte, tebibyte, pebibyte... DecimalUnits boolean No Use decimal (base-1000) units: megabyte, gigabyte, terabyte, petabyte...