Update Path Group of Tenant (v2.1)

PUT 
/v2.1/api/tenants/:tenant_id/pathgroups/:path_group_id

Update the path group of a tenant.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

path_group_id stringrequired

ID of the path group.

application/json

Body

Details of the path group to be updated

description

The description of the path group. Max length 256.

id string

The ID of the path group.

name string

The name of the path group. Max length 128.

paths WANPath[]required
List of paths in the group.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description of the path group. Max length 256.

id string

The ID of the path group.

name string

The name of the path group. Max length 128.

paths WANPath[]
List of paths in the group.
Array [
label string
The label to identify the path.
path_type stringrequired
Possible values: [vpn, direct, servicelink]
The path type.
]

Example (from schema)

{
  "id": "string",
  "name": "string",
  "paths": [
    {
      "label": "string",
      "path_type": "vpn"
    }
  ]
}

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": "PATHGROUP_NOT_FOUND"
      },
      {
        "code": "PATHGROUP_INVALID_DESCRIPTION"
      },
      {
        "code": "PATHGROUP_INVALID_NAME"
      },
      {
        "code": "PATHGROUP_INVALID_PATHS"
      }
    ]
  }
}

Loading...