Lifecycles

List the Lifecycles in the supplied Octopus Deploy Space in pages. The results will be sorted alphabetically by name

GET /api/{spaceId}/lifecycles

Also reachable at /api/lifecycles, /api/spaces/{spaceIdentifier}/lifecycles.

Path Parameters

spaceId string (required)

Query Parameters

ids array of string
name string
The exact name of a Lifecycle to be matched.
partialName string
skip integer
Number of items to skip. Defaults to zero. Minimum 0.
take integer
Number of items to take. Defaults to 30. Minimum 0.

Response

200 — A paginated list of lifecycles

Id string
Gets or sets a unique identifier for this resource.
ItemType string
Items array of object
- Description string
- Id string
  Gets or sets a unique identifier for this resource.
- LastModifiedBy string
  Gets or sets the username of the user who last modified this resource.
- LastModifiedOn string
  Gets or sets the date/time that this resource was last modified. Format date-time.
- Links object
  Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
- Name string
- Phases array of object
- ReleaseRetentionPolicy object
- Slug string
- SpaceId string
- TentacleRetentionPolicy object
ItemsPerPage integer
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LastPageNumber integer
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
NumberOfPages integer
TotalResults integer

{
  "Id": "string",
  "ItemType": "string",
  "Items": [
    {
      "Description": "string",
      "Id": "string",
      "LastModifiedBy": "string",
      "LastModifiedOn": "2020-01-01T00:00:00.000Z",
      "Links": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      },
      "Name": "string",
      "Phases": [
        {}
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "Slug": "string",
      "SpaceId": "string",
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ItemsPerPage": 0,
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "LastPageNumber": 0,
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "NumberOfPages": 0,
  "TotalResults": 0
}

Create a new Lifecycle

POST /api/{spaceId}/lifecycles

Also reachable at /api/lifecycles, /api/spaces/{spaceIdentifier}/lifecycles.

Path Parameters

spaceId string (required)
The id of the Space for the Lifecycle.

Request Body

Description string
A description of the Lifecycle.
Name string (required)
The name of the Lifecycle. Minimum length 1.
Phases array of object
The promotion phases in order. Each phase lists environments deployed to automatically (AutomaticDeploymentTargets) or manually (OptionalDeploymentTargets); an environment may appear in only one phase, and at most one phase may list no environments, meaning all remaining environments. MinimumEnvironmentsBeforePromotion is how many of the phase’s environments must be deployed before a release can progress (0 means all). IsOptionalPhase allows skipping the phase, but not every phase may be optional. Per-phase retention policies override the lifecycle-level ones. Leave each phase’s Id blank; the server assigns it.
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
A slug for the Lifecycle.
SpaceId string (required)
The id of the Space for the Lifecycle.
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

Response

201 — Created

Description string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Phases array of object
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
SpaceId string
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

{
  "Description": "string",
  "Name": "string",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "string"
      ],
      "Id": "string",
      "IsOptionalPhase": true,
      "IsPriorityPhase": true,
      "MinimumEnvironmentsBeforePromotion": 0,
      "Name": "string",
      "OptionalDeploymentTargets": [
        "string"
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ReleaseRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  },
  "Slug": "string",
  "SpaceId": "string",
  "TentacleRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  }
}

{
  "Description": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "string"
      ],
      "Id": "string",
      "IsOptionalPhase": true,
      "IsPriorityPhase": true,
      "MinimumEnvironmentsBeforePromotion": 0,
      "Name": "string",
      "OptionalDeploymentTargets": [
        "string"
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ReleaseRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  },
  "Slug": "string",
  "SpaceId": "string",
  "TentacleRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  }
}

List all the lifecycles in the supplied Octopus Deploy Space

GET /api/{spaceId}/lifecycles/all

Also reachable at /api/lifecycles/all, /api/spaces/{spaceIdentifier}/lifecycles/all.

Path Parameters

spaceId string (required)

Response

200 — All of the lifecycles in the supplied Octopus Deploy Space.

Description string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Phases array of object
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
SpaceId string
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

