# Organization API: Customer Portal: Databases

> The 16 Organization API operations for databases.

Source: https://www.coritan.com/docs/api/reference/organizations/customer-portal/servers-databases/

Part of [Customer Portal](/docs/api/reference/organizations/customer-portal/).

## Operations

| Method | Path | Summary |
| --- | --- | --- |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases) | List databases |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases) | Create database |
| DELETE | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}`](#op-delete-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id) | Delete database |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/credentials`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-credentials) | Get database credentials |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/query`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-query) | Query database |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/retry`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-retry) | Retry database |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/rotate-password`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-rotate-passw) | Rotate database password |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables) | List database tables |
| DELETE | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}`](#op-delete-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-tab) | Drop database table |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/columns`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table) | Describe database table |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/export.csv`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table) | Export database table |
| GET | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows`](#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table) | Read database rows |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table) | Insert database row |
| PATCH | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows`](#op-patch-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-tabl) | Update database row |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows/delete`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table) | Delete database row |
| POST | [`/api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/truncate`](#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table) | Truncate database table |

### List databases {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Create database {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases`

#### Parameters

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

#### Request body

`application/json`

Type: object or null.

#### Responses

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

### Delete database {#op-delete-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id}

`DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `database_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Get database credentials {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-credentials}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/credentials`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `database_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Query database {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-query}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/query`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `database_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `sql` | string | yes |

#### Responses

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

### Retry database {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-retry}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/retry`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `database_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Rotate database password {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-rotate-passw}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/rotate-password`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `database_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### List database tables {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables`

#### Parameters

| Name | In | Type | Required |
| --- | --- | --- | --- |
| `uuid` | path | string | yes |
| `database_id` | path | integer | yes |
| `org_slug` | path | string | yes |

#### Responses

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

### Drop database table {#op-delete-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-tab}

`DELETE /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}`

#### Parameters

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

#### Responses

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

### Describe database table {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/columns`

#### Parameters

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

#### Responses

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

### Export database table {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/export.csv`

#### Parameters

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

#### Responses

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

### Read database rows {#op-get-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table}

`GET /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows`

#### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `uuid` | path | string | yes |  |
| `database_id` | path | integer | yes |  |
| `table` | path | string | yes |  |
| `org_slug` | 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

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

### Insert database row {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows`

#### Parameters

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

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `values` | Values | yes |

#### Responses

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

### Update database row {#op-patch-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-tabl}

`PATCH /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows`

#### Parameters

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

#### Request body

`application/json` (required)

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

#### Responses

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

### Delete database row {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/rows/delete`

#### Parameters

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

#### Request body

`application/json` (required)

| Field | Type | Required |
| --- | --- | --- |
| `key` | Key | yes |

#### Responses

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

### Truncate database table {#op-post-api-v1-orgs-org-slug-portal-servers-uuid-databases-database-id-tables-table}

`POST /api/v1/orgs/{org_slug}/portal/servers/{uuid}/databases/{database_id}/tables/{table}/truncate`

#### Parameters

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

#### Responses

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