{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/v2"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"common.CurrentTask":{"type":"object","description":"Asynchronous operation currently running","properties":{"errors":{"type":"array","description":"Errors that occurred on the task","nullable":true,"items":{"$ref":"#/components/schemas/common.TaskError"},"readOnly":true},"id":{"type":"string","description":"Identifier of the current task","format":"uuid","readOnly":true},"link":{"type":"string","description":"Link to the task details","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.CurrentTaskStatusEnum"}],"description":"Current global status of the current task","nullable":true,"readOnly":true},"type":{"type":"string","description":"Type of the current task","readOnly":true}}},"common.CurrentTaskStatusEnum":{"type":"string","description":"Current status of a task. A task in ERROR cannot be retried without your inputs. PENDING tasks will be executed as soon as possible. A RUNNING task is currently executing your original request. SCHEDULED is used for tasks that will be executed in the future.","enum":["ERROR","PENDING","RUNNING","SCHEDULED","WAITING_USER_INPUT"]},"common.ResourceStatusEnum":{"type":"string","description":"Current status of a resource","enum":["CREATING","CREATION_PLANNED","DELETING","ERROR","OUT_OF_SYNC","READY","SUSPENDED","UNKNOWN","UPDATING"]},"common.TaskError":{"type":"object","description":"Errors that occurred on the task","properties":{"message":{"type":"string","description":"Error description","readOnly":true}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"publicCloud.vpn.AuthAlgorithmEnum":{"type":"string","description":"Integrity algorithm of an IKE or IPsec negotiation","enum":["SHA256","SHA384","SHA512"]},"publicCloud.vpn.EncryptionAlgorithmEnum":{"type":"string","description":"Encryption algorithm of an IKE or IPsec negotiation. The AES_*_GCM values are AES-GCM with a 16-byte integrity check value.","enum":["AES_128","AES_128_GCM","AES_192","AES_256","AES_256_GCM"]},"publicCloud.vpn.IpsecPolicy":{"type":"object","description":"An IPsec policy, with its desired specification and its observed state","properties":{"checksum":{"type":"string","description":"Hash of the current target specification. Send it back in the update payload to detect concurrent changes.","readOnly":true},"createdAt":{"type":"string","description":"Date and time the IPsec policy was created","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicyCurrentState"}],"description":"Observed state of the IPsec policy. Null while the IPsec policy is being created.","nullable":true,"readOnly":true},"currentTasks":{"type":"array","description":"Asynchronous operations ongoing on the IPsec policy","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the IPsec policy","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Readiness of the IPsec policy: whether its observed state has converged to its target specification","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicyTargetSpec"}],"description":"Last target specification requested for the IPsec policy","readOnly":true},"updatedAt":{"type":"string","description":"Date and time the IPsec policy was last updated","format":"date-time","readOnly":true}}},"publicCloud.vpn.IpsecPolicyCreation":{"type":"object","description":"Payload to create an IPsec policy","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicyTargetSpec"}],"description":"Desired specification of the IPsec policy to create"}},"required":["targetSpec"]},"publicCloud.vpn.IpsecPolicyCurrentState":{"type":"object","description":"Observed state of an IPsec policy","properties":{"authAlgorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.AuthAlgorithmEnum"}],"description":"Integrity algorithm. Null with an AES_*_GCM encryptionAlgorithm, which carries its own integrity.","nullable":true,"readOnly":true},"description":{"type":"string","description":"Free-form description of the IPsec policy. Null when none was given.","nullable":true,"readOnly":true},"encryptionAlgorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.EncryptionAlgorithmEnum"}],"description":"Encryption algorithm","readOnly":true},"lifetime":{"type":"integer","description":"Lifetime of the IPsec security association in seconds","readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.Location"}],"description":"Region of the IPsec policy","readOnly":true},"name":{"type":"string","description":"Name of the IPsec policy","readOnly":true},"pfs":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.PfsGroupEnum"}],"description":"Diffie-Hellman group for perfect forward secrecy","readOnly":true}}},"publicCloud.vpn.IpsecPolicyTargetSpec":{"type":"object","description":"Desired specification of an IPsec policy. Configure the same algorithms on the remote device.","properties":{"authAlgorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.AuthAlgorithmEnum"}],"description":"Integrity algorithm. Must be null with an AES_*_GCM encryptionAlgorithm, which carries its own integrity. Defaults to SHA256 when null with any other.","nullable":true},"description":{"type":"string","description":"Free-form description of the IPsec policy. At most 255 characters.","nullable":true},"encryptionAlgorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.EncryptionAlgorithmEnum"}],"description":"Encryption algorithm. Defaults to AES_256 when null.","nullable":true},"lifetime":{"type":"integer","description":"Lifetime of the IPsec security association in seconds. Defaults to 3600 (1 hour) when null. At least 60.","nullable":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.Location"}],"description":"Region of the IPsec policy: only the IPsec tunnels of the VPN gateways of this region can use it. Immutable after creation."},"name":{"type":"string","description":"Name of the IPsec policy. At most 255 characters."},"pfs":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.PfsGroupEnum"}],"description":"Diffie-Hellman group for perfect forward secrecy. Defaults to GROUP14 when null.","nullable":true}},"required":["location","name"]},"publicCloud.vpn.IpsecPolicyUpdate":{"type":"object","description":"Payload to update an IPsec policy","properties":{"checksum":{"type":"string","description":"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).","nullable":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicyUpdateTargetSpec"}],"description":"Desired specification of the IPsec policy. It replaces the previous one as a whole."}},"required":["targetSpec"]},"publicCloud.vpn.IpsecPolicyUpdateTargetSpec":{"type":"object","description":"Desired specification of an IPsec policy on update: the fields that can change after creation","properties":{"authAlgorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.AuthAlgorithmEnum"}],"description":"Integrity algorithm. Must be null with an AES_*_GCM encryptionAlgorithm, which carries its own integrity. Required with any other.","nullable":true},"description":{"type":"string","description":"Free-form description of the IPsec policy. At most 255 characters.","nullable":true},"encryptionAlgorithm":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.EncryptionAlgorithmEnum"}],"description":"Encryption algorithm"},"lifetime":{"type":"integer","description":"Lifetime of the IPsec security association in seconds. At least 60."},"name":{"type":"string","description":"Name of the IPsec policy. At most 255 characters."},"pfs":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.PfsGroupEnum"}],"description":"Diffie-Hellman group for perfect forward secrecy"}},"required":["encryptionAlgorithm","lifetime","name","pfs"]},"publicCloud.vpn.Location":{"type":"object","description":"Where a VPN resource is deployed","properties":{"region":{"type":"string","description":"Region code, such as GRA11"}},"required":["region"]},"publicCloud.vpn.PfsGroupEnum":{"type":"string","description":"Diffie-Hellman group of an IKE or IPsec negotiation: GROUP14, GROUP15 and GROUP16 are the 2048, 3072 and 4096-bit MODP groups, GROUP19, GROUP20 and GROUP21 the NIST P-256, P-384 and P-521 curves, GROUP31 is Curve25519","enum":["GROUP14","GROUP15","GROUP16","GROUP19","GROUP20","GROUP21","GROUP31"]},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/publicCloud/project/{projectId}/vpn/ipsecPolicy":{"get":{"operationId":"getAllVpnIpsecPolicies","summary":"List IPsec policies","description":"Returns the IPsec policies of the project, in every region.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"header","name":"X-Pagination-Cursor","description":"Pagination cursor","schema":{"type":"string"}},{"in":"header","name":"X-Pagination-Size","description":"Pagination size","schema":{"type":"integer"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicy"}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","IPsec policies"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/ipsecPolicy/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudVpnIpsecPolicy"},"post":{"operationId":"createVpnIpsecPolicy","summary":"Create an IPsec policy","description":"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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicyCreation"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicy"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}},"Client::BadRequest::QuotaExceeded":{"value":{"class":"Client::BadRequest::QuotaExceeded","message":"This request exceeds the project's quota in this region"}}}}}},"403":{"description":"Error 403 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Forbidden::VpnBetaProjectLimitReached":{"value":{"class":"Client::Forbidden::VpnBetaProjectLimitReached","message":"Site-to-Site VPN is in beta and has reached its maximum number of projects: this project cannot use it yet"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::RegionInMaintenance":{"value":{"class":"Client::Conflict::RegionInMaintenance","message":"This region is currently in maintenance"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","IPsec policies"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.vpn.IpsecPolicyCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy\",\n\ttargetSpec = None, # Desired specification of the IPsec policy to create (type: publicCloud.vpn.IpsecPolicyTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.vpn.IpsecPolicyCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy\", array(\n\ttargetSpec => null, // Desired specification of the IPsec policy to create (type: publicCloud.vpn.IpsecPolicyTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/ipsecPolicy/create","required":true}]}},"/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}":{"delete":{"operationId":"deleteVpnIpsecPolicy","summary":"Delete an IPsec policy","description":"Deletes the IPsec policy. It is refused while an IPsec tunnel uses it. Deletion applies immediately: the response already holds the result.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ipsecPolicyId","description":"Ipsec policy ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicy"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::VpnIpsecPolicyDoesNotExist":{"value":{"class":"Client::NotFound::VpnIpsecPolicyDoesNotExist","message":"IPsec policy not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::VpnIpsecPolicyInUse":{"value":{"class":"Client::Conflict::VpnIpsecPolicyInUse","message":"This IPsec policy is used by an IPsec tunnel and cannot be deleted"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","IPsec policies"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.delete(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/ipsecPolicy/delete","required":true}]},"get":{"operationId":"getVpnIpsecPolicy","summary":"Get an IPsec policy","description":"Returns the IPsec policy and its observed state.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ipsecPolicyId","description":"Ipsec policy ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicy"}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::VpnIpsecPolicyDoesNotExist":{"value":{"class":"Client::NotFound::VpnIpsecPolicyDoesNotExist","message":"IPsec policy not found"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","IPsec policies"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/ipsecPolicy/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editVpnIpsecPolicy","summary":"Update an IPsec policy","description":"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.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"ipsecPolicyId","description":"Ipsec policy ID","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"projectId","description":"Project ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicyUpdate"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.IpsecPolicy"}}}},"400":{"description":"Error 400 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::BadRequest::InvalidParameter":{"value":{"class":"Client::BadRequest::InvalidParameter","message":"Invalid parameter in the request"}}}}}},"404":{"description":"Error 404 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::NotFound::VpnIpsecPolicyDoesNotExist":{"value":{"class":"Client::NotFound::VpnIpsecPolicyDoesNotExist","message":"IPsec policy not found"}}}}}},"409":{"description":"Error 409 response","content":{"application/json":{"schema":{"type":"object","description":"Common error model","properties":{"class":{"type":"string","description":"Class of the error"},"message":{"type":"string","description":"Error message"}}},"examples":{"Client::Conflict::ChecksumMismatch":{"value":{"class":"Client::Conflict::ChecksumMismatch","message":"Checksum mismatch — a concurrent update was detected. Refresh the resource and retry"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","IPsec policies"]],"x-badges":[{"color":"blue","label":"Alpha version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: publicCloud.vpn.IpsecPolicyUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}\",\n\tchecksum = None, # 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). (type: string, nullable)\n\ttargetSpec = None, # Desired specification of the IPsec policy. It replaces the previous one as a whole. (type: publicCloud.vpn.IpsecPolicyUpdateTargetSpec)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: publicCloud.vpn.IpsecPolicyUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/vpn/ipsecPolicy/{ipsecPolicyId}\", array(\n\tchecksum => null, // 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). (type: string, nullable)\n\ttargetSpec => null, // Desired specification of the IPsec policy. It replaces the previous one as a whole. (type: publicCloud.vpn.IpsecPolicyUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/ipsecPolicy/edit","required":true}]}}},"tags":[{"name":"Network","x-tag-expanded":false,"description":"Missing description"}]}
