> ## Documentation Index
> Fetch the complete documentation index at: https://ara-90a60a07.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Update an automation
> Partial update of the automation's configuration. Send only the fields you want to change. Triggers are managed through the triggers sub-resource.
Scope: `automations:write`
## OpenAPI
````yaml /openapi/openapi.json patch /v3/organizations/{orgId}/automations/{automationId}
openapi: 3.1.0
info:
title: Ara API
version: 3.0.0
description: >-
The Ara HTTP API. Drive cloud software-engineering agents: open sessions
against your repositories, stream their work, and manage the secrets,
knowledge, skills, and automations they run with.
All requests authenticate with an `ara_` API key sent as a bearer token.
Every resource is scoped to an organization; resolve your `org_id` once with
`GET /v3/self`.
servers:
- url: https://api.ara.so
security:
- araApiKey: []
tags:
- name: Account
description: Verify a key and resolve the organization it belongs to.
- name: Sessions
description: >-
A session is one run of an agent against a repository: it reproduces the
task, writes the code, verifies it, and opens a pull request or merge
request.
- name: Secrets
description: >-
Encrypted credentials injected into the agent's sandbox. Write-only:
values can be set but never read back.
- name: Knowledge
description: Durable notes the agent consults while it works.
- name: Memory
description: >-
Editable repository notes that are projected into native memory; generated
memory remains read-only.
- name: Skills
description: Reusable instruction bundles that activate for matching agent tasks.
- name: Automations
description: Recurring or one-time triggers that open sessions on a timetable.
- name: Change Request Reviews
description: >-
Automated senior-engineer reviews posted on pull requests and merge
requests.
- name: Repositories
description: Connected repositories, their indexing state, and generated wikis.
- name: Git Connections
description: Linked source-control accounts and the repositories they expose.
- name: Consumption
description: 'Billing-aligned usage: daily consumption and billing cycles.'
- name: Metrics
description: Aggregate analytics over sessions, change requests, and usage.
- name: Audit Logs
description: An append-only record of changes made within the organization.
- name: Organizations
description: The top-level tenant. Create, read, update, and delete organizations.
- name: Members
description: People in an organization and their pending invites.
- name: Service Users
description: Machine principals that own API keys for headless access.
- name: Roles
description: Role assignments that govern what each member can do.
- name: Attachments
description: >-
Files uploaded to the organization and shared with sessions, downloaded
via short-lived signed URLs.
- name: Guardrails
description: >-
Per-repository automation limits and the violations recorded when a limit
is hit.
- name: MCP Servers
description: >-
Org-level Model Context Protocol servers exposed to the agent. Secret
values are write-only.
- name: Settings
description: 'Organization configuration: namespaced settings and the run tag policy.'
- name: Blueprints
description: >-
Read-only declarative manifests of an organization's agents (identity, run
config, triggers, suite), with credentials redacted.
- name: IP Access List
description: >-
Source-network allow-list that, when enabled, restricts the organization's
API surface to a set of CIDR ranges.
- name: Groups
description: Manually-curated member groups carrying optional per-day resource limits.
paths:
/v3/organizations/{orgId}/automations/{automationId}:
parameters:
- $ref: '#/components/parameters/orgId'
- name: automationId
in: path
required: true
schema:
type: string
patch:
tags:
- Automations
summary: Update an automation
description: >-
Partial update of the automation's configuration. Send only the fields
you want to change. Triggers are managed through the triggers
sub-resource.
Scope: `automations:write`
operationId: updateAutomation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAutomation'
responses:
'200':
description: Updated.
content:
application/json:
schema:
$ref: '#/components/schemas/Automation'
'402':
description: Available during an Ara trial or paid subscription.
'404':
$ref: '#/components/responses/NotFound'
security:
- araApiKey:
- automations:write
components:
parameters:
orgId:
name: orgId
in: path
required: true
description: Organization id or slug. Resolve it with `GET /v3/self`.
schema:
type: string
schemas:
UpdateAutomation:
type: object
properties:
name:
type: string
instructions:
type: string
model:
type:
- string
- 'null'
tools:
type: object
properties:
mcp_servers:
description: >-
Org MCP server slugs this automation may use. `null` inherits
every enabled org server.
type:
- array
- 'null'
items:
type: string
app_tools:
type: array
items:
type: string
description: Catalog connector slugs (e.g. `linear`, `sentry`).
enabled:
type: boolean
description: >-
Set `false` to pause the automation. A paused automation's triggers
never fire.
description: All fields optional. Only the fields you send are changed.
Automation:
type: object
properties:
id:
type: string
org_id:
type: string
name:
type:
- string
- 'null'
instructions:
description: The system instructions the automation runs with.
type:
- string
- 'null'
model:
type:
- string
- 'null'
enabled:
type: boolean
description: A paused (`false`) automation's triggers never fire.
tools:
type: object
properties:
mcp_servers:
description: '`null` inherits every enabled org MCP server.'
type:
- array
- 'null'
items:
type: string
app_tools:
type: array
items:
type: string
environment:
type: object
properties:
repo:
description: >-
Provider-native repository path. GitHub uses `owner/name`;
GitLab may include nested groups.
type:
- string
- 'null'
provider:
type:
- string
- 'null'
enum:
- github
- gitlab
triggers:
type: array
items:
$ref: '#/components/schemas/Trigger'
description: Every condition that fires this automation. Empty until you add one.
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
description: >-
An automation: its instructions, tools, environment binding, and
triggers.
Trigger:
type: object
properties:
id:
type: string
kind:
type: string
enum:
- schedule
- github_event
- webhook
enabled:
type: boolean
schedule:
type:
- object
- 'null'
properties:
kind:
type:
- string
- 'null'
enum:
- cron
- every
- at
- null
expression:
description: Cron expression, or the ISO run-at time for a one-time trigger.
type:
- string
- 'null'
every_seconds:
type:
- integer
- 'null'
next_run_at:
type:
- string
- 'null'
format: date-time
github:
type:
- object
- 'null'
properties:
event:
type:
- string
- 'null'
action:
type:
- string
- 'null'
repo:
type:
- string
- 'null'
webhook:
type:
- object
- 'null'
properties:
configured:
type: boolean
run_kind:
type:
- string
- 'null'
last_fired_at:
type:
- string
- 'null'
format: date-time
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
description: >-
A condition that fires the automation. The webhook secret is never
returned.
Error:
type: object
properties:
error:
type: string
message:
type: string
responses:
NotFound:
description: Resource not found.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: session_not_found
securitySchemes:
araApiKey:
type: http
scheme: bearer
bearerFormat: ara_
description: >-
Your `ara_` API key from Settings > Ara API. Keys are capability-scoped:
run, plugins:read, secrets:read, secrets:write, sessions:read,
knowledge:read, repos:read, repos:write, reviews:read, reviews:write,
analytics:read, org:read, org:write, attachments:read,
attachments:write, plugins:write, guardrails:read, guardrails:write.
````