---
title: "Get a list of Octopus Server Nodes"
method: GET
path: "/octopusservernodes"
tags: ["OctopusServerNodes"]
---

# Get a list of Octopus Server Nodes

`GET /octopusservernodes`

## Request

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

Lists all of the Octopus Server Nodes participating in the current Octopus Server cluster.

## Query parameters

- `ids` string[]
- `partialName` string
- `skip` integer
- `take` integer

## Response `200`

The requested list of Octopus Server Nodes

- OctopusServerNodeResourceCollection
  - `Id` string: Gets or sets a unique identifier for this resource.
  - `Items` OctopusServerNodeResource[]
    - `Id` string: Gets or sets a unique identifier for this resource.
    - `IsInMaintenanceMode` 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.
    - `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
  - `ItemsPerPage` integer
  - `ItemType` string: The type of item in this list
  - `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.
  - `LastPageNumber` integer
  - `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.
  - `NumberOfPages` integer
  - `TotalResults` integer

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

---

[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)