[
  {
    "Description": "string",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "Phases": [
      {
        "AutomaticDeploymentTargets": [
          "string"
        ],
        "Id": "string",
        "IsOptionalPhase": true,
        "IsPriorityPhase": true,
        "MinimumEnvironmentsBeforePromotion": 0,
        "Name": "string",
        "OptionalDeploymentTargets": [
          "string"
        ],
        "ReleaseRetentionPolicy": {},
        "TentacleRetentionPolicy": {}
      }
    ],
    "ReleaseRetentionPolicy": {
      "QuantityToKeep": 0,
      "ShouldKeepForever": true,
      "Strategy": "string",
      "Unit": "Days"
    },
    "Slug": "string",
    "SpaceId": "string",
    "TentacleRetentionPolicy": {
      "QuantityToKeep": 0,
      "ShouldKeepForever": true,
      "Strategy": "string",
      "Unit": "Days"
    }
  }
]

Get a list of Lifecycle previews

GET /api/{spaceId}/lifecycles/previews

Also reachable at /api/lifecycles/previews, /api/spaces/{spaceIdentifier}/lifecycles/previews.

Path Parameters

spaceId string (required)
The Space ID of the Lifecycles.

Query Parameters

ids array of string (required)
The IDs of the Lifecycles to retrieve.

Response

200 — Get a list of Lifecycle previews

Description string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Phases array of object
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
SpaceId string
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

[
  {
    "Description": "string",
    "Id": "string",
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "Phases": [
      {
        "AutomaticDeploymentTargets": [
          "string"
        ],
        "Id": "string",
        "IsOptionalPhase": true,
        "IsPriorityPhase": true,
        "MinimumEnvironmentsBeforePromotion": 0,
        "Name": "string",
        "OptionalDeploymentTargets": [
          "string"
        ],
        "ReleaseRetentionPolicy": {},
        "TentacleRetentionPolicy": {}
      }
    ],
    "ReleaseRetentionPolicy": {
      "QuantityToKeep": 0,
      "ShouldKeepForever": true,
      "Strategy": "string",
      "Unit": "Days"
    },
    "Slug": "string",
    "SpaceId": "string",
    "TentacleRetentionPolicy": {
      "QuantityToKeep": 0,
      "ShouldKeepForever": true,
      "Strategy": "string",
      "Unit": "Days"
    }
  }
]

Get a specific Lifecycle

GET /api/{spaceId}/lifecycles/{id}

Also reachable at /api/lifecycles/{id}, /api/spaces/{spaceIdentifier}/lifecycles/{id}.

This request does not support getting Lifecycles that belong to Templated Projects

Path Parameters

id string (required)
spaceId string (required)

Response

200 — The requested Lifecycle

Description string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Phases array of object
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
SpaceId string
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

{
  "Description": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "string"
      ],
      "Id": "string",
      "IsOptionalPhase": true,
      "IsPriorityPhase": true,
      "MinimumEnvironmentsBeforePromotion": 0,
      "Name": "string",
      "OptionalDeploymentTargets": [
        "string"
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ReleaseRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  },
  "Slug": "string",
  "SpaceId": "string",
  "TentacleRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  }
}

Modify a Lifecycle

PUT /api/{spaceId}/lifecycles/{id}

Also reachable at /api/lifecycles/{id}, /api/spaces/{spaceIdentifier}/lifecycles/{id}.

Path Parameters

id string (required)
The Id of the Lifecycle to modify.
spaceId string (required)
The id of the Space for the Lifecycle.

Request Body

Description string
A description of the Lifecycle.
Id string (required)
The Id of the Lifecycle to modify.
Name string (required)
The name of the Lifecycle. Minimum length 1.
Phases array of object
The complete list of promotion phases in order; existing phases not resubmitted are deleted. Each phase lists environments deployed to automatically (AutomaticDeploymentTargets) or manually (OptionalDeploymentTargets); an environment may appear in only one phase, and at most one phase may list no environments, meaning all remaining environments. MinimumEnvironmentsBeforePromotion is how many of the phase’s environments must be deployed before a release can progress (0 means all). IsOptionalPhase allows skipping the phase, but not every phase may be optional. Per-phase retention policies override the lifecycle-level ones.
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
The slug of the Lifecycle.
SpaceId string (required)
The id of the Space for the Lifecycle.
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

Response

200 — Contains a Lifecycle resource which represents changes to the Lifecycle.

Description string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Phases array of object
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
SpaceId string
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

{
  "Description": "string",
  "Id": "string",
  "Name": "string",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "string"
      ],
      "Id": "string",
      "IsOptionalPhase": true,
      "IsPriorityPhase": true,
      "MinimumEnvironmentsBeforePromotion": 0,
      "Name": "string",
      "OptionalDeploymentTargets": [
        "string"
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ReleaseRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  },
  "Slug": "string",
  "SpaceId": "string",
  "TentacleRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  }
}

