OCoctopus
Deployments

Create a new tenanted deployment.

post/spaces/{spaceIdentifier}/deployments/create/tenanted/v1

Request

Path parameters

spaceIdentifierstring required

Identifier (ID or slug) of the space

Request body

DebugModestring

Contributes the OctopusPrintVariables and OctopusPrintEvaluatedVariables variables to the execution. One of "None", "Log" or "Debug"; leave unset for the default of "None".

DeploymentFreezeNamesstring[]

Active deployment freezes to override so this execution can proceed despite them. Overriding a freeze bypasses a deliberate block on deploying, so only set this when explicitly asked to. Requires DeploymentFreezeOverrideReason.

DeploymentFreezeOverrideReasonstring

Required, and must not be blank, whenever DeploymentFreezeNames is non-empty. Recorded against the override.

EnvironmentNamestring required

A single environment. To deploy to several, call the command once per environment.

ExcludedMachineNamesstring[]

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

ExcludedTargetTagNamesstring[]

A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be excluded from the deployment.

ForcePackageDownloadboolean

Whether to force downloading of already installed packages (flag, default false).

ForcePackageRedeploymentboolean

If a project is configured to skip packages with already-installed versions, override this setting to force re-deployment (flag, default false).

NoRunAfterstring date-time

Time at which a scheduled execution should expire if it has not started, specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone. Only meaningful alongside RunAt.

Prioritystring

Whether this execution jumps the task queue ahead of other queued tasks. One of "LifecycleDefault" (use the lifecycle's configured setting), "On" or "Off".

ProjectNamestring required
ReleaseVersionstring required

The version of an existing release, for example "1.2.3" — not a release ID.

RunAtstring date-time

Time at which the execution should start (scheduling it for later), specified as any valid DateTimeOffset format, and assuming the time zone is the current local time zone.

SkipStepNamesstring[]

Steps that are to be skipped for this execution. A name that matches no step is logged as a warning rather than failing the command, so check the step name carefully.

SpaceIdstring required
SpaceIdOrNamestring required

Both this and SpaceId are required, and normally hold the same space ID; set both.

SpecificMachineNamesstring[]

A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed. A name that matches no machine fails the command.

SpecificTargetTagNamesstring[]

A collection of deployment target tags (canonical names in format TagSetName/TagName) that should be included in the deployment.

Tenantsstring[]

The tenants to deploy for; one deployment is created per tenant. Set this or TenantTags — with both empty nothing is deployed and no error is raised. The single entry "*" means every tenant that can be deployed to this environment, which may be a very large number — only use it when explicitly asked to deploy to all tenants.

TenantTagsstring[]

Tenant tags, in canonical "TagSetName/TagName" form, selecting the tenants to deploy for. Set this or Tenants — with both empty nothing is deployed and no error is raised.

UpdateVariableSnapshotboolean

If set to true, the release's variable set snapshot is updated from the project's current variables before the deployment. This mutates the release itself, so it affects later deployments of it too — leave it unset unless refreshed variables were asked for.

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.

Variablesobject

Name/value pairs for prompted variables. A prompted variable that is required and has no value supplied here fails the command, naming the variable.

Example request

{
  "SpaceId": "Spaces-1"
}

Response

Server tasks associated with the newly-created Deployment

Example response

{
  "DeploymentServerTasks": [
    {
      "DeploymentId": "Deployments-1",
      "ServerTaskId": "ServerTasks-1"
    }
  ]
}

Changes

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