Dry Run Not Supported

dry-run-unsupported · 400

The call asked for a dry run on a route that can't plan one, so the API refused it rather than make the change for real.

supportedRoutes lists the routes that answer a dry run; POST /v1/agent-sessions/<id>/rollback takes one too, though the list leaves it out. dryRun=false, or any value but true, 1 or none, asks for no dry run, and the call runs for real. Case doesn't matter: dryRun=TRUE is a dry run too.

Besides the members every error carries, this type adds supportedRoutes.

Common causes

  • The call added dryRun=true to a route the list doesn't name, such as creating an environment.
  • A client adds dryRun to every call to check each one first.

How to fix the call

  • Drop dryRun to make the change for real, once the user has agreed to it.
  • Or check the change another way: read the resources it would touch first.
  • Don't retry with dryRun on the same route: it never plans.

Example response

json
{
  "type": "dry-run-unsupported",
  "title": "Dry Run Not Supported",
  "detail": "POST /v1/projects/0199e0a3-6f21-7c4a-9d18-2b7c5f3ad401/environments does not support dryRun. Drop the parameter to perform the operation, or dry-run one of the supported routes instead.",
  "method": "POST",
  "path": "/v1/projects/0199e0a3-6f21-7c4a-9d18-2b7c5f3ad401/environments",
  "supportedRoutes": [
    "POST /v1/projects/:projectId/services",
    "POST /v1/admin/instances",
    "POST /v1/services/:serviceId/domains"
  ],
  "requestId": "req-1785231000000-4f7b2c9ae",
  "timestamp": "2026-07-28T09:30:00.000Z",
  "instance": "POST /v1/projects/0199e0a3-6f21-7c4a-9d18-2b7c5f3ad401/environments",
  "status": 400,
  "docs": "https://ghaym.me/docs/errors/dry-run-unsupported"
}