Skip to main content

Get Snap Configs for Storage Array at Client​

Select

SaaS
Customer Managed

API to fetch Snap configs for Storage Arrays at client level

Path Parameters
  • arrayId int32 required
  • clientId int32 required
Responses

OK

Schema
  • assocType int64

    Association type, at subclient level it is 9, at client level it is 8, at copy level it is 6 and by default at array level it is 3

  • clientId int64

    Client Id

  • subclientId int64

    Subclient id

  • copyId int64

    snap copy id

  • snapConfigurations object[]

    Snap Config options that can be overridden

  • masterConfigId int32

    This is the masterConfigId, which is available for each vendors configs

  • id int32

    This is the id of the config which is required during config override

  • name string

    This is the name of the config which is displayed on the Command Center Console

  • type int32

    Possible values: [1, 2, 8, 10, 12, 13, 14]

    Type of the config value. type can accept 7 values [1,2,8,10,12,13,14], 1: boolean, 2: integer, 8: text, 10: array[string] are common configs, the rest three are special keys, 12 is for password type key for NetApp E-Series and HPE Nimble, 13 is Private Key for GCP, 14 is a hidden config to select type of Disk for GCP

  • value string

    Value of the config

  • values object[]

    Holds a single value for types except 10, for 10 it holds one or more values. Incase of HPE 3PAR StoreServ, name field will have the remote snap MA Id.

  • id int32
  • name string
  • flags int32

    Flag regarding placement of config in the CC page

  • description string

    Description about the config that tells the user what it is for and the range of values it accepts

  • isEnabled boolean

    Whether the config is enabled or not

  • isOverridden boolean

    Whether the config is Overridden or not

  • checkRange boolean

    Whether to check if the value is in range or not of accepted values

  • minValue int64

    This is the lower limit value to which the config can be set for numeric types

  • maxValue int64

    This is the higher limit value to which the config can be set for numeric types

GET /v4/storagearrays/:arrayid/client/:clientid/snap/configs

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
arrayId — path required
clientId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/StorageArrays/:arrayId/Client/:clientId/Snap/Configs' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'