Skip to content
aYOUne
← DevOps API

DeploymentPlans

Singular: DeploymentPlan — Base URL: https://devops-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": {
    "_id": "6aa61cf60ca857facde075d4",
    "name": "ACADEMIC_FUCHSIA_JAR JAR BINKS",
    "description": "",
    "status": "draft",
    "executionCount": 0,
    "successCount": 0,
    "failureCount": 0,
    "createdBy": "6045f4d25704710012485569",
    "steps": [],
    "shares": [],
    "createdAt": "2026-09-13T03:48:07.000Z",
    "updatedAt": "2026-09-13T03:48:07.000Z"
  },
  "meta": {
    "links": [
      {
        "rel": "self",
        "href": "https://devops-api.ayoune.app/deploymentplans/6aa61cf60ca857facde075d4",
        "method": "get",
        "title": "GET",
        "types": [
          "application/json",
          "application/yaml",
          "text/csv"
        ]
      }
    ],
    "relations": [],
    "debugId": "6adec99f04dd7214f8ca7a11",
    "errors": [],
    "actions": [],
    "version": {
      "host": "2026.27.0",
      "core": "2026.388.0"
    },
    "rateLimit": {
      "limit": "10000",
      "remaining": "9918",
      "reset": "1792987346",
      "resetDate": "Mon Oct 26 2026"
    },
    "responseTime": 107.901607,
    "code": 200,
    "status": "success",
    "error": false
  }
}

Endpoints

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

SDK

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

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

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

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

See also