{"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/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"complexType.UnitAndValue_long":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string","description":"Unit of the value","readOnly":true},"value":{"type":"integer"}}},"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"},"hosting.privateDatabase.AvailableRamSizeEnum":{"type":"string","description":"Private database available ram sizes","enum":["1024","2048","4096","512"]},"hosting.privateDatabase.AvailableVersionEnum":{"type":"string","description":"Private database available version","enum":["mariadb_10.11","mariadb_11.4","mariadb_11.8","mysql_8.0","mysql_8.4","postgresql_14","postgresql_15","postgresql_16","postgresql_17","postgresql_18","valkey_7.2","valkey_8.1","valkey_9.1"]},"hosting.privateDatabase.Capability":{"type":"object","description":"Private database capability","properties":{"create":{"type":"boolean","description":"Can the object be created","readOnly":true},"delete":{"type":"boolean","description":"Can the object be deleted","readOnly":true},"object":{"type":"string","description":"Object name","readOnly":true},"update":{"type":"boolean","description":"Can the object be updated","readOnly":true}}},"hosting.privateDatabase.ChangeFtpPasswordPayload":{"type":"object","description":"Payload used to change the FTP password of a Web Cloud Database","properties":{"password":{"type":"string","description":"New ftp admin password (alphanumeric and 8 characters minimum)","format":"password"}},"required":["password"]},"hosting.privateDatabase.ChangeVersionPayload":{"type":"object","description":"Payload used to change the DBMS version of a Web Cloud Database","properties":{"version":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.AvailableVersionEnum"}],"description":"Change the private database engine version"}},"required":["version"]},"hosting.privateDatabase.DatacenterEnum":{"type":"string","description":"Private database datacenter","enum":["bhs1","gra1","gra2","gra3"]},"hosting.privateDatabase.GraphEndpoint":{"type":"object","description":"Parameters required to query metrics from OpenTSDB","properties":{"host":{"type":"string","description":"The OpenTSDB host","nullable":true,"readOnly":true},"readToken":{"type":"string","description":"A read-only token","nullable":true,"format":"password","readOnly":true},"readTokenId":{"type":"string","description":"A read-only token ID","nullable":true,"readOnly":true}}},"hosting.privateDatabase.InfrastructureEnum":{"type":"string","description":"Private database infrastructure","enum":["docker"]},"hosting.privateDatabase.OfferEnum":{"type":"string","description":"Available offers","enum":["classic","public"]},"hosting.privateDatabase.Service":{"type":"object","description":"Web Cloud Database","properties":{"capabilities":{"type":"array","description":"Private database capabilities","items":{"$ref":"#/components/schemas/hosting.privateDatabase.Capability"},"readOnly":true},"cpu":{"type":"integer","description":"Number of cpu on your private database","readOnly":true},"datacenter":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.DatacenterEnum"}],"description":"Datacenter where this private database is located","readOnly":true},"displayName":{"type":"string","description":"Set the name displayed in customer panel for your private database (max 50 chars)","nullable":true},"graphEndpoint":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.GraphEndpoint"}],"description":"Parameters required to query metrics from OpenTSDB","nullable":true,"readOnly":true},"guiURL":{"type":"string","description":"URL for the graphical user interface","nullable":true,"readOnly":true},"hostname":{"type":"string","description":"Private database hostname","readOnly":true},"hostnameFtp":{"type":"string","description":"Private database ftp hostname","nullable":true,"readOnly":true},"infrastructure":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.InfrastructureEnum"}],"description":"Infrastructure where service was stored","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Private database ip","nullable":true,"readOnly":true},"isUnderMaintenance":{"type":"boolean","description":"Is the service under maintenance","readOnly":true},"lastCheck":{"type":"string","description":"Date of the last data synchronization","format":"date-time","readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.OfferEnum"}],"description":"Type of the private database offer","readOnly":true},"port":{"type":"integer","description":"Private database service port","readOnly":true},"portFtp":{"type":"integer","description":"Private database ftp port","nullable":true,"readOnly":true},"quotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Space allowed on your private database","readOnly":true},"quotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Total space used on your private database","readOnly":true},"ram":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Amount of ram on your private database","readOnly":true},"server":{"type":"string","description":"Private database server name","readOnly":true},"serviceName":{"type":"string","description":"Service name","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.StateEnum"}],"description":"Private database state","readOnly":true},"tlsCa":{"type":"string","description":"Return the TLS certificate authority used by the private database","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.TypeEnum"}],"description":"Private database type","readOnly":true},"version":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.VersionEnum"}],"description":"Private database version","readOnly":true},"versionLabel":{"type":"string","description":"Private database version label","readOnly":true},"versionNumber":{"type":"number","description":"Private database version number","readOnly":true}}},"hosting.privateDatabase.ServiceWithIAM":{"type":"object","description":"Web Cloud Database","properties":{"capabilities":{"type":"array","description":"Private database capabilities","items":{"$ref":"#/components/schemas/hosting.privateDatabase.Capability"},"readOnly":true},"cpu":{"type":"integer","description":"Number of cpu on your private database","readOnly":true},"datacenter":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.DatacenterEnum"}],"description":"Datacenter where this private database is located","readOnly":true},"displayName":{"type":"string","description":"Set the name displayed in customer panel for your private database (max 50 chars)","nullable":true},"graphEndpoint":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.GraphEndpoint"}],"description":"Parameters required to query metrics from OpenTSDB","nullable":true,"readOnly":true},"guiURL":{"type":"string","description":"URL for the graphical user interface","nullable":true,"readOnly":true},"hostname":{"type":"string","description":"Private database hostname","readOnly":true},"hostnameFtp":{"type":"string","description":"Private database ftp hostname","nullable":true,"readOnly":true},"iam":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata"}],"description":"IAM resource metadata","nullable":true,"readOnly":true},"infrastructure":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.InfrastructureEnum"}],"description":"Infrastructure where service was stored","readOnly":true},"ip":{"allOf":[{"$ref":"#/components/schemas/ipv4"}],"description":"Private database ip","nullable":true,"readOnly":true},"isUnderMaintenance":{"type":"boolean","description":"Is the service under maintenance","readOnly":true},"lastCheck":{"type":"string","description":"Date of the last data synchronization","format":"date-time","readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.OfferEnum"}],"description":"Type of the private database offer","readOnly":true},"port":{"type":"integer","description":"Private database service port","readOnly":true},"portFtp":{"type":"integer","description":"Private database ftp port","nullable":true,"readOnly":true},"quotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Space allowed on your private database","readOnly":true},"quotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Total space used on your private database","readOnly":true},"ram":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Amount of ram on your private database","readOnly":true},"server":{"type":"string","description":"Private database server name","readOnly":true},"serviceName":{"type":"string","description":"Service name","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.StateEnum"}],"description":"Private database state","readOnly":true},"tlsCa":{"type":"string","description":"Return the TLS certificate authority used by the private database","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.TypeEnum"}],"description":"Private database type","readOnly":true},"version":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.VersionEnum"}],"description":"Private database version","readOnly":true},"versionLabel":{"type":"string","description":"Private database version label","readOnly":true},"versionNumber":{"type":"number","description":"Private database version number","readOnly":true}}},"hosting.privateDatabase.StateEnum":{"type":"string","description":"Private database state","enum":["detached","restartPending","startPending","started","stopPending","stopped"]},"hosting.privateDatabase.Task":{"type":"object","description":"Web Cloud Database task","properties":{"databaseName":{"type":"string","description":"Database name on which the task is working","nullable":true,"readOnly":true},"doneDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"dumpId":{"type":"integer","description":"DumpId on which the task is working","nullable":true,"readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.task.FunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"The id of the task","readOnly":true},"lastUpdate":{"type":"string","description":"Last update","nullable":true,"format":"date-time","readOnly":true},"startDate":{"type":"string","description":"Task creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.task.StatusEnum"}],"description":"Task status","readOnly":true},"userName":{"type":"string","description":"User name on which the task is working","nullable":true,"readOnly":true}}},"hosting.privateDatabase.TypeEnum":{"type":"string","description":"Private database type","enum":["mariadb","mysql","postgresql","valkey"]},"hosting.privateDatabase.VersionEnum":{"type":"string","description":"Private database version","enum":["mariadb_10.11","mariadb_11.4","mariadb_11.8","mysql_8.0","mysql_8.4","postgresql_14","postgresql_15","postgresql_16","postgresql_17","postgresql_18","valkey_7.2","valkey_8.1","valkey_9.1"]},"hosting.privateDatabase.availableOrderCapacities":{"type":"object","description":"Description for available order capacities following an offer","properties":{"datacenter":{"type":"array","description":"A list of datacenter available for this offer","items":{"$ref":"#/components/schemas/hosting.privateDatabase.DatacenterEnum"},"readOnly":true},"offer":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.OfferEnum"}],"description":"Offer","readOnly":true},"ram":{"type":"array","description":"A list of ram size available for this offer","items":{"$ref":"#/components/schemas/hosting.privateDatabase.AvailableRamSizeEnum"},"readOnly":true},"version":{"type":"array","description":"A list of version available for this offer","items":{"$ref":"#/components/schemas/hosting.privateDatabase.AvailableVersionEnum"},"readOnly":true}}},"hosting.privateDatabase.task.FunctionEnum":{"type":"string","description":"Task's dunction","enum":["abuse","changeFtpPassword","changeRam","changeVersion","configuration/update","create","database/copy","database/copyRestore","database/create","database/delete","database/dump","database/dump/delete","database/extension/create","database/extension/delete","database/import","database/restore","database/wizard","delete","grant/create","grant/delete","grant/update","install","overquota/in","overquota/out","quotaRefresh","refresh","reopen","restart","start","stop","suspend","user/changePassword","user/create","user/delete","webhostingNetwork/disable","webhostingNetwork/enable","whitelist/create","whitelist/delete","whitelist/update"]},"hosting.privateDatabase.task.StatusEnum":{"type":"string","description":"Task's status","enum":["cancelled","doing","done","error","todo"]},"iam.ResourceMetadata":{"type":"object","description":"IAM resource metadata embedded in services models","properties":{"displayName":{"type":"string","description":"Resource display name","nullable":true,"readOnly":true},"id":{"type":"string","description":"Unique identifier of the resource","format":"uuid","readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/iam.ResourceMetadata.StateEnum"}],"description":"Resource state","nullable":true,"readOnly":true},"tags":{"type":"object","description":"Resource tags. Tags that were internally computed are prefixed with ovh:","nullable":true,"additionalProperties":{"type":"string"},"readOnly":true},"urn":{"type":"string","description":"Unique resource name used in policies","readOnly":true}}},"iam.ResourceMetadata.StateEnum":{"type":"string","description":"Resource state","enum":["EXPIRED","IN_CREATION","OK","SUSPENDED"]},"iam.resource.TagFilter":{"type":"object","description":"Resource tag filter","properties":{"operator":{"allOf":[{"$ref":"#/components/schemas/iam.resource.TagFilter.OperatorEnum"}],"description":"Operator to use in order to filter on the value (defaults to 'EQ')","nullable":true,"readOnly":true},"value":{"type":"string","description":"Value to use in order to filter tags","readOnly":true}}},"iam.resource.TagFilter.OperatorEnum":{"type":"string","description":"Operator that can be used in order to filter resources tags","enum":["EQ","EXISTS","ILIKE","LIKE","NEQ","NEXISTS"]},"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"},"service.RenewType":{"type":"object","description":"Map a possible renew for a specific service","properties":{"automatic":{"type":"boolean","description":"The service is automatically renewed"},"deleteAtExpiration":{"type":"boolean","description":"The service will be deleted at expiration"},"forced":{"type":"boolean","description":"The service forced to be renewed"},"manualPayment":{"type":"boolean","description":"The service needs to be manually renewed and paid","nullable":true},"period":{"type":"integer","description":"period of renew in month","nullable":true}}},"service.RenewalTypeEnum":{"type":"string","description":"Detailed renewal type of a service","enum":["automaticForcedProduct","automaticV2012","automaticV2014","automaticV2016","manual","oneShot","option"]},"service.StateEnum":{"type":"string","description":"service.StateEnum","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"service.TerminationFutureUseEnum":{"type":"string","description":"All future uses you can provide for a service termination","enum":["NOT_REPLACING_SERVICE","OTHER","SUBSCRIBE_AN_OTHER_SERVICE","SUBSCRIBE_OTHER_KIND_OF_SERVICE_WITH_COMPETITOR","SUBSCRIBE_SIMILAR_SERVICE_WITH_COMPETITOR"]},"service.TerminationReasonEnum":{"type":"string","description":"All reasons you can provide for a service termination","enum":["FEATURES_DONT_SUIT_ME","LACK_OF_PERFORMANCES","MIGRATED_TO_ANOTHER_OVH_PRODUCT","MIGRATED_TO_COMPETITOR","NOT_ENOUGH_RECOGNITION","NOT_NEEDED_ANYMORE","NOT_RELIABLE","NO_ANSWER","OTHER","PRODUCT_DIMENSION_DONT_SUIT_ME","PRODUCT_TOOLS_DONT_SUIT_ME","TOO_EXPENSIVE","TOO_HARD_TO_USE","UNSATIFIED_BY_CUSTOMER_SUPPORT"]},"services.Service":{"type":"object","description":"Details about a Service","properties":{"canDeleteAtExpiration":{"type":"boolean","description":"Indicates that the service can be set up to be deleted at expiration","readOnly":true},"contactAdmin":{"type":"string","readOnly":true},"contactBilling":{"type":"string","readOnly":true},"contactTech":{"type":"string","readOnly":true},"creation":{"type":"string","format":"date","readOnly":true},"domain":{"type":"string","readOnly":true},"engagedUpTo":{"type":"string","nullable":true,"format":"date","readOnly":true},"expiration":{"type":"string","format":"date","readOnly":true},"possibleRenewPeriod":{"type":"array","description":"All the possible renew period of your service in month","nullable":true,"items":{"type":"integer"},"readOnly":true},"renew":{"allOf":[{"$ref":"#/components/schemas/service.RenewType"}],"description":"Way of handling the renew","nullable":true},"renewalType":{"allOf":[{"$ref":"#/components/schemas/service.RenewalTypeEnum"}],"readOnly":true},"serviceId":{"type":"integer","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/service.StateEnum"}],"readOnly":true}}},"services.changeContact":{"type":"object","description":"Service change contact payload","properties":{"contactAdmin":{"type":"string","description":"The contact to set as admin contact"},"contactBilling":{"type":"string","description":"The contact to set as billing contact"},"contactTech":{"type":"string","description":"The contact to set as tech contact"}}},"services.confirmTermination":{"type":"object","description":"Service confirm termination payload","properties":{"commentary":{"type":"string","description":"Commentary about your termination request"},"commentaryFutureUse":{"type":"string","description":"Commentary about your future use"},"commentaryReason":{"type":"string","description":"Commentary about your reason for termination request"},"futureUse":{"allOf":[{"$ref":"#/components/schemas/service.TerminationFutureUseEnum"}],"description":"All future uses you can provide for a service termination"},"reason":{"allOf":[{"$ref":"#/components/schemas/service.TerminationReasonEnum"}],"description":"All reasons you can provide for a service termination"},"token":{"type":"string","description":"The termination token sent by email to the admin contact"}},"required":["token"]},"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":{"/hosting/privateDatabase":{"get":{"summary":"List Web Cloud Databases","description":"Returns the service names of the Web Cloud Databases of the account.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"iamTags","description":"Filter resources on IAM tags","schema":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/iam.resource.TagFilter"}}}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/hosting/privateDatabase\")\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(\"/hosting/privateDatabase\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:get","required":true}],"x-expanded-response":"HostingPrivateDatabaseServiceWithIAM"}},"/hosting/privateDatabase/availableOrderCapacities":{"get":{"summary":"Get available order capacities","description":"Returns the datacenters, RAM sizes and DBMS versions available for the requested offer.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"offer","required":true,"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.OfferEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.availableOrderCapacities"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/hosting/privateDatabase/availableOrderCapacities\")\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(\"/hosting/privateDatabase/availableOrderCapacities\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"account:apiovh:webCloudDatabases/availableOrderCapacities/get","required":true}]}},"/hosting/privateDatabase/{serviceName}":{"get":{"summary":"Get a Web Cloud Database","description":"Returns the service properties, such as offer, DBMS type and version, hostname and ports, RAM, quota and state.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.ServiceWithIAM"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/hosting/privateDatabase/{serviceName}\")\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(\"/hosting/privateDatabase/{serviceName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:get","required":true}]},"put":{"summary":"Update a Web Cloud Database","description":"Updates the editable properties of the service, such as the display name (50 characters maximum).","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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: hosting.privateDatabase.Service\nresult = client.put(\"/hosting/privateDatabase/{serviceName}\",\n\tdisplayName = None, # Set the name displayed in customer panel for your private database (max 50 chars) (type: string, nullable)\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: hosting.privateDatabase.Service\n$result = $ovh->put(\"/hosting/privateDatabase/{serviceName}\", array(\n\tdisplayName => null, // Set the name displayed in customer panel for your private database (max 50 chars) (type: string, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:put","required":true}]}},"/hosting/privateDatabase/{serviceName}/availableVersions":{"get":{"summary":"List available DBMS versions","description":"Returns the DBMS versions available for the service. Use one of them to change the DBMS version.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.privateDatabase.AvailableVersionEnum"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/hosting/privateDatabase/{serviceName}/availableVersions\")\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(\"/hosting/privateDatabase/{serviceName}/availableVersions\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:availableVersions/get","required":true}]}},"/hosting/privateDatabase/{serviceName}/changeContact":{"post":{"summary":"Change the contacts","description":"Starts a change procedure for the admin, billing or tech contact of the service. Returns the IDs of the account contact change tasks, which are not listed in the service tasks.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.changeContact"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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: services.changeContact\nresult = client.post(\"/hosting/privateDatabase/{serviceName}/changeContact\",\n\tcontactAdmin = None, # The contact to set as admin contact (type: string)\n\tcontactBilling = None, # The contact to set as billing contact (type: string)\n\tcontactTech = None, # The contact to set as tech contact (type: string)\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: services.changeContact\n$result = $ovh->post(\"/hosting/privateDatabase/{serviceName}/changeContact\", array(\n\tcontactAdmin => null, // The contact to set as admin contact (type: string)\n\tcontactBilling => null, // The contact to set as billing contact (type: string)\n\tcontactTech => null, // The contact to set as tech contact (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:changeContact","required":true}]}},"/hosting/privateDatabase/{serviceName}/changeFtpPassword":{"post":{"summary":"Change the FTP password","description":"Changes the FTP admin password of the service. The password must be alphanumeric and at least 8 characters long.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.ChangeFtpPasswordPayload"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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: hosting.privateDatabase.ChangeFtpPasswordPayload\nresult = client.post(\"/hosting/privateDatabase/{serviceName}/changeFtpPassword\",\n\tpassword = None, # New ftp admin password (alphanumeric and 8 characters minimum) (type: string)\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: hosting.privateDatabase.ChangeFtpPasswordPayload\n$result = $ovh->post(\"/hosting/privateDatabase/{serviceName}/changeFtpPassword\", array(\n\tpassword => null, // New ftp admin password (alphanumeric and 8 characters minimum) (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:changeFtpPassword","required":true}]}},"/hosting/privateDatabase/{serviceName}/changeVersion":{"post":{"summary":"Change the DBMS version","description":"Changes the DBMS version of the service to one of the available versions. Returns a task to follow the change.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.ChangeVersionPayload"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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: hosting.privateDatabase.ChangeVersionPayload\nresult = client.post(\"/hosting/privateDatabase/{serviceName}/changeVersion\",\n\tversion = None, # Change the private database engine version (type: hosting.privateDatabase.AvailableVersionEnum)\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: hosting.privateDatabase.ChangeVersionPayload\n$result = $ovh->post(\"/hosting/privateDatabase/{serviceName}/changeVersion\", array(\n\tversion => null, // Change the private database engine version (type: hosting.privateDatabase.AvailableVersionEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:changeVersion","required":true}]}},"/hosting/privateDatabase/{serviceName}/confirmTermination":{"post":{"summary":"Confirm the termination","description":"Confirms the termination of the service with the token sent by email to the admin contact.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.confirmTermination"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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: services.confirmTermination\nresult = client.post(\"/hosting/privateDatabase/{serviceName}/confirmTermination\",\n\tcommentary = None, # Commentary about your termination request (type: string)\n\tcommentaryFutureUse = None, # Commentary about your future use (type: string)\n\tcommentaryReason = None, # Commentary about your reason for termination request (type: string)\n\tfutureUse = None, # All future uses you can provide for a service termination (type: service.TerminationFutureUseEnum)\n\treason = None, # All reasons you can provide for a service termination (type: service.TerminationReasonEnum)\n\ttoken = None, # The termination token sent by email to the admin contact (type: string)\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: services.confirmTermination\n$result = $ovh->post(\"/hosting/privateDatabase/{serviceName}/confirmTermination\", array(\n\tcommentary => null, // Commentary about your termination request (type: string)\n\tcommentaryFutureUse => null, // Commentary about your future use (type: string)\n\tcommentaryReason => null, // Commentary about your reason for termination request (type: string)\n\tfutureUse => null, // All future uses you can provide for a service termination (type: service.TerminationFutureUseEnum)\n\treason => null, // All reasons you can provide for a service termination (type: service.TerminationReasonEnum)\n\ttoken => null, // The termination token sent by email to the admin contact (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:confirmTermination","required":true}]}},"/hosting/privateDatabase/{serviceName}/restart":{"post":{"summary":"Restart the service","description":"Restarts the service, which is unavailable for a few seconds. Returns a task to follow the restart.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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.post(\"/hosting/privateDatabase/{serviceName}/restart\")\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->post(\"/hosting/privateDatabase/{serviceName}/restart\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:restart","required":true}]}},"/hosting/privateDatabase/{serviceName}/serviceInfos":{"get":{"summary":"Get service information","description":"Returns the billing information of the service, such as creation and expiration dates, contacts and renewal settings.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/hosting/privateDatabase/{serviceName}/serviceInfos\")\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(\"/hosting/privateDatabase/{serviceName}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:serviceInfos/get","required":true}]},"put":{"summary":"Update service information","description":"Updates the editable service information, such as the renewal settings.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/services.Service"}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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: services.Service\nresult = client.put(\"/hosting/privateDatabase/{serviceName}/serviceInfos\",\n\trenew = None, # Way of handling the renew (type: service.RenewType, nullable)\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: services.Service\n$result = $ovh->put(\"/hosting/privateDatabase/{serviceName}/serviceInfos\", array(\n\trenew => null, // Way of handling the renew (type: service.RenewType, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:serviceInfos/edit","required":true}]}},"/hosting/privateDatabase/{serviceName}/terminate":{"post":{"summary":"Request the termination","description":"Starts the termination of the service and sends a confirmation token by email to the admin contact. Confirm it with the termination confirmation.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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.post(\"/hosting/privateDatabase/{serviceName}/terminate\")\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->post(\"/hosting/privateDatabase/{serviceName}/terminate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:terminate","required":true}]}},"/hosting/privateDatabase/{serviceName}/webs":{"get":{"summary":"List linked web hostings","description":"Returns the service names of the web hostings linked to the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Instances"]],"x-badges":[{"color":"green","label":"Stable production 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(\"/hosting/privateDatabase/{serviceName}/webs\")\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(\"/hosting/privateDatabase/{serviceName}/webs\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:webs/get","required":true}]}}}}
