Eagle Eye Networks Action Rules API

openapi: 3.2.0
info:
  title: AUTOMATIONS Action Rules API
  version: 3.0.0
  description: Describe when an alert should trigger an automated action.
servers:
- url: https://{BaseUrl}/api/v3.0
  description: Eagle Eye Networks API Server
  variables:
    BaseUrl:
      default: api.cxxx.eagleeyenetworks.com
      description: HTTPS Base url to use for all API calls, retrieved from https://api.eagleeyenetworks.com/api/v3.0/clientSettings
security:
- bearerAuth: []
tags:
- name: Action Rules
  description: Describe when an alert should trigger an automated action.
paths:
  /alertActionRules:
    post:
      operationId: addAlertActionRule
      description: Registers a new alert action rule with the account. These rules allow users to link alert action rules to alert condition rule.
      tags:
      - Action Rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertActionRuleCreate'
      responses:
        '201':
          description: Alert action rule registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertActionRule'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
      summary: Add alert action rule
      x-summary-source: derived
    get:
      tags:
      - Action Rules
      operationId: listAlertActionRules
      description: List the configured action rules.
      parameters:
      - $ref: '#/components/parameters/pageToken'
      - $ref: '#/components/parameters/pageSize'
      responses:
        '200':
          description: Alert action rule results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertActionRules'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: List alert action rules
      x-summary-source: derived
  /alertActionRules/{actionRuleId}:
    parameters:
    - in: path
      name: actionRuleId
      schema:
        type: string
      required: true
    get:
      operationId: getAlertActionRule
      description: Retrieve a single alert action rule.
      tags:
      - Action Rules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertActionRule'
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Get alert action rule
      x-summary-source: derived
    patch:
      operationId: updateAlertActionRule
      description: Update single alert action rule.
      tags:
      - Action Rules
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertActionRuleUpdate'
      responses:
        '204':
          description: Alert Condition Rule Updated
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Update alert action rule
      x-summary-source: derived
    delete:
      operationId: deleteAlertActionRule
      description: Removes alert action rule.
      tags:
      - Action Rules
      responses:
        '204':
          description: Alert action rule deleted.
        '400':
          $ref: '#/components/responses/validationError'
        '401':
          $ref: '#/components/responses/unauthorized'
        '403':
          $ref: '#/components/responses/forbidden'
        '404':
          $ref: '#/components/responses/resourceNotFound'
        '500':
          $ref: '#/components/responses/internalServerError'
      summary: Delete alert action rule
      x-summary-source: derived
