• Native OpenStack API

noa
  1. Help Center
  2. Native OpenStack API
  3. API Reference
  4. Neutron
  5. VPNaas
  6. Update VPN endpoint group

Update VPN endpoint group

Function Description

This interface is used to update settings for a VPN endpoint group.

Interface Format

Method

URI

Description

PUT

/v2.0/vpn/endpoint-groups/{endpoint_group_id}

Updates settings for a VPN endpoint group.

Restrictions

  • Parameter endpoint_group_id is mandatory.
  • The name value must contain 1 to 64 characters.
  • The description value can contain a maximum of 255 characters.
  • The project_id attribute is not supported.

Request Parameter

Parameter

Type

Mandatory

Description

endpoint_group_id

String

No

Specifies the ID of the VPN endpoint group.

description

String

Yes

Specifies the description about the VPN endpoint group.

name

String

Yes

Specifies the name of the VPN endpoint group.

Response Parameter

Parameter

Type

Mandatory

Description

description

Yes

String

Specifies the description about the VPN endpoint group.

tenant_id

Yes

String

Specifies the ID of the tenant.

endpoints

Yes

List<endpoint-group>

Specifies the list of endpoints of the same type for the endpoint group.

type

Yes

String

Specifies the type of endpoints. A valid value can be subnet or cidr.

id

Yes

String

Specifies the ID of the VPN endpoint group.

name

Yes

String

Specifies the description about the VPN endpoint group.

project_id

Yes

String

Specifies the ID of the project.

Request Example

PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
{
 "endpoint_group" : {
"description" : "New description"
 }
}

Response Example

{
 "endpoint_group" : {
"description" : "New description",
"project_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
"tenant_id" : "4ad57e7ce0b24fca8f12b9834d91079d",
"endpoints" : [ "10.2.0.0/24", "10.3.0.0/24" ],
"type" : "cidr",
"id" : "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a",
"name" : "peers"
 }
}

Error Code

For details, see section Return Code Processing.