List Databases
GET
/v1/databasesList all databases directly linked to your account.
Request
Header Params
Accept
string
required
Example:
application/json
Content-Type
string
required
Example:
application/json
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
array [object {4}]
required
id
integer
required
type
string
required
attributes
object
required
relationships
object
required
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": 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": "« Previous",
"active": false
},
{
"url": "https://xxx/v1/databases?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "https://xxx/v1/databases",
"per_page": 15,
"to": 7,
"total": 7
}
}
Modified at 4 months ago