Progression

Get the progress of a release in the environment lifecycle.

get/projects/{projectId}/progression/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/projects/{projectId}/progression/v1
  • 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

projectIdstring required

ID of the Project

Query parameters

releaseHistoryCountinteger

Number of releases to include per environment/channel/tenant combination. Defaults to 3. Maximum allowed is 100.

Response

The requested Project Progression information

Example response

{
  "Progression": {
    "Links": {
      "Self": "/api/..."
    },
    "Releases": [
      {
        "Channel": {
          "Links": {
            "Self": "/api/..."
          },
          "ParentEnvironmentId": "Environments-1",
          "ProjectId": "Projects-1",
          "Rules": [
            {
              "Links": {
                "Self": "/api/..."
              }
            }
          ],
          "SpaceId": "Spaces-1"
        },
        "NextDeployments": [
          "Environments-1",
          "..."
        ],
        "Release": {
          "ChannelId": "Channels-1",
          "Id": "Releases-1",
          "Links": {
            "Self": "/api/..."
          },
          "ProjectId": "Projects-1",
          "SpaceId": "Spaces-1"
        }
      }
    ]
  }
}

Changes

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