Client API: Deployment servers: Databases

Name	In	Type	Required
`uuid`	path	string	yes

Responses

Section titled Create a new database

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A 200 response is a list; each item has these fields:

Field	Type
`[].id`	integer
`[].uuid`	string or null
`[].server_id`	integer or null
`[].database_host_id`	integer
`[].name`	string
`[].username`	string
`[].password`	string or null
`[].remote`	string or null
`[].remote_connect_string`	string or null
`[].max_connections`	integer
`[].host`	string or null
`[].port`	integer or null
`[].host_name`	string or null
`[].uri`	string or null
`[].jdbc`	string or null
`[].status`	string
`[].status_message`	string or null
`[].last_error`	string or null
`[].operation`	string or null
`[].busy`	boolean
`[].colocated`	boolean or null
`[].db_name`	string or null
`[].created_at`	string (date-time) or null
`[].updated_at`	string (date-time) or null

Create a new database

POST /api/v1/client/servers/{uuid}/databases

Create a new database.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`Idempotency-Key`	header	string or null	no

Request body

application/json (required)

Field	Type	Required
`database_host_id`	integer or null	no
`name_suffix`	string	no
`remote`	string	no
`idempotency_key`	string or null	no

Responses

Section titled Run a script of SQL statements, one block of results per statement

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Fields of a 201 response:

Field	Type
`id`	integer
`uuid`	string or null
`server_id`	integer or null
`database_host_id`	integer
`name`	string
`username`	string
`password`	string or null
`remote`	string or null
`remote_connect_string`	string or null
`max_connections`	integer
`host`	string or null
`port`	integer or null
`host_name`	string or null
`uri`	string or null
`jdbc`	string or null
`status`	string
`status_message`	string or null
`last_error`	string or null
`operation`	string or null
`busy`	boolean
`colocated`	boolean or null
`db_name`	string or null
`created_at`	string (date-time) or null
`updated_at`	string (date-time) or null

Run a script of SQL statements, one block of results per statement

POST /api/v1/client/servers/{uuid}/databases/{database_id}/query

Run a script of SQL statements, one block of results per statement.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes

Request body

application/json (required)

Field	Type	Required
`sql`	string	yes

Responses

Section titled The database's tables with their row estimates and sizes

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

The database's tables with their row estimates and sizes

GET /api/v1/client/servers/{uuid}/databases/{database_id}/tables

The database's tables with their row estimates and sizes.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes

Responses

Section titled Delete a table and its rows

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete a table and its rows

DELETE /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}

Delete a table and its rows.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Responses

Section titled One table's columns and its key

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

One table's columns and its key

GET /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/columns

One table's columns and its key.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Responses

Section titled A table as a CSV file

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A table as a CSV file

GET /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/export.csv

A table as a CSV file.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Responses

Section titled A page of a table's rows, searched and sorted

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

A page of a table's rows, searched and sorted

GET /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/rows

A page of a table's rows, searched and sorted.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required	Description
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes
`limit`	query	integer	no	Default: `50`.
`offset`	query	integer	no	Default: `0`.
`search`	query	string	no
`sort`	query	string or null	no
`direction`	query	string	no	Default: `asc`.

Responses

Section titled Add one row

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Add one row

POST /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/rows

Add one row.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`values`	Values	yes

Responses

Section titled Change one row, named by its key

Status	Meaning
`201`	Success.
`422`	The request is not valid. `detail` lists each problem.

Change one row, named by its key

PATCH /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/rows

Change one row, named by its key.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`key`	Key	yes
`values`	Values	yes

Responses

Section titled Delete one row, named by its key

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete one row, named by its key

POST /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/rows/delete

Delete one row, named by its key.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Request body

application/json (required)

Field	Type	Required
`key`	Key	yes

Responses

Section titled Delete every row of a table and keep the table

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete every row of a table and keep the table

POST /api/v1/client/servers/{uuid}/databases/{database_id}/tables/{table}/truncate

Delete every row of a table and keep the table.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`database_id`	path	integer	yes
`table`	path	string	yes

Responses

Section titled Delete a database

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Delete a database

DELETE /api/v1/client/servers/{uuid}/databases/{db_id}

Delete a database.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`db_id`	path	integer	yes

Responses

Section titled Reveal the stored password for a database on this server

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Reveal the stored password for a database on this server

GET /api/v1/client/servers/{uuid}/databases/{db_id}/credentials

Reveal the stored password for a database on this server.

Authentication: an access token, sent as Authorization: Bearer <token>.

Parameters

Name	In	Type	Required
`uuid`	path	string	yes
`db_id`	path	integer	yes

Responses