Skip to main content

Edit Client Snap Configs for Storage Arrays​

Select

SaaS
Customer Managed

API to edit Snap Configurations at Client Level

Path Parameters
  • arrayId int32 required
  • clientId int32 required
Request Body
  • snapConfigurations object[]
  • masterConfigId int32 required

    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 required

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

  • type int32 required

    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. For HPE 3PAR StoreServ, pass MA Id in name field to configure that MA as remote snap MA.

  • id int32
  • name string
  • flags int32 required

    Flag regarding placement of config in the CC page

  • isUpdated boolean

    Whether the config is updated or not

  • isOverridden boolean required

    whether the config is overridden or not

Responses

OK

Schema
  • errorMessage string
  • errorCode int32
PUT /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
Body
{

  "snapConfigurations": [

    {

      "masterConfigId": 0,

      "id": 0,

      "name": "string",

      "type": 1,

      "value": "string",

      "values": [

        {

          "id": 0,

          "name": "string"

        }

      ],

      "flags": 0,

      "isUpdated": true,

      "isOverridden": true

    }

  ]

}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V4/StorageArrays/:arrayId/Client/:clientId/Snap/Configs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "snapConfigurations": [
    {
      "masterConfigId": 0,
      "id": 0,
      "name": "string",
      "type": 1,
      "value": "string",
      "values": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "flags": 0,
      "isUpdated": true,
      "isOverridden": true
    }
  ]
}'