Interruptions

Submit a dictionary of form values for the interruption.

Only the user with responsibility for this interruption can submit this form.

post/interruptions/{id}/submit

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/interruptions/{id}/submit
  • 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

idstring required

ID of the Interruption

Request body

Guidancestring

Used for Guided Failure Interruptions. Should be one of "Fail", "Retry", "Ignore" or "Exclude"

Idstring required

ID of the Interruption

Instructionsstring

Optional free-text instructions recorded with the submission.

Notesstring

Optional notes recorded with the submission and included in the audit log entry.

Resultstring

Used for Manual Intervention Interruptions. Should be one of "Proceed" or "Abort"

SpaceIdstring required

ID of the Space

Example request

{
  "SpaceId": "Spaces-1"
}

Response

Confirms that the Interruption has been submitted successfully, containing the updated Interruption

CanTakeResponsibilityboolean

Gets or sets a value indicating whether the current user has permissions to take responsibility for this interruption.

CorrelationIdstring

Gets or sets the correlation ID of the activity in which the interruption was requested, if any.

Createdstring date-time

Gets the time at which the interruption was created.

HasResponsibilityboolean

Gets or sets a value indicating whether the current user has responsibility for this interruption.

Idstring

Gets or sets a unique identifier for this resource.

IsLinkedToOtherInterruptionboolean

If this interruption is linked to another it will be automatically completed when the other one is. Used to handle interruptions in child deployments.

IsPendingboolean

True if the interruption is waiting for user action; otherwise, false.

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.

RelatedDocumentIdsstring[]

Gets the ids of documents related to this interruption.

ResponsibleTeamIdsstring[]

Gets the ids of groups that can take responsibility for this interruption.

ResponsibleUserActorstring

Gets or sets the agent client (such as an MCP client) the responsible user acted through, typically in the same form as OAuth client. Null for other kinds of credential.

ResponsibleUserActorType'Unknown' | 'System' | 'User' | 'Agent' | 'ServiceAccount'

Gets or sets the kind of actor (user, service account, AI agent) that took responsibility for this interruption. Unknown when nobody has taken responsibility, or for interruptions claimed before this was recorded.

ResponsibleUserIdstring

Gets or sets the

SpaceIdstring
TaskIdstring

Gets or sets the id of the Server Task raising the interruption.

Titlestring

Gets or sets a title for this interruption.

Type'ManualIntervention' | 'GuidedFailure' | 'PullRequestCompletion' | 'ArgoCDApplicationSync' | 'KubernetesResourceVerification'

Gets or sets the type of interruption

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "PullRequests": [
    {
      "Id": "InterruptionPullRequests-1"
    }
  ],
  "SpaceId": "Spaces-1"
}

Changes

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