v2
Released 2022-09-20Active
Migration Effort
Medium
Estimated Hours
~8h
Primary risk if skipped: Interruption of automated processes relying on affected API endpoints and query parameters, leading to data gaps or incorrect monitoring.
Breaking Changes2
paramHighAudit TrailLog Management
query
The `query` parameter for the Audit Trail Log Streams API has been changed to support a more structured query language, impacting existing log stream filters.
Before
Uses a simpler string-based filter.
After
Uses a structured query language similar to Datadog's log search syntax.
→
Update Audit Trail log stream queries to the new structured query syntax.
endpointMediumCI Visibility
/api/v2/ci/tests
The endpoint for retrieving CI Visibility test results has been renamed and potentially reorganized. Existing integrations relying on the old path will fail.
Before
/api/v2/ci/test
After
/api/v2/ci/visibility/tests
→
Update the endpoint path for retrieving CI Visibility test results from /api/v2/ci/test to /api/v2/ci/visibility/tests.
Migration Checklist
Full interactive checklist →- 1Review Datadog API v2 release notes for all changes since the last version used.
- 2Identify all API calls interacting with the `/api/v2/ci/test` endpoint and update the path to `/api/v2/ci/visibility/tests`.
- 3Analyze existing Audit Trail log stream queries and rewrite them using the new structured query syntax.
- 4Update any code or configurations that might rely on deprecated fields or parameters mentioned in the v2 release.
- 5Test all modified API integrations thoroughly in a staging environment.
- 6Deploy updated integrations to production.
- 7Monitor API error rates and application behavior post-deployment to verify successful migration.
Never get blindsided by an API change again
Deprecatr AI monitors 150+ providers, maps changes to your codebase, and delivers migration checklists before your team hits a breaking change.
Join the Waitlist