{"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.ChartSerie_complexType.ChartTimestampValue":{"type":"object","description":"A value set tagged with its unit and serie name","properties":{"serieName":{"type":"string"},"unit":{"type":"string"},"values":{"type":"array","items":{"$ref":"#/components/schemas/complexType.ChartTimestampValue"}}}},"complexType.ChartTimestampValue":{"type":"object","description":"A timestamp associated to a value","properties":{"timestamp":{"type":"integer"},"value":{"type":"number","nullable":true}}},"complexType.UnitAndValue_double":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"value":{"type":"number"}}},"complexType.UnitAndValue_long":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string"},"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.web.StatisticsPeriodEnum":{"type":"string","description":"Available periods for statistics","enum":["daily","monthly","weekly","yearly"]},"hosting.web.database":{"type":"object","description":"Database","properties":{"databaseServiceDeprecated":{"type":"boolean","description":"Whether service database is deprecated","readOnly":true},"databaseType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.DatabaseServiceTypeEnum"}],"description":"Database service type","nullable":true,"readOnly":true},"dumps":{"type":"integer","description":"The number of available dumps associated to this database","readOnly":true},"guiURL":{"type":"string","description":"URL for the graphical user interface","nullable":true,"readOnly":true},"lastCheck":{"type":"string","description":"Date of the last check quota","nullable":true,"format":"date-time","readOnly":true},"mode":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.ModeEnum"}],"description":"Mode of your database","readOnly":true},"name":{"type":"string","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","readOnly":true},"port":{"type":"integer","description":"The port on where to contact this database","readOnly":true},"quotaSize":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Space allowed","readOnly":true},"quotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Space used","readOnly":true},"server":{"type":"string","description":"Your database server name","nullable":true,"readOnly":true},"sqlpersoId":{"type":"integer","description":"Which SQLPerso this database is linked to (if any)","nullable":true,"readOnly":true},"state":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.StateEnum"}],"description":"Database state","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.StatusEnum"}],"description":"The database status","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this database","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.DatabaseTypeEnum"}],"description":"Type of your database","readOnly":true},"user":{"type":"string","description":"Database user name","readOnly":true},"version":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.VersionEnum"}],"description":"Database version following the database type","readOnly":true},"versionSupport":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.SupportedVersionEnum"}],"description":"Indicates the current support state of your database version","readOnly":true}}},"hosting.web.database.AvailableVersionStruct":{"type":"object","description":"Database Available and Default version","properties":{"default":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.VersionEnum"}],"description":"Database default version"},"list":{"type":"array","description":"Database available version","items":{"$ref":"#/components/schemas/hosting.web.database.VersionEnum"}}}},"hosting.web.database.CreationDatabaseCapabilities":{"type":"object","description":"Struct which describs quota and available for a specific type of database","properties":{"available":{"type":"integer","description":"Number of database left for creation"},"engines":{"type":"array","description":"Database software available on this platform","items":{"$ref":"#/components/schemas/hosting.web.database.DatabaseTypeEnum"}},"isolation":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.DatabaseIsolationEnum"}],"description":"Technology use to isolate differents webhosting accounts"},"quota":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Size of data can be used"},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.DatabaseCapabilitiesTypeEnum"}],"description":"Database offer name"}}},"hosting.web.database.DatabaseCapabilities":{"type":"object","description":"Struct which describe available features for a database","properties":{"changePassword":{"type":"boolean","description":"Availability of the changePassword function"},"changeRight":{"type":"boolean","description":"Availability of the changeRight function"},"delete":{"type":"boolean","description":"Availability of the delete function"},"dump":{"type":"boolean","description":"Availability of the dump function"},"getQuota":{"type":"boolean","description":"Availability of the getQuota function"},"getRight":{"type":"boolean","description":"Availability of the getQuota function"},"guiURL":{"type":"string","description":"URL of the database management tool"},"optimize":{"type":"boolean","description":"Availability of the optimize function"},"restore":{"type":"boolean","description":"Availability of the restore function"}}},"hosting.web.database.DatabaseCapabilitiesTypeEnum":{"type":"string","description":"Database capabitities type enum","enum":["extraSqlPerso","local","privateDatabase","sqlLocal","sqlPerso","sqlPro"]},"hosting.web.database.DatabaseCreationTypeEnum":{"type":"string","description":"Database Type enum","enum":["mariadb","mysql","postgresql","redis"]},"hosting.web.database.DatabaseIsolationEnum":{"type":"string","description":"Database Isolation enum","enum":["dedicated","local","shared"]},"hosting.web.database.DatabaseServiceTypeEnum":{"type":"string","description":"Database Service Type enum","enum":["extra","included","optional"]},"hosting.web.database.DatabaseTypeEnum":{"type":"string","description":"Database Type enum","enum":["mariadb","mongodb","mysql","postgresql","redis"]},"hosting.web.database.ExtraSqlQuotaEnum":{"type":"integer","description":"ExtraSqlPerso quota enum","enum":[25,100,200,256,400,512,800,1024]},"hosting.web.database.MetricsToken":{"type":"object","description":"A structure describing the metrics token result","properties":{"endpoint":{"type":"string","description":"The url of the endpoint"},"token":{"type":"string","description":"The token value","format":"password"}}},"hosting.web.database.ModeEnum":{"type":"string","description":"Database mode","enum":["besteffort","classic","module"]},"hosting.web.database.RequestActionEnum":{"type":"string","description":"Types of action you can request for your database","enum":["CHECK_QUOTA"]},"hosting.web.database.StateEnum":{"type":"string","description":"Database state","enum":["close","ok","readonly"]},"hosting.web.database.StatisticsTypeEnum":{"type":"string","description":"Types of statistics available for the database","enum":["statement","statementMeanTime"]},"hosting.web.database.StatusEnum":{"type":"string","description":"Database status","enum":["checking","created","creating","deleting","dumping","importing","locked","optimizing","restoring","updating"]},"hosting.web.database.SupportedVersionEnum":{"type":"string","description":"Indicates the current support state of your database version","enum":["beta","deprecated","stable"]},"hosting.web.database.VersionEnum":{"type":"string","description":"Database Version enum","enum":["10","10.1","10.11","10.2","10.3","10.4","10.5","10.6","11","12","13","15","3.2","3.4","4.0","5.1","5.5","5.6","5.7","6.0","7.0","8.0","8.4","9.4","9.5","9.6"]},"hosting.web.database.copy":{"type":"object","description":"Copy","properties":{"creationDate":{"type":"string","description":"Creation date","format":"date-time","readOnly":true},"expirationDate":{"type":"string","description":"Expiration date","nullable":true,"format":"date-time","readOnly":true},"id":{"type":"string","description":"Copy id","format":"uuid","readOnly":true},"lastUpdate":{"type":"string","description":"Last update date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.copy.StatusEnum"}],"description":"Copy status","readOnly":true}}},"hosting.web.database.copy.StatusEnum":{"type":"string","description":"Database copy status","enum":["doing","done","error","todo"]},"hosting.web.database.dump":{"type":"object","description":"Dump","properties":{"creationDate":{"type":"string","description":"Creation date of the dump","format":"date-time","readOnly":true},"deletionDate":{"type":"string","description":"Automatic deletion date of the dump","format":"date-time","readOnly":true},"id":{"type":"integer","description":"Dump id","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.dump.StatusEnum"}],"description":"The dump status","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this dump","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.dump.DateEnum"}],"description":"Dump type","readOnly":true},"url":{"type":"string","description":"Dump url access","nullable":true,"readOnly":true}}},"hosting.web.database.dump.DateEnum":{"type":"string","description":"List of dump types","enum":["daily.1","now","weekly.1"]},"hosting.web.database.dump.StatusEnum":{"type":"string","description":"Database dump status","enum":["created","creating","deleting"]},"hosting.web.dump":{"type":"object","description":"Dump","properties":{"creationDate":{"type":"string","description":"Creation date of the dump","format":"date-time","readOnly":true},"databaseName":{"type":"string","description":"Source database name","readOnly":true},"deletionDate":{"type":"string","description":"Automatic deletion date of the dump","format":"date-time","readOnly":true},"id":{"type":"integer","description":"Dump id","readOnly":true},"orphan":{"type":"boolean","description":"If source database was deleted","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.dump.StatusEnum"}],"description":"The dump status","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this dump","nullable":true,"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/hosting.web.database.dump.DateEnum"}],"description":"Dump type","readOnly":true},"url":{"type":"string","description":"Dump url access","nullable":true,"readOnly":true}}},"hosting.web.extrasqlperso":{"type":"object","description":"Sqlperso service","properties":{"database":{"type":"integer","description":"Number of database allowed by this option","readOnly":true},"id":{"type":"integer","description":"Identifier of the (additional) SQL slot","readOnly":true},"name":{"type":"string","description":"The extraSqlPerso option name","readOnly":true},"serviceName":{"type":"string","description":"Billing name of the matching subscription (or internal naming otherwise)","readOnly":true},"size":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_double"}],"description":"Quota size allowed per each database by this option","readOnly":true},"status":{"type":"string","description":"The extraSqlPerso option status","readOnly":true},"taskId":{"type":"integer","description":"The task ID working on this extraSqlPerso","nullable":true,"readOnly":true},"usage":{"type":"array","description":"Linked databases","items":{"type":"string"},"readOnly":true}}},"hosting.web.task":{"type":"object","description":"Tasks","properties":{"doneDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"function":{"type":"string","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},"objectId":{"type":"string","description":"Task related object ID","nullable":true,"readOnly":true},"objectType":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.ObjectTypeEnum"}],"description":"Task object type","nullable":true,"readOnly":true},"startDate":{"type":"string","description":"Task Creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.web.task.StatusEnum"}],"description":"Task status","readOnly":true}}},"hosting.web.task.ObjectTypeEnum":{"type":"string","description":"Task object type listing","enum":["Abuse","AttachedDomain","BlockedIp","Cdn","Cron","Database","Dump","EnvVar","Filerz","Hostedssl","Hosting","Indy","Infra","Minor","Module","Other","OvhConfig","OvhOrg","OwnLogs","Runtime","Scan","Sqlperso","User","UserLogs","Web","Webd"]},"hosting.web.task.StatusEnum":{"type":"string","description":"Task's status","enum":["cancelled","doing","done","error","init","todo"]},"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","automaticV2024","manual","oneShot","option"]},"service.StateEnum":{"type":"string","enum":["autorenewInProgress","expired","inCreation","ok","pendingDebt","unPaid"]},"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}}},"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/web/{serviceName}/database":{"get":{"summary":"List databases","description":"List databases. Returns the names of the databases of the hosting. Filter them by mode, name, server, type or user.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"mode","description":"Filter the value of mode property (=)","schema":{"$ref":"#/components/schemas/hosting.web.database.ModeEnum"}},{"in":"query","name":"name","description":"Filter the value of name property (like)","schema":{"type":"string"}},{"in":"query","name":"server","description":"Filter the value of server property (like)","schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Filter the value of type property (=)","schema":{"$ref":"#/components/schemas/hosting.web.database.DatabaseTypeEnum"}},{"in":"query","name":"user","description":"Filter the value of user property (like)","schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/get","required":true}],"x-expanded-response":"HostingWebDatabase"},"post":{"summary":"Create a database","description":"Create a database. Creates a MariaDB, MySQL, PostgreSQL or Redis database with its user, and returns the task. The quota applies only to extraSqlPerso databases.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"capabilitie":{"description":"Type of your database","$ref":"#/components/schemas/hosting.web.database.DatabaseCapabilitiesTypeEnum"},"password":{"type":"string","description":"Database password","format":"password"},"quota":{"description":"Quota assign to your database. Only for extraSql","$ref":"#/components/schemas/hosting.web.database.ExtraSqlQuotaEnum"},"type":{"description":"Type you want for your database","$ref":"#/components/schemas/hosting.web.database.DatabaseCreationTypeEnum"},"user":{"type":"string","description":"Database user name. Must begin with your hosting login and must be in lower case"},"version":{"description":"Version you want for your database following the type","$ref":"#/components/schemas/hosting.web.database.VersionEnum"}},"required":["capabilitie","type","user"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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/web/{serviceName}/database\",\n\tcapabilitie = None, # Type of your database (type: hosting.web.database.DatabaseCapabilitiesTypeEnum)\n\tpassword = None, # Database password (type: password, nullable)\n\tquota = None, # Quota assign to your database. Only for extraSql (type: hosting.web.database.ExtraSqlQuotaEnum, nullable)\n\ttype = None, # Type you want for your database (type: hosting.web.database.DatabaseCreationTypeEnum)\n\tuser = None, # Database user name. Must begin with your hosting login and must be in lower case (type: string)\n\tversion = None, # Version you want for your database following the type (type: hosting.web.database.VersionEnum, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database\", array(\n\tcapabilitie => null, // Type of your database (type: hosting.web.database.DatabaseCapabilitiesTypeEnum)\n\tpassword => null, // Database password (type: password, nullable)\n\tquota => null, // Quota assign to your database. Only for extraSql (type: hosting.web.database.ExtraSqlQuotaEnum, nullable)\n\ttype => null, // Type you want for your database (type: hosting.web.database.DatabaseCreationTypeEnum)\n\tuser => null, // Database user name. Must begin with your hosting login and must be in lower case (type: string)\n\tversion => null, // Version you want for your database following the type (type: hosting.web.database.VersionEnum, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/create","required":true}]}},"/hosting/web/{serviceName}/database/{name}":{"delete":{"summary":"Delete a database","description":"Delete a database. Deletes the database and returns the task. Its dumps are kept until their automatic deletion date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@110"]],"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.delete(\"/hosting/web/{serviceName}/database/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/hosting/web/{serviceName}/database/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/delete","required":true}]},"get":{"summary":"Get a database","description":"Get a database. Returns the type, version, server, port, user, quota and status of the database, and the URL of its management tool.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/get","required":true}]}},"/hosting/web/{serviceName}/database/{name}/capabilities":{"get":{"summary":"Get database capabilities","description":"Get database capabilities. Returns the functions available on the database, such as dump, restore or password change, and the URL of its management tool.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database.DatabaseCapabilities"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/capabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/capabilities\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/capabilities/get","required":true}]}},"/hosting/web/{serviceName}/database/{name}/changePassword":{"post":{"summary":"Change the database password","description":"Change the database password. Changes the password of the database user and returns the task. Available when changePassword is true in the database capabilities.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"The new database password","format":"password"}},"required":["password"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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: password\nresult = client.post(\"/hosting/web/{serviceName}/database/{name}/changePassword\",\n\tpassword = None, # The new database password (type: password)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/changePassword\", array(\n\tpassword => null, // The new database password (type: password)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/changePassword","required":true}]}},"/hosting/web/{serviceName}/database/{name}/copy":{"get":{"summary":"List database copies","description":"List database copies. Returns the IDs of the copies of the database. Each copy is kept until its expiration date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/copy\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/copy\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/copy/get","required":true}],"x-expanded-response":"HostingWebDatabaseCopy"},"post":{"summary":"Create a database copy","description":"Create a database copy. Creates a copy of the database, kept until its expiration date. Restore it later with copyRestore.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database.copy"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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/web/{serviceName}/database/{name}/copy\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/copy\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/copy/create","required":true}]}},"/hosting/web/{serviceName}/database/{name}/copy/{id}":{"delete":{"summary":"Delete a database copy","description":"Delete a database copy. Deletes the database copy before its expiration date. The database itself is not changed.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Copy id","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@110"]],"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.delete(\"/hosting/web/{serviceName}/database/{name}/copy/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/hosting/web/{serviceName}/database/{name}/copy/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/copy/delete","required":true}]},"get":{"summary":"Get a database copy","description":"Get a database copy. Returns the status, creation date and expiration date of the copy. Restore it into the database with copyRestore.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Copy id","required":true,"schema":{"type":"string","format":"uuid"}},{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database.copy"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/copy/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/copy/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/copy/get","required":true}]}},"/hosting/web/{serviceName}/database/{name}/copyRestore":{"post":{"summary":"Restore a database copy","description":"Restore a database copy. Restores a copy into the database and returns the task. Set flushDatabase to true to empty the database first.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"copyId":{"type":"string","description":"UUID of the copy to restore","format":"uuid"},"flushDatabase":{"type":"boolean","description":"If database will be flushed before importing the dump. Default: false"}},"required":["copyId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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/web/{serviceName}/database/{name}/copyRestore\",\n\tcopyId = None, # UUID of the copy to restore (type: uuid)\n\tflushDatabase = None, # If database will be flushed before importing the dump. Default: false (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/copyRestore\", array(\n\tcopyId => null, // UUID of the copy to restore (type: uuid)\n\tflushDatabase => null, // If database will be flushed before importing the dump. Default: false (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/copyRestore","required":true}]}},"/hosting/web/{serviceName}/database/{name}/dump":{"get":{"summary":"List database dumps","description":"List database dumps. Returns the IDs of the dumps of the database. Filter them by creation or deletion date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"creationDate.from","description":"Filter the value of creationDate property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDate.to","description":"Filter the value of creationDate property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"deletionDate.from","description":"Filter the value of deletionDate property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"deletionDate.to","description":"Filter the value of deletionDate property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Filter the value of type property (=)","schema":{"$ref":"#/components/schemas/hosting.web.database.dump.DateEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/dump\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/dump\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/dump/get","required":true}],"x-expanded-response":"HostingWebDatabaseDump"},"post":{"summary":"Create a database dump","description":"Create a database dump. Creates a dump of the current database or of a daily or weekly backup, and returns the task. An email is sent when the dump is ready, unless sendEmail is false.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"description":"The date you want to dump","$ref":"#/components/schemas/hosting.web.database.dump.DateEnum"},"sendEmail":{"type":"boolean","description":"Send an email when dump will be available? Default: true"}},"required":["date"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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/web/{serviceName}/database/{name}/dump\",\n\tdate = None, # The date you want to dump (type: hosting.web.database.dump.DateEnum)\n\tsendEmail = None, # Send an email when dump will be available? Default: true (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/dump\", array(\n\tdate => null, // The date you want to dump (type: hosting.web.database.dump.DateEnum)\n\tsendEmail => null, // Send an email when dump will be available? Default: true (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/dump/create","required":true}]}},"/hosting/web/{serviceName}/database/{name}/dump/{id}":{"delete":{"summary":"Delete a database dump","description":"Delete a database dump. Deletes the dump before its automatic deletion date and returns the task. Otherwise, the dump is deleted on that date.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Dump id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@110"]],"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.delete(\"/hosting/web/{serviceName}/database/{name}/dump/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/hosting/web/{serviceName}/database/{name}/dump/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/dump/delete","required":true}]},"get":{"summary":"Get a database dump","description":"Get a database dump. Returns the status, type, download URL and automatic deletion date of the dump. The type tells whether it comes from the current database or from a daily or weekly backup.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Dump id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database.dump"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/dump/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/dump/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/dump/get","required":true}]}},"/hosting/web/{serviceName}/database/{name}/dump/{id}/restore":{"post":{"summary":"Restore a database dump","description":"Restore a database dump. Restores the dump into the database and returns the task. The current content of the database is replaced by the dump.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Dump id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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/web/{serviceName}/database/{name}/dump/{id}/restore\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/dump/{id}/restore\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/dump/restore","required":true}]}},"/hosting/web/{serviceName}/database/{name}/import":{"post":{"summary":"Import a dump","description":"Import a dump. Imports a dump file uploaded with /me/documents into the database, and returns the task. Set flushDatabase to true to empty the database first.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Documents ID of the dump from /me/documents"},"flushDatabase":{"type":"boolean","description":"If database will be flushed before importing the dump. Default: false"},"sendEmail":{"type":"boolean","description":"Send an email when the import will be done? Default: false"}},"required":["documentId"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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: boolean\nresult = client.post(\"/hosting/web/{serviceName}/database/{name}/import\",\n\tdocumentId = None, # Documents ID of the dump from /me/documents (type: string)\n\tflushDatabase = None, # If database will be flushed before importing the dump. Default: false (type: boolean, nullable)\n\tsendEmail = None, # Send an email when the import will be done? Default: false (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/import\", array(\n\tdocumentId => null, // Documents ID of the dump from /me/documents (type: string)\n\tflushDatabase => null, // If database will be flushed before importing the dump. Default: false (type: boolean, nullable)\n\tsendEmail => null, // Send an email when the import will be done? Default: false (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/import","required":true}]}},"/hosting/web/{serviceName}/database/{name}/metricsToken":{"get":{"summary":"Get a database metrics token","description":"Get a database metrics token. Generates a token to read the database metrics and returns it with the endpoint to query.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database.MetricsToken"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/metricsToken\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/metricsToken\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/metricsToken/get","required":true}]}},"/hosting/web/{serviceName}/database/{name}/request":{"post":{"summary":"Run a database action","description":"Run a database action. Runs an action on the database and returns the task. CHECK_QUOTA refreshes the space used by the database.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"description":"Action you want to request","$ref":"#/components/schemas/hosting.web.database.RequestActionEnum"}},"required":["action"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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.web.database.RequestActionEnum\nresult = client.post(\"/hosting/web/{serviceName}/database/{name}/request\",\n\taction = None, # Action you want to request (type: hosting.web.database.RequestActionEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/request\", array(\n\taction => null, // Action you want to request (type: hosting.web.database.RequestActionEnum)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/request/create","required":true}]}},"/hosting/web/{serviceName}/database/{name}/restore":{"post":{"summary":"Restore a database backup","description":"Restore a database backup. Restores the database from a daily or weekly backup and returns the task. Set sendEmail to true to receive an email when it is done.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"date":{"description":"The date you want to dump","$ref":"#/components/schemas/hosting.web.database.dump.DateEnum"},"sendEmail":{"type":"boolean","description":"Send an email when the restore will be done? Default: false"}},"required":["date"]}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@90"]],"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/web/{serviceName}/database/{name}/restore\",\n\tdate = None, # The date you want to dump (type: hosting.web.database.dump.DateEnum)\n\tsendEmail = None, # Send an email when the restore will be done? Default: false (type: boolean, nullable)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/database/{name}/restore\", array(\n\tdate => null, // The date you want to dump (type: hosting.web.database.dump.DateEnum)\n\tsendEmail => null, // Send an email when the restore will be done? Default: false (type: boolean, nullable)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/restore","required":true}]}},"/hosting/web/{serviceName}/database/{name}/statistics":{"get":{"summary":"Get database statistics","description":"Get database statistics. Returns the number of statements or their mean execution time over a period.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"name","description":"Database name (like mydb.mysql.db or mydb.postgres.db)","required":true,"schema":{"type":"string"}},{"in":"query","name":"period","description":"Available periods for statistics","required":true,"schema":{"$ref":"#/components/schemas/hosting.web.StatisticsPeriodEnum"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Types of statistics available for the database","required":true,"schema":{"$ref":"#/components/schemas/hosting.web.database.StatisticsTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/complexType.ChartSerie_complexType.ChartTimestampValue"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@10"]],"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/web/{serviceName}/database/{name}/statistics\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/database/{name}/statistics\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:database/statistics/get","required":true}]}},"/hosting/web/{serviceName}/databaseAvailableType":{"get":{"summary":"List database types","description":"List database types. Returns the database types that can be created on the hosting: MariaDB, MongoDB, MySQL, PostgreSQL or Redis, depending on the offer.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.database.DatabaseTypeEnum"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@20"]],"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/web/{serviceName}/databaseAvailableType\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/databaseAvailableType\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:databaseAvailableType/get","required":true}]}},"/hosting/web/{serviceName}/databaseAvailableVersion":{"get":{"summary":"List database versions","description":"List database versions. Returns the available versions of a database type, and the version used when a database is created without one.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}},{"in":"query","name":"type","description":"Type of the database","required":true,"schema":{"$ref":"#/components/schemas/hosting.web.database.DatabaseTypeEnum"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.database.AvailableVersionStruct"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@30"]],"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/web/{serviceName}/databaseAvailableVersion\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/databaseAvailableVersion\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:databaseAvailableVersion/get","required":true}]}},"/hosting/web/{serviceName}/databaseCreationCapabilities":{"get":{"summary":"Get database creation capabilities","description":"Get database creation capabilities. Returns, for each database offer of the hosting, the engines, the quota and the number of databases left to create.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.database.CreationDatabaseCapabilities"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@40"]],"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/web/{serviceName}/databaseCreationCapabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/databaseCreationCapabilities\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:databaseCreationCapabilities/get","required":true}]}},"/hosting/web/{serviceName}/dump":{"get":{"summary":"List dumps","description":"List dumps. Returns the IDs of the database dumps of the hosting, including those of deleted databases. Filter them by database, date or orphan.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"query","name":"creationDate.from","description":"Filter the value of creationDate property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"creationDate.to","description":"Filter the value of creationDate property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"databaseName","description":"Filter the value of databaseName property (=)","schema":{"type":"string"}},{"in":"query","name":"deletionDate.from","description":"Filter the value of deletionDate property (>=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"deletionDate.to","description":"Filter the value of deletionDate property (<=)","schema":{"type":"string","format":"date-time"}},{"in":"query","name":"orphan","description":"Filter the value of orphan property (=)","schema":{"type":"boolean"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@50"]],"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/web/{serviceName}/dump\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/dump\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:dump/get","required":true}],"x-expanded-response":"HostingWebDump"}},"/hosting/web/{serviceName}/dump/{id}":{"delete":{"summary":"Delete a dump","description":"Delete a dump. Deletes the dump before its automatic deletion date and returns the task. This also applies to dumps of deleted databases.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Dump id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@120"]],"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.delete(\"/hosting/web/{serviceName}/dump/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"delete(\"/hosting/web/{serviceName}/dump/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:dump/delete","required":true}]},"get":{"summary":"Get a dump","description":"Get a dump. Returns the source database, status, type, download URL and automatic deletion date of the dump.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Dump id","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.dump"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@50"]],"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/web/{serviceName}/dump/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/dump/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:dump/get","required":true}]}},"/hosting/web/{serviceName}/extraSqlPerso":{"get":{"summary":"List extra SQL options","description":"List extra SQL options. Returns the IDs of the additional SQL options of the hosting. Each option adds databases, each with its own quota.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@60"]],"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/web/{serviceName}/extraSqlPerso\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/extraSqlPerso\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:extraSqlPerso/get","required":true}],"x-expanded-response":"HostingWebExtrasqlperso"}},"/hosting/web/{serviceName}/extraSqlPerso/{id}":{"get":{"summary":"Get an extra SQL option","description":"Get an extra SQL option. Returns the number of databases allowed, the quota per database, the linked databases and the status of the option.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Identifier of the (additional) SQL slot","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.web.extrasqlperso"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@60"]],"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/web/{serviceName}/extraSqlPerso/{id}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/extraSqlPerso/{id}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:extraSqlPerso/get","required":true}]}},"/hosting/web/{serviceName}/extraSqlPerso/{id}/databases":{"get":{"summary":"List extra SQL option databases","description":"List extra SQL option databases. Returns the names of the databases linked to the additional SQL option, within its number of allowed databases.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Identifier of the (additional) SQL slot","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","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 Hosting","Databases@@@60"]],"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/web/{serviceName}/extraSqlPerso/{id}/databases\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/extraSqlPerso/{id}/databases\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:extraSqlPerso/databases/get","required":true}]}},"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfos":{"get":{"summary":"Get extra SQL option service information","description":"Get extra SQL option service information. Returns the billing information of the option: creation and expiration dates, renewal settings and contacts.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Identifier of the (additional) SQL slot","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","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 Hosting","Databases@@@60"]],"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/web/{serviceName}/extraSqlPerso/{id}/serviceInfos\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfos\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:extraSqlPerso/serviceInfos/get","required":true}]}},"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfosUpdate":{"post":{"summary":"Update extra SQL option renewal","description":"Update extra SQL option renewal. Updates the renewal settings of the additional SQL option: automatic renewal, renewal period and deletion at expiration.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Identifier of the (additional) SQL slot","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"renew":{"description":"Renew type","$ref":"#/components/schemas/service.RenewType"}},"required":["renew"]}}}},"responses":{"200":{"description":"successful operation"}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@100"]],"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: service.RenewType\nresult = client.post(\"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfosUpdate\",\n\trenew = None, # Renew type (type: service.RenewType)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/extraSqlPerso/{id}/serviceInfosUpdate\", array(\n\trenew => null, // Renew type (type: service.RenewType)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:extraSqlPerso/serviceInfosUpdate/create","required":true}]}},"/hosting/web/{serviceName}/extraSqlPerso/{id}/terminate":{"post":{"summary":"Terminate an extra SQL option","description":"Terminate an extra SQL option. Requests the termination of the additional SQL option. A link to confirm it is sent by email to the administrator contact.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"id","description":"Identifier of the (additional) SQL slot","required":true,"schema":{"type":"integer"}},{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@100"]],"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/web/{serviceName}/extraSqlPerso/{id}/terminate\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"post(\"/hosting/web/{serviceName}/extraSqlPerso/{id}/terminate\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:extraSqlPerso/terminate","required":true}]}},"/hosting/web/{serviceName}/privateDatabaseCreationCapabilities":{"get":{"summary":"Get private database creation capabilities","description":"Get private database creation capabilities. Returns, for each private database offer, the engines, the quota and the number of databases left to create.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/hosting.web.database.CreationDatabaseCapabilities"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Hosting","Databases@@@70"]],"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/web/{serviceName}/privateDatabaseCreationCapabilities\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/privateDatabaseCreationCapabilities\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:privateDatabaseCreationCapabilities/get","required":true}]}},"/hosting/web/{serviceName}/privateDatabases":{"get":{"summary":"List linked private databases","description":"List linked private databases. Returns the service names of the private databases linked to the hosting.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"The internal name of your hosting","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 Hosting","Databases@@@80"]],"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/web/{serviceName}/privateDatabases\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"get(\"/hosting/web/{serviceName}/privateDatabases\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webHosting:apiovh:privateDatabases/get","required":true}]}}}}