{
  "Description": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "string"
      ],
      "Id": "string",
      "IsOptionalPhase": true,
      "IsPriorityPhase": true,
      "MinimumEnvironmentsBeforePromotion": 0,
      "Name": "string",
      "OptionalDeploymentTargets": [
        "string"
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ReleaseRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  },
  "Slug": "string",
  "SpaceId": "string",
  "TentacleRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  }
}

Delete an existing Lifecycle

DELETE /api/{spaceId}/lifecycles/{id}

Also reachable at /api/lifecycles/{id}, /api/spaces/{spaceIdentifier}/lifecycles/{id}.

Path Parameters

id string (required)
The ID of the lifecycle to delete.
spaceId string (required)
The ID of the space containing the resource(s).

Response

200 — Success

{}

Get a Lifecycle preview by Lifecycle id

GET /api/{spaceId}/lifecycles/{id}/preview

Also reachable at /api/lifecycles/{id}/preview, /api/spaces/{spaceIdentifier}/lifecycles/{id}/preview.

Path Parameters

id string (required)
The id of the Lifecycle.
spaceId string (required)
The id of the space for the Lifecycle.

Response

200 — Returns a Lifecycle preview

Description string
Id string
Gets or sets a unique identifier for this resource.
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
Phases array of object
- AutomaticDeploymentTargets array of string
- Id string
- IsOptionalPhase boolean
- IsPriorityPhase boolean
- MinimumEnvironmentsBeforePromotion integer
- Name string
- OptionalDeploymentTargets array of string
- ReleaseRetentionPolicy object
- TentacleRetentionPolicy object
ReleaseRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.
Slug string
SpaceId string
TentacleRetentionPolicy object
- QuantityToKeep integer
- ShouldKeepForever boolean
- Strategy string
- Unit enum
  Allowed values: Days, Items.

{
  "Description": "string",
  "Id": "string",
  "LastModifiedBy": "string",
  "LastModifiedOn": "2020-01-01T00:00:00.000Z",
  "Links": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "Name": "string",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "string"
      ],
      "Id": "string",
      "IsOptionalPhase": true,
      "IsPriorityPhase": true,
      "MinimumEnvironmentsBeforePromotion": 0,
      "Name": "string",
      "OptionalDeploymentTargets": [
        "string"
      ],
      "ReleaseRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      },
      "TentacleRetentionPolicy": {
        "QuantityToKeep": 0,
        "ShouldKeepForever": true,
        "Strategy": "string",
        "Unit": "Days"
      }
    }
  ],
  "ReleaseRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  },
  "Slug": "string",
  "SpaceId": "string",
  "TentacleRetentionPolicy": {
    "QuantityToKeep": 0,
    "ShouldKeepForever": true,
    "Strategy": "string",
    "Unit": "Days"
  }
}

Get all projects that use this lifecycle

GET /api/{spaceId}/lifecycles/{id}/projects

Also reachable at /api/lifecycles/{id}/projects, /api/spaces/{spaceIdentifier}/lifecycles/{id}/projects.

Path Parameters

id string (required)
The id of the Lifecycle.
spaceId string (required)
The id of the space for the Lifecycle and projects.

Response

200 — Get all projects that use this lifecycle.

AllowIgnoreChannelRules boolean
AutoCreateRelease boolean
AutoDeployReleaseOverrides array of object
- EnvironmentId string
- ReleaseId string
- TenantId string
ClonedFromProjectId string
CombineHealthAndSyncStatusInDashboardLiveStatus boolean
DefaultGuidedFailureMode enum
Allowed values: EnvironmentDefault, Off, On.
DefaultPowerShellEdition string
DefaultToSkipIfAlreadyInstalled boolean
DeploymentChangesTemplate string
DeploymentProcessId string
DeprovisioningRunbookId string
Description string
DiscreteChannelRelease boolean
Treats releases of different channels to the same environment as a seperate deployment dimension. ‘False’ indicates a “hotfix”-style usage of channels (single release active per environment ignoring channels), whereas True indicates “microservice”-style usage (single release per environment per channel).
ExecuteDeploymentsOnEventBasedPipeline boolean
ExtensionSettings array of object
- ExtensionId string
- Values string
ForcePackageDownload boolean
Icon object
- Color string
  Icon background colour, as a Hex string.
