Ploi API
Ploi API

List databases

List all the databases available in the server.

GET api/servers/{server}/databases

Example request:

curl -X GET "https://ploi.io/api/servers/{server}/databases" \
-H "Authorization: Bearer {token}" \
-H "Content-Type: application/json" \
-H "Accept: application/json"

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "data": [
        {
            "id": 1,
            "type": "mysql",
            "name": "my_database",
            "server_id": 1,
            "status": "active",
            "created_at": "2019-07-16 13:05:58"
        },
        {
            "id": 2,
            "type": "mysql",
            "name": "my_database_with_site",
            "server_id": 1,
            "status": "active",
            "site": {
                "id": 1,
                "root_domain": "domain.com"
            },
            "created_at": "2022-02-16 13:55:26"
        },
    ],
    "links": {
        "first": "http://ploi.io/api/servers/{serverId}/databases?page=1",
        "last": "http://ploi.io/api/servers/{serverId}/databases?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://ploi.io/api/servers/{serverId}/databases",
        "per_page": 15,
        "to": 1,
        "total": 1
    }
}