Update Service Binding Map (v2.1)

PUT 
/sdwan/v2.1/api/servicebindingmaps/:map_id

Update a service binding map.

Request

Path Parameters

map_id stringrequired

The ID of the service binding map.

application/json

Body

Details of the service binding maps to be updated

description

The description of the service binding map. Max size = 256.

id string

The ID of the service binding map.

is_default boolean

The default map.

name stringrequired

The name of the service binding map. Max size = 128.

service_bindings ServiceBinding[]required
The service binding endpoint IDs and labels.
Array [
service_endpoint_ids string[]
The service endpoint IDs.
service_label_id string
The service label ID.
]
tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the service binding map. Max size = 256.

id string

The ID of the service binding map.

is_default boolean

The default map.

name stringrequired

The name of the service binding map. Max size = 128.

service_bindings ServiceBinding[]required
The service binding endpoint IDs and labels.
Array [
service_endpoint_ids string[]
The service endpoint IDs.
service_label_id string
The service label ID.
]
tags string[]

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

Example (from schema)

{
  "id": "string",
  "is_default": true,
  "name": "string",
  "service_bindings": [
    {
      "service_endpoint_ids": [
        "string"
      ],
      "service_label_id": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

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": "SERVICEBINDINGMAP_NAME_REQD"
      },
      {
        "code": "SERVICEBINDING_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "DESCRIPTION_SIZE_EXCEEDED"
      },
      {
        "code": "SERVICEBINDINGMAP_CONFIG_SASELABEL_TOO_MANY_SERVICEENDPOINTS"
      }
    ]
  }
}

Loading...