Skip to main content
GET
/
workspaces
/
{workspaceSlug}
/
databases
/
{databaseName}
Get a database
curl --request GET \
  --url https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "workspace": {
    "name": "<string>",
    "slug": "<string>",
    "id": "<string>",
    "stripe_customer_id": "<string>",
    "created": "2023-11-07T05:31:56Z"
  },
  "status": "PENDING",
  "region": "AWS_US_WEST_2",
  "expandable": true,
  "apiHost": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "deleted": "2023-11-07T05:31:56Z",
  "dbHost": "<string>",
  "sharded": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspaceSlug
string
required
​
databaseName
string
required

Response

Database details

​
id
string
required
​
name
string
required
Minimum string length: 1
​
workspace
object
required
​
status
enum<string>
required
Available options:
PENDING,
REQUESTED,
BUILT,
READY
​
region
enum<string>
required
Available options:
AWS_US_WEST_2,
AWS_EU_CENTRAL_1,
AZURE_EASTUS
​
expandable
boolean
required
​
apiHost
string<uri>
required
​
created
string<date-time>
​
deleted
string<date-time>
​
dbHost
string<uri>
​
sharded
boolean