MachinePolicies

Modify an existing Machine Policy

put/spaces/{spaceIdentifier}/machinepolicies/{id}

Request

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

spaceIdentifierstring required

Identifier (ID or slug) of the space

idstring required

The Machine Policy ID

Request body

ConnectionConnectTimeoutstring date-span
ConnectionRetryCountLimitinteger
ConnectionRetrySleepIntervalstring date-span
ConnectionRetryTimeLimitstring date-span
Descriptionstring
Idstring required

The Machine Policy ID

IsDefaultboolean
Namestring required
PollingRequestQueueTimeoutstring date-span
SpaceIdstring required

The Space ID

Example request

{
  "Id": "MachinePolicies-1",
  "SpaceId": "Spaces-1"
}

Response

Confirmation that the Machine Policy was modified, containing the new Policy

ConnectionConnectTimeoutstring date-span
ConnectionRetryCountLimitinteger
ConnectionRetrySleepIntervalstring date-span
ConnectionRetryTimeLimitstring date-span
Descriptionstring
Idstring

Gets or sets a unique identifier for this resource.

IsDefaultboolean
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
PollingRequestQueueTimeoutstring date-span
SpaceIdstring

Example response

{
  "Links": {
    "Self": "/api/..."
  },
  "SpaceId": "Spaces-1"
}

Changes

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