Skip to content
Management API Reference

Get PostgREST OpenAPI spec

get/v1/projects/{ref}/database/openapi

Returns the PostgREST OpenAPI specification for the project. This is the replacement for querying /rest/v1/ directly with the anon key.

OAuth scopes

  • database:read

The fine-grained token must include the following permissions to access this endpoint:

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Query parameters

  • schema
    Optional
    string

    The database schema to generate the OpenAPI spec for

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

1
{}