Skip to main content
PATCH
/
v1
/
tasks
/
{taskId}
/
automations
/
{automationId}
Update an existing automation
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>",
  "scheduleFrequency": "daily"
}
'
{
  "success": true,
  "automation": {
    "id": "auto_abc123def456",
    "name": "Updated Automation Name",
    "description": "Updated description"
  }
}

Documentation Index

Fetch the complete documentation index at: https://www.trycomp.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

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

Automation updated successfully

​
success
boolean
Example:

true

​
automation
object