Skip to content
Cloud infrastructure/devops

circleci.com

CircleCI sandbox and mock API

The CircleCI API is a RESTful, fully-featured API that allows you to do almost anything in CircleCI. You can access all information and trigger all actions. The only thing we don’t provide access to is billing functions, which must be done from the CircleCI web UI. Writes persist, data moves on a schedule and every change can fire a signed webhook.

Operations
22
Collections
-
Event types
-
Start this simulation Vendor documentation
example request
curl https://your-circleci.slurry.io/api/v1/me \
  -H "Authorization: Bearer slurry_sim_..."

Your simulation gets its own hostname, key and IP allow-list. Built from API version v1.

What gets simulated

Collections, relationships and state machines are worked out from the spec when you start the simulation.

  • State. Creates, updates and deletes persist and show up in later reads.
  • Behaviour. Records move through their states on a schedule you control, and you can fast-forward up to 30 days.
  • Webhooks. Every change emits a signed, retried event.
  • Failure. Per-endpoint errors, latency and chaos rules, on demand.

Operations

First 12 of 22.

  • GET/me
  • GET/project/{username}/{project}
  • POST/project/{username}/{project}
  • DELETE/project/{username}/{project}/build-cache
  • GET/project/{username}/{project}/checkout-key
  • POST/project/{username}/{project}/checkout-key
  • GET/project/{username}/{project}/checkout-key/{fingerprint}
  • DELETE/project/{username}/{project}/checkout-key/{fingerprint}
  • GET/project/{username}/{project}/envvar
  • POST/project/{username}/{project}/envvar
  • GET/project/{username}/{project}/envvar/{name}
  • DELETE/project/{username}/{project}/envvar/{name}