Oodle API
The Oodle API provides programmatic access to your Oodle observability platform.
All endpoints support authentication via an API key or an OAuth2 Bearer token.
API Key Authentication
Create an API key in the Oodle UI under Settings > API Keys, then pass it in every request:
curl https://us1.api.oodle.ai/v1/api/monitors \
-H 'X-API-Key: YOUR_API_KEY'
OAuth2 Authentication
Authenticate with OAuth2 using the Oodle CLI:
# Log in (opens browser)
oodle auth login
# Print the current OAuth2 access token
oodle auth token
Use the token in API requests:
curl https://us1.api.oodle.ai/v1/api/monitors \
-H "Authorization: Bearer $(oodle auth token)"
The CLI handles token storage, refresh, and renewal automatically. Running oodle auth token returns a valid access token, refreshing it if needed.
When to use which
| Method | Best for |
|---|---|
| API Key | Scripts, CI pipelines, quick integrations |
| OAuth2 | CLI usage, integrations with token rotation, SSO-based access |
Base URL
Base URL varies by region:
https://us1.api.oodle.ai- US (default)https://ap1.api.oodle.ai- AP1
Authentication
- API Key: ApiKeyAuth
- OAuth 2.0: OAuth2Auth
API key for authentication. Create one in Oodle UI under Settings > API Keys.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-API-Key |
OAuth2 authentication using Authorization Code with PKCE. Discover the authorization server via GET /.well-known/oauth-protected-resource, then run the PKCE flow to obtain an access token. The easiest option is oodle auth login from the Oodle CLI.
Security Scheme Type: | oauth2 |
|---|---|
OAuth Flow (authorizationCode): | Token URL: https://AUTH_SERVER/oauth/token Authorization URL: https://AUTH_SERVER/authorize Scopes:
|
This API supports both API Key and OAuth2 Bearer Token authentication. See the authentication section above for setup instructions.
Browse the full API listing in the sidebar, organized by resource type.
Support
If you need assistance or have any questions, please reach out to us through:
- Email at [email protected]