← DevOps API
DeploymentPlans
Singular: DeploymentPlan — Base URL: https://devops-api.ayoune.app — Access: CRUD
Try it now
beta
Response (live)
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": "6a618ee96cea51dbecadfad5",
"name": "EQUAL_SILVER_FINIS VALORUM",
"description": "",
"status": "draft",
"executionCount": 0,
"successCount": 0,
"failureCount": 0,
"createdBy": "6045f4d25704710012485569",
"steps": [],
"createdAt": "2026-07-23T03:47:53.566Z",
"updatedAt": "2026-07-23T03:47:53.566Z"
},
"meta": {
"links": [
{
"rel": "self",
"href": "https://devops-api.ayoune.app/deploymentplans/6a618ee96cea51dbecadfad5",
"method": "get",
"title": "GET",
"types": [
"application/json",
"application/yaml",
"text/csv"
]
}
],
"relations": [],
"debugId": "6a62dfc567b3860bb3d75a48",
"errors": [],
"actions": [],
"version": {
"host": "2026.10.1",
"core": "2026.234.0"
},
"rateLimit": {
"limit": "2500",
"remaining": "2402",
"reset": "1784866297",
"resetDate": "Fri Jul 24 2026"
},
"responseTime": 91.671148,
"code": 200,
"status": "success",
"error": false
}
}
Endpoints
| Method | Path | Description | Right |
|---|---|---|---|
| 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' });