Update Service Label (v2.1)

PUT 
/sdwan/v2.1/api/servicelabels/:service_label_id

Update a service label.

Request

Path Parameters

service_label_id stringrequired

The ID of the service label.

application/json

Body

Details of the Service Label to be updated

description

The description of the service label. Max size = 256.

id string

The ID of the service label.

name stringrequired

The name of the service label. Max size = 128.

sase_properties SaseServiceLabelProperties

The sase service label properties.

active_sase_label boolean

The active sase service label.

tags string[]

A information field that can be added to identify the service label. Maximum 10 unique tags of length 1024 each are allowed.

type stringrequired

Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

The network service type.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the service label. Max size = 256.

id string

The ID of the service label.

name stringrequired

The name of the service label. Max size = 128.

sase_properties SaseServiceLabelProperties

The sase service label properties.

active_sase_label boolean

The active sase service label.

tags string[]

A information field that can be added to identify the service label. Maximum 10 unique tags of length 1024 each are allowed.

type stringrequired

Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]

The network service type.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "sase_properties": {
    "active_sase_label": true
  },
  "tags": [
    "string"
  ],
  "type": "CG_TRANSIT"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_JSON"
      },
      {
        "code": "SERVICELABEL_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "SERVICELABEL_NAME_REQD"
      },
      {
        "code": "DESCRIPTION_SIZE_EXCEEDED"
      },
      {
        "code": "SERVICELABEL_CONFIG_UPDATE_NOTALLOWED"
      },
      {
        "code": "SERVICELABEL_UPDATE_NOTALLOWED_SASE"
      }
    ]
  }
}

Loading...