Databases
Database deployment and management endpoints
GET /api/v1/database/{id}/details
Bearer token for authentication. Format: Bearer
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
Bearer token for authentication. Format: Bearer
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}/connection-strings
Bearer token for authentication. Format: Bearer
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/
Bearer token for authentication. Format: Bearer
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
POST /api/v1/database/
Bearer token for authentication. Format: Bearer
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/dedicated
Bearer token for authentication. Format: Bearer
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/dns
Bearer token for authentication. Format: Bearer
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
DELETE /api/v1/database/dns/{name}
Bearer token for authentication. Format: Bearer
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
GET /api/v1/database/status
Bearer token for authentication. Format: Bearer
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
DELETE /api/v1/database/{id}
Bearer token for authentication. Format: Bearer
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
Bearer token for authentication. Format: Bearer
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
POST /api/v1/database/{id}/backups/restore
Bearer token for authentication. Format: Bearer
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
Bearer token for authentication. Format: Bearer
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/manual
Bearer token for authentication. Format: Bearer
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}/backup
Bearer token for authentication. Format: Bearer
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
Bearer token for authentication. Format: Bearer
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
Bearer token for authentication. Format: Bearer
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}/configuration
Bearer token for authentication. Format: Bearer
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
GET /api/v1/database/{id}/query-analytics
Bearer token for authentication. Format: Bearer
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
Bearer token for authentication. Format: Bearer
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}/root-password
Bearer token for authentication. Format: Bearer
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
POST /api/v1/database/dns/
Bearer token for authentication. Format: Bearer
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
Last updated