Calagopus

Interact with the Calagopus API

Actions343

Admin Activity Actions
- Get Many
Admin Announcements Actions
- Create
- Delete
- Duplicate
- Get
- Get Many
- Update
Admin Assets Actions
- Delete
- Get Many
- Upload
Admin Backup Configurations Actions
- Create
- Delete
- Get
- Get Backups
- Get Locations
- Get Many
- Get Nodes
- Get Servers
- Get Stats
- Update
Admin Database Hosts Actions
- Create
- Delete
- Get
- Get Databases
- Get Many
- Test
- Update
Admin Egg Configurations Actions
- Create
- Delete
- Duplicate
- Get
- Get Many
- Update
Admin Egg Repositories Actions
- Create
- Delete
- Get
- Get Eggs
- Get Many
- Install Egg
- Install Egg From Repository
- Sync
- Update
Admin Extensions Actions
- Add
- Get Build Logs
- Get Many
- Get Status
- Rebuild
- Remove
Admin Locations Actions
- Create
- Create Database Host Link
- Delete
- Delete Database Host Link
- Duplicate
- Get
- Get Database Hosts
- Get Many
- Get Nodes
- Update
Admin Mounts Actions
- Create
- Delete
- Duplicate
- Get
- Get Many
- Get Nest Eggs
- Get Nodes
- Get Servers
- Update
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
- Create
- Create Mapping
- Delete
- Delete Mapping
- Duplicate
- Get
- Get Many
- Get Mapping
- Get Mappings
- Get User By Identifier
- Get Users
- Update
- Update Mapping
Admin Roles Actions
- Create
- Delete
- Duplicate
- Get
- Get Many
- Get Users
- Update
Admin Servers Actions
- Cancel Transfer
- Clear State
- Create
- Create Allocation
- Create Mount Link
- Delete
- Delete Allocation
- Delete Mount Link
- Deploy
- Get
- Get Allocations
- Get Available Mounts
- Get Backups
- Get By External ID
- Get Install Logs
- Get Logs
- Get Many
- Get Mounts
- Get Variables
- Start Transfer
- Update
- Update Allocation
- Update Variables
Admin Settings Actions
- Get
- Get Email Template
- Get Email Templates
- Test Email
- Update
- Update Email Template
Admin Stats Actions
- Get Backup Stats
- Get General Stats
Admin System Actions
- Get Debug Mode
- Get General Health
- Get Node Updates
- Get Nodes Health
- Get OpenAPI Document
- Get Overview
- Get Telemetry
- Get Update History
- Get Updates
- Recheck Updates
- Set Debug Mode
Admin Users Actions
- Create
- Create OAuth Link
- Delete
- Delete OAuth Link
- Disable Two-Factor
- Get
- Get Activity
- Get By External ID
- Get Many
- Get OAuth Link
- Get OAuth Links
- Get Servers
- Send Password Reset Email
- Update
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
- Create Server Group
- Delete Server Group
- Get
- Get Activity
- Get Command Snippets For Egg
- Get Eggs
- Get Logs
- Get Many
- Get Node Resources
- Get Resources
- Get Server Group Servers
- Get Server Groups
- Get Websocket Token
- Send Command
- Set Power State
- Update Server Group
- Update Server Group Order
Custom Request Actions
- Request
Server Allocations Actions
- Create
- Delete
- Get Many
- Update
Server Announcements Actions
- Get Many
Server Backups Actions
- Delete
- Download
- Get
- Get Many
- Restore
- Start Backup
- Update
Server Databases Actions
- Create
- Delete
- Get
- Get Hosts
- Get Many
- Get Size
- Recreate
- Rotate Password
- Update
Server Files Actions
- Cancel Operation
- Change Permissions
- Compress
- Copy
- Copy Many
- Copy Remote
- Create Directory
- Decompress
- Delete
- Download
- Get Contents
- Get Fingerprint
- Get Largest Directories
- Get Revision Content
- Get Revisions
- Get Upload URL
- List
- Pull
- Query Pull
- Rename
- Search
- Write
Server Mounts Actions
- Attach
- Detach
- Get Many
Server Schedules Actions
- Abort
- Create
- Create Step
- Delete
- Delete Step
- Duplicate
- Duplicate Step
- Export
- Get
- Get Many
- Get Status
- Get Steps
- Import
- Trigger
- Update
- Update Step
- Update Step Order
Server Settings Actions
- Cancel Install
- Install
- Rename
- Unlock Install
- Update Auto Kill
- Update Auto Start
- Update Timezone
Server Startup Actions
- Get Variables
- Update Command
- Update Docker Image
- Update Variables
Server Subusers Actions
- Create
- Delete
- Get Many
- Update
System Actions
- Get Announcements
- Get Languages
- Get OpenAPI Document
- Get Public Settings

Admin Roles → Get

AI-generated

Summary

Retrieve details of a specific admin role by its UUID from the Calagopus API.

Inputs

Role UUID (required) — The UUID of the admin role to retrieve.
Query Parameters JSON — Additional query parameters to include in the request as a JSON object.
Additional Options — Optional settings such as ignoring HTTP status errors, returning the full HTTP response, and setting a request timeout in milliseconds.

Output shape

A single JSON object representing the admin role details.

The output is the response body parsed as JSON by default. If 'Return Full Response' option is set, the output includes status, headers, and body. If an error occurs and 'Ignore HTTP Status Errors' is set, error responses are returned instead of throwing an error.

CalagopusInstall

Actions343

Admin Roles → Get

Summary

Inputs

Output shape

Links

Discussion

Calagopus