eos API Reference

This is the interactive API reference for the eos cloud platform. Every page lets you browse endpoints, inspect request/response schemas, and send real requests directly from your browser — no external tools needed.

---

Authentication

Three authentication methods are supported. Click Authorize in the top-right corner of any API page to pick one.

Current session (easiest)

If you are already logged in to the eos Console, your session is automatically used for all requests. No extra steps are needed — just open an API page and start sending requests.

INFO

The session carries your currently selected organization and realm from the Console. All requests will operate within that context, so make sure you have the right org and realm selected before trying out endpoints.

Authorization Code (interactive login)

Authenticates as a user via the eos identity provider. Best for exploring APIs with your own account permissions.

1. Select OAuth2 → Authorization Code in the Authorize dialog.
2. Click Authorize — you will be redirected to the eos login page.
3. After login you are sent back and Scalar attaches the token to all requests.

Client Credentials (service accounts)

Authenticates as a machine/service client. Best for automation or when you have a dedicated client ID and secret.

1. Select OAuth2 → Client Credentials in the Authorize dialog.
2. Enter your Client ID and Client Secret.
3. Click Authorize — Scalar fetches a token and attaches it to all requests.

---

Available APIs

API	What it covers
Account API	Users, credentials, and account-level settings
Organization API	Organizations, realms, roles, and team membership
Compute API	Virtual machines and compute resource lifecycle
Auditlog API	Audit events and activity history across your organization
Notification API	Platform event notifications and delivery settings
Search API	Cross-resource search across the platform

---

Base URLs

All APIs follow the same URL pattern:

https://{service}.{your-environment-domain}/v1/

The interactive client resolves the correct base URL automatically based on the environment this documentation is served from.