Skip to main content
These conventions apply across the reporting endpoints under /app/pulse/v1/partner. The provisioning lists under /ta page by number instead; see Provisioning lists.

Response envelope

List endpoints return a fixed envelope.

Pagination

Use page_size and cursor. The default page size is 100 and the maximum is 500. Read the first page, then pass the returned next_cursor back unchanged until it is null.
Cursors are opaque. Do not construct or modify them. Ordering is deterministic, so a full walk returns every row exactly once.

Provisioning lists

The tenant, user, and technician lists under /ta/v1/msp/admin take page, starting at 1, and page_size, from 1 to 100 with a default of 50. Each response returns page, page_size, total_count, and next_page. Request the next page with page set to next_page, until next_page is null.

Filters

Reading one asset

asset_id narrows /vulnerabilities/cves, /vulnerabilities/root-causes or /assets to a single asset. Asset identifiers are unique within a tenant rather than across tenants, so tenant_ids must be supplied alongside asset_id. A request with asset_id and no tenant_ids is rejected with 400 asset_id_requires_tenant_ids.
asset_id combines with the other filters, so one call answers narrower questions such as the patchable critical CVEs on a single machine.

Expansions

Two endpoints accept expand. Expansions perform additional work, so request them only when the extra detail is required.

Time windows

Event and export endpoints accept from and to as RFC 3339 timestamps. On /dashboards/vulnerability-rollups and /usage both are required and take calendar dates in yyyy-MM-dd form. Omitting either returns 400 invalid_date_range. Treat as_of, from, and to values in responses as UTC instants.

Errors

Errors use RFC 7807 application/problem+json.