Skip to content

Endpoint groups

All operations require authentication.

5 operationsv2/publicCloud/project
View as Markdown (opens in a new tab)
Agent setup

List endpoint groupsAlpha

GET
/v2/publicCloud/project/{projectId}/vpn/endpointGroup

Returns the endpoint groups of the project, in every region.

Path parameters

projectId
required
string

Project ID

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200EndpointGroup[]successful operation
checksum
read-only
string

Hash of the current target specification. Send it back in the update payload to detect concurrent changes.

createdAt
read-only
stringdate-time

Date and time the endpoint group was created

currentState
read-only
EndpointGroupCurrentState

Observed state of the endpoint group. Null while the endpoint group is being created.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the endpoint group

id
read-only
stringuuid

Unique identifier of the endpoint group

resourceStatus
read-only
ResourceStatusEnum

Readiness of the endpoint group: whether its observed state has converged to its target specification

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
EndpointGroupTargetSpec

Last target specification requested for the endpoint group

updatedAt
read-only
stringdate-time

Date and time the endpoint group was last updated

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/vpn/endpointGroup \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z" }]

Get an endpoint groupAlpha

GET
/v2/publicCloud/project/{projectId}/vpn/endpointGroup/{endpointGroupId}

Returns the endpoint group and its observed state.

Path parameters

endpointGroupId
required
stringuuid

Endpoint group ID

projectId
required
string

Project ID

Response

200EndpointGroupsuccessful operation
checksum
read-only
string

Hash of the current target specification. Send it back in the update payload to detect concurrent changes.

createdAt
read-only
stringdate-time

Date and time the endpoint group was created

currentState
read-only
EndpointGroupCurrentState

Observed state of the endpoint group. Null while the endpoint group is being created.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the endpoint group

id
read-only
stringuuid

Unique identifier of the endpoint group

resourceStatus
read-only
ResourceStatusEnum

Readiness of the endpoint group: whether its observed state has converged to its target specification

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
EndpointGroupTargetSpec

Last target specification requested for the endpoint group

updatedAt
read-only
stringdate-time

Date and time the endpoint group was last updated

404objectError 404 response

Example uses endpointGroupId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/vpn/endpointGroup/{endpointGroupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Create an endpoint groupAlpha

POST
/v2/publicCloud/project/{projectId}/vpn/endpointGroup

Creates an endpoint group: a list of networks, in CIDR notation, that the IPsec connections of its region reference as targetSpec.endpointGroup.local or targetSpec.endpointGroup.distant. Several IPsec connections can share one endpoint group. Creation applies immediately: the response already holds the result.

Path parameters

projectId
required
string

Project ID

Request body (required)

targetSpec
required
EndpointGroupTargetSpec

Desired specification of the endpoint group to create

Response

200EndpointGroupsuccessful operation
checksum
read-only
string

Hash of the current target specification. Send it back in the update payload to detect concurrent changes.

createdAt
read-only
stringdate-time

Date and time the endpoint group was created

currentState
read-only
EndpointGroupCurrentState

Observed state of the endpoint group. Null while the endpoint group is being created.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the endpoint group

id
read-only
stringuuid

Unique identifier of the endpoint group

resourceStatus
read-only
ResourceStatusEnum

Readiness of the endpoint group: whether its observed state has converged to its target specification

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
EndpointGroupTargetSpec

Last target specification requested for the endpoint group

updatedAt
read-only
stringdate-time

Date and time the endpoint group was last updated

400objectError 400 response
403objectError 403 response
409objectError 409 response

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/vpn/endpointGroup \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Delete an endpoint groupAlpha

DELETE
/v2/publicCloud/project/{projectId}/vpn/endpointGroup/{endpointGroupId}

Deletes the endpoint group. It is refused while an IPsec connection uses it. Deletion applies immediately: the response already holds the result.

Path parameters

endpointGroupId
required
stringuuid

Endpoint group ID

projectId
required
string

Project ID

Response

200EndpointGroupsuccessful operation
checksum
read-only
string

Hash of the current target specification. Send it back in the update payload to detect concurrent changes.

createdAt
read-only
stringdate-time

Date and time the endpoint group was created

currentState
read-only
EndpointGroupCurrentState

Observed state of the endpoint group. Null while the endpoint group is being created.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the endpoint group

id
read-only
stringuuid

Unique identifier of the endpoint group

resourceStatus
read-only
ResourceStatusEnum

Readiness of the endpoint group: whether its observed state has converged to its target specification

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
EndpointGroupTargetSpec

Last target specification requested for the endpoint group

updatedAt
read-only
stringdate-time

Date and time the endpoint group was last updated

404objectError 404 response
409objectError 409 response

Example uses endpointGroupId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/vpn/endpointGroup/{endpointGroupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}

Update an endpoint groupAlpha

PUT
/v2/publicCloud/project/{projectId}/vpn/endpointGroup/{endpointGroupId}

The target specification replaces the previous one as a whole: a field left null goes back to its default, and targetSpec.cidrs replaces the networks as a whole. Send the checksum of the last GET to reject the update with a checksum mismatch when someone changed the resource in between. While an IPsec connection uses the endpoint group, its networks cannot change and only the name and the description can: sending the current networks again is accepted. The update applies immediately: the response already holds the result.

Path parameters

endpointGroupId
required
stringuuid

Endpoint group ID

projectId
required
string

Project ID

Request body (required)

checksum
string

Optional concurrency-control checksum. When supplied, it must match the resource's current checksum or the request is rejected with a 409 checksum-mismatch conflict. When omitted or empty, the concurrency check is skipped and the write is forced (last-write-wins).

targetSpec
required
EndpointGroupUpdateTargetSpec

Desired specification of the endpoint group. It replaces the previous one as a whole.

Response

200EndpointGroupsuccessful operation
checksum
read-only
string

Hash of the current target specification. Send it back in the update payload to detect concurrent changes.

createdAt
read-only
stringdate-time

Date and time the endpoint group was created

currentState
read-only
EndpointGroupCurrentState

Observed state of the endpoint group. Null while the endpoint group is being created.

currentTasks
read-only
CurrentTask[]

Asynchronous operations ongoing on the endpoint group

id
read-only
stringuuid

Unique identifier of the endpoint group

resourceStatus
read-only
ResourceStatusEnum

Readiness of the endpoint group: whether its observed state has converged to its target specification

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
EndpointGroupTargetSpec

Last target specification requested for the endpoint group

updatedAt
read-only
stringdate-time

Date and time the endpoint group was last updated

400objectError 400 response
404objectError 404 response
409objectError 409 response

Example uses endpointGroupId = 00000000-0000-0000-0000-000000000000, projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/vpn/endpointGroup/{endpointGroupId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "currentTasks": [ { "errors": [ { "message": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "link": "string", "status": "ERROR", "type": "string" } ], "id": "00000000-0000-0000-0000-000000000000", "resourceStatus": "CREATING", "targetSpec": { "cidrs": [ "192.0.2.0/24" ], "description": "string", "location": { "region": "string" }, "name": "string" }, "updatedAt": "2024-01-01T12:00:00Z"}