Listing VPN endpoint groups

GET /v2.0/vpn/endpoint-groups

List VPN endpoint groups.

Source: https://docs.openstack.org/api-ref/network/v2/index.html?expanded=list-vpn-endpoint-groups-detail#list-vpn-endpoint-groups

Request

Name In Type Description
fields (Optional) query string

The fields that you want the server to return. If no fields query parameter is specified, the networking API returns all attributes allowed by the policy settings. By using the fields parameter, the API returns only the requested set of attributes. The fields parameter can be specified multiple times. For example, if you specify fields=id&fields=name in the request URL, only the id and name attributes will be returned.

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:9696/v2.0/vpn/endpoint-groups

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
401 - Unauthorized

User must authenticate before making a request.

403 - Forbidden

Policy does not allow current user to do this operation.

Example

{
  "endpoint_groups": [
    {
      "id": "e3b89342-73ee-42b9-8ee9-fd91ec36aceb",
      "tenant_id": "284a2547ea8445d1be0e68ef2d76672c",
      "name": "peers",
      "description": "",
      "type": "cidr",
      "endpoints": [
        "10.2.0.0/24",
        "10.3.0.0/24"
      ],
      "project_id": "284a2547ea8445d1be0e68ef2d76672c"
    },
    {
      "id": "646938a8-322e-44b3-ac35-60deadcd4252",
      "tenant_id": "284a2547ea8445d1be0e68ef2d76672c",
      "name": "locals",
      "description": "",
      "type": "subnet",
      "endpoints": [
        "79a060e3-3395-4fbf-9505-4517a65f81af",
        "62cd794c-6682-4793-884b-828eb84324b0"
      ],
      "project_id": "284a2547ea8445d1be0e68ef2d76672c"
    }
  ]
}