---
title: "Get a list of Deployments"
method: GET
path: "/deployments"
tags: ["Deployments"]
---

# Get a list of Deployments

`GET /deployments`

Lists all of the Deployments in the supplied Space. The results will be sorted from most recent to least recent deployment.

## Query parameters

- `channels` string[]
- `environments` string[]
- `ids` string[]
- `partialName` string
- `projects` string[]
- `skip` integer
- `take` integer
- `taskState` 'Queued' | 'Executing' | 'Failed' | 'Canceled' | 'TimedOut' | 'Success' | 'Cancelling'
- `tenants` string[]

## Response `200`

The requested Deployments

- DeploymentResourceCollection
  - `Id` string — Gets or sets a unique identifier for this resource.
  - `Items` 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[] — Aggregate of distinct commits from all VersionMetadata
        - `Comment` string
        - `Id` string
        - `LinkUrl` string
      - `ReleaseNotes` string
      - `Version` string
      - `WorkItems` WorkItemLink[] — Aggregate of distinct work items from all VersionMetadata
        - `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[] — A collection of machines in the target environment that should be excluded from the deployment.
    - `ExcludedTargetTagIds` string[] — A collection of target tag IDs that should be excluded from the deployment. Only deployment targets that have none of these tags will be deployed to. Tag IDs are in the format "TagSets-{id}/Tags-{id}".
    - `ExecutionPlanLogContext` ExecutionPlanLogContext
      - `Steps` StepLogContext[], required
        - `CorrelationId` string, required
        - `Slug` string, required
    - `FailTargetDiscovery` boolean
    - `FailureEncountered` boolean
    - `ForcePackageDownload` boolean
    - `ForcePackageRedeployment` boolean
    - `FormValues` object
    - `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, date-time — Gets or sets the date/time that this resource was last modified.
    - `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.
    - `ManifestVariableSetId` string
    - `Name` string
    - `Priority` string
    - `ProjectId` string
    - `QueueTime` string, date-time — If set this time will be the used to schedule the deployment to a later time, null is assumed to mean the time will be executed immediately.
    - `QueueTimeExpiry` string, date-time
    - `ReleaseId` string, required
    - `SkipActions` string[]
    - `SpaceId` string
    - `SpecificMachineIds` string[] — A collection of machines in the target environment that should be deployed to. If the collection is empty, all enabled machines are deployed.
    - `SpecificTargetTagIds` string[] — A collection of target tag IDs that should be included in the deployment. Only deployment targets that have at least one of these tags will be deployed to. Tag IDs are in the format "TagSets-{id}/Tags-{id}".
    - `TaskId` string
    - `TenantId` string
    - `TentacleRetentionPeriod` RetentionPeriod
      - `QuantityToKeep` integer
      - `ShouldKeepForever` boolean
      - `Strategy` string
      - `Unit` 'Days' | 'Items'
    - `UseGuidedFailure` boolean — 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.
  - `ItemsPerPage` integer
  - `ItemType` string
  - `LastModifiedBy` string — Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time — Gets or sets the date/time that this resource was last modified.
  - `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

## 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/revisions/b296c3a60aa5/schema)