Databases

Database deployment and management endpoints

get

GET /api/v1/database/{id}/details

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/details
GET /api/v1/database/{id}/details?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/{id}/topology

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/topology
GET /api/v1/database/{id}/topology?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/{id}/connection-strings

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/connection-strings
GET /api/v1/database/{id}/connection-strings?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/
GET /api/v1/database/?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
post

POST /api/v1/database/

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
instanceTypeanyOptionalExample: any
typeanyOptionalExample: any
passwordanyOptionalExample: any
nameanyOptionalExample: any
visibilityanyOptionalExample: any
usernameanyOptionalExample: any
dbNameanyOptionalExample: any
versionanyOptionalExample: any
descriptionanyOptionalExample: any
backupanyOptionalExample: any
regionanyOptionalExample: any
architectureanyOptionalExample: any
sluganyOptionalExample: any
lengthanyOptionalExample: any
Responses
201

Created

application/json
Responseobject
post
/api/v1/database/
POST /api/v1/database/?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "organization_id": "any",
  "instanceType": "any",
  "type": "any",
  "password": "any",
  "name": "any",
  "visibility": "any",
  "username": "any",
  "dbName": "any",
  "version": "any",
  "description": "any",
  "backup": "any",
  "region": "any",
  "architecture": "any",
  "slug": "any",
  "length": "any"
}
{}
post

POST /api/v1/database/dedicated

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
sluganyOptionalExample: any
lengthanyOptionalExample: any
organization_idanyOptionalExample: any
nameanyOptionalExample: any
descriptionanyOptionalExample: any
versionanyOptionalExample: any
serverTypeanyOptionalExample: any
locationanyOptionalExample: any
dbNameanyOptionalExample: any
usernameanyOptionalExample: any
passwordanyOptionalExample: any
backupFrequencyanyOptionalExample: any
backupRetentionanyOptionalExample: any
highAvailabilityanyOptionalExample: any
monitoringanyOptionalExample: any
typeanyOptionalExample: any
deploymentModelanyOptionalExample: any
regionanyOptionalExample: any
Responses
201

Created

application/json
Responseobject
post
/api/v1/database/dedicated
POST /api/v1/database/dedicated?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 331

{
  "slug": "any",
  "length": "any",
  "organization_id": "any",
  "name": "any",
  "description": "any",
  "version": "any",
  "serverType": "any",
  "location": "any",
  "dbName": "any",
  "username": "any",
  "password": "any",
  "backupFrequency": "any",
  "backupRetention": "any",
  "highAvailability": "any",
  "monitoring": "any",
  "type": "any",
  "deploymentModel": "any",
  "region": "any"
}
{}
post

POST /api/v1/database/dns

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
nameanyOptionalExample: any
visibilityanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/database/dns
POST /api/v1/database/dns?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "name": "any",
  "visibility": "any",
  "organization_id": "any"
}
{}
delete

DELETE /api/v1/database/dns/{name}

Authorizations
Path parameters
namestringRequired

Path parameter: name

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/database/dns/{name}
DELETE /api/v1/database/dns/{name}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/status

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/status
GET /api/v1/database/status?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
delete

DELETE /api/v1/database/{id}

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
delete
/api/v1/database/{id}
DELETE /api/v1/database/{id}?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/{id}/backups

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/backups
GET /api/v1/database/{id}/backups?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
post

POST /api/v1/database/{id}/backups/restore

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
backupFileanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/database/{id}/backups/restore
POST /api/v1/database/{id}/backups/restore?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "backupFile": "any",
  "organization_id": "any"
}
{}
post

POST /api/v1/database/{id}/backups/rebuild

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
backupFileanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/database/{id}/backups/rebuild
POST /api/v1/database/{id}/backups/rebuild?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "backupFile": "any",
  "organization_id": "any"
}
{}
post

POST /api/v1/database/{id}/backups/manual

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/database/{id}/backups/manual
POST /api/v1/database/{id}/backups/manual?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
put

PUT /api/v1/database/{id}/backup

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
backupanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/database/{id}/backup
PUT /api/v1/database/{id}/backup?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "backup": "any",
  "organization_id": "any"
}
{}
put

PUT /api/v1/database/{id}/instance

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
instanceTypeanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/database/{id}/instance
PUT /api/v1/database/{id}/instance?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "instanceType": "any",
  "organization_id": "any"
}
{}
put

PUT /api/v1/database/{id}/ssl

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
enabledanyOptionalExample: any
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/database/{id}/ssl
PUT /api/v1/database/{id}/ssl?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "enabled": "any",
  "organization_id": "any"
}
{}
put

PUT /api/v1/database/{id}/configuration

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
organization_idanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
put
/api/v1/database/{id}/configuration
PUT /api/v1/database/{id}/configuration?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "organization_id": "any"
}
{}
get

GET /api/v1/database/{id}/query-analytics

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/query-analytics
GET /api/v1/database/{id}/query-analytics?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/{id}/access-logs

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/access-logs
GET /api/v1/database/{id}/access-logs?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
get

GET /api/v1/database/{id}/root-password

Authorizations
Path parameters
idstringRequired

Path parameter: id

Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Responses
200

OK

application/json
Responseobject
get
/api/v1/database/{id}/root-password
GET /api/v1/database/{id}/root-password?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*

{}
post

POST /api/v1/database/dns/

Authorizations
Query parameters
organization_idstringRequired

Organization ID - required for all API requests to scope data to your organization

Example: 1234567890
Header parameters
AuthorizationstringRequired

Bearer token for authentication

Example: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Body
nameanyOptionalExample: any
Responses
200

OK

application/json
Responseobject
post
/api/v1/database/dns/
POST /api/v1/database/dns/?organization_id=1234567890 HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "name": "any"
}
{}
PreviousUsersNextAnalytics