GET /bsus/api/v1/events - Adaptive Applications - BlueCat Gateway - 23.1

BlueCat Server Update Services Administration Guide
Locale
English
Product name
BlueCat Gateway
Version
23.1

Description

Retrieves event list items.

Parameters

Name Description
page

(Optional)

 Location: query

Type: integer

The page number to return. The value must be greater than 0.
size Location: query

Type: integer

The page size. The value must be greater than 0.
q Location: query

Type: string

The search query.

Responses

Status Description
Successful

Code: 200

Return the list of events.

Body:

An array of the following:

{
  "data": {
    "items": [
      {
        "id": "string",
        "dispatched_at": int,
        "server": "string",
        "batch": "string",
        "summary": "string",
        "status": int,
        "user": "string"
      },
    ],
    "total": int
  }
}
Returned event data items have the following fields.
  • id: The event's ID.
  • dispatched_at: The timestamp when the event took place.
  • server: The server associated with the event (if any).
  • batch: The Server Batch associated with the event (if any).
  • summary: Event summary.
  • status: Status ID associated with the event.
  • user: The user associated with the event (if any).
Error

Code: 500

Internal server error.

Body: 
{
  "error": "string"
}

This can be caused when an unknown application error is encountered on the Server side. The API attempts to return additional details within the error parameter.