{"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.ExternalGateway":{"type":"object","description":"Attachment of a VPN gateway to the external network, which gives it its public addresses","properties":{"enabled":{"type":"boolean","description":"Whether the VPN gateway is attached to the external network. When true, the VPN gateway gets the public addresses reported in currentState.externalIpv4 and externalIpv6."}},"required":["enabled"]},"publicCloud.vpn.Gateway":{"type":"object","description":"A VPN gateway, 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 VPN gateway was created","format":"date-time","readOnly":true},"currentState":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.GatewayCurrentState"}],"description":"Observed state of the VPN gateway. Null while the VPN gateway is being created.","nullable":true,"readOnly":true},"currentTasks":{"type":"array","description":"Asynchronous operations ongoing on the VPN gateway","nullable":true,"items":{"$ref":"#/components/schemas/common.CurrentTask"},"readOnly":true},"id":{"type":"string","description":"Unique identifier of the VPN gateway","format":"uuid","readOnly":true},"resourceStatus":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Readiness of the VPN gateway: whether its observed state has converged to its target specification","readOnly":true},"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.GatewayTargetSpec"}],"description":"Last target specification requested for the VPN gateway","readOnly":true},"updatedAt":{"type":"string","description":"Date and time the VPN gateway was last updated","format":"date-time","readOnly":true}}},"publicCloud.vpn.GatewayCreation":{"type":"object","description":"Payload to create a VPN gateway","properties":{"targetSpec":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.GatewayTargetSpec"}],"description":"Desired specification of the VPN gateway to create"}},"required":["targetSpec"]},"publicCloud.vpn.GatewayCurrentState":{"type":"object","description":"Observed state of a VPN gateway","properties":{"description":{"type":"string","description":"Free-form description of the VPN gateway. Null when none was given. At most 255 characters.","nullable":true,"readOnly":true},"externalGateway":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.ExternalGateway"}],"description":"Attachment of the VPN gateway to the external network, as currently applied","readOnly":true},"externalIpv4":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Public IPv4 address of the VPN gateway, for the IPv4 peers. Null while the external gateway is disabled, until it is attached, or when the external network has no IPv4 subnet.","nullable":true,"readOnly":true},"externalIpv6":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Public IPv6 address of the VPN gateway, for the IPv6 peers. Null while the external gateway is disabled, until it is attached, or when the external network has no IPv6 subnet.","nullable":true,"readOnly":true},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.Location"}],"description":"Region of the VPN gateway. Immutable after creation.","readOnly":true},"name":{"type":"string","description":"Name of the VPN gateway, at most 255 characters, unique in the project","readOnly":true},"operatingStatus":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.OperatingStatusEnum"}],"description":"Operating status of the VPN gateway, as observed on the platform. `UP`: running. `DOWN`: not running. `UNKNOWN`: not observed recently. `DISABLED`: never returned for a VPN gateway. Null until the VPN gateway is first observed, and while `provisioningStatus` is not `ACTIVE`.","nullable":true,"readOnly":true},"provisioningStatus":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.ProvisioningStatusEnum"}],"description":"Provisioning status of the VPN gateway configuration on the platform. `ACTIVE`: applied. `PENDING_CREATE`, `PENDING_UPDATE`, `PENDING_DELETE`: a change is being applied. `ERROR`: the last change failed. Null when the platform reports another status.","nullable":true,"readOnly":true},"subnets":{"type":"array","description":"Subnets the VPN gateway is attached to, with its address on each","items":{"$ref":"#/components/schemas/publicCloud.vpn.GatewaySubnet"},"readOnly":true}}},"publicCloud.vpn.GatewaySubnet":{"type":"object","description":"Subnet a VPN gateway is attached to","properties":{"id":{"type":"string","description":"Identifier of the Public Cloud subnet","format":"uuid","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ip"}],"description":"Address of the VPN gateway on the subnet. Set it as the next hop of the subnet host routes toward the remote networks. Null until the address is allocated.","nullable":true,"readOnly":true},"network":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.NetworkRef"}],"description":"Network of the subnet. Null until the platform reports it.","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/common.ResourceStatusEnum"}],"description":"Provisioning status of the VPN gateway on the subnet. `CREATING`: being plugged into the subnet. `READY`: plugged into the subnet. `ERROR`: plugging failed. `DELETING`: being detached.","readOnly":true}}},"publicCloud.vpn.GatewayTargetSpec":{"type":"object","description":"Desired specification of a VPN gateway","properties":{"description":{"type":"string","description":"Free-form description of the VPN gateway. At most 255 characters.","nullable":true},"externalGateway":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.ExternalGateway"}],"description":"Attachment of the VPN gateway to the external network, which gives it its public addresses"},"location":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.Location"}],"description":"Region of the VPN gateway. Immutable after creation."},"name":{"type":"string","description":"Name of the VPN gateway, at most 255 characters, unique in the project"},"subnets":{"type":"array","description":"Private subnets the VPN gateway is plugged into, as router interfaces: the IPsec connections carry the traffic of the networks behind them. Each subnet must belong to the project, or sit on a network shared with the project. The interfaces run without port security, so any host of these subnets can reach the VPN gateway. Replaced as a whole on update: a subnet added is plugged, a subnet removed is unplugged. Null or empty at creation plugs the VPN gateway into no subnet. Null in a response when it is plugged into none.","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.vpn.SubnetRef"}}},"required":["externalGateway","location","name"]},"publicCloud.vpn.GatewayUpdate":{"type":"object","description":"Payload to update a VPN gateway","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.GatewayUpdateTargetSpec"}],"description":"Desired specification of the VPN gateway. It replaces the previous one as a whole."}},"required":["targetSpec"]},"publicCloud.vpn.GatewayUpdateTargetSpec":{"type":"object","description":"Desired specification of a VPN gateway on update: the fields that can change after creation","properties":{"description":{"type":"string","description":"Free-form description of the VPN gateway. At most 255 characters.","nullable":true},"externalGateway":{"allOf":[{"$ref":"#/components/schemas/publicCloud.vpn.ExternalGateway"}],"description":"Attachment of the VPN gateway to the external network, which gives it its public addresses"},"name":{"type":"string","description":"Name of the VPN gateway, at most 255 characters, unique in the project"},"subnets":{"type":"array","description":"Private subnets the VPN gateway is plugged into, as router interfaces: the IPsec connections carry the traffic of the networks behind them. Each subnet must belong to the project, or sit on a network shared with the project. The interfaces run without port security, so any host of these subnets can reach the VPN gateway. Replaced as a whole on update: a subnet added is plugged, a subnet removed is unplugged. Null or empty unplugs the VPN gateway from every subnet.","nullable":true,"items":{"$ref":"#/components/schemas/publicCloud.vpn.SubnetRef"}}},"required":["externalGateway","name"]},"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.NetworkRef":{"type":"object","description":"Reference to a Public Cloud network","properties":{"id":{"type":"string","description":"Unique identifier of the Public Cloud network, as returned by /publicCloud/project/{projectId}/network","format":"uuid","readOnly":true}}},"publicCloud.vpn.OperatingStatusEnum":{"type":"string","description":"Operating status of a VPN resource, as observed on the platform","enum":["DISABLED","DOWN","UNKNOWN","UP"]},"publicCloud.vpn.ProvisioningStatusEnum":{"type":"string","description":"Provisioning status of the configuration of a VPN resource on the platform","enum":["ACTIVE","ERROR","PENDING_CREATE","PENDING_DELETE","PENDING_UPDATE"]},"publicCloud.vpn.SubnetRef":{"type":"object","description":"Reference to a Public Cloud subnet","properties":{"id":{"type":"string","description":"Unique identifier of the Public Cloud subnet, as returned by /publicCloud/project/{projectId}/network/{networkId}/subnet","format":"uuid"}},"required":["id"]},"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/gateway":{"get":{"operationId":"getAllVpnGateways","summary":"List VPN gateways","description":"Returns the VPN gateways 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.Gateway"}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","VPN gateways"]],"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/gateway\")\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/gateway\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/gateway/get","required":true}],"x-response-identifier":"id","x-expanded-response":"PublicCloudVpnGateway"},"post":{"operationId":"createVpnGateway","summary":"Create a VPN gateway","description":"Creates a VPN gateway: a router dedicated to IPsec, running on a managed instance. When targetSpec.externalGateway.enabled is true, it gets its public addresses automatically. It is plugged into the subnets of targetSpec.subnets. Creation is asynchronous: follow resourceStatus and currentTasks, then currentState.externalIpv4 and externalIpv6 for the addresses to give to the peers.","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.GatewayCreation"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.Gateway"}}}},"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"}}}}}},"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::SubnetDoesNotExist":{"value":{"class":"Client::NotFound::SubnetDoesNotExist","message":"Subnet 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::RegionInMaintenance":{"value":{"class":"Client::Conflict::RegionInMaintenance","message":"This region is currently in maintenance"}},"Client::Conflict::VpnGatewayNameAlreadyExists":{"value":{"class":"Client::Conflict::VpnGatewayNameAlreadyExists","message":"A VPN gateway with this name already exists in this project"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","VPN gateways"]],"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.GatewayCreation\nresult = client.post(\"/v2/publicCloud/project/{projectId}/vpn/gateway\",\n\ttargetSpec = None, # Desired specification of the VPN gateway to create (type: publicCloud.vpn.GatewayTargetSpec)\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.GatewayCreation\n$result = $ovh->post(\"/v2/publicCloud/project/{projectId}/vpn/gateway\", array(\n\ttargetSpec => null, // Desired specification of the VPN gateway to create (type: publicCloud.vpn.GatewayTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/gateway/create","required":true}]}},"/publicCloud/project/{projectId}/vpn/gateway/{gatewayId}":{"delete":{"operationId":"deleteVpnGateway","summary":"Delete a VPN gateway","description":"Deletes the VPN gateway, with its IPsec connections and their tunnels, and releases its public addresses. Refused while the VPN gateway is being created, updated or deleted: follow its resourceStatus and retry once it is READY or ERROR. Deletion is asynchronous: the VPN gateway stays listed with resourceStatus DELETING until it is gone.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"gatewayId","description":"Gateway 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.Gateway"}}}},"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::VpnGatewayDoesNotExist":{"value":{"class":"Client::NotFound::VpnGatewayDoesNotExist","message":"VPN gateway 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::ResourceAlreadyBeingDeleted":{"value":{"class":"Client::Conflict::ResourceAlreadyBeingDeleted","message":"Resource is already being deleted"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","VPN gateways"]],"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/gateway/{gatewayId}\")\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/gateway/{gatewayId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/gateway/delete","required":true}]},"get":{"operationId":"getVpnGateway","summary":"Get a VPN gateway","description":"Returns the VPN gateway and its observed state.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"gatewayId","description":"Gateway 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.Gateway"}}}},"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::VpnGatewayDoesNotExist":{"value":{"class":"Client::NotFound::VpnGatewayDoesNotExist","message":"VPN gateway not found"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","VPN gateways"]],"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/gateway/{gatewayId}\")\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/gateway/{gatewayId}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/gateway/get","required":true}],"x-response-identifier":"id"},"put":{"operationId":"editVpnGateway","summary":"Update a VPN gateway","description":"The target specification replaces the previous one as a whole: a field left null goes back to its default. Send the checksum of the last GET to reject the update with a checksum mismatch when someone changed the resource in between. Subnets added to targetSpec.subnets are plugged and subnets removed are unplugged, which is asynchronous: follow resourceStatus and currentState.subnets. Likewise, setting targetSpec.externalGateway.enabled to true attaches the VPN gateway to the external network: follow resourceStatus. Once enabled, it cannot be disabled: create another VPN gateway instead. Refused while the VPN gateway is being created, updated or deleted: follow its resourceStatus and retry once it is READY or ERROR.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"gatewayId","description":"Gateway 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.GatewayUpdate"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/publicCloud.vpn.Gateway"}}}},"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::SubnetDoesNotExist":{"value":{"class":"Client::NotFound::SubnetDoesNotExist","message":"Subnet not found"}},"Client::NotFound::VpnGatewayDoesNotExist":{"value":{"class":"Client::NotFound::VpnGatewayDoesNotExist","message":"VPN gateway 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"}},"Client::Conflict::ResourceInInvalidState":{"value":{"class":"Client::Conflict::ResourceInInvalidState","message":"Resource cannot be modified in its current state"}}}}}}},"tags":["Network"],"x-developer-hub-navigation":[["Public Cloud","Network","Site-to-Site VPN","VPN gateways"]],"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.GatewayUpdate\nresult = client.put(\"/v2/publicCloud/project/{projectId}/vpn/gateway/{gatewayId}\",\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 VPN gateway. It replaces the previous one as a whole. (type: publicCloud.vpn.GatewayUpdateTargetSpec)\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.GatewayUpdate\n$result = $ovh->put(\"/v2/publicCloud/project/{projectId}/vpn/gateway/{gatewayId}\", 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 VPN gateway. It replaces the previous one as a whole. (type: publicCloud.vpn.GatewayUpdateTargetSpec)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"publicCloudProject:apiovh:vpn/gateway/edit","required":true}]}}},"tags":[{"name":"Network","x-tag-expanded":false,"description":"Missing description"}]}
