Skip to main content
GET
/
v1
/
instances
/
{instance}
/
databases
/
{database}
/
sdlSchema
{
  "schema": "<string>",
  "contentType": "<string>"
}

Path Parameters

​
instance
string
required

The instance id.

​
database
string
required

The database id.

Query Parameters

​
format
enum<string>

The format of the SDL schema output.

Available options:
SDL_FORMAT_UNSPECIFIED,
SINGLE_FILE,
MULTI_FILE

Response

OK

DatabaseSDLSchema contains the schema in SDL format.

​
schema
string<bytes>

The SDL schema content.

  • For SINGLE_FILE format: contains the complete SDL schema as a text string.
  • For MULTI_FILE format: contains the ZIP archive as binary data.
​
contentType
string

The MIME type of the schema content. Indicates how the client should interpret the schema field. Examples:

  • "text/plain; charset=utf-8" for SINGLE_FILE format
  • "application/zip" for MULTI_FILE format