Retrieve a schema

GET /v1/tenants/{tenant}/schemas/{id}

Read the definition behind a tableThe response is TOML, not JSON or table records.

Select a registered tableUse its schema ID.
Retrieve its manifestRead the table's TOML definition.
Inspect fields and relationshipsCheck columns, primary key and declared links.

Before you start

Use your database bearer token.

Use the ID of a registered table, such as demo.people.

Path parameters

Field	Type	Required
`tenant`	`string`	Required
`id`	`string`	Required

Headers

Field	Type	Required	Description
`x-oc-db-user`	`string`	Optional	Acting database user (role, grant and row-policy checks). Send with x-oc-db-key.
`x-oc-db-key`	`string`	Optional	API key of the x-oc-db-user user.

Read the result

The response is a TOML manifest, not a JSON row or a table's data. It describes the primary key, columns and declared relationships used by subsequent writes and queries.

Response statuses

HTTP status reference

Status	What to do
200	OK
400	Correct the request before retrying.
401	Check the credential and Authorization header.
402	Check feature access or available credits.
403	Check tenant access, roles and permissions.
404	Check the resource ID and API route.
429	Honor Retry-After when present; back off.
500	Check the outcome before retrying a write.
503	Honor Retry-After when present; check write outcomes.

Request example

curl --include --request GET "${OC_BASE_URL}/v1/tenants/${OC_TENANT}/schemas/demo.people" \
  --header "Authorization: Bearer ${OC_TOKEN}"

Response example

Examples use synthetic values to show the response format.

Response status

namespace = "demo"
table = "people"
primary_key = ["id"]

[[columns]]
name = "id"
ty = "str"
required = true

[[columns]]
name = "follows_id"
ty = "str"

[[columns]]
name = "score"
ty = "i64"

[[relations]]
name = "follows"
from_col = "follows_id"
bidirectional = true

[relations.target]
namespace = "demo"
table = "people"
pk = "id"

Illustrative TOML; canonical responses may include synthesized defaults such as the primary-key index.

Download the OpenAPI specification for the complete response schemas.

Before you startCopy Anchor Link

Path parametersCopy Anchor Link

HeadersCopy Anchor Link

Read the resultCopy Anchor Link

Response statusesCopy Anchor Link

Before you start

Path parameters

Headers

Read the result

Response statuses