OctopusServerNodes

Ping an octopus server node.

Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline, otherwise HTTP OK (200). Always returns the node information in the body.

get/octopusservernodes/ping

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/octopusservernodes/ping
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Response

Contains information about the octopus server node

Idstring

Gets or sets a unique identifier for this resource.

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

LastSeenstring date-time
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
Versionstring

Example response

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

Changes

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