v106

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-02160524464.6 KB

Automations

Replace automation

Replaces an automation definition when If-Match matches the current automation revision.

put/api/v1/automations/{id}

Path parameters

idstring required

Unique automation identifier.

Headers

If-Matchstring required

Current resource revision used for optimistic concurrency, as returned in the ETag response header.

Request body

namestring required

descriptionstring nullable

Example request

{
  "name": "Nightly dependency update",
  "description": "Keeps dependencies fresh.",
  "target": {
    "repository": "fabro-sh/fabro",
    "ref": "main",
    "workflow": "dependency-update"
  },
  "triggers": [
    {
      "id": "manual",
      "enabled": true
    }
  ]
}

Response

Automation replaced

idstring required

revisionstring required

Stable revision used with If-Match for optimistic concurrency.

namestring required

descriptionstring nullable required

Example response

{
  "id": "nightly-deps",
  "revision": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
  "name": "Nightly dependency update",
  "description": "Keeps dependencies fresh.",
  "target": {
    "repository": "fabro-sh/fabro",
    "ref": "main",
    "workflow": "dependency-update"
  },
  "triggers": [
    {
      "id": "manual",
      "enabled": true
    }
  ]
}