Databases
Database deployment and management endpoints
GET /api/v1/database/{id}/details
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/{id}/details HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/{id}/topology
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/{id}/topology HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/{id}/connection-strings
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Unauthorized
Forbidden
Internal Server Error
GET /api/v1/database/{id}/connection-strings HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/ HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}POST /api/v1/database/
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyanyanyanyanyanyanyanyanyanyanyanyanyanyCreated
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/database/ 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 /api/v1/database/dedicated
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyanyanyanyanyanyanyanyanyanyanyanyanyanyanyanyanyCreated
Bad Request
Unauthorized
Forbidden
Not Found
Conflict
Internal Server Error
POST /api/v1/database/dedicated 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 /api/v1/database/dns
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/database/dns 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 /api/v1/database/dns/{name}
Path parameter: name
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
DELETE /api/v1/database/dns/{name} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/status
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/status HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}DELETE /api/v1/database/{id}
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
DELETE /api/v1/database/{id} HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/{id}/backups
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/{id}/backups HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}POST /api/v1/database/{id}/backups/restore
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/database/{id}/backups/restore 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 /api/v1/database/{id}/backups/rebuild
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/database/{id}/backups/rebuild 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 /api/v1/database/{id}/backups/manual
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/database/{id}/backups/manual HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}PUT /api/v1/database/{id}/backup
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
PUT /api/v1/database/{id}/backup 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 /api/v1/database/{id}/instance
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
PUT /api/v1/database/{id}/instance 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 /api/v1/database/{id}/ssl
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyanyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
PUT /api/v1/database/{id}/ssl 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 /api/v1/database/{id}/configuration
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
PUT /api/v1/database/{id}/configuration HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 25
{
"organization_id": "any"
}{}GET /api/v1/database/{id}/query-analytics
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/{id}/query-analytics HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/{id}/access-logs
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/{id}/access-logs HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}GET /api/v1/database/{id}/root-password
Path parameter: id
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304OK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
GET /api/v1/database/{id}/root-password HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Accept: */*
{}POST /api/v1/database/dns/
Organization ID - required for all API requests to scope data to your organization
1234567890Bearer token for authentication
Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304anyOK
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
POST /api/v1/database/dns/ HTTP/1.1
Host: api.pandastack.io
Authorization: Bearer psk_1db3560bebe10dcd43acceb6121a1de598bbd3d4ad6ab6e8a570d3389e5de304
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"name": "any"
}{}