curl -L https://api.turso.tech/v1/organizations/{organizationSlug}/databases/{databaseName}/instances/{instanceName} \
-H 'Authorization: Bearer TOKEN'
import { createClient } from "@tursodatabase/api";
const turso = createClient({
org: "...",
token: "",
});
const instance = await turso.databases.retrieveInstance(
"my-db",
"instanceName",
);
{
"instance": {
"uuid": "0be90471-6906-11ee-8553-eaa7715aeaf2",
"name": "aws-us-east-1",
"type": "primary",
"region": "aws-us-east-1",
"hostname": "[databaseName]-[organizationSlug].turso.io"
}
}Databases
Retrieve Database Instance
Return the individual database instance by name.
GET
/
v1
/
organizations
/
{organizationSlug}
/
databases
/
{databaseName}
/
instances
/
{instanceName}
curl -L https://api.turso.tech/v1/organizations/{organizationSlug}/databases/{databaseName}/instances/{instanceName} \
-H 'Authorization: Bearer TOKEN'
import { createClient } from "@tursodatabase/api";
const turso = createClient({
org: "...",
token: "",
});
const instance = await turso.databases.retrieveInstance(
"my-db",
"instanceName",
);
{
"instance": {
"uuid": "0be90471-6906-11ee-8553-eaa7715aeaf2",
"name": "aws-us-east-1",
"type": "primary",
"region": "aws-us-east-1",
"hostname": "[databaseName]-[organizationSlug].turso.io"
}
}curl -L https://api.turso.tech/v1/organizations/{organizationSlug}/databases/{databaseName}/instances/{instanceName} \
-H 'Authorization: Bearer TOKEN'
import { createClient } from "@tursodatabase/api";
const turso = createClient({
org: "...",
token: "",
});
const instance = await turso.databases.retrieveInstance(
"my-db",
"instanceName",
);
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The slug of the organization or user account.
The name of the database.
The name of the instance (location code).
Response
200 - application/json
Successful response
Show child attributes
Show child attributes
Was this page helpful?