components:
  schemas:
    ErrorInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
        reason:
          description: 'The reason for the error. This is a constant value that identifies the proximate cause of the

            error. Error reasons are unique within a particular domain of errors.

            '
          type: string
          enum:
          - unauthenticated
          - unexpectedArgument
          - missingRequiredArgument
          - wrongArgumentValue
          - invalidPermission
          - wrongEdition
          - wrongAccountType
          - resourceNotFound
          - endpointNotFound
          - methodNotSupported
          - unexpectedError
          - acceptNotSupported
          - alreadyExists
          - foreignKeyConflict
          - childDevicesExist
          - contentNotSupported
          - deadlineExpired
          - tooManyRequests
          - deviceUnavailable
          - serviceUnavailable
          - invalidJSON
          - resourceLocked
          - notSupportedOnBridge
          - outOfRetention
          - deviceIdentificationFailed
          - credentialValidationFailed
          - credentialSetupFailed
          - localUrlValidationFailed
          - hwRegistrationFailed
          - failedAddingCameraAfterValidation
          - neverConnected
          - reconnectFailed
          - unsupportedModel
          - purged
          - userBlocked
          - userTemporarilyBlocked
          - quotaExceeded
          - alreadyValidated
          - reAuthenticationRequired
          - badGateway
        domain:
          description: 'Logical grouping to which the "reason" belongs

            '
          type: string
        metadata:
          $ref: '#/components/schemas/ExceptionMetadata'
    ExceptionDetail:
      type: object
      oneOf:
      - $ref: '#/components/schemas/ErrorInfoExceptionDetail'
      - $ref: '#/components/schemas/BadRequestExceptionDetail'
      - $ref: '#/components/schemas/ResourceInfoExceptionDetail'
      discriminator:
        propertyName: type
        mapping:
          errorInfo: '#/components/schemas/ErrorInfoExceptionDetail'
          badRequest: '#/components/schemas/BadRequestExceptionDetail'
          resourceInfo: '#/components/schemas/ResourceInfoExceptionDetail'
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - errorInfo
          - badRequest
          - resourceInfo
      required:
      - type
    ApiV3Error:
      type: object
      properties:
        code:
          description: HTTP code defined in EEN Standard Code Values
          type: integer
        status:
          description: A string enum describing the code
          type: string
          enum:
          - cancelled
          - unknown
          - invalidArgument
          - deadlineExceeded
          - notFound
          - conflict
          - permissionDenied
          - resourceExhausted
          - failedPrecondition
          - aborted
          - outOfRange
          - unimplemented
          - internal
          - unavailable
          - dataLoss
          - unauthenticated
          - mediaTypeNotSupported
          - acceptNotSupported
          - methodNotSupported
          - tooManyRequests
          - badGateway
        message:
          description: Developer friendly human readable error message in English
          type: string
        details:
          description: An array of extensible objects that define error information
          type: array
          items:
            $ref: '#/components/schemas/ExceptionDetail'
      required:
      - code
      - status
      - message
      - details
    ContextImageItem:
      type: object
      description: Configuration for one context image at a specific second offset from the event timestamp.
      required:
      - offsetSeconds
      properties:
        offsetSeconds:
          type: integer
          enum:
          - -5
          - -4
          - -3
          - -2
          - -1
          - 1
          - 2
          - 3
          - 4
          - 5
          description: 'Seconds relative to the event timestamp. Negative values are before the event, positive values are after. 0 is excluded — that is the alert image itself (configured in alertImage). Valid range: -5 to +5 excluding 0.

            '
        imageType:
          type: string
          enum:
          - full
          default: full
          description: Image type. Only "full" is supported currently.
    BadRequestExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - badRequest
        argumentViolations:
          type: array
          items:
            $ref: '#/components/schemas/ArgumentViolation'
    AlertActionRules:
      allOf:
      - $ref: '#/components/schemas/PaginatedResponse'
      - type: object
        properties:
          results:
            type: array
            items:
              $ref: '#/components/schemas/AlertActionRule'
    ResourceInfoExceptionDetail:
      properties:
        type:
          description: A string enum describing the type of detail object.
          type: string
          enum:
          - resourceInfo
        resource:
          description: Referenced resource type, eg "cameras", "bridges", or "locations".
          type: string
        ids:
          type: array
          description: Identities of resources
          items:
            type: string
    AlertImageConfig:
      type: object
      description: Configuration for the primary alert image. Always included when imageOptions is set; cannot be disabled.
      properties:
        embeddedOverlay:
          type: boolean
          default: true
          description: 'Use the overlay-embedded full-frame image. Falls back to the plain full-frame image if the overlay version is unavailable in alert.data.

            '
        includeCropUrl:
          type: boolean
          default: false
          description: 'Also attach the cropped detection-region image. Silently skipped if the crop URL is not present in alert.data.

            '
    AlertActionRuleUpdate:
      type: object
      properties:
        id:
          description: Unique identifier of the alert action rule.
          type: string
          readOnly: true
          example: 322d38b9-8ed7-41b5-a57d-3fe9f160939c
        createTimestamp:
          description: Time at which the alert action rule was created.
          type: string
          format: date-time
          readOnly: true
          example: '2021-04-22T00:00:00.000+00:00'
        name:
          description: Name to let humans easily identify and understand the alert action rule.
          type: string
          example: Cameras offline for 5 min.
        notes:
          description: Large text field that allows users to leave notes for themselves and others.
          type: string
          example: Take action if cameras are offline for more than 5 minutes.
        enabled:
          description: If set to true, this rule is active, if set to false, it will not be applied.
          type: boolean
          example: true
          default: true
        alertTypes:
          description: If defined, this rule will only trigger on alerts of the given types.
          type:
          - array
          - 'null'
          items:
            type: string
            example: userLogin
          minLength: 1
        actorIds:
          description: If defined, this rule will only trigger on alerts about actors with the given ids.
          type:
          - array
          - 'null'
          items:
            type: string
          minLength: 1
        actorTypes:
          description: If defined, this rule will only trigger on alerts about actors of the given types.
          type:
          - array
          - 'null'
          items:
            type: string
            example: device
          minLength: 1
        actorAccountIds:
          description: If defined, this rule will only trigger on alerts about actors from the given accounts.
          type:
          - array
          - 'null'
          items:
            type: string
          minLength: 1
        ruleIds:
          description: 'If defined, this rule will only trigger on alerts that were generated by one of the given alert condition

            rules.

            '
          type:
          - array
          - 'null'
          items:
            type: string
            example: d290f1ee-6c54-4b01-90e6-d701748f0851
          minLength: 1
        priority__gte:
          description: 'If defined, this rule will only trigger on alerts with a priority greater than or equal to the given value.

            '
          type:
          - integer
          - 'null'
          example: 3
        priority__lte:
          description: 'If defined, this rule will only trigger on alerts with a priority less than or equal to the given value.

            '
          type:
          - integer
          - 'null'
          example: 8
        alertActionIds:
          description: Defines the actions to take if an alert matches the rule.
          type: array
          items:
            type: string
            example: f3436b61-94fd-41b6-8f0a-ee6ff55acaa6
        locationIds:
          description: If defined, this rule will only trigger on alerts about actors from the given locations.
          type:
          - array
          - 'null'
          items:
            type: string
          minLength: 1
        imageOptions:
          allOf:
          - $ref: '#/components/schemas/ImageOptions'
          default: null
          description: 'Image attachment configuration for this rule. When null, the existing single-image behaviour is used unchanged. When set, all actions linked to this rule will receive images resolved from alert.data URLs (images are resolved from alert.data URLs). Maximum 6 images total per execution. Currently applied to SMTP and Immix actions.

            '
    ArgumentViolation:
      properties:
        argumentName:
          type: string
          description: Name of the argument
        description:
          type: string
          description: Description of the violation
    ImageOptions:
      type: object
      description: 'Image attachment configuration for an alert action rule. Defines which images are attached when the rule fires. Maximum 6 images total per execution: 1 alert image + 1 optional crop + up to 4 context images.

        '
      required:
      - alertImage
      properties:
        alertImage:
          $ref: '#/components/schemas/AlertImageConfig'
        contextImages:
          type: array
          description: 'Ordered list of additional context images. Each item specifies one image at an explicit second offset from the event timestamp. Offsets must be unique; 0 is excluded (that is the alert image itself).

            '
          default: []
          maxItems: 4
          uniqueItems: true
          items:
            $ref: '#/components/schemas/ContextImageItem'
    ExceptionMetadata:
      properties:
        path:
          description: Path of the request
          type: string
        method:
          description: Method of the request
          type: string
    AlertActionRule:
      allOf:
      - $ref: '#/components/schemas/AlertActionRuleUpdate'
      - required:
        - name
    PaginatedResponse:
      type: object
      description: 'Used to wrap results for a paginated response, containing information on how to retrieve further pages and, if  available, the total number of results.

        '
      properties:
        nextPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the next page. The value of this token is passed into the field pageToken.  This value can be null if there is no next page.

            '
        prevPageToken:
          type:
          - string
          - 'null'
          readOnly: true
          description: 'Token to retrieve the previous page. The value of this token is passed into the field pageToken.  This value can be null of there is no previous page.

            '
        totalSize:
          type:
          - integer
          - 'null'
          minimum: 0
          readOnly: true
          description: 'The number of resource entries being returned from the result set.  This can be omitted if the API endpoint does not have total size information.

            '
        results:
          type: array
          readOnly: true
          description: The result set from a collection API call.
          items:
            type: object
      required:
      - nextPageToken
      - prevPageToken
      - results
    AlertActionRuleCreate:
      allOf:
      - $ref: '#/components/schemas/AlertActionRuleUpdate'
      - required:
        - name
        - alertActionIds
  responses:
    forbidden:
      description: You have no permission to access the specified resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            invalidPermission:
              value:
                code: 403
                status: permissionDenied
                message: The client caller does not have permission for the specified operation
                details:
                - type: errorInfo
                  reason: invalidPermission
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            wrongEdition:
              value:
                code: 403
                status: permissionDenied
                message: This feature is not enabled for the account
                details:
                - type: errorInfo
                  reason: wrongEdition
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
            wrongAccountType:
              value:
                code: 403
                status: permissionDenied
                message: This feature is only available for end users
                details:
                - type: errorInfo
                  reason: wrongAccountType
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/locations
    resourceNotFound:
      description: Referenced resource could not be found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            endpointNotFound:
              value:
                code: 404
                status: notFound
                message: The API endpoint was not found
                details:
                - type: errorInfo
                  reason: endpointNotFound
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            resourceNotFound:
              value:
                code: 404
                status: notFound
                message: The resource was not found
                details:
                - type: errorInfo
                  reason: resourceNotFound
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: resourceInfo
                  resource: <resource>
                  ids:
                  - <ids>
    internalServerError:
      description: Something went wrong in the server. Please try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 500
            status: internal
            message: An internal error has occurred. Please try again later.
            details:
            - type: errorInfo
              reason: unexpectedError
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    unauthorized:
      description: You are not authenticated. Please authenticate and try again.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          example:
            code: 401
            status: unauthenticated
            message: The client caller does not have a valid authentication credential
            details:
            - type: errorInfo
              reason: unauthenticated
              domain: apiv3
              metadata:
                path: /api/v3.0/<resource>
    validationError:
      description: The supplied object is invalid. Error detail will contain the validation error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiV3Error'
          examples:
            unexpectedArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Unexpected argument: name'
                details:
                - type: errorInfo
                  reason: unexpectedArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            missingRequiredArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Missing required arguments: name, id'
                details:
                - type: errorInfo
                  reason: missingRequiredArgument
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidJSON:
              value:
                code: 400
                status: invalidArgument
                message: Invalid JSON
                details:
                - type: errorInfo
                  reason: invalidJSON
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
            badRequestInvalidArgument:
              value:
                code: 400
                status: invalidArgument
                message: 'Invalid Argument: Argument name is too long'
                details:
                - type: errorInfo
                  reason: wrongArgumentValue
                  domain: apiv3
                  metadata:
                    path: /api/v3.0/<resource>
                - type: badRequest
                  argumentViolations:
                  - argumentName: name
                    description: Name is too long
  parameters:
    pageSize:
      in: query
      name: pageSize
      description: 'The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and  maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a `nextPageToken` value.

        '
      example: 100
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 500
        default: 100
    pageToken:
      in: query
      name: pageToken
      description: 'Token string value that references a page for pagination. This value is received when retrieving the first page in the `nextPageToken` and `prevPageToken` fields.

        When a pageToken is provided, the backend remembers search parameters from the original request, so search  parameters that affect the result set or order are optional and will be ignored if provided. Representation  parameters like `include` should still be applied.

        '
      example: b2Zmc2V0PTEwJmxpbWl0PTEw
      required: false
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://developer.eagleeyenetworks.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.eagleeyenetworks.com/reference/addalertaction.md
  - https://developer.eagleeyenetworks.com/reference/addalertactionrule.md
  - https://developer.eagleeyenetworks.com/reference/addeventalertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/deletealertaction.md
  - https://developer.eagleeyenetworks.com/reference/deletealertactionrule.md
  - https://developer.eagleeyenetworks.com/reference/deleteeventalertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/getalertaction.md
  - https://developer.eagleeyenetworks.com/reference/getalertactionrule.md
  - https://developer.eagleeyenetworks.com/reference/geteventalertconditionrule.md
  - https://developer.eagleeyenetworks.com/reference/geteventalertconditionrulesfieldvalues.md
  - https://developer.eagleeyenetworks.com/reference/listalertactionrules.md
  - https://developer.eagleeyenetworks.com/reference/listalertactions.md
  - https://developer.eagleeyenetworks.com/reference/listeventalertconditionrules.md
  - https://developer.eagleeyenetworks.com/reference/updatealertaction.md
  - https://developer.eagleeyenetworks.com/reference/updatealertactionrule.md
  - https://developer.eagleeyenetworks.com/reference/updateeventalertconditionrule.md
  merge:
    pages: 16
    deduped: 330
    conflicts_kept_first: 0