- Id string
  Font Awesome Icon Id.
Id string
Gets or sets a unique identifier for this resource.
IncludedLibraryVariableSetIds array of string
Library variable sets included in the project. Sets are listed in order of precedence, with earlier items in the list overriding any variables with the same name and scope definition appearing later in the list.
IsBadgesEnabled boolean
IsDisabled boolean
IsVersionControlled boolean
LastModifiedBy string
Gets or sets the username of the user who last modified this resource.
LastModifiedOn string
Gets or sets the date/time that this resource was last modified. Format date-time.
LifecycleId string
Links object
Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
Name string
PersistenceSettings object
- Type enum
  Allowed values: Database, VersionControlled.
ProjectConnectivityPolicy object
- AllowDeploymentsToNoTargets boolean
- ExcludeUnhealthyTargets boolean
- SkipMachineBehavior enum
  Allowed values: None, SkipUnavailableMachines.
- TargetRoles array of string
ProjectGroupId string
ProjectTags array of string
List of tags assigned to this project.
ProjectTemplateDetails object
- IsShared boolean
- Slug string
- VersionMask string
  Minimum length 1.
ProvisioningRunbookId string
ReleaseCreationStrategy object
- ChannelId string
- ReleaseCreationPackage object
ReleaseNotesTemplate string
Slug string
SpaceId string
Templates array of object
- DefaultValue object
- DisplaySettings object
- HelpText string
- Id string
- Label string
- Name string
TenantedDeploymentMode enum
Allowed values: Untenanted, TenantedOrUntenanted, Tenanted.
VariableSetId string
VersioningStrategy object
- DonorPackage object
- Template string

[
  {
    "AllowIgnoreChannelRules": true,
    "AutoCreateRelease": true,
    "AutoDeployReleaseOverrides": [
      {
        "EnvironmentId": "string",
        "ReleaseId": "string",
        "TenantId": "string"
      }
    ],
    "ClonedFromProjectId": "string",
    "CombineHealthAndSyncStatusInDashboardLiveStatus": true,
    "DefaultGuidedFailureMode": "EnvironmentDefault",
    "DefaultPowerShellEdition": "string",
    "DefaultToSkipIfAlreadyInstalled": true,
    "DeploymentChangesTemplate": "string",
    "DeploymentProcessId": "string",
    "DeprovisioningRunbookId": "string",
    "Description": "string",
    "DiscreteChannelRelease": true,
    "ExecuteDeploymentsOnEventBasedPipeline": true,
    "ExtensionSettings": [
      {
        "ExtensionId": "string",
        "Values": "string"
      }
    ],
    "ForcePackageDownload": true,
    "Icon": {
      "Color": "string",
      "Id": "string"
    },
    "Id": "string",
    "IncludedLibraryVariableSetIds": [
      "string"
    ],
    "IsBadgesEnabled": true,
    "IsDisabled": true,
    "IsVersionControlled": true,
    "LastModifiedBy": "string",
    "LastModifiedOn": "2020-01-01T00:00:00.000Z",
    "LifecycleId": "string",
    "Links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "Name": "string",
    "PersistenceSettings": {
      "Type": "Database"
    },
    "ProjectConnectivityPolicy": {
      "AllowDeploymentsToNoTargets": true,
      "ExcludeUnhealthyTargets": true,
      "SkipMachineBehavior": "None",
      "TargetRoles": [
        "string"
      ]
    },
    "ProjectGroupId": "string",
    "ProjectTags": [
      "string"
    ],
    "ProjectTemplateDetails": {
      "IsShared": true,
      "Slug": "string",
      "VersionMask": "string"
    },
    "ProvisioningRunbookId": "string",
    "ReleaseCreationStrategy": {
      "ChannelId": "string",
      "ReleaseCreationPackage": {
        "DeploymentAction": "string",
        "PackageReference": "string"
      }
    },
    "ReleaseNotesTemplate": "string",
    "Slug": "string",
    "SpaceId": "string",
    "Templates": [
      {
        "DefaultValue": {},
        "DisplaySettings": {},
        "HelpText": "string",
        "Id": "string",
        "Label": "string",
        "Name": "string"
      }
    ],
    "TenantedDeploymentMode": "Untenanted",
    "VariableSetId": "string",
    "VersioningStrategy": {
      "DonorPackage": {
        "DeploymentAction": "string",
        "PackageReference": "string"
      },
      "Template": "string"
    }
  }
]