IPsec policies
All operations require authentication.
List IPsec policiesAlpha
Returns the IPsec policies 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 IPsec policy was created
Observed state of the IPsec policy. Null while the IPsec policy is being created.
Asynchronous operations ongoing on the IPsec policy
Unique identifier of the IPsec policy
Readiness of the IPsec policy: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the IPsec policy
Date and time the IPsec policy was last updated
Example uses projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ vpn/ ipsecPolicy \
-H "authorization: Bearer $OVH_TOKEN"[ { "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "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": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "updatedAt": "2024-01-01T12:00:00Z" }]
Create an IPsec policyAlpha
Creates an IPsec policy: a set of IPsec (phase 2) algorithms used by the IPsec tunnels that reference it in their targetSpec.ipsec. Several IPsec tunnels can share one policy, provided their VPN gateways are in the region of the policy. The policy uses ESP in tunnel mode. Creation applies immediately: the response already holds the result.
Path parameters
Project ID
Request body (required)
Desired specification of the IPsec policy to create
Response
Hash of the current target specification. Send it back in the update payload to detect concurrent changes.
Date and time the IPsec policy was created
Observed state of the IPsec policy. Null while the IPsec policy is being created.
Asynchronous operations ongoing on the IPsec policy
Unique identifier of the IPsec policy
Readiness of the IPsec policy: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the IPsec policy
Date and time the IPsec policy was last updated
Example uses projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ vpn/ ipsecPolicy \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "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": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "updatedAt": "2024-01-01T12:00:00Z"}
Get an IPsec policyAlpha
Returns the IPsec policy and its observed state.
Path parameters
Ipsec policy 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 IPsec policy was created
Observed state of the IPsec policy. Null while the IPsec policy is being created.
Asynchronous operations ongoing on the IPsec policy
Unique identifier of the IPsec policy
Readiness of the IPsec policy: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the IPsec policy
Date and time the IPsec policy was last updated
Example uses ipsecPolicyId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ vpn/ ipsecPolicy/ {ipsecPolicyId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "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": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "updatedAt": "2024-01-01T12:00:00Z"}
Update an IPsec policyAlpha
The target specification replaces the previous one as a whole: every algorithm and the lifetime must be sent, and a description left null is removed. Send the checksum of the last GET to reject the update with a checksum mismatch when someone changed the resource in between. Changing the algorithms does not renegotiate the IPsec tunnels already using the policy: each one takes them the next time it is configured, for example on its next update. The update applies immediately: the response already holds the result.
Path parameters
Ipsec policy 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 IPsec policy. 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 IPsec policy was created
Observed state of the IPsec policy. Null while the IPsec policy is being created.
Asynchronous operations ongoing on the IPsec policy
Unique identifier of the IPsec policy
Readiness of the IPsec policy: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the IPsec policy
Date and time the IPsec policy was last updated
Example uses ipsecPolicyId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ vpn/ ipsecPolicy/ {ipsecPolicyId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "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": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "updatedAt": "2024-01-01T12:00:00Z"}
Delete an IPsec policyAlpha
Deletes the IPsec policy. It is refused while an IPsec tunnel uses it. Deletion applies immediately: the response already holds the result.
Path parameters
Ipsec policy 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 IPsec policy was created
Observed state of the IPsec policy. Null while the IPsec policy is being created.
Asynchronous operations ongoing on the IPsec policy
Unique identifier of the IPsec policy
Readiness of the IPsec policy: whether its observed state has converged to its target specification
CREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATINGLast target specification requested for the IPsec policy
Date and time the IPsec policy was last updated
Example uses ipsecPolicyId = 00000000-0000-0000-0000-000000000000, projectId = string
$ curl https:/ / api.eu.ovhcloud.com/ v2/ publicCloud/ project/ {projectId}/ vpn/ ipsecPolicy/ {ipsecPolicyId} \
-H "authorization: Bearer $OVH_TOKEN"{ "checksum": "string", "createdAt": "2024-01-01T12:00:00Z", "currentState": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "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": { "authAlgorithm": "SHA256", "description": "string", "encryptionAlgorithm": "AES_128", "lifetime": 0, "location": { "region": "string" }, "name": "string", "pfs": "GROUP14" }, "updatedAt": "2024-01-01T12:00:00Z"}