Updating VPN endpoint groups
PUT /v2.0/vpn/endpoint-groups/{endpoint_group_id}
Update settings for a VPN endpoint group.
Request
Parameters
Name | In | Type | Description |
---|---|---|---|
endpoint_group_id
|
path | string | The ID of the VPN endpoint group. |
name (Optional) |
body | string | A human-readable name of the resource. Default is an empty string. |
description (Optional) |
body | string | A human-readable description for the resource. Default is an empty string. |
Example
# curl -ks -X PUT -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' -d '\ { "endpoint_group": { "description": "Remote endpoint group" } }' https://<node_IP_addr>:9696/v2.0/vpn/endpoint-groups/e3b89342-73ee-42b9-8ee9-fd91ec36aceb
Response
Parameters
Name | In | Type | Description |
---|---|---|---|
endpoints
|
body | array | List of endpoints of the same type, for the endpoint group. The values will depend on the type. |
name (Optional) |
body | string | A human-readable name of the resource. Default is an empty string. |
description (Optional) |
body | string | A human-readable description for the resource. Default is an empty string. |
tenant_id
|
body | string | The ID of the project. |
project_id
|
body | string | The ID of the project. |
type
|
body | string | The type of the endpoints in the group. A valid value is subnet , cidr , network , router , or vlan . Only subnet and cidr are supported at this moment. |
id
|
body | string | The ID of the VPN endpoint group. |
Status codes
Success
Code | Reason |
---|---|
200 - OK
|
Request was successful. |
Error
Code | Reason |
---|---|
400 - Bad Request
|
Some content in the request was invalid. |
401 - Unauthorized
|
User must authenticate before making a request. |
404 - Not Found
|
The requested resource could not be found. |
Example
{ "endpoint_group": { "id": "e3b89342-73ee-42b9-8ee9-fd91ec36aceb", "tenant_id": "284a2547ea8445d1be0e68ef2d76672c", "name": "peers", "description": "Remote endpoint group", "type": "cidr", "endpoints": [ "10.2.0.0/24", "10.3.0.0/24" ], "project_id": "284a2547ea8445d1be0e68ef2d76672c" } }