# Which permission each API action needs

Look up a workspace permission to see which API actions use it.

Reference: v1 (open beta).

## How to read this page

Find a permission below to see its actions. If an action accepts either of two permissions, it appears under both.

For an action without a listed workspace permission, check its entry in the API reference for sign-in requirements.

- [Browse the customer API reference](https://rustsc.com/help/v1/reference/index.html.md)

## Alerts

- alerts.manage: Clear an acknowledgement; Acknowledge an alert.
- alerts.read: Read the alert manager; Preview applying a template; List alert templates; List open resource alerts; List chat words; List console words; List quiet times.
- alerts.settings.manage: Save alert settings; Apply a template; Send a test card of an alert to Discord; Save the current settings as a template; Remove a template; Rename a template or update it from the current settings; Add a chat word; Remove a chat word; Change a chat word; Add a console word; Remove a console word; Change a console word; Save a host's alert settings; Make a notification template; Remove a notification template; Rename or change a notification template; Save a server's alert settings.

## Apikeys

- apikeys.manage: List integration keys; Make an integration key; Revoke an integration key; Choose what an agent key asks first; Choose the servers an agent key reaches; Pause all assistants; Resume all assistants.

## Audit

- audit.read: List audit records; Download the audit trail.

## Automation

- automation.manage: Send a broadcast; Save a timed chat line or console command for a rented server; Save a broadcast; Change a saved broadcast; Send a saved broadcast; Archive a saved broadcast.

## Backups

- backups.create: Back up a server now.
- backups.export: Read whether a backup export can be downloaded; Download a backup export; Make a download link for a backup export; Export a backup as a zip; Restore a backup to a folder.
- backups.manage: Change backup protection; Change how many backups a server keeps; Free up space; Check what can be cleaned up; Delete a backup; Turn a server's cloud copy on or off.
- backups.read: Read backup protection status; Read the host's backup protection setting; Read how many backups a server keeps; List a server's backups; Read a server's cloud copy; List a server's cloud copies; Read how well a server's backups are keeping up; Download a rented server's backup; Make a download link for a rented server's backup.
- backups.restore: Check a backup for a copy; Preview restoring a backup; Restore a backup; Restore a backup over another server; Get a cloud backup back onto the host; Restore a server's cloud backup onto its new host; Use the previous save; Keep the server stopped.

## Evidence

- evidence.delete: Delete every report about a player; Delete a report; Delete what a server captured.
- evidence.export: Download the events of the servers you can export; Download the report inbox; Download the events a server recorded.
- evidence.read: Read the events a server recorded; Read one recorded event with the events around it.

## Groups

- groups.manage: Create a server group; Delete a server group; Rename a server group; Add servers to a group; Take servers out of a group.

## Hosts

- hosts.enroll: Create an enrollment token; Revoke an enrollment token; Reconnect a host.
- hosts.manage: Rename a host in RustSC; Remove an installation; Connect a rented server; Check what a key allows on a host; Disconnect a rented server; Ask a connected rented server to start, stop, restart, kill or run a command; Check a connected rented server again; Read the game console saved with a connected rented server; Change the game console saved with a connected rented server; Read the recent lines of a connected rented server's log file; List the other servers of the same account at the host; Connect more servers from the same account; Remove the plugin key of a connected rented server; Make or replace the plugin key of a connected rented server; Read a connected server's startup values; Change one startup value on the host.
- hosts.read: List pending enrollment tokens; Read an enrollment token; List hosts; Read a host; Read a host's alert settings and open alerts; List what you can ask of a host now; List a host's log lines; Get the latest host measurements; Read a host's update settings; Get the performance history of a host; List host restart schedules; Read a host restart schedule; List occurrences; Read a host's restart with the server restart choice; List what a host did and how it ended; List the hosts a rented server can be connected through, and the connected servers; List the latest actions of a connected rented server; See whether a connected rented server has a plugin key; Read the workspace's own Steam key state.
- hosts.reboot: Restart a host; Request operating system updates; Save a host's update settings; Run the host's updates now; Schedule a host restart; Change a host restart schedule; Remove a host restart schedule; Save a host's restart with the server restart choice.
- hosts.remove: Remove a host from RustSC.
- hosts.update: Check what an update of the host would do; Choose when the host gets updates; Turn the host's automatic updates on or off; Update the host.

## Integrations

- integrations.manage: Send alerts to a Discord channel; Send a test alert to a picked channel; Remove an alert route; Change an alert route; Send a test alert to a saved route; Remove the workspace's Codefling key; Save the workspace's Codefling key; Check the workspace's Codefling key; Disconnect Discord; Create the link channel; Choose the link channel; List the text channels to choose the link channel from; Connect the Discord server the bot was added to; Choose who can search links in Discord; Get the address that adds the bot to Discord; Save the Discord invite link; Turn the nickname sync on or off; Try the players who could not be renamed again; List the channels to post alerts and status in; Save the words players see for the link; Remove an integration's key from one host; Give linked players a Discord role; List the Discord roles a rule can give; List the Rust groups linked players can be added to; Stop giving a Discord role; Give the roles staff took away again; Stop adding linked players to a Rust group; Also add linked players to a Rust group; Add the players who already linked to the Rust group; Remove the workspace's RustHQ key; Save the workspace's RustHQ key; Check the workspace's RustHQ key; Disconnect a server from Discord; Save a server's Discord settings; Turn off and forget a server's chat relay; Save a server's chat relay; Send a chat relay test line; Send a Discord test message; Remove the workspace's own Steam key; Save the workspace's own Steam key; Send a test with the workspace's Steam key; Add a webhook; Remove a webhook; Change a webhook; Make a new signing key; Send a test delivery.
- integrations.read: List alert routes; Read the workspace's Codefling connection; Read the Discord link setup; Get a saved Discord look picture; List the workspace's integrations; List the hosts that hold an integration's key; List the roles linked players get; List the Discord role and Rust group syncs; Read the workspace's RustHQ connection; Read a server's Discord settings; Read a server's chat relay; List webhooks; Show what a webhook receives; Show a webhook's delivery log.

## Links

- links.manage: List the uploaded link files; Upload the data of the old link service; Throw an uploaded file away; Make the links from an uploaded file; Search the linked players; Sync the links now; End a player's link.

## Members

- members.manage: Invite someone; Withdraw an invitation; Send an invitation again; Set what a member can do; Set a member's chat name.
- members.read: List pending invitations; List members; List permissions; List roles.

## Players

- players.actions: Heal a player; Kill a player; Restore a player's blueprints; Change a player's health, hunger or thirst; Move a player; Unlock a player's blueprints.
- players.admit: Stop allowing a player anyway from the workspace settings; Save the ban list choices of the workspace; Add a BattleMetrics ban list; Add a community ban list; Remove a community ban list; Remove a community ban list's key; Add a community ban list's key; Save the join rule defaults of the workspace; Stop allowing a player anyway; Allow a player anyway; Refuse listed players when they join a rented server, or stop; Save the join rules of a server; Use the workspace's setting for a join rule.
- players.entities.remove: Look at everything a player owns; Remove everything a player owns.
- players.gameroles.manage: Take an owner or moderator role away; Make a player an owner or moderator.
- players.inventory.manage: Give items to a player; Save inventory changes; Remove items from a player; Get saved inventory change results; List the item sets of a server; Save an item set; Delete an item set; Change an item set; Give an item set to a player.
- players.inventory.read: Look at what a player carries; Read items available in the game; Get the game's items from a read.
- players.moderate: Check the global ban list again; Ban a player on all servers, now and later; Unban a player on all servers; Ban a player; Also ban a player from Discord; Also lift a player's Discord ban; Freeze a player; Import a list of bans; Kick a player; Send a private message to a player; Kick, ban, unban or mute several players of a rented server; Mute a player's chat through the game's console; Mute a player; Preview a list of bans; Release a player; Unban a player; Let a player chat again through the game's console; Check players against the ban lists again; Apply the global bans to a hosting panel server, or stop; Take a label off a player; List the labels on a server's players; Put a label on a player; List the private notes of a server; Write a private note about a player; Remove a private note; Change a private note; List the texts a note has had; Check whether a player can also be banned from Discord; Lift a server's own ban where a global ban also applies.
- players.permissions.manage: Turn the permission sync on or off and choose its servers; Choose what the sync does for players a server has not seen yet; Keep items Only on this server, or sync them again; List the saved permission templates; Save a permission template; Delete a permission template; Apply changes to a server's groups and permissions at once.
- players.permissions.temporary: Give temporary access; End what an order reference gave; List temporary access packs; Delete a temporary access pack; Save a temporary access pack; Read temporary access settings; Save temporary access settings; Add time to temporary access; Apply temporary access again; End temporary access now; Keep temporary access.
- players.read: List the players allowed anyway; Read the ban list choices of the workspace; Read where the global ban list stands on each server; Read the join rule defaults of the workspace; List the servers a join rule default would newly apply to; List the workspace bans; List the names players were seen under; Read the player stats; List the players of the workspace; Read the ban facts of players; Read the ban lists of a server; Read whether a rented server refuses listed players when they join; List the bans of a server; Download the ban list; List the join checks of a server; Read the join rules of a server; Read where a hosting panel server's global bans stand; List the player history of a server; Read the players seen on a server; Read what RustSC knows about some players; List connected players; List the owners and moderators of a server.
- players.read.sensitive: Read the permission sync of the workspace; Read the history of the permission sync; Read the groups the permission sync keeps the same; Read a server's groups, players' permissions and in-game staff.
- players.structures.manage: Take items out of a container; Remove one thing from the world; Remove a whole building from the world; Unlock a hackable crate.

## Plugins

- plugins.manage: Check a server's plugins for updates now; Check a plugin file at a web address; Install a plugin from a marketplace; Remove the RustSC plugin from a rented server; Enable, disable, reload, remove or update a plugin; Check one plugin for updates now; Grant or revoke a permission, or change a group; Roll a plugin update back or forward; Mark a plugin as Custom; Keep a plugin up to date; Choose the marketplace of a plugin; Give the marketplace page of a plugin.
- plugins.read: List a server's plugins; Find plugins on the marketplaces; Recognise a pasted plugin address; Open a found plugin; Read whether a rented server can take the RustSC plugin and whether it has it; Which plugin updates can be rolled back; Which plugin updates RustSC can make.

## Profiles

- profiles.manage: Save a settings profile; Delete a settings profile; Change a settings profile; Let a server keep its own value.

## Reports

- reports.manage: Change a report.
- reports.read: Read the report inbox; Read a report; Read what the server recorded around a report.

## Roles

- roles.manage: Make a role; Delete a role; Change a role.
- roles.sync.manage: Keep a Discord role and a Rust group in step; List what a sync can be made from; Stop a sync; Give again what staff took away; Compare one sync's players again now.

## Rules

- rules.enable: Switch a rule on or off.
- rules.manage: Delete a rule; Change a rule.

## Schedules

- schedules.manage: Save the Discord announcement of a schedule or temporary change; Delete a timed chat line or console command of a rented server; Save a restart for a rented server; Delete a saved restart of a rented server; Change a saved restart of a rented server; Add dropped plugin files to the library; Add the plugin files in the inbox to the library; Look in the plugin inbox; Look for newer versions at the plugins' GitHub update sources; Put the previous version of a library plugin back; Check what dropped plugin files would do; Swap a running plugin to the newer version in the inbox and reload it; Update the library from the plugins folder; Take the newer version from the plugins' GitHub update sources into the library; Save the plugin library's choices; Create a schedule; Change a schedule; Revoke a schedule; Save a temporary change; Take a plugin from the library; Check a temporary change before saving it; Delete a temporary change; Change a temporary change; Copy a temporary change that reads its folder to another server; Duplicate a temporary change; End a temporary change now; Extend a temporary change; Create, fill or list-write a temporary change's folder; Keep a temporary change on anyway; Pause a temporary change; Receive a copied folder on the target host; Resume a temporary change; Run a finished temporary change again; Start a temporary change now; Update a plugin a temporary change places; Save a temporary change as one that reads its folder.

## Servers

- servers.config.write: Save a Nexus network; Delete a Nexus network; Change a Nexus network; Save configuration changes; Apply the saved configuration; Check an image link; Save desired server ports; Apply saved server ports; Choose what a server records of its history; Add the Windows Firewall rule; Remove the Windows Firewall rule; Save the start settings of a server; Rename a server in RustSC; Save the public IPv4 address of the server; Change automatic recovery; Switch history on or off for a rented server; Save the query address of a rented server; Choose the time zone of a server's schedules; Save or switch off a server's Upkeep setting.
- servers.console.execute: Run a console command; Hide repeated errors in a server's console for a while, or stop hiding them; Save a mod command; Change a mod command; Remove a mod command; Save a command; Change a saved command; Run a saved command; Archive a saved command.
- servers.console.read: Read whether commands reach a rented server; Read whether a server's console hides repeated errors; List the times a server's console repeated the same line; Search older console lines; List the ends of a server's game; List mod commands; List saved commands; Read a saved command.
- servers.create: Browse folders on a host; Create a folder on a host; Preview adopting a server folder; Read a folder on a host; Check a custom map link; Add a server; Adopt a server folder; Adopt a server again with what is there now; Copy a backup as a new server.
- servers.delete: Remove a server.
- servers.files.read: Look at the files in a server's Oxide or Carbon folder; Read the last listing kept for a server's Oxide or Carbon folder; Read the names of a plugin's files, its permissions or its commands.
- servers.files.write: Keep files for a server until a person has looked at them; Get an address to send one large file to; Throw a staged attachment away; Read a staged attachment; Put a staged attachment on the server; Delete, rename, move, copy or create files and folders in a server's Oxide or Carbon folder; Save a file in a server's Oxide or Carbon folder; Keep the listing the Files area has just read; Save a temporary change for a rented server; Delete a temporary change of a rented server; Change a temporary change of a rented server; Take a temporary change of a rented server out now; Put a saved temporary change of a rented server in place now; Start uploading files to a server's host; Stop an upload; Read an upload; Send a finished upload to the server's host; Put a finished upload in a folder of the server.
- servers.helpers.manage: Save a server's helpers.
- servers.helpers.read: Read a server's helpers.
- servers.lifecycle: Plan a quiet time; Restart a server; Start a server; Stop a server; Save a server's player warnings.
- servers.modcommands.run: Run a mod command; List the commands a moderator can run.
- servers.read: List the RustSC plugin's player commands on every server; Read linking in the game; Read a command result; Read a rule; Read a server; Read a server's alert settings and the alerts that concern it; Read RustSC's default Discord announcement; Read the Discord announcement of a schedule or temporary change; List what you can ask of a server now; Read a server's configuration; Read endpoints from the host; Read what a rented server's host says happened to the server; Read a server's map name; Get the latest server measurements; Preview a message template; Get the performance history of a server; Read the plugin library of a server; List quick actions; Preview a quick action; Read whether players can reach the server; Check that players can reach the server; Read the host's automatic recovery setting; Check a release channel again; Read the game and framework versions of a rented server; Read the status of a rented server; Read whether history is kept for a rented server; Read whether a server has a RustEdit map key; Read whether the next start is the start the game runs with now; List saved broadcasts; List schedules; List a server's temporary changes; List the temporary changes that are on; List the saved files of a server's temporary changes; Read a temporary change; Refresh the files of a temporary change that reads its folder; Read the next start times of a temporary change; Read a server's Upkeep setting; List a server's installed and latest versions; List a server's saved wipes; Read a saved wipe.
- servers.save: Save a server.
- servers.secrets.write: Read a server's RCON connection details; Set a server's RCON password or where its console listens; Show a server's RCON password.
- servers.setup.read: List the saved Nexus networks; Read what a rule did; Inspect the server configuration; Read configuration inspection history; Read server network endpoints; Read what a server records of its history; Read the Windows Firewall rule of a server; Read what the host of a rented server allows; Read the launch arguments an adoption imported; Read the start settings saved for a server; Read who restarts a rented server; List the temporary changes, wipes and restarts saved for a rented server; List the timed chat lines and console commands saved for a rented server; Read automatic crash recovery status; List release channels; Read a saved broadcast; Read a schedule; List occurrences; List the starting points for a temporary change; Read what a temporary change did; Read the visible folder of a temporary change; Read a server's automatic update settings; Read a server's player warnings; Preview a player warning; List the extras of a server's wipes; List the runs of a saved wipe; Read a server's wipe settings; List a server's wipe templates; Read a wipe template.
- servers.software.manage: Save linking in the game; Install, update or remove a supporting extension; Install, upgrade, switch or uninstall Oxide or Carbon; Change the Steam branch of the game; Check for a game update; Inspect a server's game files; Install again; Repair a server's game files; Replace a server; Switch Oxide, Carbon or no framework on a rented server; Update the game; Update Oxide or Carbon on a rented server; Choose a release channel; Check a replacement; Remove a server's RustEdit map key; Set a server's RustEdit 2 map key; Save a server's automatic update settings.

## Workspace

- workspace.close: Keep a closing workspace; Read what closing a workspace does; Close a workspace.
- workspace.export: Download a workspace's data.
- workspace.manage: Rename a workspace; Replace the workspace's sign-in rule; Save the workspace's time zone.
- workspace.read: Read the workspace's sign-in rule.

## Worlds

- worlds.read: Count what the world holds; Count what each player owns; Find things in the world; Look at one thing in the world; Look inside a container; Look at the building a part belongs to; Read a player's cupboards and upkeep trail on a server.
- worlds.reset: Check a custom map link; Plan a new map; Wipe the map; Save a server's map name; Save a wipe template for a rented server; Delete a wipe template of a rented server; Change a wipe template of a rented server; Save a wipe for a rented server; Preview a wipe of a rented server before it is saved; Delete a saved wipe of a rented server; Change a saved wipe of a rented server; Add an extra to a saved wipe; Check a plugin at a web address; Remove an extra; Change an extra; Put an extra in place now; Save an extra to its plan's template; Take an extra out now; Use an extra again; Save a new wipe plan; Delete a saved wipe; Change a saved wipe; Wipe again or schedule a saved wipe; Switch off a saved wipe; Switch on a saved wipe; Copy a saved wipe; See what a saved wipe will do; Save a server's wipe settings; Save a new wipe template; Delete a wipe template; Change a wipe template; Copy a wipe template.

HTML version: https://rustsc.com/help/v1/permissions/
