Calagopus icon

Calagopus

Interact with the Calagopus API

Actions343

Admin Nests → Get Egg Servers

AI-generated

Summary

Retrieve a list of servers that use a specific egg within a specified nest from the Calagopus API.

Inputs

  • Nest UUID (required) — The unique identifier of the nest.
  • Egg UUID (required) — The unique identifier of the egg.
  • Query Parameters JSON — Optional JSON object containing query parameters to include in the API request.
  • Additional Options — Optional settings such as ignoring HTTP status errors, returning the full HTTP response, and request timeout in milliseconds.

Output shape

a list of server records using the specified egg within the nest, returned as JSON objects

Supports passing additional query parameters as JSON. Can return the full HTTP response if requested. Handles error responses depending on the 'Ignore HTTP Status Errors' option.

Examples

Example 1: Get servers for a given egg in a nest

Specify the Nest UUID and Egg UUID parameters to query the Calagopus API endpoint '/api/admin/nests/{nestUuid}/eggs/{eggUuid}/servers' with a GET request, returning the list of servers using that egg.

Links

Discussion