aYOUne
← Configuration API

APIs

Singular: API — Base URL: https://config-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": {
    "limit": true,
    "rateLimit": 10000,
    "_id": "6031e7df05eda1001243de1d",
    "callback_url": "http://localhost:3000",
    "active": true,
    "access_token": "***",
    "access_token_key": "***",
    "title": "ayoune Test API",
    "user": "5ee06fc3860473001cfb290e",
    "createdAt": "2021-02-21T04:55:59.523Z",
    "updatedAt": "2022-01-12T02:26:33.939Z",
    "scopes": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/apis/6031e7df05eda1001243de1d",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6a62dcb930b7d778029e51ca",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_API",
        "href": "https://api.ayoune.app/config/apis/6031e7df05eda1001243de1d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_API",
        "href": "https://api.ayoune.app/config/apis/6031e7df05eda1001243de1d/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.94.0",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2471",
      "reset": "1784865648",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 194.71156,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also