---
title: "Ping an octopus server node."
method: GET
path: "/octopusservernodes/ping"
tags: ["OctopusServerNodes"]
---

# Ping an octopus server node.

`GET /octopusservernodes/ping`

## Request

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

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.

## Response `200`

Contains information about the octopus server node

- LoadBalancerPingResource
  - `Id` string: Gets or sets a unique identifier for this resource.
  - `IsInMaintenanceMode` boolean
  - `IsOffline` boolean
  - `LastModifiedBy` string: Gets or sets the username of the user who last modified this resource.
  - `LastModifiedOn` string, date-time: Gets or sets the date/time that this resource was last modified.
  - `LastSeen` string, date-time
  - `Links` object: Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.
  - `MaxConcurrentTasks` integer
  - `Name` string
  - `Version` string

## Other responses

- `400`: Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404`: Not found. One or more of the entities involved in the operation was not found.
- `418`: Indicates that the node is draining or offline

---

[API](https://skmtc.dev/octopus/apis/octopus-server-api.md) - [All operations](https://skmtc.dev/octopus/apis/octopus-server-api/llms.txt) - [OpenAPI document](https://skmtc.dev/octopus/apis/octopus-server-api/revisions/fe937c07da34?raw)