Update NAT Global Prefix (v2.0)

PUT 
/sdwan/v2.0/api/natglobalprefixes/:prefix_id

Update a specific NAT global prefix.

Request

Path Parameters

prefix_id stringrequired

ID of the global NAT prefix.

application/json

Body

Details to update the NAT Global prefix.

description

The description for the global NAT prefix. Max size = 256.

id string

The ID of the global NAT prefix.

ipv4_prefixes string[]

Lists the IP addresses.

name stringrequired

The name of the global NAT prefix. Max size = 128.

tags string[]

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

Responses

200

Successful Operation

application/json

Schema

Schema

description

The description for the global NAT prefix. Max size = 256.

id string

The ID of the global NAT prefix.

ipv4_prefixes string[]

Lists the IP addresses.

name stringrequired

The name of the global NAT prefix. Max size = 128.

tags string[]

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

Example (from schema)

{
  "id": "string",
  "ipv4_prefixes": [
    "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": "INVALID_REQUEST_DUPLICATE_KEY"
      },
      {
        "code": "NAT_PREFIX_INVALID_NAME"
      },
      {
        "code": "NAT_PREFIX_NAME_REQUIRED"
      },
      {
        "code": "NAT_PREFIX_INVALID_DESCRIPTION"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      }
    ]
  }
}

Loading...