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
Admin Roles → Update
AI-generatedSummary
Update an existing admin role by specifying its UUID and sending patch data in the request body to modify the role's properties.
Inputs
- Role UUID (required) — The unique identifier of the role to update.
- Query Parameters JSON — Optional query parameters as a JSON object to send with the request.
- Body Mode — Format of the request body: JSON object, raw text, or none.
- Body JSON — JSON object containing the data fields to update on the admin role (used when Body Mode is JSON).
- Raw Body — Raw plain text to send as the request body (used when Body Mode is Raw Text).
- Additional Options — Additional request options including ignoring HTTP status errors, returning the full response, and setting a request timeout.
Output shape
a list of JSON objects, each representing the updated role data or an error if failed
Returns the API response body parsed to JSON by default, but can return full HTTP response including status and headers if specified. Supports processing multiple items in batch.
Examples
Example 1: Update an admin role's name and permissions by providing a JSON body with the changes using the Role UUID to identify the role.
Set Resource to 'Admin Roles', Operation to 'Update', input the Role UUID, select Body Mode 'JSON', and provide the update fields in Body JSON. Optional query parameters and additional options may be added as needed.