List Databricks catalogs

GET

/api/v1/catalogs

curl --request GET \
  --url https://example.com/api/v1/catalogs

Lists all accessible catalogs in the Databricks workspace.

Parameters

Query Parameters

max_results

Any of:

integer

integer

<= 1000

null

null

page_token

Any of:

string

string

null

null

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

CatalogListResponse

Response for listing catalogs.

object

catalogs

required

Catalogs

Array<object>

CatalogResponse

Databricks catalog information.

object

name

required

Name

string

comment

Any of:

string

string

null

null

owner

Any of:

string

string

null

null

created_at

Any of:

string

string

null

null

updated_at

Any of:

string

string

null

null

health_status

Any of:

string

string

null

null

table_count

Any of:

integer

integer

null

null

schema_count

Any of:

integer

integer

null

null

access_level

Any of:

string

string

null

null

count

required

Count

integer

next_page_token

Any of:

string

string

null

null

Example

{
  "catalogs": [
    {
      "health_status": "unknown",
      "access_level": "full"
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}