LogoGitpod API Reference

Events

events

Methods

List Audit Logs -> EntriesPage<{ id, action, actorId, 4 more... }>
post/gitpod.v1.EventService/ListAuditLogs

Lists audit logs with filtering and pagination options.

Use this method to:

  • View audit history
  • Track user actions
  • Monitor system changes

Examples

  • List all logs:

    pagination:
  pageSize: 20

  • Filter by actor:

    filter:
  actorIds: ["d2c94c27-3b76-4a42-b88c-95a85e392c68"]
  actorPrincipals: ["PRINCIPAL_USER"]
pagination:
  pageSize: 20
Watch Events -> { operation, resourceId, resourceType }
post/gitpod.v1.EventService/WatchEvents

Streams events for all projects, runners, environments, tasks, and services based on the specified scope.

Use this method to:

  • Monitor resource changes in real-time
  • Track system events
  • Receive notifications

The scope parameter determines which events to watch:

  • Organization scope (default): Watch all organization-wide events including projects, runners and environments. Task and service events are not included. Use by setting organization=true or omitting the scope.
  • Environment scope: Watch events for a specific environment, including its tasks, task executions, and services. Use by setting environment_id to the UUID of the environment to watch.
Response fields
operation:
ResourceOperation
Optional
resourceId: string
Optional
(format: uuid)
resourceType:
ResourceType
Optional
Request example

Domain types

ResourceOperation = "RESOURCE_OPERATION_UNSPECIFIED" | "RESOURCE_OPERATION_CREATE" | "RESOURCE_OPERATION_UPDATE" | 2 more...
ResourceType = "RESOURCE_TYPE_UNSPECIFIED" | "RESOURCE_TYPE_ENVIRONMENT" | "RESOURCE_TYPE_RUNNER" | 16 more...