Retention

Modify a default retention policy.

put/{spaceId}/retentionpolicies/{id}

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/retentionpolicies/{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 that contains the default retention policy.

idstring required

The id of the default retention policy.

Request body

Idstring required

The id of the default retention policy.

RetentionTypestring required

The type of the default retention policy. ["MachinePackageCache", "LifecycleRetention", "TentacleRetention", "RunbookRetention"]

SpaceIdstring required

The id of the space that contains the default retention policy.

Example request

{
  "Id": "RetentionPolicies-1",
  "RetentionType": "LifecycleRelease",
  "SpaceId": "Spaces-1"
}

Response

The response returned from the request to modify a default retention policy.

Idstring
Namestring
RetentionTypestring
SpaceIdstring

Example response

{
  "RetentionType": "LifecycleRelease",
  "SpaceId": "Spaces-1"
}

Changes

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