Skip to main content
PUT
/
api
/
v1
/
automations
/
{id}
Replace automation
curl --request PUT \
  --url https://api.example.com/api/v1/automations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'If-Match: <if-match>' \
  --data '
{
  "name": "Nightly dependency update",
  "target": {
    "repository": "fabro-sh/fabro",
    "ref": "main",
    "workflow": "dependency-update"
  },
  "triggers": [
    {
      "id": "manual",
      "type": "api",
      "enabled": true
    }
  ],
  "description": "Keeps dependencies fresh."
}
'
{
  "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",
      "type": "api",
      "enabled": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Raw dev token passed as Authorization: Bearer fabro_dev_... when server.auth.methods includes dev-token.

Headers

​
If-Match
string
required

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

Path Parameters

​
id
string
required

Unique automation identifier.

Pattern: ^[a-z0-9][a-z0-9-]{0,62}$

Body

application/json

Request body for replacing an automation.

​
name
string
required
Example:

"Nightly dependency update"

​
target
object
required

Repository and workflow selected by an automation.

​
triggers
object[]
required

Automation trigger configuration. Unknown type discriminator values are reported by handlers as domain validation errors with HTTP 422.

​
description
string | null
Example:

"Keeps dependencies fresh."

Response

Automation replaced

Public automation definition.

​
id
string
required
Pattern: ^[a-z0-9][a-z0-9-]{0,62}$
Example:

"nightly-deps"

​
revision
string
required

Stable revision used with If-Match for optimistic concurrency.

Pattern: ^[0-9a-f]{64}$
Example:

"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

​
name
string
required
Example:

"Nightly dependency update"

​
description
string | null
required
Example:

"Keeps dependencies fresh."

​
target
object
required

Repository and workflow selected by an automation.

​
triggers
object[]
required

Automation trigger configuration. Unknown type discriminator values are reported by handlers as domain validation errors with HTTP 422.