Skip to content
Console(the OVHcloud Console, opens in a new tab)

Databases

All operations require authentication.

2 operationsv2/publicCloud/project
OpenAPI
Agent setup

List servicesBeta

GET
/v2/publicCloud/project/{projectId}/managedDatabase/service

Returns the database services of the project, across all engines.

Path parameters

projectId
required
string

Project ID

Query parameters

category
CategoryEnum

Filter services by engine category

ValuesANALYTICSDATABASE

Headers

X-Pagination-Cursor
string

Pagination cursor

X-Pagination-Size
integer

Pagination size

Response

200Service[]successful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the service was created

currentState
read-only
ServiceCurrentState

Current configuration deployed on the service

currentTasks
read-only
CurrentTask[]

Asynchronous operations currently running on the service

id
read-only
stringuuid

Unique identifier of the service

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the service. A new target specification is accepted only in READY status.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
ServiceTargetSpec

Last requested target specification for the service

updatedAt
read-only
stringdate-time

Date of the last update to the service

Example uses projectId = string

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/service \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
[  {    "checksum": "string",    "createdAt": "2024-01-01T12:00:00Z",    "currentState": {      "advancedConfiguration": {        "key": "string"      },      "backup": {        "pitr": "2024-01-01T12:00:00Z",        "regions": [          "af-north-lz-rba"        ],        "retentionDays": 0,        "time": "string"      },      "capabilities": {        "key": {          "create": "DISABLED",          "delete": "DISABLED",          "read": "DISABLED",          "update": "DISABLED"        }      },      "deletionProtected": true,      "description": "string",      "endpoints": [        {          "component": "CLICKHOUSE",          "domain": "string",          "path": "string",          "port": 0,          "public": true,          "scheme": "string",          "ssl": true,          "sslMode": "REQUIRE",          "uri": "string"        }      ],      "engineCapabilities": {        "advancedConfigurationProperties": [          {            "default": "string",            "description": "string",            "maximum": 0,            "minimum": 0,            "name": "string",            "requiresRestart": true,            "type": "BOOLEAN",            "values": [              null            ]          }        ],        "backupRegions": [          "string"        ],        "categories": [          "string"        ],        "commands": [          "string"        ],        "connectors": [          {            "author": "string",            "configuration": [              null            ],            "documentationUrl": "string",            "id": "00000000-0000-0000-0000-000000000000",            "latest": true,            "name": "string",            "preview": true,            "transforms": [              null            ],            "type": "SINK",            "version": "string"          }        ],        "integrations": [          {            "destinationEngine": "CLICKHOUSE",            "parameters": [              null            ],            "sourceEngine": "CLICKHOUSE",            "type": "GRAFANA_DASHBOARD"          }        ]      },      "flavor": "string",      "maintenanceWindow": {        "startTimeUtc": "string"      },      "network": {        "authorizedIps": {          "rules": [            {              "cidr": null,              "createdAt": null,              "description": null            }          ]        },        "networkId": "00000000-0000-0000-0000-000000000000",        "public": true,        "subnetId": "00000000-0000-0000-0000-000000000000"      },      "nodes": [        {          "createdAt": "2024-01-01T12:00:00Z",          "flavor": "string",          "id": "00000000-0000-0000-0000-000000000000",          "location": {            "availabilityZone": "string",            "region": "string"          },          "name": "string",          "port": 0,          "role": "ANALYTICS",          "status": "CREATING"        }      ],      "nodesCount": 0,      "plan": "string",      "prometheusEnabled": true,      "status": "CREATING",      "storage": {        "size": {          "unit": "GB",          "value": 0        },        "type": "HIGH_SPEED"      },      "version": "string"    },    "currentTasks": [      {        "errors": [          {            "message": "string"          }        ],        "id": "00000000-0000-0000-0000-000000000000",        "link": "string",        "status": "ERROR",        "type": "string"      }    ],    "id": "00000000-0000-0000-0000-000000000000",    "resourceStatus": "CREATING",    "targetSpec": {      "advancedConfiguration": {        "key": "string"      },      "backup": {        "regions": [          "af-north-lz-rba"        ],        "time": "string"      },      "deletionProtected": true,      "description": "string",      "flavor": "string",      "maintenanceWindow": {        "startTimeUtc": "string"      },      "network": {        "authorizedIps": {          "rules": [            {              "cidr": null,              "createdAt": null,              "description": null            }          ]        },        "public": true      },      "nodesCount": 0,      "plan": "string",      "prometheusEnabled": true,      "storage": {        "size": {          "unit": "GB",          "value": 0        }      },      "version": "string"    },    "updatedAt": "2024-01-01T12:00:00Z"  }]

Get a serviceBeta

GET
/v2/publicCloud/project/{projectId}/managedDatabase/service/{serviceId}

Returns a database service whatever its engine, with its target specification, current state and running tasks.

Path parameters

projectId
required
string

Project ID

serviceId
required
stringuuid

Service ID

Response

200Servicesuccessful operation
checksum
read-only
string

Hash of the resource used for concurrency control

