API overview
The console uses the same API you can call. Everything is scoped to the organization of the token’s owner.
Base URL
Section titled “Base URL”https://api.endpointworks.comAuthenticate
Section titled “Authenticate”Create a token in Devices & Access › API tokens (how), then send it in the Authorization header with the Token scheme:
curl -H "Authorization: Token ewt_xxxxxxxx" https://api.endpointworks.com/api/catalog- A token has explicit scopes, such as
packages:read. It can never do more than its owner’s current role. - Tokens expire after 1 to 365 days. A token can’t create another token.
- Tokens keep working when SSO enforcement is on.
Requests and responses
Section titled “Requests and responses”- JSON in and out, with camelCase field names.
- Success bodies are
{ "data": … }. Lists may addtotal,limit,offsetandcounts. - Lists page with
limit(usually 1-100, default 50) andoffset. - Write endpoints reject unknown fields.
Errors
Section titled “Errors”{ "error": { "code": "entitlement_required", "message": "A complete sentence.", "fields": {} } }See API errors.
Permissions
Section titled “Permissions”Each endpoint checks a permission. Use these as token scopes.
| Scope | Allows |
|---|---|
packages:read, packages:write |
Catalog, uploads, approvals, baselines |
security:read, security:write |
Findings, policy, advisories, feeds, rules, exceptions |
devices:read, devices:write |
Devices, device groups, enrollment tokens, device settings |
devices:assign, devices:kill |
Managed-mode assignments; pausing them |
issues:read, issues:write |
Install issues |
users:read, users:write |
Users and user groups |
settings:read, settings:write |
Organization, SSO, SCIM settings, API tokens, source keys |
webhooks:read, webhooks:write |
Webhooks |
audit:read |
Audit log |
Endpoints
Section titled “Endpoints”| Area | Page |
|---|---|
| Catalog, packages, uploads, search | Catalog and packages |
| Approve and reject versions | Approvals |
| Findings, policy, vulnerabilities, compliance | Security and compliance |
| Baselines and their revisions | Baselines |
| Devices, groups, tokens, install issues | Devices and agent |
| Users, SSO, tokens, keys, organization, audit | Access and organization |
| Webhooks | Webhooks |
| What winget calls | WinGet REST source |
| What your IdP calls | SCIM 2.0 |
| Health | Health |
Request and response fields for each endpoint are not documented here yet. Ask support for the field reference of an area you need.
Examples
Section titled “Examples”Approve a version:
curl -X POST -H "Authorization: Token ewt_xxxxxxxx" \ https://api.endpointworks.com/api/approvals/<versionId>/approveExport the audit log as CSV:
curl -H "Authorization: Token ewt_xxxxxxxx" \ "https://api.endpointworks.com/api/audit-logs?format=csv" -o audit.csv