ESestuary

GET /api/v1/catalog/status

Changed on

Request

  • Base URL
    https://api.estuary.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://api.estuary.dev/api/v1/catalog/status
  • Auth
    HTTP bearer

Query parameters

connectedboolean

Whether to fetch statuses for connected specs, in addition to those named

namestring[] required

The catalog name of the live spec to get the status of

shortboolean

Whether to return a smaller response that excludes the connector_status and controller_status fields.

Response

catalog_namestring required

The name of the live spec

controller_errorstring nullable

Error from the most recent controller run, or null if the run was successful.

controller_failuresinteger

The number of consecutive failures of the controller. Resets to 0 after any successful run.

controller_next_runstring date-time nullable required

Time at which the controller is next scheduled to run. Or null if there is no run scheduled.

controller_updated_atstring date-time required

Time of the last controller run for this spec.

disabledboolean

Whether the shards are disabled. Only pertinent to tasks. Omitted if false.

last_build_idstring required
last_pub_idstring required
live_spec_idstring required
live_spec_updated_atstring date-time required

Time of the last publication that affected the live spec.

spec_type'capture' | 'collection' | 'materialization' | 'test'

Changes

  • baf52a643cfbRevision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 to the ///// response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 from the ///// response property oneOf list for the response status