Changelog
API changelog
apiChangelog(). See the versioning and deprecation guide for the policy and the deprecation headers.- addition
api-key-scopesAPI keys can be scoped by resource, action, dataset, and environment.
- addition
api-usage-analyticsGET /api/v1/usage reports API-key calls by endpoint for the caller’s workspace: calls, client and server error rates, average and bucketed p50/p95 latency, and credits, per billing month. `format=csv` exports the same report.
- change
cursor-paginationList reads default to cursor pagination with filter and sort.
- deprecation
deprecate-activity-api-activity/api/activity is deprecated. Use /api/v1/activity.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-agents-api-agents/api/agents is deprecated. Use /api/v1/agents.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-alert-channels-api-alert-channels/api/alert-channels is deprecated. Use /api/v1/alert-channels.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-alert-rules-api-alert-rules/api/alert-rules is deprecated. Use /api/v1/alert-rules.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-api-keys-api-api-keys/api/api-keys is deprecated. Use /api/v1/api-keys.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-connector-connections-api-connectors-connections/api/connectors/connections is deprecated. Use /api/v1/connector-connections.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-contracts-api-contracts/api/contracts is deprecated. Use /api/v1/contracts.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-crawl-api-crawl/api/crawl is deprecated. Use /api/v1/crawl.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-dashboards-api-dashboards/api/dashboards is deprecated. Use /api/v1/dashboards.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-datasets-api-data/api/data is deprecated. Use /api/v1/datasets.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-enrichments-api-enrich/api/enrich is deprecated. Use /api/v1/enrichments.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-entities-api-entities/api/entities is deprecated. Use /api/v1/entities.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-events-api-events/api/events is deprecated. Use /api/v1/events.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-jobs-api-jobs/api/jobs is deprecated. Use /api/v1/jobs.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-map-api-crawl-map/api/crawl/map is deprecated. Use /api/v1/map.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-mappings-api-mappings/api/mappings is deprecated. Use /api/v1/mappings.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-packs-api-packs/api/packs is deprecated. Use /api/v1/packs.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-queries-api-query/api/query is deprecated. Use /api/v1/queries.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-retrievals-api-retrieve/api/retrieve is deprecated. Use /api/v1/retrievals.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-scrape-api-crawl-scrape/api/crawl/scrape is deprecated. Use /api/v1/scrape.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-targets-api-targets/api/targets is deprecated. Use /api/v1/targets.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-templates-api-templates/api/templates is deprecated. Use /api/v1/templates.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-users-api-users/api/users is deprecated. Use /api/v1/users.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-webhooks-api-webhooks/api/webhooks is deprecated. Use /api/v1/webhooks.
Sunset 2027-02-19T00:00:00.000Z
- deprecation
deprecate-workflows-api-workflows/api/workflows is deprecated. Use /api/v1/workflows.
Sunset 2027-02-19T00:00:00.000Z
- addition
error-contractErrors return a stable code, message, remediation, and request id.
- addition
rate-limit-headersResponses include limit, remaining, and reset headers.
- change
spec-post-queries-retrievalsThe OpenAPI spec lists POST, with QueryRequest and RetrievalRequest bodies, for queries and retrievals. These routes never served GET; the generated listQueries and listRetrievals methods are now runQuery and retrieve.
- addition
v1-surfaceCustomer resources are canonical under /api/v1. Older paths stay as aliases.