DOCS/Technical Docs/API Reference/Authentication

Authentication

The Yoba Systems API uses Bearer tokens for authentication. All API requests must include a valid API token in the Authorization header.

Getting an API Token

API tokens can be generated from the Yoba Systems dashboard at https://dash.yoba.systems/settings/api-tokens.

Token Types:

  • Personal Access Token - For individual developers
  • Service Account Token - For automated systems and CI/CD
  • Session Token - Temporary token from OAuth flow

Using Your Token

Include your API token in the Authorization header:

bash

Token Security

  • Never commit API tokens to version control
  • Store tokens securely (e.g., environment variables, secret managers)
  • Rotate tokens regularly
  • Revoke unused tokens immediately
  • Use the least privilege principle (scope tokens to specific resources)

Scopes

API tokens can be scoped to limit access:

ScopePermissions
racks:readView rack information
racks:writeModify rack configurations
workloads:readView workload details
workloads:writeDeploy and scale workloads
fullFull access to all resources

Example: Create a token with limited scope:

bash

Token Refresh

Session tokens expire after 1 hour. Use the refresh endpoint to get a new token:

http

Response:

json