Progression

Get the progress of a release in the environment lifecycle.

get/progression/{projectId}

Request

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

ChannelEnvironmentsobject
Idstring

Gets or sets a unique identifier for this resource.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LifecycleEnvironmentsobject
Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Example response

{
  "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.