APIAuthentication

Authentication

The BioNodulo cloud API authenticates with API keys presented as bearer tokens. Use it to create, run, and monitor workflows from scripts, CI, or your own services.

The REST API is a stub today and will expand over time. The endpoints below document the intended, stable shape.

Create an API key

  1. Sign in at cloud.bionodulo.com.
  2. Go to Settings → API Keys.
  3. Click Create key, name it (e.g. ci-pipeline), and copy the secret. It is shown only once.

Keys inherit the permissions of the account or workspace that created them. For team workspaces, prefer a dedicated service account.

Authenticate requests

Send the key as a bearer token:

curl https://api.bionodulo.com/v1/workflows \
  -H "Authorization: Bearer $BIONODULO_API_KEY"

Store keys in environment variables or a secrets manager — never commit them.

Scopes & rotation

  • Scopes. Keys can be scoped to read-only or read-write, and to a specific workspace.
  • Rotation. Rotate keys periodically; revoke a key instantly from Settings → API Keys. Revocation takes effect immediately.

Errors

StatusMeaning
401Missing or invalid key
403Key lacks permission for this resource
429Rate limit exceeded — back off and retry

Next