{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"complexType.UnitAndValue_long":{"type":"object","description":"A numeric value tagged with its unit","properties":{"unit":{"type":"string","description":"Unit of the value","readOnly":true},"value":{"type":"integer"}}},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"hosting.privateDatabase.Database":{"type":"object","description":"Databases","properties":{"backupTime":{"allOf":[{"$ref":"#/components/schemas/time"}],"description":"Time of the next backup (every day)","nullable":true,"readOnly":true},"creationDate":{"type":"string","description":"Creation date of the database","format":"date-time","readOnly":true},"databaseName":{"type":"string","description":"Database name","readOnly":true},"quotaUsed":{"allOf":[{"$ref":"#/components/schemas/complexType.UnitAndValue_long"}],"description":"Space used by the database","readOnly":true},"users":{"type":"array","description":"Users granted to this database","items":{"$ref":"#/components/schemas/hosting.privateDatabase.Database.User"},"readOnly":true}}},"hosting.privateDatabase.Database.CreatePayload":{"type":"object","description":"Payload used to create a database on a Web Cloud Database","properties":{"databaseName":{"type":"string","description":"Name of your new database"}},"required":["databaseName"]},"hosting.privateDatabase.Database.User":{"type":"object","description":"Users","properties":{"grantId":{"type":"integer","description":"The grantId associated for this databaseName and this userName","readOnly":true},"grantType":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.grant.GrantEnum"}],"description":"User's rights on this database","readOnly":true},"userName":{"type":"string","description":"User's name granted on this database","readOnly":true}}},"hosting.privateDatabase.DatabaseWizardPayload":{"type":"object","description":"Payload used to create user and grant and apply it on a new database on a Web Cloud Database","properties":{"databaseName":{"type":"string","description":"Name of your new database"},"grant":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.grant.GrantEnum"}],"description":"Grant of the user on this database"},"password":{"type":"string","description":"Password for the new user (alphanumeric and 8 characters minimum)","format":"password"},"userName":{"type":"string","description":"New user name used to connect on your database"}},"required":["databaseName","grant","password","userName"]},"hosting.privateDatabase.Task":{"type":"object","description":"Web Cloud Database task","properties":{"databaseName":{"type":"string","description":"Database name on which the task is working","nullable":true,"readOnly":true},"doneDate":{"type":"string","description":"Completion date","nullable":true,"format":"date-time","readOnly":true},"dumpId":{"type":"integer","description":"DumpId on which the task is working","nullable":true,"readOnly":true},"function":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.task.FunctionEnum"}],"description":"Function name","readOnly":true},"id":{"type":"integer","description":"The id of the task","readOnly":true},"lastUpdate":{"type":"string","description":"Last update","nullable":true,"format":"date-time","readOnly":true},"startDate":{"type":"string","description":"Task creation date","format":"date-time","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/hosting.privateDatabase.task.StatusEnum"}],"description":"Task status","readOnly":true},"userName":{"type":"string","description":"User name on which the task is working","nullable":true,"readOnly":true}}},"hosting.privateDatabase.grant.GrantEnum":{"type":"string","description":"Grant on a database for a specific user","enum":["admin","none","overquota_admin","overquota_rw","ro","rw"]},"hosting.privateDatabase.task.FunctionEnum":{"type":"string","description":"Task's dunction","enum":["abuse","changeFtpPassword","changeRam","changeVersion","configuration/update","create","database/copy","database/copyRestore","database/create","database/delete","database/dump","database/dump/delete","database/extension/create","database/extension/delete","database/import","database/restore","database/wizard","delete","grant/create","grant/delete","grant/update","install","overquota/in","overquota/out","quotaRefresh","refresh","reopen","restart","start","stop","suspend","user/changePassword","user/create","user/delete","webhostingNetwork/disable","webhostingNetwork/enable","whitelist/create","whitelist/delete","whitelist/update"]},"hosting.privateDatabase.task.StatusEnum":{"type":"string","description":"Task's status","enum":["cancelled","doing","done","error","todo"]},"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"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/hosting/privateDatabase/{serviceName}/database":{"get":{"summary":"List databases","description":"Returns the names of the databases of the service.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Databases"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/privateDatabase/{serviceName}/database\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/privateDatabase/{serviceName}/database\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:database/get","required":true}],"x-expanded-response":"HostingPrivateDatabaseDatabase"},"post":{"summary":"Create a database","description":"Creates an empty database on the service and returns a task to follow the creation. To also create a user with access to it, use the database wizard.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Database.CreatePayload"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Databases"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.privateDatabase.Database.CreatePayload\nresult = client.post(\"/hosting/privateDatabase/{serviceName}/database\",\n\tdatabaseName = None, # Name of your new database (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.privateDatabase.Database.CreatePayload\n$result = $ovh->post(\"/hosting/privateDatabase/{serviceName}/database\", array(\n\tdatabaseName => null, // Name of your new database (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:database/create","required":true}]}},"/hosting/privateDatabase/{serviceName}/database/{databaseName}":{"delete":{"summary":"Delete a database","description":"Deletes the database and returns a task to follow the deletion. Its dumps are kept as orphan dumps.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"databaseName","description":"Database name","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Databases"]],"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/privateDatabase/{serviceName}/database/{databaseName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->delete(\"/hosting/privateDatabase/{serviceName}/database/{databaseName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:database/delete","required":true}]},"get":{"summary":"Get a database","description":"Returns the size and creation date of the database, its daily backup time and the users granted on it.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"databaseName","description":"Database name","required":true,"schema":{"type":"string"}},{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Database"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Databases"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\nresult = client.get(\"/hosting/privateDatabase/{serviceName}/database/{databaseName}\")\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n$result = $ovh->get(\"/hosting/privateDatabase/{serviceName}/database/{databaseName}\");\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:database/get","required":true}],"x-response-identifier":"databaseName"}},"/hosting/privateDatabase/{serviceName}/databaseWizard":{"post":{"summary":"Create a database with a user","description":"Creates a database and a user in one call, and grants the user the chosen rights on the database. The password must be alphanumeric and at least 8 characters long.","security":[{"oAuth2AuthCode":[]}],"parameters":[{"in":"path","name":"serviceName","description":"Service name","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.DatabaseWizardPayload"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/hosting.privateDatabase.Task"}}}}},"x-developer-hub-navigation":[["Web Cloud","Web Cloud DB","Databases"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: hosting.privateDatabase.DatabaseWizardPayload\nresult = client.post(\"/hosting/privateDatabase/{serviceName}/databaseWizard\",\n\tdatabaseName = None, # Name of your new database (type: string)\n\tgrant = None, # Grant of the user on this database (type: hosting.privateDatabase.grant.GrantEnum)\n\tpassword = None, # Password for the new user (alphanumeric and 8 characters minimum) (type: string)\n\tuserName = None, # New user name used to connect on your database (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: hosting.privateDatabase.DatabaseWizardPayload\n$result = $ovh->post(\"/hosting/privateDatabase/{serviceName}/databaseWizard\", array(\n\tdatabaseName => null, // Name of your new database (type: string)\n\tgrant => null, // Grant of the user on this database (type: hosting.privateDatabase.grant.GrantEnum)\n\tpassword => null, // Password for the new user (alphanumeric and 8 characters minimum) (type: string)\n\tuserName => null, // New user name used to connect on your database (type: string)\n));\n\nprint_r($result);\n?>"}],"x-iam-actions":[{"name":"webCloudDatabases:apiovh:databaseWizard/create","required":true}]}}}}