aYOUne
← Automation API

AutomationChecks

Singular: AutomationCheck — Base URL: https://automation-api.ayoune.app — Access: CRUD

play_circle Try it now beta

Requests are proxied through the consumer-app to *.ayoune.app. Tokens stay in your browser and are forwarded per call.

Example response (recorded) sample

A real, previously recorded GET /:id response of this endpoint — not the live call above. Sensitive fields are masked.

{
  "payload": {
    "_id": "65e0afba121b7d48fe15517d",
    "singleEvent": false,
    "active": false,
    "execMode": "interval",
    "scheduled": false,
    "scheduledIntervalUnit": "weekly",
    "interval": 1,
    "intervalUnit": "days",
    "minuteOfHour": 0,
    "timeOfDay": "9",
    "dayOfWeek": "1",
    "dayOfMonth": "1",
    "runs": 0,
    "lastExecutionTime": 0,
    "totalExecutionTime": 0,
    "numExecutions": 0,
    "useQuery": false,
    "createdBy": "6045f4d25704710012485569",
    "createdAt": "2024-02-29T16:24:26.539Z",
    "updatedAt": "2024-02-29T16:24:26.539Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://automation-api.ayoune.app/automationchecks/65e0afba121b7d48fe15517d",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Queries",
        "title": "MODEL_QUERY",
        "href": "https://api.ayoune.app/config/queries",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.queries"
      }
    ],
    "debugId": "6a62dc3cf9f895648ea72476",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_AUTOMATIONCHECK",
        "href": "https://api.ayoune.app/automation/automationchecks/65e0afba121b7d48fe15517d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_AUTOMATIONCHECK",
        "href": "https://api.ayoune.app/automation/automationchecks/65e0afba121b7d48fe15517d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.19.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2490",
      "reset": "1784867403",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 162.688498,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

MethodPathDescriptionRight
GET /automationchecks List with filters/pagination automation.automationchecks.view
GET /automationchecks/:id Single record automation.automationchecks.view
POST /automationchecks Create new record automation.automationchecks.new
PUT /automationchecks Update record automation.automationchecks.edit
DELETE /automationchecks/:id Delete record automation.automationchecks.delete

SDK

import { aYOUne } from '@tolinax/ayoune';
const ay = new aYOUne('pat_your_token');

// List all
const list = await ay.automation.automationChecks.find().limit(10).exec();

// Single record
const one = await ay.automation.automationChecks.findById('OBJECT_ID').exec();

// Create
const created = await ay.automation.automationChecks.create({ name: 'Foo' });

See also