Events

List Event Agents

An Event Agent represents a source of events. Agents are either well known, or remote.

Well-known agents are represented in the response list by an Id and Name:

{ "Id": "Server", "Name": "Octopus Server task" }

Remote agents are represented in the response list by their HTTP User-Agent:

{ "Id": "curl/8.7.1", "Name": "curl/8.7.1" }
get/events/agents

Request

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

Response

The requested event agents

Idstring

A well-known identifier for a source of Events, or the HTTP User-Agent of a remote client which generated one or more events.

Linksobject

The Links property is not set but exists for backwards compatibility

Namestring

A well-known name for a source of Events, or the HTTP User-Agent of a remote client which generated one or more events.

Example response

[
  {
    "Id": "curl/8.7.1",
    "Name": "curl/8.7.1"
  }
]

Changes

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