> ## Documentation Index > Fetch the complete documentation index at: https://docs.advinservers.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a role > ### Overview Replaces a role's name, description and permissions and returns the updated role. Send all three fields. Omitted permissions are removed from every member on their next request. Creation limits apply. Built-in roles and unknown permission keys return 422. You cannot edit a role with more permissions than yours or grant permissions you do not hold. ### Permissions Requires the account permission `teams.manage` (Manage teams). ## OpenAPI ````yaml https://console.advinservers.com/docs/openapi.json patch /teams/{team}/roles/{role} openapi: 3.1.0 info: title: API reference version: 1.0.0 description: >- Use this API to manage your team's servers, networks, backups, and other resources. ## Authentication Create an API key under **API Keys** and send it as a bearer token with every request: ``` Authorization: Bearer {YOUR_API_KEY} Accept: application/json ``` Copy the key when you create it. It cannot be shown again. Revoking a key takes effect immediately. ## Permissions Give each key only the permissions it needs. Every endpoint lists the required permission. Permissions cover servers and other resources in the key's team. ## Team scope A key can access resources in the team selected when it was created. This includes servers, snapshots, backups, firewall groups, images, SSH keys, scripts, networks and addresses. Resources in other teams return `404 Not Found`. Create a separate key for each team. The key determines the team for every request. Legacy keys that had no team are assigned to the account's first owned team. ## Actions that need the panel API keys cannot do the following, even with every permission. Sign in to the panel in a browser to do them: - Create, edit or revoke API keys - Edit the IP groups that restrict API keys - End signed-in sessions - Change two-factor authentication - Change the account's email address - Accept or decline team invitations - Switch or leave a team This keeps a leaked key from widening its own access or locking you out of your account. ## Source IP restrictions A key can be restricted to one or more IP groups. Requests from other addresses are rejected. ## Requests and responses Each endpoint lists its path, query, header, and body parameters. Examples use fictional data. Single records use JSON objects. Collections use JSON arrays unless the endpoint supports pagination. Timestamps use ISO 8601 in UTC. Error responses include `message`. Validation errors also include an `errors` object for each field. Each endpoint lists its status codes. ## Audit log Every API request, including reads, is recorded in the account audit log with the key that made it. servers: - url: https://console.advinservers.com/api/v1/client security: - http: [] tags: - name: Account description: Billing contact details and account setup progress. - name: Account activity description: Actions performed in the current team by people and API keys. - name: Servers description: >- Order and list servers, read their state and resource use, open a console, and control power. - name: Server settings description: >- Rename a server, rebuild it, and change its hardware, media, resolvers and credentials. - name: Backups description: Scheduled server copies stored separately from the server. - name: Snapshots description: >- Take, restore and move server snapshots. Snapshots are kept in snapshot storage that the team buys by the GiB. - name: Firewall groups description: Reusable sets of firewall rules, and the servers they apply to. - name: IP groups description: Reusable source address lists for firewall rules. - name: Server firewall description: >- Read default traffic policies and rules managed outside your firewall groups. - name: IP addresses description: Manage floating IPs and server address assignments. - name: Private networks description: Connect servers over a private network in the same location. - name: Reverse DNS description: Set the hostnames returned by IP address lookups. - name: DDoS protection description: Configure attack filtering for server addresses. - name: Bandwidth description: Buy extra bandwidth and share it between servers or location pools. - name: SSH keys description: Public keys the account can install on a server when it is built. - name: Setup scripts description: Scripts the account can run on a server when it is built. - name: ISO images description: ISO images you have downloaded, and the servers they are mounted on. - name: Server upgrades description: Change an existing server's plan. - name: Checkout description: Choose a payment method and pay for a purchase. - name: Invoices description: View and pay account invoices. - name: Billing description: Manage service renewals, payment methods and account credit. - name: Transfers description: Move resources between teams or transfer ownership. - name: Teams description: Manage the team assigned to your API key. - name: Team members description: Invite people and manage their team access. - name: Team roles description: Define the permissions granted to team members. - name: Team activity description: View actions performed in a team. - name: Support tickets description: >- Open, read, reply to and close support tickets. Tickets belong to the account holder and are not shared with team members. paths: /teams/{team}/roles/{role}: patch: tags: - Team roles summary: Update a role description: >- ### Overview Replaces a role's name, description and permissions and returns the updated role. Send all three fields. Omitted permissions are removed from every member on their next request. Creation limits apply. Built-in roles and unknown permission keys return 422. You cannot edit a role with more permissions than yours or grant permissions you do not hold. ### Permissions Requires the account permission `teams.manage` (Manage teams). operationId: client.teams.roles.update parameters: - name: team in: path required: true description: The team UUID schema: type: string examples: - fbb31f5f-bd6f-4019-a3ed-1062a28f56f7 example: fbb31f5f-bd6f-4019-a3ed-1062a28f56f7 - name: role in: path required: true description: The role UUID schema: type: string examples: - 18f11680-0831-4d41-9d71-824c99009cbf example: 18f11680-0831-4d41-9d71-824c99009cbf requestBody: description: >- Send a JSON object containing the fields below. Required fields are marked in the schema. required: true content: application/json: schema: examples: - name: Research Associate description: >- Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money. permissions: - team.read - server.read - server.power - server.console - server.update - backup.read - backup.create - snapshot.read - snapshot.create - firewall.read - firewall.update - network.read - sshkey.read - sshkey.update allOf: - $ref: '#/components/schemas/UpdateTeamRoleRequest' responses: '200': description: The record, as a JSON object. There is no envelope. content: application/json: schema: examples: - id: 18f11680-0831-4d41-9d71-824c99009cbf name: Research Associate description: >- Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money. permissions: - team.read - server.read - server.power - server.console - server.update - backup.read - backup.create - snapshot.read - snapshot.create - firewall.read - firewall.update - network.read - sshkey.read - sshkey.update type: custom system_key: null is_system: false members_count: 1 created_at: '2026-01-09T20:14:52+00:00' allOf: - $ref: '#/components/schemas/TeamRoleData' '401': description: >- The key was missing, malformed, revoked, or belongs to an account that no longer exists. content: application/json: schema: type: object properties: message: type: string examples: - Unauthenticated. required: - message '403': description: >- Access denied. Check the key's team, permissions and allowed IP addresses. Some actions, such as managing API keys, require a browser session. The response message explains the reason. content: application/json: schema: type: object properties: message: type: string examples: - >- This API key is not allowed to do that in this team. It needs the "snapshot.delete" permission. required: - message '404': description: >- The resource was not found in the selected team. Resources in another account or team also return 404. content: application/json: schema: type: object properties: message: type: string examples: - Not found. required: - message '422': description: >- A field is missing or invalid, or the resource cannot accept this change in its current state. Check `message` for details. Field validation also includes an `errors` object keyed by field name. content: application/json: schema: type: object properties: message: type: string description: >- A summary of the validation error or the reason the change was refused. examples: - The name field is required. errors: type: object description: Validation errors grouped by field name. additionalProperties: type: array items: type: string required: - message '429': description: >- Too many requests. The `Retry-After` header says how many seconds to wait. Limits are per account, so several keys on one account share them. content: application/json: schema: type: object properties: message: type: string examples: - Too Many Attempts. required: - message components: schemas: UpdateTeamRoleRequest: type: object examples: - name: Research Associate description: >- Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money. permissions: - team.read - server.read - server.power - server.console - server.update - backup.read - backup.create - snapshot.read - snapshot.create - firewall.read - firewall.update - network.read - sshkey.read - sshkey.update properties: name: type: string description: The name shown to customers. pattern: ^[^\p{C}]+$ minLength: 1 maxLength: 64 description: type: - string - 'null' description: An optional description shown to customers. pattern: ^[^\p{C}\n\r]*$ maxLength: 512 permissions: type: array description: The value of `permissions`. items: type: string description: |- Rejected rather than quietly dropped. An account that has just ticked something this release does not have needs to be told, not left believing the role grants it. enum: - team.read - team.manage - server.read - server.power - server.console - server.update - server.credentials - server.reinstall - server.transfer - backup.read - backup.create - backup.restore - backup.delete - snapshot.read - snapshot.create - snapshot.restore - snapshot.delete - snapshot.update - snapshot.transfer - firewall.read - firewall.update - firewall.delete - network.read - network.update - network.transfer - network.delete - sshkey.read - sshkey.update - sshkey.delete - script.read - script.update - script.delete - iso.read - iso.update - iso.delete - measured_boot.read - measured_boot.update - measured_boot.delete - billing.read - billing.manage - billing.purchase maxItems: 41 required: - name - permissions title: UpdateTeamRoleRequest TeamRoleData: type: object description: A named set of permissions in a team. examples: - id: 18f11680-0831-4d41-9d71-824c99009cbf name: Research Associate description: >- Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money. permissions: - team.read - server.read - server.power - server.console - server.update - backup.read - backup.create - snapshot.read - snapshot.create - firewall.read - firewall.update - network.read - sshkey.read - sshkey.update type: custom system_key: null is_system: false members_count: 1 created_at: '2026-01-09T20:14:52+00:00' properties: id: type: string description: The id ID. examples: - 18f11680-0831-4d41-9d71-824c99009cbf name: type: string description: The name shown to customers. examples: - Research Associate description: type: - string - 'null' description: An optional description shown to customers. examples: - >- Runs the test chamber servers and takes snapshots before each experiment, but cannot delete, reinstall or spend money. permissions: type: array description: >- Read through the model rather than off the column: a seeded role resolves its permissions from the catalogue every time, so it picks up anything added in a later release, and a key that no longer exists is dropped instead of being shown. examples: - - team.read - server.read - server.power - server.console - server.update - backup.read - backup.create - snapshot.read - snapshot.create - firewall.read - firewall.update - network.read - sshkey.read - sshkey.update items: type: string type: type: string description: 'The role type: `system` or `custom`.' enum: - system - custom examples: - custom system_key: type: - string - 'null' description: The value of `system_key`. examples: - null is_system: type: boolean description: >- The three seeded roles are readable and assignable but never editable or deletable, so an account always has a working set to hand out. examples: - false members_count: type: - integer - 'null' description: >- Only present when the listing asked for it; a role fetched on its own does not pay for the count. examples: - 1 created_at: type: - string - 'null' description: The date and time for created at, in UTC. examples: - '2026-01-09T20:14:52+00:00' required: - id - name - description - permissions - type - system_key - is_system - members_count - created_at title: TeamRoleData securitySchemes: http: type: http description: >- Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.