Skip to content

Gets database metadata for the given project.
experimental

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

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

OAuth scopes

  • projects:read

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

  • database_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
  "databases": [
    {
      "name": "lorem",
      "schemas": [
        {
          "name": "lorem"
        }
      ]
    }
  ]
}
{
  "type": "object",
  "properties": {
    "databases": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "schemas": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                }
              },
              "required": [
                "name"
              ]
            }
          }
        },
        "required": [
          "name",
          "schemas"
        ]
      }
    }
  },
  "required": [
    "databases"
  ]
}