aYOUne
← CMS API

WebPages

Singular: WebPage — Base URL: https://cms-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": {
    "config": {
      "assets": [],
      "pages": [],
      "styles": []
    },
    "metaRules": {
      "title": "[CAT] kaufen im [CAT] Onlineshop",
      "description": "[CAT] kaufen im [CAT] Onlineshop",
      "titleSingle": "[TITLE] kaufen im [CAT] Onlineshop",
      "descriptionSingle": "[TITLE] kaufen im [CAT] Onlineshop"
    },
    "maintenance": {
      "enabled": false
    },
    "isPublished": false,
    "supportedLocales": [],
    "sortOrder": 0,
    "_id": "65e0afd1121b7d48fe155918",
    "leads": [],
    "customers": [],
    "createdBy": "6045f4d25704710012485569",
    "headerScripts": [],
    "links": [],
    "footerScripts": [],
    "dataSources": [],
    "createdAt": "2024-02-29T16:24:49.360Z",
    "updatedAt": "2024-02-29T16:24:49.360Z",
    "blocks": []
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://cms-api.ayoune.app/webpages/65e0afd1121b7d48fe155918",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [
      {
        "rel": "Properties",
        "title": "MODEL_PROPERTY",
        "href": "https://api.ayoune.app/config/properties",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.properties"
      },
      {
        "rel": "Projects",
        "title": "MODEL_PROJECT",
        "href": "https://api.ayoune.app/pm/projects",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "pm.projects"
      },
      {
        "rel": "Affiliates",
        "title": "MODEL_AFFILIATE",
        "href": "https://api.ayoune.app/config/affiliates",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "config.affiliates"
      },
      {
        "rel": "Websites",
        "title": "MODEL_WEBSITE",
        "href": "https://api.ayoune.app/cms/websites",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.websites"
      },
      {
        "rel": "WebPages",
        "title": "MODEL_WEBPAGE",
        "href": "https://api.ayoune.app/cms/webpages",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "cms.webpages"
      },
      {
        "rel": "Keywords",
        "title": "MODEL_KEYWORD",
        "href": "https://api.ayoune.app/monitoring/keywords",
        "method": "get",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ],
        "right": "monitoring.keywords"
      }
    ],
    "debugId": "6a62dc8301c81db07e1db935",
    "errors": [],
    "actions": [
      {
        "rel": "self",
        "action": "COPY",
        "title": "MODEL_WEBPAGE",
        "href": "https://api.ayoune.app/cms/webpages/65e0afd1121b7d48fe155918/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      },
      {
        "rel": "self",
        "action": "DELETE",
        "title": "MODEL_WEBPAGE",
        "href": "https://api.ayoune.app/cms/webpages/65e0afd1121b7d48fe155918/copy",
        "method": "post",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "version": {
      "host": "2026.25.5",
      "core": "2026.258.0"
    },
    "rateLimit": {
      "limit": "2500",
      "remaining": "2303",
      "reset": "1784867449",
      "resetDate": "Fri Jul 24 2026"
    },
    "responseTime": 76.454074,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also