Update procedure

PATCH/v2/procedures/{id}

Authorization

api_key

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

id*string

Unique identifier of the procedure to update.

Request Body

application/json

name?string

New name for the procedure.

Length1 <= length <= 60

productionBranch?|

Branch treated as production. Pushes to this branch deploy as production; every other branch deploys as preview. Null = no branch promoted to production.

autoPushEnabled?boolean

Master switch for auto-pushing builds to linked stations. Build artifacts are always recorded; this only gates the station fan-out.

excludedBranchPatterns?array<>

Branches matching any of these patterns (exact name or minimatch glob, e.g. "renovate/*") skip preview deployments. Empty array = no exclusions.

rootDirectory?|

Path within the linked repo to the directory holding this procedure's pyproject.toml (and procedure.yaml for framework procedures). Empty/null = repo root.

entryPoint?|

Entry-point path inside the procedure's package dir, relative to it. Forwarded to the CLI through the deployment manifest. Empty/null = use the framework default (openhtf/plain → main.py, pytest → ".", yaml → procedure.yaml auto-discovery).

Response Body

`application/json`

curl -X PATCH "https://example.com/v2/procedures/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

{
  "message": "Bad request",
  "code": "BAD_REQUEST",
  "issues": []
}

{
  "message": "Unauthorized",
  "code": "UNAUTHORIZED",
  "issues": []
}

{
  "message": "Not found",
  "code": "NOT_FOUND",
  "issues": []
}

{
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "issues": []
}

Update procedure

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`