Skip to content
aYOUne
← Configuration API

Domains

Singular: Domain — Base URL: https://config-api.ayoune.app — Access: CRUD — Machine-readable spec (JSON · YAML)

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": {
    "tls": {
      "provisioned": false
    },
    "_id": "6aa6130c67420e014000fc07",
    "email": false,
    "websites": false,
    "landingpages": false,
    "verified": false,
    "createdBy": "6045f4d25704710012485569",
    "shares": [],
    "createdAt": "2026-09-13T03:05:48.801Z",
    "updatedAt": "2026-09-13T03:05:48.801Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://config-api.ayoune.app/domains/6aa6130c67420e014000fc07",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Websites",
        "title": "MODEL_WEBSITE",
        "href": "https://api.ayoune.app/cms/websites",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.websites"
      }
    ],
    "debugId": "6acafffe9933be37fb1b44e5",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_DOMAIN",
        "href": "https://api.ayoune.app/config/domains/6aa6130c67420e014000fc07/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_DOMAIN",
        "href": "https://api.ayoune.app/config/domains/6aa6130c67420e014000fc07",
        "method": "delete",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.170.1",
      "core": "2026.368.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9983",
      "reset": "1791691321",
      "resetDate": "Sun Oct 11 2026"
    },
    "responseTime": 116.408887,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also