createdAt
read-only
stringdate-time

Date at which the service was created

currentState
read-only
ServiceCurrentState

Current configuration deployed on the service

currentTasks
read-only
CurrentTask[]

Asynchronous operations currently running on the service

id
read-only
stringuuid

Unique identifier of the service

resourceStatus
read-only
ResourceStatusEnum

Readiness status of the service. A new target specification is accepted only in READY status.

ValuesCREATINGCREATION_PLANNEDDELETINGERROROUT_OF_SYNCREADYSUSPENDEDUNKNOWNUPDATING
targetSpec
read-only
ServiceTargetSpec

Last requested target specification for the service

updatedAt
read-only
stringdate-time

Date of the last update to the service

Example uses projectId = string, serviceId = 00000000-0000-0000-0000-000000000000

$ curl https://api.eu.ovhcloud.com/v2/publicCloud/project/{projectId}/managedDatabase/service/{serviceId} \
  -H "authorization: Bearer $OVH_TOKEN"
ResponseExample
{  "checksum": "string",  "createdAt": "2024-01-01T12:00:00Z",  "currentState": {    "advancedConfiguration": {      "key": "string"    },    "backup": {      "pitr": "2024-01-01T12:00:00Z",      "regions": [        "af-north-lz-rba"      ],      "retentionDays": 0,      "time": "string"    },    "capabilities": {      "key": {        "create": "DISABLED",        "delete": "DISABLED",        "read": "DISABLED",        "update": "DISABLED"      }    },    "deletionProtected": true,    "description": "string",    "endpoints": [      {        "component": "CLICKHOUSE",        "domain": "string",        "path": "string",        "port": 0,        "public": true,        "scheme": "string",        "ssl": true,        "sslMode": "REQUIRE",        "uri": "string"      }    ],    "engineCapabilities": {      "advancedConfigurationProperties": [        {          "default": "string",          "description": "string",          "maximum": 0,          "minimum": 0,          "name": "string",          "requiresRestart": true,          "type": "BOOLEAN",          "values": [            "string"          ]        }      ],      "backupRegions": [        "string"      ],      "categories": [        "string"      ],      "commands": [        "string"      ],      "connectors": [        {          "author": "string",          "configuration": [            {              "defaultValue": null,              "description": null,              "displayName": null,              "group": null,              "importance": null,              "name": null,              "required": null,              "type": null,              "values": null            }          ],          "documentationUrl": "string",          "id": "00000000-0000-0000-0000-000000000000",          "latest": true,          "name": "string",          "preview": true,          "transforms": [            {              "description": null,              "displayName": null,              "name": null,              "required": null,              "transformType": null,              "type": null,              "values": null            }          ],          "type": "SINK",          "version": "string"        }      ],      "integrations": [        {          "destinationEngine": "CLICKHOUSE",          "parameters": [            {              "name": null,              "type": null            }          ],          "sourceEngine": "CLICKHOUSE",          "type": "GRAFANA_DASHBOARD"        }      ]    },    "flavor": "string",    "maintenanceWindow": {      "startTimeUtc": "string"    },    "network": {      "authorizedIps": {        "rules": [          {            "cidr": "192.0.2.0/24",            "createdAt": "2024-01-01T12:00:00Z",            "description": "string"          }        ]      },      "networkId": "00000000-0000-0000-0000-000000000000",      "public": true,      "subnetId": "00000000-0000-0000-0000-000000000000"    },    "nodes": [      {        "createdAt": "2024-01-01T12:00:00Z",        "flavor": "string",        "id": "00000000-0000-0000-0000-000000000000",        "location": {          "availabilityZone": "string",          "region": "string"        },        "name": "string",        "port": 0,        "role": "ANALYTICS",        "status": "CREATING"      }    ],    "nodesCount": 0,    "plan": "string",    "prometheusEnabled": true,    "status": "CREATING",    "storage": {      "size": {        "unit": "GB",        "value": 0      },      "type": "HIGH_SPEED"    },    "version": "string"  },  "currentTasks": [    {      "errors": [        {          "message": "string"        }      ],      "id": "00000000-0000-0000-0000-000000000000",      "link": "string",      "status": "ERROR",      "type": "string"    }  ],  "id": "00000000-0000-0000-0000-000000000000",  "resourceStatus": "CREATING",  "targetSpec": {    "advancedConfiguration": {      "key": "string"    },    "backup": {      "regions": [        "af-north-lz-rba"      ],      "time": "string"    },    "deletionProtected": true,    "description": "string",    "flavor": "string",    "maintenanceWindow": {      "startTimeUtc": "string"    },    "network": {      "authorizedIps": {        "rules": [          {            "cidr": "192.0.2.0/24",            "createdAt": "2024-01-01T12:00:00Z",            "description": "string"          }        ]      },      "public": true    },    "nodesCount": 0,    "plan": "string",    "prometheusEnabled": true,    "storage": {      "size": {        "unit": "GB",        "value": 0      }    },    "version": "string"  },  "updatedAt": "2024-01-01T12:00:00Z"}