---
title: "Create a Deployment"
method: POST
path: "/deployments"
tags: ["Deployments"]
---

# Create a Deployment

`POST /deployments`

## Request body

- CreateDeploymentCommand
  - `ChangeRequestSettings` ChangeRequestSettings[]
    - `Type` 'ServiceNow' | 'JiraServiceManagement'
  - `Changes` ReleaseChangesResource[]
    - `BuildInformation` ReleasePackageVersionBuildInformation[]
      - `Branch` string
      - `BuildEnvironment` string
      - `BuildNumber` string
      - `BuildUrl` string
      - `Commits` CommitDetails[]
        - `Comment` string
        - `Id` string
        - `LinkUrl` string
      - `PackageId` string
      - `VcsCommitNumber` string
      - `VcsCommitUrl` string
      - `VcsRoot` string
      - `VcsType` string
      - `Version` string
      - `WorkItems` WorkItemLink[]
        - `Description` string
        - `Id` string
        - `LinkUrl` string
        - `Source` string
    - `Commits` CommitDetails[]
      - `Comment` string
      - `Id` string
      - `LinkUrl` string
    - `ReleaseNotes` string
    - `Version` string
    - `WorkItems` WorkItemLink[]
      - `Description` string
      - `Id` string
      - `LinkUrl` string
      - `Source` string
  - `ChangesMarkdown` string
  - `ChannelId` string
  - `Comments` string
  - `Created` string, date-time
  - `DebugMode` string
  - `DeployedBy` string
  - `DeployedById` string
  - `DeployedToMachineIds` string[]
  - `DeploymentProcessId` string
  - `EnvironmentId` string, required
  - `ExcludedMachineIds` string[]
  - `ExcludedTargetTagIds` string[]
  - `ExecutionPlanLogContext` ExecutionPlanLogContext
    - `Steps` StepLogContext[], required
      - `CorrelationId` string, required
      - `Slug` string, required
  - `FailTargetDiscovery` boolean
  - `FailureEncountered` boolean
  - `ForcePackageDownload` boolean
  - `ForcePackageRedeployment` boolean
  - `FormValues` object
  - `Id` string
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `Links` object
  - `ManifestVariableSetId` string
  - `Name` string
  - `Priority` string
  - `ProjectId` string
  - `QueueTime` string, date-time
  - `QueueTimeExpiry` string, date-time
  - `ReleaseId` string, required
  - `SkipActions` string[]
  - `SpaceId` string
  - `SpecificMachineIds` string[]
  - `SpecificTargetTagIds` string[]
  - `TaskId` string
  - `TenantId` string
  - `TentacleRetentionPeriod` RetentionPeriod
    - `QuantityToKeep` integer
    - `ShouldKeepForever` boolean
    - `Strategy` string
    - `Unit` 'Days' | 'Items'
  - `UseGuidedFailure` boolean

## Response `201`

Created

- DeploymentResource
  - `ChangeRequestSettings` ChangeRequestSettings[]
    - `Type` 'ServiceNow' | 'JiraServiceManagement'
  - `Changes` ReleaseChangesResource[]
    - `BuildInformation` ReleasePackageVersionBuildInformation[]
      - `Branch` string
      - `BuildEnvironment` string
      - `BuildNumber` string
      - `BuildUrl` string
      - `Commits` CommitDetails[]
        - `Comment` string
        - `Id` string
        - `LinkUrl` string
      - `PackageId` string
      - `VcsCommitNumber` string
      - `VcsCommitUrl` string
      - `VcsRoot` string
      - `VcsType` string
      - `Version` string
      - `WorkItems` WorkItemLink[]
        - `Description` string
        - `Id` string
        - `LinkUrl` string
        - `Source` string
    - `Commits` CommitDetails[]
      - `Comment` string
      - `Id` string
      - `LinkUrl` string
    - `ReleaseNotes` string
    - `Version` string
    - `WorkItems` WorkItemLink[]
      - `Description` string
      - `Id` string
      - `LinkUrl` string
      - `Source` string
  - `ChangesMarkdown` string
  - `ChannelId` string
  - `Comments` string
  - `Created` string, date-time
  - `DebugMode` string
  - `DeployedBy` string
  - `DeployedById` string
  - `DeployedToMachineIds` string[]
  - `DeploymentProcessId` string
  - `EnvironmentId` string, required
  - `ExcludedMachineIds` string[]
  - `ExcludedTargetTagIds` string[]
  - `ExecutionPlanLogContext` ExecutionPlanLogContext
    - `Steps` StepLogContext[], required
      - `CorrelationId` string, required
      - `Slug` string, required
  - `FailTargetDiscovery` boolean
  - `FailureEncountered` boolean
  - `ForcePackageDownload` boolean
  - `ForcePackageRedeployment` boolean
  - `FormValues` object
  - `Id` string
  - `LastModifiedBy` string
  - `LastModifiedOn` string, date-time
  - `Links` object
  - `ManifestVariableSetId` string
  - `Name` string
  - `Priority` string
  - `ProjectId` string
  - `QueueTime` string, date-time
  - `QueueTimeExpiry` string, date-time
  - `ReleaseId` string, required
  - `SkipActions` string[]
  - `SpaceId` string
  - `SpecificMachineIds` string[]
  - `SpecificTargetTagIds` string[]
  - `TaskId` string
  - `TenantId` string
  - `TentacleRetentionPeriod` RetentionPeriod
    - `QuantityToKeep` integer
    - `ShouldKeepForever` boolean
    - `Strategy` string
    - `Unit` 'Days' | 'Items'
  - `UseGuidedFailure` boolean

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)