Deployments

Create a Deployment

post/deployments

Request

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

Request body

ChangesMarkdownstring
ChannelIdstring
Commentsstring
Createdstring date-time
DebugModestring
DeployedBystring
DeployedByActorType'Unknown' | 'System' | 'User' | 'Agent' | 'ServiceAccount'
DeployedByIdstring
DeployedToMachineIdsstring[]
DeploymentProcessIdstring
EnvironmentIdstring required
ExcludedMachineIdsstring[]

A collection of machines in the target environment that should be excluded from the deployment.

ExcludedTargetTagIdsstring[]

A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format "TagSets-{id}/Tags-{id}".

FailTargetDiscoveryboolean
FailureEncounteredboolean
ForcePackageDownloadboolean
ForcePackageRedeploymentboolean
FormValuesobject
Idstring

Gets or sets a unique identifier for this resource.

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.

ManifestVariableSetIdstring
Namestring
Prioritystring
ProjectIdstring
QueueTimestring date-time

If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately.

QueueTimeExpirystring date-time
ReleaseIdstring required
SkipActionsstring[]
SpaceIdstring
SpecificMachineIdsstring[]

A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.

SpecificTargetTagIdsstring[]

A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format "TagSets-{id}/Tags-{id}".

TaskIdstring
TenantIdstring
UseGuidedFailureboolean

If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable.

Example request

{
  "ChannelId": "Channels-1",
  "EnvironmentId": "Environments-1",
  "ExecutionPlanLogContext": {
    "Steps": [
      {
        "CorrelationId": "0c5a872485ac4b10857939a92d082e67"
      }
    ]
  },
  "Id": "Deployments-1",
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "ReleaseId": "Releases-1",
  "SpaceId": "Spaces-1",
  "TaskId": "ServerTasks-1",
  "TenantId": "Tenants-1"
}

Response

Created

ChangesMarkdownstring
ChannelIdstring
Commentsstring
Createdstring date-time
DebugModestring
DeployedBystring
DeployedByActorType'Unknown' | 'System' | 'User' | 'Agent' | 'ServiceAccount'
DeployedByIdstring
DeployedToMachineIdsstring[]
DeploymentProcessIdstring
EnvironmentIdstring required
ExcludedMachineIdsstring[]

A collection of machines in the target environment that should be excluded from the deployment.

ExcludedTargetTagIdsstring[]

A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format "TagSets-{id}/Tags-{id}".

FailTargetDiscoveryboolean
FailureEncounteredboolean
ForcePackageDownloadboolean
ForcePackageRedeploymentboolean
FormValuesobject
Idstring

Gets or sets a unique identifier for this resource.

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.

ManifestVariableSetIdstring
Namestring
Prioritystring
ProjectIdstring
QueueTimestring date-time

If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately.

QueueTimeExpirystring date-time
ReleaseIdstring required
SkipActionsstring[]
SpaceIdstring
SpecificMachineIdsstring[]

A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.

SpecificTargetTagIdsstring[]

A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format "TagSets-{id}/Tags-{id}".

TaskIdstring
TenantIdstring
UseGuidedFailureboolean

If set to true, the deployment will prompt for manual intervention (Fail/Retry/Ignore) when failures are encountered in activities that support it. May be overridden with the Octopus.UseGuidedFailure special variable.

Example response

{
  "ChannelId": "Channels-1",
  "EnvironmentId": "Environments-1",
  "ExecutionPlanLogContext": {
    "Steps": [
      {
        "CorrelationId": "0c5a872485ac4b10857939a92d082e67"
      }
    ]
  },
  "Id": "Deployments-1",
  "Links": {
    "Self": "/api/..."
  },
  "ProjectId": "Projects-1",
  "ReleaseId": "Releases-1",
  "SpaceId": "Spaces-1",
  "TaskId": "ServerTasks-1",
  "TenantId": "Tenants-1"
}

Changes

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