Authentication
Published 28 March 2024
To access the PowerShell API you will need to obtain an access token.
Creating access tokens
- Select Configuration in the top menu of Redgate Monitor.
- Choose Access tokens from the PowerShell API section.
- Click on Create new token to open the access token creation wizard.
- Enter a name, description (optional) and expiry date for the token. The default expiry date is one year after token creation.
- Select the desired role for the access token. More information about token roles can be found here.
- In the Access Rights section, select the desired servers the token should have access to. Please note that administrator tokens are granted access to all groups and monitored servers.
- Click Continue and review the token details.
- Click Create. A new token will be generated and a dialog will display the token itself.
- This is the only time you can access the token, so note it down somewhere safe.
Screenshot of a new token
Deleting access tokens
Tokens can be deleted from Redgate Monitor in the table of tokens.