Events

List Events

A list of all audit events collected to date, ordered by the date of the event in descending order. Events can be filtered by various criteria and can be returned as a csv file when the optional parameter 'asCsv' is set to true.

get/spaces/{spaceIdentifier}/events

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/events
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

Query parameters

asCsvboolean

Returns list of events as a csv file when set to true

documentTypesstring[]

The document types to be matched, provided as a comma separated list of strings

environmentsstring[]

The environment ids to be matched, provided as a comma separated list of strings

eventAgentsstring[]

The event agents to be matched, provided as a comma separated list of strings

eventCategoriesstring[]

The event categories to be matched, provided as a comma separated list of strings

eventGroupsstring[]

The event groups to be matched, provided as a comma separated list of strings

excludeDifferenceboolean

Omits the change details of all events when set to true

fromstring date-time

Filter events that occurred after this datetime

fromAutoIdinteger

Filter events after specified autoId

idsstring

The event ids to be matched, provided as a comma separated list of strings

includeInternalEventsboolean

Exclude the machine-related CRUD events that were added for auto-deploy events

projectGroupsstring[]

The project group ids to be matched, provided as a comma separated list of strings

projectsstring[]

The project ids to be matched, provided as a comma separated list of strings

regardingstring[]

The related document ids to be matched, provided as a comma separated list of strings

regardingAnystring[]

The related document ids to be matched, provided as a comma separated list of strings

skipinteger

Number of items to skip. Defaults to zero

tagsstring[]

The canonical tag ids to be matched, provided as a comma separated list of strings

takeinteger

Number of items to take. Defaults to 30

tenantsstring[]

The tenant ids to be matched, provided as a comma separated list of strings

tostring date-time

Filter events that occurred before this datetime

toAutoIdinteger

Filter events before specified autoId

userstring
usersstring[]

The user ids to be matched, provided as a comma separated list of strings

Response

A paginated list of events, unless AsCsv is true, in which case a text/csv file is returned

Idstring

Gets or sets a unique identifier for this resource.

ItemsPerPageinteger
ItemTypestring

The type of item in this list

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastPageNumberinteger
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

NumberOfPagesinteger
TotalResultsinteger

Example response

{
  "Items": [
    {
      "Actor": "Claude (client_id: https://claude.ai/oauth/mcp-oauth-client-metadata, redirect_uri: https://claude.ai/api/mcp/auth_callback)",
      "ActorOAuthClient": {
        "ClientId": "https://claude.ai/oauth/mcp-oauth-client-metadata",
        "ClientName": "Claude",
        "RedirectUri": "https://claude.ai/api/mcp/auth_callback"
      },
      "ActorType": "Agent",
      "Category": "Modified",
      "ChangeDetails": {
        "Differences": [
          {
            "path": "/IsDisabled",
            "op": "replace",
            "value": true
          }
        ],
        "DocumentContext": {
          "Id": "Tenants-1",
          "Name": "ExampleTenant"
        }
      },
      "IdentityEstablishedWith": "Session cookie",
      "IpAddress": "127.0.0.1",
      "Links": {
        "Self": "/api/..."
      },
      "Message": "Tenant ExampleTenant was modified",
      "MessageHtml": "Tenant ExampleTenant was modified",
      "OnBehalfOf": "Users-1",
      "RelatedDocumentIds": [
        "Tenants-1"
      ],
      "SpaceId": "Spaces-1",
      "UserAgent": "OctopusClient-js/2026.3.15581",
      "UserId": "Users-1",
      "Username": "MyUserName"
    }
  ],
  "ItemsPerPage": 30,
  "ItemType": "Event",
  "LastPageNumber": 1,
  "Links": {
    "Self": "/api/..."
  },
  "NumberOfPages": 2,
  "TotalResults": 42
}

Changes

No recorded changes to this operation across all 13 revisions of this API.