Actions343
- Admin Activity Actions
- Admin Announcements Actions
- Admin Assets Actions
- Admin Backup Configurations Actions
- Admin Database Hosts Actions
- Admin Egg Configurations Actions
- Admin Egg Repositories Actions
- Admin Extensions Actions
- Admin Locations Actions
- Admin Mounts Actions
- Admin Nests Actions
- Create
- Create Egg
- Create Egg Mount
- Create Egg Variable
- Delete
- Delete Egg
- Delete Egg Mount
- Delete Egg Variable
- Delete Eggs
- Duplicate Egg
- Export Egg
- Get
- Get All Eggs
- Get Egg
- Get Egg Mounts
- Get Egg Servers
- Get Egg Variables
- Get Eggs
- Get Many
- Import Egg
- Move Egg
- Move Eggs
- Update
- Update Egg
- Update Egg From Import
- Update Egg From Repository
- Update Egg Variable
- Update Egg Variable Order
- Update Eggs From Repository
- Admin Nodes Actions
- Create
- Create Allocations
- Create Mount Link
- Delete
- Delete Allocations
- Delete Backup
- Delete Mount Link
- Detach Backup
- Download Backup
- Duplicate
- Get
- Get Allocations
- Get Available Allocations
- Get Backup
- Get Backups
- Get Capacity
- Get Config
- Get Many
- Get Mounts
- Get Server Resources
- Get Servers
- Get System Log
- Get System Logs
- Get System Overview
- Get System Stats
- Get Token
- Get Transferring Servers
- Reattach Backup
- Reset Token
- Restore Backup
- Send Servers Power Action
- Transfer Servers
- Update
- Update Allocations
- Update Config
- Update Default Config
- Admin OAuth Providers Actions
- Admin Roles Actions
- Admin Servers Actions
- Admin Settings Actions
- Admin Stats Actions
- Admin System Actions
- Admin Users Actions
- Client Account Actions
- Create API Key
- Create Command Snippet
- Create Security Key
- Create SSH Key
- Delete API Key
- Delete Avatar
- Delete Command Snippet
- Delete OAuth Link
- Delete Security Key
- Delete Session
- Delete SSH Key
- Disable Two-Factor
- Get
- Get Activity
- Get API Keys
- Get Command Snippets
- Get OAuth Link
- Get OAuth Links
- Get Permissions
- Get Security Keys
- Get Sessions
- Get SSH Keys
- Get Two-Factor
- Import SSH Key
- Logout
- Recreate API Key
- Security Key Challenge
- Update
- Update API Key
- Update Avatar
- Update Command Snippet
- Update Email
- Update Password
- Update Security Key
- Update SSH Key
- Client Server Actions
- Custom Request Actions
- Server Allocations Actions
- Server Announcements Actions
- Server Backups Actions
- Server Databases Actions
- Server Files Actions
- Server Mounts Actions
- Server Schedules Actions
- Server Settings Actions
- Server Startup Actions
- Server Subusers Actions
- System Actions
System → Get OpenAPI Document
AI-generatedSummary
Retrieve the Panel OpenAPI document by sending a GET request to the '/openapi.json' endpoint of the Calagopus API.
Inputs
- Query Parameters JSON — Optional JSON object containing query parameters to include in the request.
- Additional Options — Collection of additional request options including ignoring HTTP status errors, returning full HTTP response (status, headers, and body), and setting a custom timeout in milliseconds.
Output shape
a JSON object containing the OpenAPI document or, if configured, the full HTTP response including status, headers, and body.
The 'Query Parameters JSON' is optional and defaults to an empty object. The 'Additional Options' can affect error handling and response details. The operation sends an authenticated GET request to '/openapi.json' endpoint and returns the parsed JSON response or full response if requested.
Examples
Example 1: Retrieve the OpenAPI document with no query parameters and default options.
Set 'Resource' to 'System', 'Operation' to 'Get OpenAPI Document', leave 'Query Parameters JSON' as '{}', and do not enable any 'Additional Options'.