Skip to main content
POST
/
workspaces
/
{workspaceSlug}
/
databases
/
{databaseName}
/
credentials
Create a database credential
curl --request POST \
  --url https://global.thenile.dev/workspaces/{workspaceSlug}/databases/{databaseName}/credentials \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "database": {
    "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
  },
  "password": "<string>",
  "tenant": "<string>",
  "internal": true,
  "created": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://thenile.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Query Parameters

​
tenantId
string
​
internal
boolean
default:false

Response

Credential created

​
id
string
required
Minimum string length: 1
​
database
object
required
​
password
string
required
Minimum string length: 1
​
tenant
string
​
internal
boolean
​
created
string<date-time>