Skip to main content
POST
POST /projects/{project}/export/schema
Creates a schema export.

Endpoint details

string
required
Bearer pat_... (Project API Token). Keep this token on your backend/server.
string
required
Project slug. This acts as the Project ID in API paths.
boolean
required
true for a successful response and false for an error response.
object | null
Endpoint-specific response data when ok is true; null on errors.
object | null
Error code and message when ok is false; null on success.
string
required
Request identifier you can use when troubleshooting a specific API call.

Authentication

Project API Token.

Parameters

Body optional: format json or sql, default json; file_name optional.

Request examples

Basic request:
Full request:

Response examples

Success:
Error or alternate response: