Observability

Returns all logs

get

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

limitintegerOptional

offsetintegerOptional

orderBystringOptional

fromDatestring · date-timeOptional

toDatestring · date-timeOptional

serverContextstringOptional

logTypestringOptional

Responses

200

A list of logs

No content

get

/observability/v2/logs

HTTPcURLJavaScriptPython

GET /observability/v2/logs HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

A list of logs

No content

Returns logs archive

get

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

logIdsstringRequired

logFormatstringOptional

Responses

200

logs archive

No content

get

/observability/v2/logs/archive

HTTPcURLJavaScriptPython

GET /observability/v2/logs/archive?logIds=text HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

logs archive

No content

Returns logs credentials

get

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

providerstringRequired

The provider of the bucket

regionstringRequired

The region of the bucket

Responses

200

Log credentials object

No content

get

/observability/v2/logs/credentials

HTTPcURLJavaScriptPython

GET /observability/v2/logs/credentials?provider=text&region=text HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

Log credentials object

No content

Returns all logs

post

Authorizations

BearerAuth

X-API-KeystringRequired

Body

application/json

fromDatestring · date-timeOptional

The start date to filter logs

limitintegerOptional

The maximum number of logs to return

logTypestring[]Optional

The log types to filter logs

offsetintegerOptional

The number of logs to skip before starting to collect the result set

orderByDirectionstringOptional

The direction to order the logs (asc or desc)

orderByFieldstringOptional

The field to order the logs by

serverContextstring[]Optional

The server contexts to filter logs

toDatestring · date-timeOptional

The end date to filter logs

Responses

200

A list of logs

No content

post

/observability/v2/logs/query

HTTPcURLJavaScriptPython

POST /observability/v2/logs/query HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "fromDate": "2025-12-27T01:06:08.154Z",
  "limit": 1,
  "logType": [
    "text"
  ],
  "offset": 1,
  "orderByDirection": "text",
  "orderByField": "text",
  "serverContext": [
    "text"
  ],
  "toDate": "2025-12-27T01:06:08.154Z"
}

200

A list of logs

No content

Returns log retention information for a bucket

get

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

bucket_namestringRequired

providerstringRequired

Responses

200

Bucket information

No content

get

/observability/v2/logs/retention

HTTPcURLJavaScriptPython

GET /observability/v2/logs/retention?bucket_name=text&provider=text HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

Bucket information

No content

Updates retention policy for a bucket

post

Authorizations

BearerAuth

X-API-KeystringRequired

Body

application/json

bucket_namestringOptional

The name of the bucket

providerstringOptional

The provider of the bucket

retention_policy_daysintegerOptional

The number of days for the retention policy

Responses

200

Bucket information

No content

post

/observability/v2/logs/retention

HTTPcURLJavaScriptPython

POST /observability/v2/logs/retention HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "bucket_name": "text",
  "provider": "text",
  "retention_policy_days": 1
}

200

Bucket information

No content

Returns servers that have logs of certain types for given time period

get

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

fromDatestring · date-timeOptional

toDatestring · date-timeOptional

logTypestringOptional

Responses

200

A list of servers

No content

get

/observability/v2/logs/servers

HTTPcURLJavaScriptPython

GET /observability/v2/logs/servers HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

A list of servers

No content

Returns logs types supported by SkySQL Monitoring

get

Authorizations

BearerAuth

X-API-KeystringRequired

Responses

200

A list of log types

No content

get

/observability/v2/logs/types

HTTPcURLJavaScriptPython

GET /observability/v2/logs/types HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

200

A list of log types

No content

Returns client metrics presented according to the Prometheus data model

get

Authorizations

BearerAuth

X-API-KeystringRequired

Query parameters

servicestringOptional

The name of the service to filter metrics

Responses

200

A list of metrics

No content

400

Missing or invalid API key

get

/observability/v2/metrics

HTTPcURLJavaScriptPython

GET /observability/v2/metrics HTTP/1.1
Host: api.skysql.com/
X-API-Key: YOUR_API_KEY
Accept: */*

No content