GET

/#Action=DescribeClientVpnEndpoints

http://ec2.{region}.amazonaws.com/#Action=DescribeClientVpnEndpoints

Describes one or more Client VPN endpoints in the account.

Access Token Required: API Key

Query Params

ClientVpnEndpointIdarray

The ID of the Client VPN endpoint.

MaxResultsinteger

The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.

NextTokenstring

The token to retrieve the next page of results.

Filterarray

One or more filters. Filter names and values are case-sensitive. <ul> <li> <code>endpoint-id</code> - The ID of the Client VPN endpoint. </li> <li> <code>transport-protocol</code> - The transport protocol (<code>tcp</code> | <code>udp</code>). </li> </ul>

DryRunboolean

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=DescribeClientVpnEndpoints' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}