Public API and Bots

Intro

RocketSLO provides public gRPC API (with HTTP REST API coming soon) to programmatically integrate existing systems with RocketSLO quality management platform.

• See API reference at https://apiref.rocketslo.com
• And checkout https://github.com/rocketslo/apiref with proto service definitions and examples how to make requests to RocketSLO.

Securing API Access with API Tokens

To ensure controlled access to RocketSLO's functionality, every API request must be accompanied by an API token (or as sometimes referenced access token). Here's how to generate and manage tokens effectively:

1. Creating Bots

• Bots are specialized principals within RocketSLO that act as gatekeepers for API access.
• When creating a bot, you'll specify:
  • Purpose Describe how the bot will be used to provide context for its access.
  • API Access Indicate which specific APIs the bot will be authorized to interact with.
  • Scopes Define the exact permissions the bot will have within those APIs, such as read-only access to components or update capabilities for components owned by a specific team.

2. Generating Access Tokens

• Once a bot is created, you can generate access tokens for it.
• Bots can have multiple active access tokens at any given time, allowing for flexibility in usage and management.

3. Revoking Tokens

• If a token is compromised or no longer needed, you can easily revoke it to maintain security.

Token Management in the RocketSLO Portal

Conveniently handle bot creation, token generation, and revocation directly within the RocketSLO portal.

TODO: add screenshot of bots and access tokens screens