Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Events

Get Project Event

Fetches the details of an event by ID within a project.

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

  • Organization Owner
  • 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.

To learn more, see Organization Roles.

get/v4/organizations/{organizationId}/projects/{projectId}/events/{eventId}

Response

Successfully returned the event details.

idstring uuid required

UUID for this instance of an Event.

sourcestring required

Identifies the originator of the event.

keystring required

Defines the specific kind of Event.

severitystring required

Severity of the event.

timestampstring date-time required

Time when the event was emitted.

projectIdstring uuid

ProjectID this Event refers to.

projectNamestring

Name of the project at the time of event emission.

clusterIdstring uuid

ClusterID this Event refers to.

clusterNamestring

Name of the cluster at the time of event emission.

appServiceIdstring uuid

SyncGatewayID this Event refers to.

appServiceNamestring

Name of the sync gateway at the time of event emission.

userIdstring

User id that initiated the request for this Event.

userNamestring

Name of the associated user at the time of event emission.

userEmailstring

Email of the associated user at the time of event emission.

sessionIdstring uuid

User that initiated the request for this Event.

requestIdstring uuid

RequestID for an Event.

kvobject

Key-value pairs for additional event data.

summarystring

Metadata.SummaryTemplate rendered for this event.

incidentIdsstring[]

Group events related to an alert incident.

occurrenceCountinteger

Number of times the alert has fired within this "incident".

imageURLstring

Rendered chart image to display for an Alert Event.

alertKeystring

Populated on demand based on the Event.Key and select labels in KV.

Example response

{
  "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"
}