Update an existing automation | Comp AI API

Update an existing automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.

PATCH /v1/tasks/{taskId}/automations/{automationId}

Update an existing automation

cURL

curl --request PATCH \
  --url https://api.trycomp.ai/v1/tasks/{taskId}/automations/{automationId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "GitHub Security Check - Evidence Collection",
  "description": "Collects evidence about GitHub repository security settings",
  "isEnabled": true,
  "evaluationCriteria": "<string>"
}
'

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'GitHub Security Check - Evidence Collection',
    description: 'Collects evidence about GitHub repository security settings',
    isEnabled: true,
    evaluationCriteria: '<string>'
  })
};

fetch('https://api.trycomp.ai/v1/tasks/{taskId}/automations/{automationId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.trycomp.ai/v1/tasks/{taskId}/automations/{automationId}"

payload = {
    "name": "GitHub Security Check - Evidence Collection",
    "description": "Collects evidence about GitHub repository security settings",
    "isEnabled": True,
    "evaluationCriteria": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "success": true,
  "automation": {
    "id": "auto_abc123def456",
    "name": "Updated Automation Name",
    "description": "Updated description"
  }
}

{
  "message": "Invalid automation data"
}

{
  "message": "Unauthorized"
}

{
  "message": "Automation not found"
}

Authorizations

X-API-Key · string · header · required

API key for authentication

Path Parameters

taskId · string · required

Unique task identifier

Example:

"tsk_abc123def456"

automationId · string · required

Unique automation identifier

Example:

"auto_abc123def456"

Body

application/json

name · string

Automation name

Example:

"GitHub Security Check - Evidence Collection"

description · string

Automation description

Example:

"Collects evidence about GitHub repository security settings"

isEnabled · boolean

Whether the automation is enabled

evaluationCriteria · string

Evaluation criteria for the automation

scheduleFrequency · enum<string>

Automation schedule cadence

Available options: daily, weekly, monthly, quarterly, yearly

Response

200

application/json

Automation updated successfully

success · boolean

Example:

true

automation · object

Show child attributes