Pterodactyl Application icon

Pterodactyl Application

Administrative panel management with Pterodactyl Panel Application API

Actions36

Nest → Get Nest

AI-generated

Summary

Retrieve detailed information about a specific nest from the Pterodactyl Panel.

Inputs

  • nestId (required) — The ID of the nest to retrieve, selectable from the list of available nests in the Pterodactyl Panel.

Output shape

a single JSON object representing the requested nest's details.

If the specified nest ID is invalid or not found, the operation may throw an error. The nest ID must be chosen from existing nests provided by the instance's current configuration via the 'getNests' load options method.

Examples

Example 1: Retrieve nest details

Set Resource to 'Nest', Operation to 'Get Nest', and select the desired Nest ID from the dropdown.

Discussion