CrawlDriftCrawlDrift
Menu
Start trial

Docs / Deployments

Deployment reporting documentation

Connect your CI/CD pipeline to CrawlDrift with the official CLI, container image or deployment API. Send the version, build and commit context automatically, then start a deployment-linked crawl after your rollout delay.

No provider lock-in. Use the same deployment endpoint from GitHub Actions, GitLab CI, Bitbucket Pipelines, Jenkins or any pipeline that can run a container or make an HTTPS request.

Quickstart

From key creation to a linked crawl

  1. 1Open Project → Deployments → CI/CD setup
  2. 2Create a Project deployment key
  3. 3Store key in CI secret manager
  4. 4Choose CLI, Docker, Action or curl
  5. 5Send a test deployment
  6. 6Confirm deployment in CrawlDrift
  7. 7Enable automatic linked crawl
  8. 8Configure rollout delay

Documentation

Official CrawlDrift clients and generic compatibility

The Deployment API is the source of truth. The CLI, container and GitHub Action are convenience layers over the same contract.

Official CrawlDrift Deployment APIUse the canonical provider-neutral endpoint to report deployment metadata and optionally request a linked FULL crawl.Official CrawlDrift CLIValidate and report a deployment from a CI runner through the canonical Deployment API.Official CrawlDrift deployment containerRun the stateless, one-shot CrawlDrift CLI image inside a compatible CI job.Official GitHub ActionReport deployment context through the official CrawlDrift Action, a thin wrapper over the same Deployment API contract.GitLab CI compatibility exampleWorks with GitLab CI using the official CrawlDrift container. This is generic CI/CD compatibility, not a native GitLab integration.Bitbucket Pipelines compatibility exampleRun the official CrawlDrift container from Bitbucket Pipelines. This is generic CI/CD compatibility, not a native Bitbucket integration.Jenkins compatibility exampleRun the official CrawlDrift container from Jenkins. This is generic CI/CD compatibility, not a native Jenkins integration.Direct curl exampleCall the provider-neutral Deployment API from any pipeline that can make an HTTPS request. The official container is recommended, not mandatory.

Project-scoped authentication

Deployment keys have deployment:write scope for one Project. Send the key only as a Bearer token and keep it in your CI secret manager.

Idempotent acceptance

Use an Idempotency-Key or externalDeploymentId. Repeating the same logical submission returns its original result and does not create another crawl.

Visible crawl state

The rollout delay is processed durably. Active FULL crawl collisions wait, and quota-blocked linked crawls remain visible without discarding the deployment.