Skip to main content
GET
/
status
Get server status and health information
curl --request GET \
  --url https://{organization}.data.credibledata.com/api/v0/status \
  --header 'Authorization: Bearer <token>'
{
  "timestamp": 123,
  "projects": [
    {
      "resource": "<string>",
      "name": "<string>",
      "readme": "<string>",
      "location": "<string>",
      "connections": [
        {
          "resource": "<string>",
          "name": "<string>",
          "attributes": {
            "dialectName": "<string>",
            "isPool": true,
            "canPersist": true,
            "canStream": true
          },
          "postgresConnection": {
            "host": "<string>",
            "port": 123,
            "databaseName": "<string>",
            "userName": "<string>",
            "password": "<string>",
            "connectionString": "<string>"
          },
          "bigqueryConnection": {
            "defaultProjectId": "<string>",
            "billingProjectId": "<string>",
            "location": "<string>",
            "serviceAccountKeyJson": "<string>",
            "maximumBytesBilled": "<string>",
            "queryTimeoutMilliseconds": "<string>"
          },
          "snowflakeConnection": {
            "account": "<string>",
            "username": "<string>",
            "password": "<string>",
            "privateKey": "<string>",
            "privateKeyPass": "<string>",
            "warehouse": "<string>",
            "database": "<string>",
            "schema": "<string>",
            "role": "<string>",
            "responseTimeoutMilliseconds": 123
          },
          "trinoConnection": {
            "server": "<string>",
            "port": 123,
            "catalog": "<string>",
            "schema": "<string>",
            "user": "<string>",
            "password": "<string>",
            "peakaKey": "<string>"
          },
          "mysqlConnection": {
            "host": "<string>",
            "port": 123,
            "database": "<string>",
            "user": "<string>",
            "password": "<string>"
          },
          "duckdbConnection": {
            "attachedDatabases": [
              {
                "name": "test_connection, _connection, test_connection_1",
                "attributes": {
                  "dialectName": "<string>",
                  "isPool": true,
                  "canPersist": true,
                  "canStream": true
                },
                "bigqueryConnection": {
                  "defaultProjectId": "<string>",
                  "billingProjectId": "<string>",
                  "location": "<string>",
                  "serviceAccountKeyJson": "<string>",
                  "maximumBytesBilled": "<string>",
                  "queryTimeoutMilliseconds": "<string>"
                },
                "snowflakeConnection": {
                  "account": "<string>",
                  "username": "<string>",
                  "password": "<string>",
                  "privateKey": "<string>",
                  "privateKeyPass": "<string>",
                  "warehouse": "<string>",
                  "database": "<string>",
                  "schema": "<string>",
                  "role": "<string>",
                  "responseTimeoutMilliseconds": 123
                },
                "postgresConnection": {
                  "host": "<string>",
                  "port": 123,
                  "databaseName": "<string>",
                  "userName": "<string>",
                  "password": "<string>",
                  "connectionString": "<string>"
                },
                "gcsConnection": {
                  "keyId": "<string>",
                  "secret": "<string>"
                },
                "s3Connection": {
                  "accessKeyId": "<string>",
                  "secretAccessKey": "<string>",
                  "region": "us-east-1",
                  "endpoint": "<string>",
                  "sessionToken": "<string>"
                },
                "azureConnection": {
                  "sasUrl": "<string>",
                  "tenantId": "<string>",
                  "clientId": "<string>",
                  "clientSecret": "<string>",
                  "accountName": "<string>",
                  "fileUrl": "<string>"
                }
              }
            ]
          },
          "motherduckConnection": {
            "accessToken": "<string>",
            "database": "<string>"
          },
          "ducklakeConnection": {
            "storage": {
              "bucketUrl": "<string>",
              "s3Connection": {
                "accessKeyId": "<string>",
                "secretAccessKey": "<string>",
                "region": "us-east-1",
                "endpoint": "<string>",
                "sessionToken": "<string>"
              },
              "gcsConnection": {
                "keyId": "<string>",
                "secret": "<string>"
              }
            },
            "catalog": {
              "postgresConnection": {
                "host": "<string>",
                "port": 123,
                "databaseName": "<string>",
                "userName": "<string>",
                "password": "<string>",
                "connectionString": "<string>"
              }
            }
          }
        }
      ],
      "packages": [
        {
          "resource": "<string>",
          "name": "<string>",
          "description": "<string>",
          "location": "<string>"
        }
      ]
    }
  ],
  "initialized": true,
  "frozenConfig": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.credibledata.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Returns server status

Current server status and health information

​
timestamp
number

Unix timestamp of the status check

​
projects
object[]

List of available projects

​
initialized
boolean

Whether the server is fully initialized and ready to serve requests

​
operationalState
enum<string>

Status of the server; initializing when the server is loading projects, packages and connections, serving when the server is initialized and ready to serve requests, and draining when the server is going to shut down

Available options:
initializing,
serving,
draining
​
frozenConfig
boolean

Whether the server configuration is frozen (read-only mode). When true, all mutation operations are disabled.