latestSwagger 2.02026-08-191,9198883.9 MB

b296c3a60aa5

AccessTokens1

Accounts41

ActionTemplates57

ApiKeys5

ApprovalPolicies10

Approvals8

Artifacts21

AuditStream2

Authentication2

AzureDevOps1

Branches21

BuildInformation15

Capabilities2

Certificates49

Channels52

CloudTemplate1

CommunityActionTemplates9

CompliancePolicies8

Configuration5

ConnectionAgents9

Dashboard6

DashboardConfiguration6

DeploymentFreeze8

DeploymentProcesses40

Deployments19

DeploymentSettings18

DeploymentTargets45

DeploymentTargetTags12

Deprecations2

DirectoryServices2

DynamicExtensions3

Environments47

EphemeralEnvironments16

EventRetention5

Events18

ExternalSecurityGroupProviders1

FeaturesConfiguration2

FeatureToggles14

Feeds27

GitHub34

Home2

Icons7

Insights43

IntegratedAuthentication1

Interruptions15

Invitations6

JiraIntegration2

JsonWebKeys1

LDAP2

LetsEncrypt2

LibraryVariableSets27

Licenses5

Lifecycles27

MachinePolicies30

MachineRoles6

Machines3

MaintenanceConfiguration3

Migrations2

Nuget2

Observability32

OctopusServerNodes8

OpenIdConnect1

OpenIDConnect15

OpenTelemetry2

Packages42

ParentEnvironments8

Performance2

Permissions1

PlatformHub46

ProcessTemplates14

Progression18

ProjectGroups21

Projects62

ProjectTemplates1

ProjectTriggers30

Proxies18

RateLimiting3

Releases68

Reporting3

Retention8

RolloutGroups10

RunbookProcesses30

RunbookRuns33

Runbooks115

RunbookSnapshots77

ScheduledJobs6

ScopedUserRoles15

Server3

ServerStatus9

ServerTaskApprovals6

ServiceAccountOidcIdentities5

Signing5

SlackIntegration8

Smtp5

Spaces49

SshKnownHosts3

Subscriptions18

TagSets21

Tasks36

TeamMemberships9

Teams21

Telemetry4

Tenants66

TokenExchange1

Upgrade2

UserPermissions9

UserRoles6

Users15

Variables27

VersionControl2

Web2

WorkerPools33

Workers33

WorkerTaskLeases2

Events

Get a single event by ID.

get/events/{id}

Path parameters

idstring required

The ID of the event

Response

The requested event

ApiKeyHintstring

Gets or sets the obfuscated hint of the API key used to authenticate the request, if applicable.

ApiKeyIdstring

Gets or sets the ID of the API key used to authenticate the request, if applicable.

Categorystring

Gets or sets the event category.

Commentsstring

Gets or sets any user-provided comments that were recorded with the event.

Detailsstring

Gets or sets the details of the event. For events representing a modification to a document use the ChangeDetails property.

Idstring

Gets or sets a unique identifier for this resource.

IdentityEstablishedWithstring

Gets or sets a description of how the user performing the event identified themselves to Octopus.

IpAddressstring

The IP address of the user that created the event.

IsServiceboolean

Gets or sets whether the user who created the event is a service user or an interactive user.

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.

Linksobject

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

Messagestring

Gets or sets the message text that summarizes the event.

MessageHtmlstring

Gets or sets the message text that summarizes the event, HTML formatted with links to the related documents.

Occurredstring date-time

Gets or sets the date/time that the event took place.

RelatedDocumentIdsstring[]

Gets or sets a collection of document ID's that this event relates to. Note that the document ID's may no longer exist.

SpaceIdstring

Gets or sets the SpaceId of the event. This represents the space in which the event was raised.

UserAgentstring

Gets or sets the user agent header value from the request that triggered the event

UserIdstring

Gets or sets the ID of the user who created the event.

Usernamestring

Gets or sets the name of the user who created the event.