Servebolt API (v1)
Submit feedback
Servebolt API (v1)
  • Introduction
  • Auth
  • Bolts
    • Access
    • Databases
      • List Bolt DatabasesGET
      • Get Bolt DatabaseGET
      • Create Bolt DatabasePOST
      • Update Bolt DatabasePUT
      • Delete Bolt DatabaseDELETE
    • Statistics
    • List BoltsGET
    • Bolt Name ValidatePOST
    • Available CMSGET
    • Create BoltPOST
    • Get BoltGET
    • Get Bolt EnvironmentsGET
    • Update BoltPUT
    • Archive BoltDELETE
    • Available PHP VersionsGET
    • Get Bolt SubscriptionGET
    • Bolt UsageGET
    • Update Bolt QuotaPOST
  • Environments
  • Locations
  • Databases
  • Cronjobs
  • SSH Keys
  • Certificates
  • Billing
  • Profile
logoPowered by Apidog
  1. Bolts
  2. Databases

List Bolt Databases

GET/v1/bolts/{boltId}/databases

List all databases associated with a Bolt.

Request

Authorization: Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example
Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379
Path Params
boltId
string 
required

The ID of your bolt.

Example:
1234

Request samples

Responses

OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array [object {4}] 
required
id
integer 
optional
type
string 
optional
attributes
object 
optional
relationships
object 
optional
links
object 
required
first
string 
required
last
string 
required
prev
null 
required
next
null 
required
meta
object 
required
current_page
integer 
required
from
integer 
required
last_page
integer 
required
links
array [object {3}] 
required
path
string 
required
per_page
integer 
required
to
integer 
required
total
integer 
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
          }
        }
      }
    }
  ],
  "links": {
    "first": "https://xxx/v1/bolts/8988/databases?page=1",
    "last": "https://xxx/v1/bolts/8988/databases?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "« Previous",
        "active": false
      },
      {
        "url": "https://xxx/v1/bolts/8988/databases?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "Next »",
        "active": false
      }
    ],
    "path": "https://xxx/v1/bolts/8988/databases",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}
Last modified: 6 months ago