List health-check logs with filtering and pagination

GET

/api/environments/{envId}/health-logs

const url = 'https://example.com/api/environments/example/health-logs?type=server&checkType=ssh&status=success&hours=24&page=1&limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/environments/example/health-logs?type=server&checkType=ssh&status=success&hours=24&page=1&limit=50' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

envId

required

string

Query Parameters

type

string

Allowed values: server service container

checkType

string

Allowed values: ssh url container_health discovery

status

string

Allowed values: success failure timeout

resourceId

string

hours

number

default: 24 >= 1 <= 168

page

number

default: 1 >= 1

limit

number

default: 50 >= 1 <= 100

Responses

400

Bad request — malformed input or failed validation.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

401

Unauthorized — missing or invalid bearer token.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}

404

Not found.

application/json

object

code

Stable, machine-readable error code. Always present on the wire.

string

Allowed values: VALIDATION_ERROR READONLY_FIELD UNAUTHORIZED FORBIDDEN_SCOPE FORBIDDEN_ROLE NOT_FOUND CONFLICT IDEMPOTENCY_KEY_REUSED RATE_LIMITED SERVICE_UNAVAILABLE INTERNAL

message

Human-readable error message. Always present on the wire.

string

field

Field name when the error is tied to a specific input (e.g. validation).

string

hint

Optional, human-friendly hint for resolving the error.

string

requestId

Server-assigned request ID; quote this when reporting issues.

string

key

additional properties

any

Example

{
  "code": "READONLY_FIELD",
  "message": "Field \"exposedPorts\" is read-only and cannot be set via PATCH.",
  "field": "exposedPorts",
  "hint": "Exposed ports are discovered from the running container. Change the ports mapping in the compose file at composePath and redeploy.",
  "requestId": "req_01H0…"
}