DeploymentFreeze

Override a deployment freeze to create a deployment.

post/deployments/override

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/deployments/override
  • 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

FreezeIdsstring[] required
Reasonstring required
SpaceIdstring required

Example request

{
  "CreateDeploymentCommand": {
    "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"
  },
  "SpaceId": "Spaces-1"
}

Response

Created

Example response

{
  "Deployment": {
    "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.