Databases

Database deployment and management endpoints

get

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

GET /api/v1/database/

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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/
post

POST /api/v1/database/

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
post
/api/v1/database/
post

POST /api/v1/database/dedicated

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
post
/api/v1/database/dedicated
post

POST /api/v1/database/dns

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
delete

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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}
get

GET /api/v1/database/status

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
delete

DELETE /api/v1/database/{id}

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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}
get

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
post

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
put

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
get

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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

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

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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
post

POST /api/v1/database/dns/

Authorizations
AuthorizationstringRequired

Bearer token for authentication. Format: Bearer

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/

Last updated