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
Server Settings → Rename
AI-generatedSummary
Rename a server by specifying its UUID with a new name and optionally a new description.
Inputs
- Server UUID (required) — The identifier of the server to rename.
- Query Parameters JSON — Optional query parameters as a JSON object.
- Body Mode — Choose how to provide the request body: JSON, raw text, or none (default is JSON).
- Server Name — The new name for the server (required if using JSON body mode).
- Description — The new description for the server. Leave empty to keep the current description.
- Body JSON — Additional JSON properties to include in the request body when Body Mode is JSON.
- Raw Body — Request body as plain text when Body Mode is raw text.
- Additional Options — Extra request options, such as ignoring HTTP status errors, returning full response, or setting request timeout.
Output shape
a single JSON object representing the API response indicating the result of the rename operation
The response includes the server data as a JSON object. If 'Return Full Response' is enabled in Additional Options, status and headers are also included. Errors can be caught with 'Ignore HTTP Status Errors' enabled.