Endpoint groups
All operations require authentication.
List endpoint groupsAlpha
Returns the endpoint groups of the project, in every region.
Path parameters
Project ID
Headers
Pagination cursor
Pagination size
Response
Hash of the current target specification. Send it back in the update payload to detect concurrent changes.
Date and time the endpoint group was created
Observed state of the endpoint group. Null while the endpoint group is being created.
Asynchronous operations ongoing on the endpoint group
Unique identifier of the endpoint group
Readiness of the endpoint group: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the endpoint group
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"[ { "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
Returns the endpoint group and its observed state.
Path parameters
Endpoint group ID
Project ID
Response
Hash of the current target specification. Send it back in the update payload to detect concurrent changes.
Date and time the endpoint group was created
Observed state of the endpoint group. Null while the endpoint group is being created.
Asynchronous operations ongoing on the endpoint group
Unique identifier of the endpoint group
Readiness of the endpoint group: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the endpoint group
Date and time the endpoint group was last updated
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"{ "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
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
Project ID
Request body (required)
Desired specification of the endpoint group to create
Response
Hash of the current target specification. Send it back in the update payload to detect concurrent changes.
Date and time the endpoint group was created
Observed state of the endpoint group. Null while the endpoint group is being created.
Asynchronous operations ongoing on the endpoint group
Unique identifier of the endpoint group
Readiness of the endpoint group: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the endpoint group
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"{ "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
Deletes the endpoint group. It is refused while an IPsec connection uses it. Deletion applies immediately: the response already holds the result.
Path parameters
Endpoint group ID
Project ID
Response
Hash of the current target specification. Send it back in the update payload to detect concurrent changes.
Date and time the endpoint group was created
Observed state of the endpoint group. Null while the endpoint group is being created.
Asynchronous operations ongoing on the endpoint group
Unique identifier of the endpoint group
Readiness of the endpoint group: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the endpoint group
Date and time the endpoint group was last updated
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"{ "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
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
Endpoint group ID
Project ID
Request body (required)
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).
Desired specification of the endpoint group. It replaces the previous one as a whole.
Response
Hash of the current target specification. Send it back in the update payload to detect concurrent changes.
Date and time the endpoint group was created
Observed state of the endpoint group. Null while the endpoint group is being created.
Asynchronous operations ongoing on the endpoint group
Unique identifier of the endpoint group
Readiness of the endpoint group: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the endpoint group
Date and time the endpoint group was last updated
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"{ "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"}