DeploymentFreeze

Create a new deployment freeze.

put/deploymentfreezes/{id}

Request

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

Request body

Descriptionstring
Endstring date-time required
Idstring required
Namestring required
ProjectEnvironmentScopeobject
Startstring date-time required

Example request

{
  "TenantProjectEnvironmentScope": [
    {
      "EnvironmentId": "Environments-1",
      "ProjectId": "Projects-1",
      "TenantId": "Tenants-1"
    }
  ]
}

Response

Modifies an existing deployment freeze

Descriptionstring
Endstring date-time required
Idstring required
Namestring required
ProjectEnvironmentScopeobject
Startstring date-time required

Example response

{
  "TenantProjectEnvironmentScope": [
    {
      "EnvironmentId": "Environments-1",
      "ProjectId": "Projects-1",
      "TenantId": "Tenants-1"
    }
  ]
}

Changes