Lifecycles

Modify a Lifecycle.

put/{spaceId}/lifecycles/{id}

Request

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

spaceIdstring required

The id of the Space for the Lifecycle.

idstring required

The Id of the Lifecycle to modify.

Request body

Descriptionstring

A description of the Lifecycle

Idstring required

The Id of the Lifecycle to modify.

Namestring required

The name of the Lifecycle.

Slugstring

The slug of the Lifecycle

SpaceIdstring required

The id of the Space for the Lifecycle.

Example request

{
  "Id": "Lifecycles-1",
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "Environments-1",
        "..."
      ],
      "OptionalDeploymentTargets": [
        "Environments-1",
        "..."
      ]
    }
  ],
  "SpaceId": "Spaces-1"
}

Response

Contains a Lifecycle resource which represents changes to the Lifecycle.

Descriptionstring
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.

Linksobject

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

Namestring
Slugstring
SpaceIdstring

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "Phases": [
    {
      "AutomaticDeploymentTargets": [
        "Environments-1",
        "..."
      ],
      "OptionalDeploymentTargets": [
        "Environments-1",
        "..."
      ]
    }
  ],
  "SpaceId": "Spaces-1"
}

Changes

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