OCoctopus
OctopusServerNodes

Modify an existing OctopusServerNodeResource by ID

Modifies an existing Octopus Server node.

put/octopusservernodes/{id}

Request

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

idstring required

ID of the OctopusServerNodeResource to modify

Request body

Idstring required

ID of the OctopusServerNodeResource to modify

IsInMaintenanceModeboolean

The updated maintenance mode of the OctopusServerNodeResource to modify

MaxConcurrentTasksinteger

The updated max concurrent tasks value of the OctopusServerNodeResource to modify

Example request

{
  "Id": "OctopusServerNodes-1"
}

Response

Confirmation that the Octopus Server Node was modified, containing the new Node

Idstring

Gets or sets a unique identifier for this resource.

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

MaxConcurrentTasksinteger
Namestring

Example response

{
  "Links": {
    "Self": "/api/..."
  }
}

Changes

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