Activity

List your organization's activity, newest first, narrowed by every filter you set. Access and security entries are included only when you may update the organization; other entries are included when you may read the project they belong to, or when they belong to no project. Returns a paginated collection with cursor metadata for fetching additional pages. Refused with 403 unless the activity-page feature flag is on for your organization.

Preview feature. Requires the activity-page feature flag to be enabled for your organization.

get/activity

Request

  • Base URL
    https://api.ravion.com
  • Auth
    HTTP bearer

Query parameters

cursorstring nullable
limitinteger nullable
occurredAfterstring date-time required

UTC RFC3339 timestamp with a required Z suffix

Only entries recorded at or after this time. Required: every Activity read is bounded in time, and it may be at most as far back as Activity is kept, 60 days by default.

occurredBeforestring date-time

UTC RFC3339 timestamp with a required Z suffix

Only entries recorded before this time. Defaults to now.

categoryEventsActivityCategory[] nullable

Categories to include. Omitted means every category you may read. Naming access without permission to update the organization is refused with 403.

eventstring[] nullable

Activity catalog ids to include, exactly as listActivityCatalog returns them. An id outside the activity catalog is refused with 400.

excludeEventstring[] nullable

Activity catalog ids to leave out.

identityActivityIdentityKey[] nullable

Identities to include.

excludeIdentityActivityIdentityKey[] nullable

Identities to leave out.

identityTypeEventsActivityIdentityKind[] nullable

Kinds of identity to include.

excludeIdentityTypeEventsActivityIdentityKind[] nullable

Kinds of identity to leave out.

projectIdstring[] nullable

Projects to include.

excludeProjectIdstring[] nullable

Projects to leave out.

environmentIdstring[] nullable

Environments to include.

excludeEnvironmentIdstring[] nullable

Environments to leave out.

pipelineIdstring[] nullable

Pipelines to include.

excludePipelineIdstring[] nullable

Pipelines to leave out.

moduleInstanceIdstring[] nullable

Module instances to include: entries about the module instance itself, its deployments, and the pipeline runs and steps that act on it.

subjectTypestring nullable

Only entries about one kind of resource, for example pipeline_run. Pair it with subjectId to read one resource's history.

subjectIdstring nullable

Only entries about the resource with this id. Pair it with subjectType.

resourceNamestring[] nullable

Resource names to include, as they were when each entry was recorded, compared case-insensitively. Entries keep the name a resource had, so a renamed or deleted resource is still found by its old name.

excludeResourceNamestring[] nullable

Resource names to leave out, compared case-insensitively.

statusEventsActivityStatus[] nullable

Outcomes to include.

ipstring[] nullable

Source IP addresses to include, exactly as recorded.

excludeIpstring[] nullable

Source IP addresses to leave out.

clientEventsActivityClient[] nullable

Clients to include.

excludeClientEventsActivityClient[] nullable

Clients to leave out.

requestIdstring[] nullable

Request ids to include, as returned in the responses of the requests that caused each entry.

correlationIdstring nullable

Only the entries one action caused, including work Ravion finished later on its own.

qstring[] nullable

Free-text words, compared case-insensitively. An entry matches when every word appears in who acted, its catalog id, the resource name, the project, environment or pipeline name, or the source IP address.

Response

The request has succeeded.

Changes

    • breaking

      added to the ////// response property oneOf list for the response status

    • info

      added execution_environment.budget.exceeded execution_environment.budget.warning discriminator mapping keys to the ////// response property for the response status