Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Events

List Events

Lists all the events information under a organization.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Project Creator
  • Project Owner
  • Project Manager
  • Project Viewer
  • Database Data Reader
  • Database Data Reader/Writer

The results are always limited by the role and scope of the caller's privileges. Currently, only the tags filter is multi-valued; all other filters are single-valued.

By default, to is set to the request time, and from is set to 24 hours before the request time. If 'to' is set and 'from' is not set, then 'from' is set to 24 hours before 'to'.

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/events

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: severity, timestamp.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

userIdsstring[]

Filter by user UUID. Default is to return events corresponding to all users.

[
  "ffffffff-aaaa-1414-eeee-000000000000"
]
clusterIdsstring[]

List of clusterIds to filter on. By default events corresponding to all clusters are returned.

[
  "ffffffff-aaaa-1414-eeee-000000000000"
]
projectIdsstring[]

The GUID4 ID of projects to filter on. By default, events corresponding to all projects are returned

[
  "ffffffff-aaaa-1414-eeee-000000000000"
]
severityLevelsstring[]

Filter by severity levels. Default is to return events corresponding to all supported severity levels.

tagsstring[]

Filter by tags. Default is to return events corresponding to all supported tag. Tags are availability, billing, maintenance, performance, security, alert.

fromstring date-time
Example:2024-04-24T12:53:59.000Z

Start date in RFC3339 format. If not provided, events starting from last 24 hours are returned.

tostring date-time
Example:2024-04-25T12:53:59.000Z

End datetime in the last 24 hours, RFC3339 format. Defaults to Now.

Response

Successfully listed the events under the organization.

Example response

{
  "data": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "source": "cp-jobs",
      "key": "cluster_deletion_completed",
      "severity": "info",
      "timestamp": "2024-04-29T09:00:23.475779856Z",
      "projectId": "ffffffff-aaaa-1414-eeee-000000000000",
      "projectName": "example-project",
      "clusterId": "ffffffff-aaaa-1414-eeee-000000000000",
      "clusterName": "example-cluster",
      "appServiceId": "ffffffff-aaaa-1414-eeee-000000000000",
      "appServiceName": "sample-appservice",
      "userId": "ffffffff-aaaa-1414-eeee-000000000000",
      "userName": "john",
      "userEmail": "john@example.com",
      "sessionId": "ffffffff-aaaa-1414-eeee-000000000000",
      "requestId": "ffffffff-aaaa-1414-eeee-000000000000",
      "summary": "Summary of the event occurred",
      "incidentIds": [
        "ffffffff-aaaa-1414-eeee-000000000000"
      ],
      "occurrenceCount": 2,
      "imageURL": "https://example.com",
      "alertKey": "cluster_down_example"
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}