List Databases - Servebolt API (v1)

List all databases directly linked to your account.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

Example

{
    "data": [
        {
            "id": 1160,
            "type": "databases",
            "attributes": {
                "webhostId": 8888,
                "name": "Test",
                "dbHost": "xxx",
                "dbName": "testnN",
                "dbUser": "testnN",
                "size": 0,
                "tags": "",
                "environments": [
                    {
                        "id": 1637,
                        "name": "Test",
                        "state": "development"
                    }
                ]
            },
            "relationships": {
                "bolt": {
                    "data": {
                        "type": "bolts",
                        "id": 8888
                    }
                },
                "server": {
                    "data": {
                        "type": "servers",
                        "id": 35
                    }
                }
            }
        },
        {
            "id": 1221,
            "type": "databases",
            "attributes": {
                "webhostId": 8944,
                "name": "Test",
                "dbHost": "xxx",
                "dbName": "testUi",
                "dbUser": "testUi",
                "size": 0,
                "tags": "",
                "environments": [
                    {
                        "id": 1702,
                        "name": "Test",
                        "state": "production"
                    }
                ]
            },
            "relationships": {
                "bolt": {
                    "data": {
                        "type": "bolts",
                        "id": 8944
                    }
                },
                "server": {
                    "data": {
                        "type": "servers",
                        "id": 35
                    }
                }
            }
        }
    ],
    "links": {
        "first": "https://xxxv1/databases?page=1",
        "last": "https://xxx/v1/databases?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://xxx/v1/databases?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "https://xxx/v1/databases",
        "per_page": 15,
        "to": 7,
        "total": 7
    }
}