List availability events of a database

GET

/api/databases/managed/{id}/availability/events

curl --request GET \
  --url https://opfield.example.com/api/databases/managed/550e8400-e29b-41d4-a716-446655440000/availability/events \
  --header 'Authorization: Bearer <token>'

• Your Opfield instance

Failovers, switches, degraded and restored states, rejoins, rebuilds, witness moves, newest first. Needs databases:view.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Query Parameters

page

integer

>= 1

limit

integer

>= 1 <= 200

Responses

200

Successful response

Media typeapplication/json

object

data

required

Audit rows (action availability.<event>); createdAt is when it happened, also for events the servers queued while Opfield was down (details.noticedAt: when Opfield learned of it)

Array<object>

object

key

additional properties

page

required

number

limit

required

number

Example

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Production Postgres",
      "type": "postgres",
      "healthStatus": "online"
    }
  ]
}

400

Bad request

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}