Get Bolt Database - Servebolt API (v1)

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

boltId

string

required

The ID of your Bolt.

Example:

1234

databaseId

integer

required

The ID of the database can be retrieved via the List Bolt Database endpoint.

Example:

5678

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

data

object

required

id

integer

required

type

string

required

attributes

object

required

relationships

object

required

Example

{
  "data": {
    "id": 1261,
    "type": "databases",
    "attributes": {
      "webhostId": 8988,
      "name": "Test",
      "dbHost": "xxx",
      "dbName": "testob",
      "dbUser": "testob",
      "size": 0,
      "tags": "",
      "environments": [
        {
          "id": 1760,
          "name": "Test",
          "state": "development"
        }
      ]
    },
    "relationships": {
      "bolt": {
        "data": {
          "type": "bolts",
          "id": 8988
        }
      },
      "server": {
        "data": {
          "type": "servers",
          "id": 35
        }
      }
    }
  }
}