> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rootly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Updates an AI automation

> Requires OAuth scope `ai.automations:write`. Read-only attributes are ignored on write.



## OpenAPI

````yaml https://rootly-heroku.s3.amazonaws.com/swagger/v1/swagger.json put /v1/ai/automations/{id}
openapi: 3.0.1
info:
  title: Rootly API v1
  version: v1
  license:
    name: Rootly
    url: https://rootly.com
  description: >+
    # How to generate an API Key?

    - **Organization dropdown** > **Organization Settings** > **API Keys**


    # JSON:API Specification

    Rootly is using **JSON:API** (https://jsonapi.org) specification:

    - JSON:API is a specification for how a client should request that resources
    be fetched or modified, and how a server should respond to those requests.

    - JSON:API is designed to minimize both the number of requests and the
    amount of data transmitted between clients and servers. This efficiency is
    achieved without compromising readability, flexibility, or discoverability.

    - JSON:API requires use of the JSON:API media type
    (**application/vnd.api+json**) for exchanging data.


    # Authentication and Requests

    We use standard HTTP Authentication over HTTPS to authorize your requests.

    ```
      curl --request GET \
    --header 'Content-Type: application/vnd.api+json' \

    --header 'Authorization: Bearer YOUR-TOKEN' \

    --url https://api.rootly.com/v1/incidents

    ```


    <br/>


    # Rate limiting

    - There is a default limit of **5** **GET**, **HEAD**, and **OPTIONS** calls
    **per API key** every **60 seconds** (0 hours). The limit is calculated over
    a **0-hour sliding window** looking back from the current time. While the
    limit can be configured to support higher thresholds, you must first contact
    your **Rootly Customer Success Manager** to make any adjustments.

    - There is a default limit of **3** **POST**, **PUT**, **PATCH** or
    **DELETE** calls **per API key** every **60 seconds** (0 hours). The limit
    is calculated over a **0-hour sliding window** looking back from the current
    time. While the limit can be configured to support higher thresholds, you
    must first contact your **Rootly Customer Success Manager** to make any
    adjustments.

    - When rate limits are exceeded, the API will return a **429 Too Many
    Requests** HTTP status code with the response: `{"error": "Rate limit
    exceeded. Try again later."}`

    - **X-RateLimit headers** are included in every API response, providing
    real-time rate limit information:
      - **X-RateLimit-Limit** - The maximum number of requests permitted and the time window (e.g., "1000, 1000;window=3600" for 1000 requests per hour)
      - **X-RateLimit-Remaining** - The number of requests remaining in the current rate limit window
      - **X-RateLimit-Used** - The number of requests already made in the current window
      - **X-RateLimit-Reset** - The time at which the current rate limit window resets, in UTC epoch seconds

    # Pagination

    - Pagination is supported for all endpoints that return a collection of
    items.

    - Pagination is controlled by the **page** query parameter


    ## Example

    ```
      curl --request GET \
    --header 'Content-Type: application/vnd.api+json' \

    --header 'Authorization: Bearer YOUR-TOKEN' \

    --url https://api.rootly.com/v1/incidents?page[number]=1&page[size]=10

    ```

  x-logo:
    url: https://rootly-heroku.s3.us-east-1.amazonaws.com/swagger/v1/logo.png
servers:
  - url: https://api.rootly.com
security: []
paths:
  /v1/ai/automations/{id}:
    parameters:
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        required: true
    put:
      tags:
        - AIAutomations
      summary: Updates an AI automation
      description: >-
        Requires OAuth scope `ai.automations:write`. Read-only attributes are
        ignored on write.
      operationId: PutAIAutomation
      parameters: []
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/update_ai_automation'
        required: true
      responses:
        '200':
          description: event automation read representation round-trips through PUT
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/ai_automation'
      security:
        - bearer_auth: []
components:
  schemas:
    update_ai_automation:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              description: Must match the automation id in the path.
            type:
              type: string
              enum:
                - ai_automations
            attributes:
              type: object
              properties:
                name:
                  type: string
                prompt:
                  type: string
                enabled:
                  type: boolean
                triggers:
                  type: array
                  description: >-
                    Replaces the automation's triggers. The automation runs when
                    any trigger matches; all conditions on a trigger must match.
                    Rows with an id update that trigger in place, including a
                    source change; an id that isn't one of this automation's
                    triggers is rejected. Omit id to add a trigger.
                  minItems: 1
                  maxItems: 10
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      source:
                        type: string
                        enum:
                          - schedule
                          - incident
                          - alert
                          - slack
                          - webhook
                      event_name:
                        type: string
                        nullable: true
                        enum:
                          - incident.created
                          - incident.updated
                          - incident.status_changed
                          - incident.severity_changed
                          - incident.resolved
                          - incident.cancelled
                          - alert.created
                          - alert.acknowledged
                          - alert.resolved
                          - slack.message_posted
                          - slack.reaction_added
                          - slack.usergroup_mentioned
                          - webhook.received
                          - null
                      schedule_rrule:
                        type: string
                        nullable: true
                        description: >-
                          Custom RRULE. Can't be combined with
                          schedule.frequency, schedule.hour or schedule.weekday;
                          schedule.timezone is allowed.
                      schedule_timezone:
                        type: string
                        nullable: true
                      schedule_frequency:
                        type: string
                        enum:
                          - hourly
                          - daily
                          - weekdays
                          - weekly
                        description: Preset alternative to schedule_rrule.
                      schedule_hour:
                        type: integer
                        minimum: 0
                        maximum: 23
                      schedule_weekday:
                        type: string
                        enum:
                          - MO
                          - TU
                          - WE
                          - TH
                          - FR
                          - SA
                          - SU
                      cooldown_seconds:
                        type: integer
                        minimum: 0
                        maximum: 604800
                        description: >-
                          Minimum seconds between runs started by this trigger.
                          Event triggers only; schedule triggers must omit it or
                          send 0.
                      next_run_at:
                        type: string
                        format: date-time
                        nullable: true
                        description: >-
                          Read-only; accepted and ignored so GET documents can
                          be sent back.
                      webhook_url:
                        type: string
                        description: >-
                          Read-only; accepted and ignored so GET documents can
                          be sent back.
                      webhook_secret_configured:
                        type: boolean
                        description: >-
                          Read-only; accepted and ignored so GET documents can
                          be sent back.
                      webhook_secret_rotated_at:
                        type: string
                        format: date-time
                        nullable: true
                        description: >-
                          Read-only; accepted and ignored so GET documents can
                          be sent back.
                      conditions:
                        type: array
                        maxItems: 20
                        description: >-
                          Fields and operators per source are listed by GET
                          /v1/ai/automations/trigger_options. Alert and webhook
                          payload conditions use field "payload" with a JSONPath
                          key; webhook keys allow only plain paths such as
                          $.alert.severity or $.tags[0].
                        items:
                          type: object
                          properties:
                            field:
                              type: string
                            field_type:
                              type: string
                              description: >-
                                Read-only; accepted and ignored so GET documents
                                can be sent back.
                            key:
                              type: string
                              nullable: true
                            operator:
                              type: string
                            values:
                              type: array
                              items:
                                type: string
                            value:
                              type: string
                              description: Single-value alternative to values.
                          required:
                            - field
                            - operator
                          additionalProperties: false
                    required:
                      - source
                    additionalProperties: false
                trigger_kind:
                  type: string
                  enum:
                    - schedule
                    - event
                  readOnly: true
                  description: >-
                    Read-only; send triggers to change how the automation is
                    triggered. Accepted on update only when unchanged from GET.
                schedule:
                  type: object
                  properties:
                    frequency:
                      type: string
                      enum:
                        - hourly
                        - daily
                        - weekdays
                        - weekly
                    hour:
                      type: integer
                      nullable: true
                      minimum: 0
                      maximum: 23
                      description: Not used for hourly schedules.
                    weekday:
                      type: string
                      nullable: true
                      enum:
                        - MO
                        - TU
                        - WE
                        - TH
                        - FR
                        - SA
                        - SU
                      description: Only used for weekly schedules.
                    timezone:
                      type: string
                  additionalProperties: false
                  nullable: true
                  readOnly: true
                  description: >-
                    Read-only; send triggers to change how the automation is
                    triggered. Accepted on update only when unchanged from GET.
                schedule_rrule:
                  type: string
                  nullable: true
                  readOnly: true
                  description: >-
                    Read-only; send triggers to change how the automation is
                    triggered. Accepted on update only when unchanged from GET.
                schedule_timezone:
                  type: string
                  nullable: true
                  readOnly: true
                  description: >-
                    Read-only; send triggers to change how the automation is
                    triggered. Accepted on update only when unchanged from GET.
                event_name:
                  type: string
                  nullable: true
                  enum:
                    - incident.created
                    - incident.updated
                    - incident.status_changed
                    - incident.severity_changed
                    - incident.resolved
                    - incident.cancelled
                    - alert.created
                    - alert.acknowledged
                    - alert.resolved
                    - slack.message_posted
                    - slack.reaction_added
                    - slack.usergroup_mentioned
                    - webhook.received
                  readOnly: true
                  description: >-
                    Read-only; send triggers to change how the automation is
                    triggered. Accepted on update only when unchanged from GET.
                conditions:
                  type: object
                  description: >-
                    Read-only; send triggers to change how the automation is
                    triggered. Accepted on update only when unchanged from GET.
                  example:
                    any:
                      - all:
                          - field: status
                            operator: eq
                            value: started
                  properties:
                    any:
                      type: array
                      items:
                        type: object
                        properties:
                          all:
                            type: array
                            items:
                              type: object
                              properties:
                                field:
                                  type: string
                                  enum:
                                    - severity
                                    - status
                                    - to_status
                                operator:
                                  type: string
                                  enum:
                                    - eq
                                    - neq
                                    - contains
                                    - present
                                    - blank
                                value:
                                  oneOf:
                                    - type: string
                                    - type: number
                                    - type: boolean
                                  description: Omitted for present/blank operators.
                              required:
                                - field
                                - operator
                              additionalProperties: false
                        required:
                          - all
                        additionalProperties: false
                  additionalProperties: false
                  readOnly: true
                destination_kind:
                  type: string
                  enum:
                    - slack_channel
                    - incident_timeline
                    - none
                  description: >-
                    slack_channel requires destination_slack_channel_id.
                    incident_timeline is only valid for event automations
                    triggered by incident events.
                destination_slack_target:
                  type: string
                  enum:
                    - channel
                    - trigger_thread
                    - incident_channel
                  default: channel
                  description: >-
                    Slack output destination. trigger_thread requires a Slack
                    trigger; incident_channel requires an incident or alert
                    trigger. When matching trigger context is unavailable, or
                    the automation owner may not post in the resolved channel,
                    output falls back to destination_slack_channel_id. Ignored
                    and stored as channel unless destination_kind is
                    slack_channel.
                destination_slack_channel_id:
                  type: string
                  nullable: true
                  description: >-
                    Slack channel ID (e.g. C0123ABCD), channel name (optional
                    leading #), or Liquid expression. Liquid is stored verbatim
                    and rendered with the run's incident/alert context, for
                    example {{ incident.slack_channel_id }}, {{
                    alert.data.slack_channel_id }}, or {{
                    alert.incidents.first.slack_channel_id }}. Liquid must
                    render a channel ID or synced channel name; names are
                    resolved from Rootly's synced Slack channel records. The
                    rendered channel is verified and checked against the
                    automation owner's Slack permissions at runtime; empty,
                    invalid, unavailable, or unauthorized results fail the run.
                    Static channels must be channels Rootly has already synced
                    from the team's connected Slack workspace; names are matched
                    case-insensitively and resolved to the channel ID on write.
                    Channels created very recently may not be synced yet and are
                    rejected until they are. Setting a channel sets
                    destination_kind to slack_channel when destination_kind is
                    omitted; sending a new channel with any other
                    destination_kind is rejected. null is ignored on write; to
                    stop posting to Slack, change destination_kind instead. When
                    Slack channel user filtering is enabled, personal keys and
                    OAuth tokens only see, and can only set new, channels the
                    user can access in Slack; an update may resend the
                    automation's current channel unchanged. Liquid destinations
                    resolvable without run context use the same acting-user
                    check at save time. Incident/alert-dependent expressions are
                    checked against the automation owner at runtime; every
                    Liquid destination is verified again before delivery.
                skill_ids:
                  type: array
                  description: >-
                    If omitted on update, current attachments are kept. Skills
                    that are no longer invocable by automations are detached the
                    next time an update changes the automation; unchanged
                    updates return the automation as-is.
                  items:
                    type: string
                    format: uuid
                allowed_tool_keys:
                  type: array
                  nullable: true
                  minItems: 1
                  maxItems: 500
                  items:
                    type: string
                  description: >-
                    Tool keys are stable identifiers; connector tools use
                    mcp:<lineage_root_id>:<tool_name> or
                    private_connect:<agent_id>:<provider_id>:<capability>. null
                    inherits all tools allowed by the team; otherwise the
                    automation can use only these tool keys.
                limits_enabled:
                  type: boolean
                  description: >-
                    Stored limit values are returned even when false and apply
                    only when this is true.
                max_credits_per_run:
                  type: number
                  nullable: true
                  minimum: 0
                  maximum: 1000
                  multipleOf: 0.1
                  description: >-
                    Null or 0 means no limit. Otherwise must be at least 1;
                    values between 0 and 1 are rejected. The stored value is
                    returned even when limits are disabled and only applies when
                    limits_enabled is true. Accepts increments of 0.1.
                rate_limit_runs:
                  type: integer
                  minimum: 1
                  maximum: 1440
                  description: >-
                    The stored value is returned even when limits are disabled
                    and only applies when limits_enabled is true.
                rate_limit_window:
                  type: string
                  enum:
                    - 1_hour
                    - 1_day
                    - 7_days
                  description: >-
                    The stored value is returned even when limits are disabled
                    and only applies when limits_enabled is true.
                owner_user_id:
                  type: integer
                  nullable: true
                  description: >-
                    User who is told when a run fails or the automation pauses.
                    Must be a member who can manage automations. Defaults to the
                    creator. null is ignored on write.
                id:
                  type: string
                  readOnly: true
                  description: Ignored on write.
                destination_slack_channel_name:
                  type: string
                  nullable: true
                  readOnly: true
                  description: Ignored on write.
                disabled_reason:
                  type: string
                  nullable: true
                  readOnly: true
                  description: Ignored on write.
                next_run_at:
                  type: string
                  format: date-time
                  nullable: true
                  readOnly: true
                  description: Ignored on write.
                last_run_at:
                  type: string
                  format: date-time
                  nullable: true
                  readOnly: true
                  description: Ignored on write.
                consecutive_failures_count:
                  type: integer
                  readOnly: true
                  description: Ignored on write.
                created_by_user_id:
                  type: integer
                  nullable: true
                  readOnly: true
                  description: Ignored on write.
                created_at:
                  type: string
                  format: date-time
                  readOnly: true
                  description: Ignored on write.
                updated_at:
                  type: string
                  format: date-time
                  readOnly: true
                  description: Ignored on write.
              additionalProperties: false
              description: Read-only attributes are ignored on write.
              minProperties: 1
          required:
            - type
            - attributes
          additionalProperties: false
      required:
        - data
      additionalProperties: false
    ai_automation:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              enum:
                - ai_automations
            attributes:
              type: object
              allOf:
                - $ref: '#/components/schemas/ai_automation_attributes'
          required:
            - id
            - type
            - attributes
      required:
        - data
    ai_automation_attributes:
      type: object
      properties:
        name:
          type: string
        prompt:
          type: string
        enabled:
          type: boolean
        trigger_kind:
          type: string
          enum:
            - schedule
            - event
          description: >-
            Legacy single-trigger view; not authoritative when the automation
            has more than one trigger. Read triggers for the full state.
        schedule:
          type: object
          nullable: true
          properties:
            frequency:
              type: string
              enum:
                - hourly
                - daily
                - weekdays
                - weekly
            hour:
              type: integer
              nullable: true
              minimum: 0
              maximum: 23
              description: Not used for hourly schedules.
            weekday:
              type: string
              nullable: true
              enum:
                - MO
                - TU
                - WE
                - TH
                - FR
                - SA
                - SU
              description: Only used for weekly schedules.
        schedule_rrule:
          type: string
          nullable: true
          description: >-
            Legacy single-schedule view; null unless the automation has exactly
            one schedule trigger. Custom RRULE. Can't be combined with
            schedule.frequency, schedule.hour or schedule.weekday;
            schedule.timezone is allowed.
        schedule_timezone:
          type: string
          nullable: true
          description: >-
            Legacy single-schedule view; null unless the automation has exactly
            one schedule trigger.
        event_name:
          type: string
          nullable: true
          enum:
            - incident.created
            - incident.updated
            - incident.status_changed
            - incident.severity_changed
            - incident.resolved
            - incident.cancelled
            - alert.created
            - alert.acknowledged
            - alert.resolved
            - slack.message_posted
            - slack.reaction_added
            - slack.usergroup_mentioned
            - webhook.received
          description: >-
            Legacy single-event view. null when the automation has no event
            trigger, more than one event, or alert, Slack or webhook conditions;
            read triggers instead.
        conditions:
          type: object
          description: >-
            Legacy view of incident trigger conditions. {} when event_name is
            null. Empty object means no conditions. Groups in any are ORed;
            clauses in all are ANDed.
          example:
            any:
              - all:
                  - field: status
                    operator: eq
                    value: started
          properties:
            any:
              type: array
              items:
                type: object
                properties:
                  all:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                          enum:
                            - severity
                            - status
                            - to_status
                        operator:
                          type: string
                          enum:
                            - eq
                            - neq
                            - contains
                            - present
                            - blank
                        value:
                          oneOf:
                            - type: string
                            - type: number
                            - type: boolean
                          description: Omitted for present/blank operators.
                      required:
                        - field
                        - operator
                      additionalProperties: false
                required:
                  - all
                additionalProperties: false
          additionalProperties: false
        triggers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              source:
                type: string
                enum:
                  - schedule
                  - incident
                  - alert
                  - slack
                  - webhook
              event_name:
                type: string
                nullable: true
                enum:
                  - incident.created
                  - incident.updated
                  - incident.status_changed
                  - incident.severity_changed
                  - incident.resolved
                  - incident.cancelled
                  - alert.created
                  - alert.acknowledged
                  - alert.resolved
                  - slack.message_posted
                  - slack.reaction_added
                  - slack.usergroup_mentioned
                  - webhook.received
                  - null
              schedule_rrule:
                type: string
                nullable: true
              schedule_timezone:
                type: string
                nullable: true
              next_run_at:
                type: string
                format: date-time
                nullable: true
              cooldown_seconds:
                type: integer
              webhook_url:
                type: string
                description: >-
                  Webhook triggers only. POST JSON here with the secret in the
                  X-Webhook-Secret header.
              webhook_secret_configured:
                type: boolean
                description: >-
                  Webhook triggers only. The secret itself is never returned;
                  generate one with POST
                  /v1/ai/automations/{id}/triggers/{trigger_id}/webhook_secret.
              webhook_secret_rotated_at:
                type: string
                format: date-time
                nullable: true
                description: Webhook triggers only.
              conditions:
                type: array
                description: >-
                  All conditions on a trigger must match. Alert and webhook
                  payload conditions use the field token and JSONPath key
                  accepted on write.
                items:
                  type: object
                  properties:
                    field:
                      type: string
                    key:
                      type: string
                      nullable: true
                    field_type:
                      type: string
                    operator:
                      type: string
                    values:
                      type: array
                      items:
                        type: string
                  required:
                    - field
                    - field_type
                    - operator
                    - values
            required:
              - id
              - source
              - event_name
              - schedule_rrule
              - schedule_timezone
              - next_run_at
              - cooldown_seconds
              - conditions
        destination_kind:
          type: string
          enum:
            - slack_channel
            - incident_timeline
            - none
        destination_slack_target:
          type: string
          enum:
            - channel
            - trigger_thread
            - incident_channel
        destination_slack_channel_id:
          type: string
          nullable: true
        destination_slack_channel_name:
          type: string
          nullable: true
        skill_ids:
          type: array
          items:
            type: string
            format: uuid
        allowed_tool_keys:
          type: array
          nullable: true
          minItems: 1
          maxItems: 500
          items:
            type: string
          description: >-
            Tool keys are stable identifiers; connector tools use
            mcp:<lineage_root_id>:<tool_name> or
            private_connect:<agent_id>:<provider_id>:<capability>. null inherits
            all tools allowed by the team; otherwise the automation can use only
            these tool keys.
        limits_enabled:
          type: boolean
          description: >-
            Stored limit values are returned even when false and apply only when
            this is true.
        max_credits_per_run:
          type: number
          nullable: true
          description: >-
            The stored value is returned even when limits are disabled and only
            applies when limits_enabled is true.
        rate_limit_runs:
          type: integer
          description: >-
            The stored value is returned even when limits are disabled and only
            applies when limits_enabled is true.
        rate_limit_window:
          type: string
          enum:
            - 1_hour
            - 1_day
            - 7_days
          description: >-
            The stored value is returned even when limits are disabled and only
            applies when limits_enabled is true.
        owner_user_id:
          type: integer
          nullable: true
        disabled_reason:
          type: string
          nullable: true
        next_run_at:
          type: string
          format: date-time
          nullable: true
        last_run_at:
          type: string
          format: date-time
          nullable: true
        consecutive_failures_count:
          type: integer
        created_by_user_id:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.