Update VRF Context (v2.0)

PUT 
/v2.0/api/tenants/:tenant_id/vrfcontexts/:vrf_context_id

Update a VRF context.

Request

Path Parameters

tenant_id stringrequired

ID of the tenant.

vrf_context_id stringrequired

The ID of the VRF context.

application/json

Body

Details of vrf segment to be updated

description

Description of the VRF context config. Max size = 256.

id string

The VRF context ID.

name stringrequired

The name of the VRF context. Max size = 128.

tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

default_vrf_context boolean

VRF context is enabled by default. True / False.

description

Description of the VRF context config. Max size = 256.

id string

The VRF context ID.

name stringrequired

The name of the VRF context. Max size = 128.

tags string[]

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

Example (from schema)

{
  "default_vrf_context": true,
  "id": "string",
  "name": "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": "VRF_CONTEXT_CONFIG_DESCRIPTION_INVALID"
      },
      {
        "code": "VRF_CONTEXT_NAME_EXCEEDS_LIMIT"
      },
      {
        "code": "VRF_CONTEXT_NAME_INVALID"
      }
    ]
  }
}

Loading...