Download OpenAPI specification:
OpsChain is an orchestration and change automation platform based in GitOps principles with a core objective to Unify Change. Connect, automate, and orchestrate people, processes, and tools across your on-premise and cloud platforms.
version: 2026-11-17 (5b38af9e1)
Endpoints to interact with projects.
Notes:
show and list response payloads include links to the project's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Lists all projects (including archived projects).
Each project in the response includes a link to:
changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this project. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this project. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this project. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this project's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this project's workflows. It acts like a Workflows endpoint.
.| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=opc API filtering guide. Named filters: |
| download | string Example: download=projects.csv Download the projects in CSV format with the specified file name. The projects will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e730-887b-7fae-8dab-43dd64de3697",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "michale_predovic-2993",
- "created_by_name": "michale_predovic-2993"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-8883-7367-94b9-bab359d3bf19",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-8883-7367-94b9-bab359d3bf19"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e730-88a3-7f1d-97ab-4dea00612dea",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-88a3-7f1d-97ab-4dea00612dea"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Creates a project.
required | object |
{- "data": {
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project"
}
}
}{- "data": {
- "id": "01a1e730-8a36-7ebc-98a7-9fa7552e9d21",
- "type": "project",
- "attributes": {
- "code": "3jpsg",
- "name": "adipisci850",
- "description": "Omnis culpa vel et.",
- "archived": false,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-8a3e-7c57-85c7-695af21d5feb",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-8a3e-7c57-85c7-695af21d5feb"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e730-8a52-7ca2-8836-404bdce8df26",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-8a52-7ca2-8836-404bdce8df26"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/3jpsg",
- "artifacts": "/api/projects/3jpsg/artifacts",
- "bookmarks": "/api/projects/3jpsg/bookmarks",
- "changes": "/api/projects/3jpsg/changes",
- "scheduled_activities": "/api/projects/3jpsg/scheduled_activities",
- "git_remotes": "/api/projects/3jpsg/git_remotes",
- "workflows": "/api/projects/3jpsg/workflows",
- "workflow_runs": "/api/projects/3jpsg/workflow_runs",
- "templates": "/api/projects/3jpsg/templates",
- "environments": "/api/projects/3jpsg/environments",
- "assets": "/api/projects/3jpsg/assets",
- "agents": "/api/projects/3jpsg/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Shows a project, including any direct children.
The response includes a link to:
changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this project. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this project. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this project. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this project's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this project's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
{- "data": {
- "id": "01a1e730-8e94-7974-b682-dbc2b5b65bcc",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "honey.kilback-3011",
- "created_by_name": "honey.kilback-3011"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-8e98-76bf-959e-961ef8e09aa7",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-8e98-76bf-959e-961ef8e09aa7"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e730-8ea7-7c56-a836-951f33693bd0",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-8ea7-7c56-a836-951f33693bd0"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": false
}, - "self": {
- "update": true,
- "delete": true
}
}, - "secret_vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true,
- "credential": null,
- "registrable": true,
- "store_policy": false
}
}
}, - "included": [ ]
}Updates a project.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated project",
- "archived": false
}
}
}{- "data": {
- "id": "01a1e730-910d-775c-9343-1c9705abef9a",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "veritatis862",
- "description": "Quisquam et vel ut.",
- "archived": true,
- "created_by": "dusty-3017",
- "created_by_name": "dusty-3017"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-9111-759d-bc9f-2feae1c26c67",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-9111-759d-bc9f-2feae1c26c67"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e730-9120-77f4-b32c-e814c5006f68",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-9120-77f4-b32c-e814c5006f68"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Archives a project.
| project_code required | string Example: opc project code |
| ignore_in_use | boolean When true and the requesting user is a superuser, bypasses in use checks and force-destroys the project. |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the project",
- "detail": "Your authorisation rules let you view the project but not delete it."
}
]
}Endpoints to interact with environments.
Notes:
show and list response payloads include links to the environment's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Lists all project environments (including archived environments).
Each environment in the response includes a link to:
changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this environment. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this environment. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this environment. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this environment's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this environment's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[name_eq]=Test API filtering guide. Named filters: |
| download | string Example: download=environments.csv Download the project environments in CSV format with the specified file name. The environments will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e72f-e97d-75e7-833d-ab537f3323ee",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "corey_dibbert-2574",
- "created_by_name": "corey_dibbert-2574"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-e987-7abf-b9de-f537fc0cf304",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-e987-7abf-b9de-f537fc0cf304"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-e8c2-71d3-8078-a6b1a6b43b31",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-e9c4-71b8-90d1-6803a2b9bce5",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-e9c4-71b8-90d1-6803a2b9bce5"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-e8c2-71d3-8078-a6b1a6b43b31",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-e8c2-71d3-8078-a6b1a6b43b31",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "artifacts": "/api/projects/opc/environments/dev/artifacts",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Creates an environment.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment"
}
}
}{- "data": {
- "id": "01a1e72f-f000-76c8-a6ba-d536f663dcfd",
- "type": "environment",
- "attributes": {
- "code": "u2u1i",
- "name": "debitis756",
- "description": "Explicabo numquam aut voluptatem.",
- "archived": false,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-f010-7e21-be64-1da581570e9f",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-f010-7e21-be64-1da581570e9f"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-ec94-7eb5-9182-707ed1c8872d",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-f04d-7de3-8b0e-4a8e33269516",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-f04d-7de3-8b0e-4a8e33269516"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-ec94-7eb5-9182-707ed1c8872d",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-ec94-7eb5-9182-707ed1c8872d",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/u2u1i",
- "artifacts": "/api/projects/opc/environments/u2u1i/artifacts",
- "bookmarks": "/api/projects/opc/environments/u2u1i/bookmarks",
- "changes": "/api/projects/opc/environments/u2u1i/changes",
- "scheduled_activities": "/api/projects/opc/environments/u2u1i/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/u2u1i/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Shows an environment.
The response includes a link to:
changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this environment. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this environment. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this environment. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this environment's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this environment's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
{- "data": {
- "id": "01a1e72f-faa6-7715-ae14-de684ab4e836",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "abram_gulgowski-2598",
- "created_by_name": "abram_gulgowski-2598"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-faad-7a51-aea9-5e930776273c",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-faad-7a51-aea9-5e930776273c"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-fa70-7025-8ed8-4e98ad1acc82",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-fabd-7e00-a42e-54894d2670d8",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-fabd-7e00-a42e-54894d2670d8"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-fa70-7025-8ed8-4e98ad1acc82",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-fa70-7025-8ed8-4e98ad1acc82",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "artifacts": "/api/projects/opc/environments/dev/artifacts",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": false
}, - "self": {
- "update": true,
- "delete": true
}
}, - "secret_vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true,
- "credential": null,
- "registrable": true,
- "store_policy": false
}
}
}, - "included": [
- {
- "id": "01a1e72f-fa70-7025-8ed8-4e98ad1acc82",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "fred_runte-2597",
- "created_by_name": "fred_runte-2597"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-fa73-7c8e-81fc-fef1ae4b3ccd",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-fa73-7c8e-81fc-fef1ae4b3ccd"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e72f-fa82-7ceb-92e6-d4fda349daaf",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-fa82-7ceb-92e6-d4fda349daaf"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e72f-faa6-7715-ae14-de684ab4e836",
- "type": "environment"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
]
}Updates an environment.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated environment",
- "archived": false
}
}
}{- "data": {
- "id": "01a1e72f-fd72-795c-a689-6adc8338dde2",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "veniam770",
- "description": "Placeat unde voluptatem beatae.",
- "archived": true,
- "created_by": "america.kris-2606",
- "created_by_name": "america.kris-2606"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-fd7a-7b3f-894b-fc8274a5e382",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-fd7a-7b3f-894b-fc8274a5e382"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-fd3d-7a44-8870-9de0128fb02e",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-fd8e-7370-8cb9-60d5ce2ce053",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-fd8e-7370-8cb9-60d5ce2ce053"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-fd3d-7a44-8870-9de0128fb02e",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-fd3d-7a44-8870-9de0128fb02e",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "artifacts": "/api/projects/opc/environments/dev/artifacts",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Archives an environment.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
| ignore_in_use | boolean When true and the requesting user is a superuser, bypasses in use checks and force-destroys the environment. |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the environment",
- "detail": "Your authorisation rules let you view the environment but not delete it."
}
]
}Show the converged settings for this environment, merged from the project and environment settings. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "dev",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Show the converged properties for this environment, merged from all database properties sources in the hierarchy (project and environment properties).
The API response will also include the individual database properties that were included in the result.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
| converge_date | string Example: converge_date=2026-11-17T01:42:02+00:00 Specify the date (and optionally time), to derive the active environment properties from. |
| exclude_layers[] | string Example: exclude_layers[]=template Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. |
{- "data": {
- "id": "dev",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "01a1e730-0cbd-74d9-b1b6-4137cdfbca25",
- "type": "properties_version"
}, - {
- "id": "01a1e730-0e3d-73c4-a810-cbbc49fff79e",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "sources": [
- {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "environment",
- "layer": "environment",
- "human": "Environment: Development (dev)"
}
]
}, - "property_layers": [
- {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "environment",
- "human": "Environment",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e730-0cbd-74d9-b1b6-4137cdfbca25",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:47:28.316159Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-0ca8-76a6-a27d-c591d94e3bc1",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-0ca8-76a6-a27d-c591d94e3bc1"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e730-0ca8-76a6-a27d-c591d94e3bc1/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e730-0ca8-76a6-a27d-c591d94e3bc1/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e730-0e3d-73c4-a810-cbbc49fff79e",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:47:28.700160Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-0e16-7fe6-82df-f71614086345",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-0e16-7fe6-82df-f71614086345"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e730-0e16-7fe6-82df-f71614086345/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/01a1e730-0e16-7fe6-82df-f71614086345/versions/1"
}, - "meta": { }
}
]
}Endpoints to interact with agents.
Notes:
show and list response payloads include links to the agent's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Builds the container image for an agent. Note, this does not restart the agent.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": {
- "id": "01a1e72b-7982-7347-8854-58a43de3b00c",
- "type": "node_background_task",
- "attributes": {
- "request_number": 2,
- "status_code": "initializing",
- "error_message": null,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-11-17T01:42:28.481043Z",
- "updated_at": "2026-11-17T01:42:28.481043Z",
- "image_sha": null,
- "image_purged": false,
- "image_in_use": false
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72b-7944-7fe4-9430-a80a6d534474",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72b-78ed-79e8-996b-04a17e0aa2b5",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72b-782e-7465-8cae-fd71b9a25cdb/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1e72b-7982-7347-8854-58a43de3b00c",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72b-7982-7347-8854-58a43de3b00c"
}
}
}Lists the image build, start and stop tasks run for the agent's current template version.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[request_number_eq]=1 API filtering guide. Named filters: |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of tasks returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-7f85-7ed0-b982-7d0238c56ed1",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "angella_hamill-371",
- "created_by_name": "angella_hamill-371",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-11-17T01:42:30.020477Z",
- "updated_at": "2026-11-17T01:42:30.034904Z",
- "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "image_purged": false,
- "image_in_use": true
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72b-7f8e-75a1-8270-e92c3eb5bcd3",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72b-7f60-7499-84c2-447dec46d0a8",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72b-7e1d-7f86-a38f-536e87391b1f/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1e72b-7f85-7ed0-b982-7d0238c56ed1",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72b-7f85-7ed0-b982-7d0238c56ed1"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}, - "partial_response": false
}
}Show a specific agent image build, start or stop task.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| node_background_task_id required | string Example: 01a1e72a-f74f-712d-85fc-66e4e50bffa7 agent background task id |
{- "data": {
- "id": "01a1e72b-825e-74ed-b592-a2cf11f01f5c",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "bryon-377",
- "created_by_name": "bryon-377",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-11-17T01:42:30.749227Z",
- "updated_at": "2026-11-17T01:42:30.763617Z",
- "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "image_purged": false,
- "image_in_use": true
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72b-8266-7e56-aab7-3029ccbda37e",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72b-81f1-743b-8b8c-2d57783a78a1",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72b-8161-7619-aa70-d0482fcc7704/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1e72b-825e-74ed-b592-a2cf11f01f5c",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72b-825e-74ed-b592-a2cf11f01f5c"
}
}
}Shows the status for an agent.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": {
- "id": "01a1e72b-849d-786d-ac7b-e184ad95dccf",
- "type": "agent_status",
- "attributes": {
- "desired_status": "running",
- "status": "initializing",
- "image_build_status": "ready",
- "active_image_sha": null,
- "newest_image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "cluster_name": "opschain-db",
- "failure_reason": null
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-8472-7ffa-b73b-d032096ed7fe",
- "type": "agent"
}
}, - "referenced_build_agent_image_task": {
- "data": {
- "id": "01a1e72b-849b-7a9f-b14d-2b3bd634ce12",
- "type": "node_background_task"
}
}, - "available_build_agent_image_tasks": {
- "data": [
- {
- "id": "01a1e72b-849b-7a9f-b14d-2b3bd634ce12",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/status",
- "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
}
}, - "included": [
- {
- "id": "01a1e72b-849b-7a9f-b14d-2b3bd634ce12",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "clare_borer-383",
- "created_by_name": "clare_borer-383",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-11-17T01:42:31.322523Z",
- "updated_at": "2026-11-17T01:42:31.338239Z",
- "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "image_purged": false,
- "image_in_use": true
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72b-84a5-716b-b675-110046d0cc6b",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72b-8472-7ffa-b73b-d032096ed7fe",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72b-83e7-7070-bdd6-b919fcd48ee1/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1e72b-849b-7a9f-b14d-2b3bd634ce12",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72b-849b-7a9f-b14d-2b3bd634ce12"
}
}
]
}Update an agent status.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
required | object |
{- "data": {
- "attributes": {
- "desired_status": "running",
- "image_sha": "sha256:de10faf919fc71ba4eb1dd7bd6449566d012b0c9436b1c61bfee21d621b009aa"
}
}
}{- "data": {
- "id": "01a1e72b-86b1-7514-94a6-cd6341532744",
- "type": "agent_status",
- "attributes": {
- "desired_status": "running",
- "status": "initializing",
- "image_build_status": "ready",
- "active_image_sha": null,
- "newest_image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "cluster_name": "opschain-db",
- "failure_reason": null
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-868b-775c-a691-b2609975b128",
- "type": "agent"
}
}, - "referenced_build_agent_image_task": {
- "data": null
}, - "available_build_agent_image_tasks": {
- "data": [
- {
- "id": "01a1e72b-86af-74cd-9498-992ce4e4c273",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/status",
- "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
}
}, - "included": [
- {
- "id": "01a1e72b-86af-74cd-9498-992ce4e4c273",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "hugo.crist-389",
- "created_by_name": "hugo.crist-389",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-11-17T01:42:31.854207Z",
- "updated_at": "2026-11-17T01:42:31.868946Z",
- "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "image_purged": false,
- "image_in_use": false
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72b-86b7-78d5-b921-2eba9dae5842",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72b-868b-775c-a691-b2609975b128",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72b-8608-7c64-94c3-64d30b4b5a49/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1e72b-86af-74cd-9498-992ce4e4c273",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72b-86af-74cd-9498-992ce4e4c273"
}
}
]
}Shows log lines for the agent.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. 10000 ] Default: 10000 Example: limit=50 Limit the number of log lines returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-92b5-7420-a2ca-4330dd7a64dd",
- "type": "agent_log_line",
- "attributes": {
- "message": "Agents running on OpsChain :-)",
- "category": "action",
- "agent_path": "/projects/opc/agents/agent1",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows Kubernetes events for the agent. When the agent is not deployed in Kubernetes, the list is empty and meta.agent_deployed is false.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": [
- {
- "id": "0",
- "type": "agent_event",
- "attributes": {
- "created_at": "2026-02-13T09:59:50.041123Z",
- "message": "Kubernetes event for this agent."
}
}
], - "meta": {
- "agent_deployed": true
}
}Lists all agents (including archived agents) that belong to the project.
Each agent in the response includes a link to:
changes endpoint for managing changes belonging to this agent. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this agent. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this agent. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this agent. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this agent's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this agent's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[name_eq]=Test API filtering guide. Named filters: |
| download | string Example: download=agents.csv Download the agents in CSV format with the specified file name. The agents will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e72f-6c30-79ce-8722-367df0b05cd4",
- "type": "agent",
- "attributes": {
- "code": "agent1",
- "name": "Agent",
- "description": "Asset description",
- "archived": false,
- "created_by": "maisha-2262",
- "created_by_name": "maisha-2262",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-6c39-7717-bba0-d9419b790b7d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-6c39-7717-bba0-d9419b790b7d"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-6b5e-791c-8ade-cbea3002212a",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-6c4d-7096-a613-d4f0c14021b5",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-6c4d-7096-a613-d4f0c14021b5"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-6b5e-791c-8ade-cbea3002212a",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-6b5e-791c-8ade-cbea3002212a",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-6be6-7441-8ee9-8aeccc9b7ddc",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-6bac-713c-894e-1153e6d72d7b/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "01a1e72f-6bac-713c-894e-1153e6d72d7b",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-6bac-713c-894e-1153e6d72d7b"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-6c58-7f58-adb5-832c9f7dd342",
- "type": "node_background_task"
}
]
}, - "agent_status": {
- "data": {
- "id": "01a1e72f-6c5a-7e34-9f5a-c638ceab4c3a",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1",
- "bookmarks": "/api/projects/opc/agents/agent1/bookmarks",
- "converged_properties": "/api/projects/opc/agents/agent1/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/agent1/node_background_tasks",
- "version_history": "/api/projects/opc/agents/agent1/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Creates an agent.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "agent1",
- "name": "Agent",
- "description": "Asset description",
- "template_code": "agn",
- "template_version": "2026_Q1_2"
}
}
}{- "data": {
- "id": "01a1e72f-7153-722b-8b76-e8339d351970",
- "type": "agent",
- "attributes": {
- "code": "huydk",
- "name": "asperiores654",
- "description": "Illo in culpa et.",
- "archived": false,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "task_active": true
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-715a-7a29-8972-c4c674ca7c8d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-715a-7a29-8972-c4c674ca7c8d"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-6e96-7812-9642-7b831d19095d",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-716c-7492-bfe6-94ccda1138fe",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-716c-7492-bfe6-94ccda1138fe"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-6e96-7812-9642-7b831d19095d",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-6e96-7812-9642-7b831d19095d",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-70f3-7f3a-bf21-48070cdaba39",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-70ad-7bee-a0a4-8d35a2a41058/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "01a1e72f-70ad-7bee-a0a4-8d35a2a41058",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-70ad-7bee-a0a4-8d35a2a41058"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-7185-7f48-9f52-356ba3220213",
- "type": "node_background_task"
}
]
}, - "agent_status": {
- "data": {
- "id": "01a1e72f-7175-7272-8ab8-3ea0971a6913",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/huydk/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/huydk",
- "bookmarks": "/api/projects/opc/agents/huydk/bookmarks",
- "converged_properties": "/api/projects/opc/agents/huydk/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/huydk/node_background_tasks",
- "version_history": "/api/projects/opc/agents/huydk/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Shows an agent belonging to a project.
The response includes a link to:
changes endpoint for managing changes belonging to this agent. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this agent. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this agent. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this agent. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this agent's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this agent's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": {
- "id": "01a1e72f-7a63-7627-87c2-60a052451383",
- "type": "agent",
- "attributes": {
- "code": "agent1",
- "name": "Agent",
- "description": "Asset description",
- "archived": false,
- "created_by": "shane_west-2289",
- "created_by_name": "shane_west-2289",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-7a6f-78f1-9cc8-ead0be03692d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-7a6f-78f1-9cc8-ead0be03692d"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-7969-75e1-bca0-5bca4fb6d641",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-7a86-7600-92f4-0d501b1a7c6d",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-7a86-7600-92f4-0d501b1a7c6d"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-7969-75e1-bca0-5bca4fb6d641",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-7969-75e1-bca0-5bca4fb6d641",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-79ed-7143-8d79-2b6b35fa5db3",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "01a1e72f-79b0-7e50-80d9-39ca8cb29483",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-7a92-7405-90ae-2e4d629ff4dd",
- "type": "node_background_task"
}
]
}, - "agent_status": {
- "data": {
- "id": "01a1e72f-7a94-753e-9d3e-d6fa29633589",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1",
- "bookmarks": "/api/projects/opc/agents/agent1/bookmarks",
- "converged_properties": "/api/projects/opc/agents/agent1/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/agent1/node_background_tasks",
- "version_history": "/api/projects/opc/agents/agent1/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": false
}, - "self": {
- "update": true,
- "delete": true
}
}, - "secret_vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true,
- "credential": null,
- "registrable": true,
- "store_policy": false
}
}
}, - "included": [
- {
- "id": "01a1e72f-7969-75e1-bca0-5bca4fb6d641",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "will-2287",
- "created_by_name": "will-2287"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-796d-7412-987c-f31cfa975636",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-796d-7412-987c-f31cfa975636"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e72f-797e-79e8-b033-3e802d885f86",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-797e-79e8-b033-3e802d885f86"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e72f-7a63-7627-87c2-60a052451383",
- "type": "agent"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}, - {
- "id": "01a1e72f-79b0-7e50-80d9-39ca8cb29483",
- "type": "template",
- "attributes": {
- "code": "agn",
- "name": "Agent example",
- "description": null,
- "archived": false,
- "disabled": false,
- "template_type": "agent",
- "created_at": "2026-11-17T01:46:50.671302Z",
- "updated_at": "2026-11-17T01:46:50.671302Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-79b9-747d-ad6f-7eceed0eafc2",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-79b9-747d-ad6f-7eceed0eafc2"
}
}, - "settings": {
- "data": {
- "id": "01a1e72f-79cb-75af-8cd2-0dd37ed0868b",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-79cb-75af-8cd2-0dd37ed0868b"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e72f-7998-735b-ac43-fc6d182c6a3a",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [
- {
- "id": "01a1e72f-79ed-7143-8d79-2b6b35fa5db3",
- "type": "template_version"
}
]
}, - "nodes": {
- "data": [
- {
- "id": "01a1e72f-7a63-7627-87c2-60a052451383",
- "type": "agent"
}, - {
- "id": "01a1e72f-7a63-7627-87c2-60a052451383",
- "type": "agent"
}
]
}, - "project": {
- "data": {
- "id": "01a1e72f-7969-75e1-bca0-5bca4fb6d641",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483",
- "template_versions": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483/versions",
- "project": "/api/projects/opc"
}
}, - {
- "id": "01a1e72f-79ed-7143-8d79-2b6b35fa5db3",
- "type": "template_version",
- "attributes": {
- "version": "2026_Q1_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "jamaal-2288",
- "created_by_name": "jamaal-2288",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:46:50.732144Z",
- "updated_at": "2026-11-17T01:46:50.732144Z",
- "committed_at": null,
- "git_rev": "neural",
- "commit_sha": "6c2bddec525ec81980c0dd2918e0b7d92e18f3af",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-79f4-79dd-8628-6b835a3d1530",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-79f4-79dd-8628-6b835a3d1530"
}
}, - "settings": {
- "data": {
- "id": "01a1e72f-7a06-791b-8a84-0efe4c2071d4",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-7a06-791b-8a84-0efe4c2071d4"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-7969-75e1-bca0-5bca4fb6d641",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e72f-79b0-7e50-80d9-39ca8cb29483",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483/versions/2026_Q1_2",
- "template": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483"
}
}, - {
- "id": "01a1e72f-7a92-7405-90ae-2e4d629ff4dd",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "lia_gleichner-2290",
- "created_by_name": "lia_gleichner-2290",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-11-17T01:46:50.896946Z",
- "updated_at": "2026-11-17T01:46:50.912138Z",
- "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "image_purged": false,
- "image_in_use": true
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72f-7a9b-721e-a329-f1c6c34ed801",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72f-7a63-7627-87c2-60a052451383",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72f-79b0-7e50-80d9-39ca8cb29483/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1e72f-7a92-7405-90ae-2e4d629ff4dd",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72f-7a92-7405-90ae-2e4d629ff4dd"
}
}, - {
- "id": "01a1e72f-7a94-753e-9d3e-d6fa29633589",
- "type": "agent_status",
- "attributes": {
- "desired_status": "running",
- "status": "initializing",
- "image_build_status": "ready",
- "active_image_sha": null,
- "newest_image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
- "cluster_name": "opschain-db",
- "failure_reason": null
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72f-7a63-7627-87c2-60a052451383",
- "type": "agent"
}
}, - "referenced_build_agent_image_task": {
- "data": {
- "id": "01a1e72f-7a92-7405-90ae-2e4d629ff4dd",
- "type": "node_background_task"
}
}, - "available_build_agent_image_tasks": {
- "data": [
- {
- "id": "01a1e72f-7a92-7405-90ae-2e4d629ff4dd",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/status",
- "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
}
}
]
}Updates an agent belonging to a project.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated agent",
- "archived": false
}
}
}{- "data": {
- "id": "01a1e72f-7fb5-7fbd-92c8-6eb7bcfdd8e6",
- "type": "agent",
- "attributes": {
- "code": "agent1",
- "name": "soluta668",
- "description": "Velit delectus impedit ut.",
- "archived": true,
- "created_by": "hailey.adams-2298",
- "created_by_name": "hailey.adams-2298",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-7fbe-7538-9332-00ffff0d869d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-7fbe-7538-9332-00ffff0d869d"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-7dcf-7097-8df3-e247b4516329",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-7fd3-7f1a-8df3-23e4a621b463",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-7fd3-7f1a-8df3-23e4a621b463"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-7dcf-7097-8df3-e247b4516329",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-7dcf-7097-8df3-e247b4516329",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-7f4e-77fd-ad05-107e2c456ec4",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-7f06-736c-af83-8003ef7cb0e4/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "01a1e72f-7f06-736c-af83-8003ef7cb0e4",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-7f06-736c-af83-8003ef7cb0e4"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-7fde-74e7-a108-48e1fde9a28c",
- "type": "node_background_task"
}
]
}, - "agent_status": {
- "data": {
- "id": "01a1e72f-7fdf-7f76-b39f-9ccdebff876a",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1",
- "bookmarks": "/api/projects/opc/agents/agent1/bookmarks",
- "converged_properties": "/api/projects/opc/agents/agent1/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/agent1/node_background_tasks",
- "version_history": "/api/projects/opc/agents/agent1/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Archives an agent belonging to a project.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| ignore_in_use | boolean When true and the requesting user is a superuser, bypasses in use checks and force-destroys the agent. |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the agent",
- "detail": "Your authorisation rules let you view the agent but not delete it."
}
]
}Show the converged settings for this agent, merged from the project and agent settings. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "agent1",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Show the converged properties as they will appear for this agent. i.e. the endpoint will
The API response will also include all the individual repository and database properties that were included in the result.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| converge_date | string Example: converge_date=2026-11-17T01:42:02+00:00 Specify the date (and optionally time), to derive the active template version and agent properties from. |
| exclude_layers[] | string Example: exclude_layers[]=template Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. |
{- "data": {
- "id": "agent1",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "repo": "project_properties",
- "common": "property",
- "project": "property",
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [
- {
- "id": "properties/properties.yaml",
- "type": "repository_properties"
}, - {
- "id": "properties/projects/opc/properties.yaml",
- "type": "repository_properties"
}
]
}, - "properties": {
- "data": [
- {
- "id": "01a1e72f-9355-75c9-b7d6-045ae52c26bd",
- "type": "properties_version"
}, - {
- "id": "01a1e72f-9390-7efd-b838-70ca44d99795",
- "type": "properties_version"
}, - {
- "id": "01a1e72f-945f-775a-9fbf-5c8c827a3289",
- "type": "properties_version"
}, - {
- "id": "01a1e72f-94be-7757-b250-9111c77a1be6",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "repo": "Repository: .opschain/properties/projects/opc/properties.yaml",
- "common": "Repository: .opschain/properties/properties.yaml",
- "project": "Repository: .opschain/properties/projects/opc/properties.yaml",
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "sources": [
- {
- "group": "repository",
- "id": "properties/properties.yaml",
- "layer": "repo_common",
- "human": "Repository: .opschain/properties/properties.yaml"
}, - {
- "group": "repository",
- "id": "properties/projects/opc/properties.yaml",
- "layer": "project",
- "human": "Repository: .opschain/properties/projects/opc/properties.yaml"
}, - {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "template",
- "layer": "template",
- "human": "Template: Agent example (agn)"
}, - {
- "group": "database",
- "id": "template_version",
- "layer": "template_version",
- "human": "Template version: Agent example (2026_Q1_2)"
}, - {
- "group": "database",
- "id": "agent",
- "layer": "agent",
- "human": "Agent: Agent (agent1)"
}
]
}, - "property_layers": [
- {
- "id": "repo_common",
- "human": "Common",
- "groups": [
- {
- "group": "repository",
- "included": true
}
]
}, - {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "repository",
- "included": true
}, - {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template",
- "human": "Template",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template_version",
- "human": "Template version",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "agent",
- "human": "Agent",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e72f-9355-75c9-b7d6-045ae52c26bd",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:46:57.236458Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-934d-7957-8170-d3ca4641d26e",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-934d-7957-8170-d3ca4641d26e"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-934d-7957-8170-d3ca4641d26e/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e72f-934d-7957-8170-d3ca4641d26e/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e72f-9390-7efd-b838-70ca44d99795",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:46:57.296022Z",
- "owner_type": "Template"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9387-74fa-8ffd-2cba153f21eb",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9387-74fa-8ffd-2cba153f21eb"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-9387-74fa-8ffd-2cba153f21eb/versions",
- "owner": "/api/projects/opc/templates/01a1e72f-937f-7330-bcf6-a580bc297c92",
- "self": "/api/properties/01a1e72f-9387-74fa-8ffd-2cba153f21eb/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e72f-945f-775a-9fbf-5c8c827a3289",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:46:57.502524Z",
- "owner_type": "Template version"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9456-7570-8202-8d29be4ecef3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9456-7570-8202-8d29be4ecef3"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-9456-7570-8202-8d29be4ecef3/versions",
- "owner": "/api/projects/opc/templates/01a1e72f-937f-7330-bcf6-a580bc297c92/versions/2026_Q1_2",
- "self": "/api/properties/01a1e72f-9456-7570-8202-8d29be4ecef3/versions/1"
}, - "meta": {
- "template_versions": {
- "2026_Q1_2": "01a1e72f-944d-76a0-b308-01a905e3a0eb"
}
}
}, - {
- "id": "01a1e72f-94be-7757-b250-9111c77a1be6",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:46:57.597516Z",
- "owner_type": "Agent"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-94b3-7b04-8685-2b82b413493d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-94b3-7b04-8685-2b82b413493d"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-94b3-7b04-8685-2b82b413493d/versions",
- "owner": "/api/projects/opc/agents/agent1",
- "self": "/api/properties/01a1e72f-94b3-7b04-8685-2b82b413493d/versions/1"
}, - "meta": {
- "template_versions": {
- "2026_Q1_2": "01a1e72f-944d-76a0-b308-01a905e3a0eb"
}
}
}, - {
- "id": "properties/properties.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "base_properties",
- "common": "property"
}
}, - "links": {
- "repository_path": ".opschain/properties/properties.yaml"
}
}, - {
- "id": "properties/projects/opc/properties.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "project_properties",
- "project": "property"
}
}, - "links": {
- "repository_path": ".opschain/properties/projects/opc/properties.yaml"
}
}
]
}Endpoints to interact with assets.
Notes:
show and list response payloads include links to the asset's changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Lists a summary of each asset accessible to the user, combining the asset with its project, environment, template, template version, background task and latest change details.
Notes:
filter[parent_path_eq] or filter[template_version_id_eq] must be supplied. filter[parent_path_eq] lists the assets directly under a project or environment, and filter[template_version_id_eq] lists the assets using a template version, across every project the user can access.meta.authorisations reports what the user may do to that asset.meta.authorisations reports whether the user may create (update) or delete assets under the parent, and is only returned for a filter[parent_path_eq] request.required | object API filtering guide Exactly one of |
| download | string Example: download=assets.csv Download the asset summaries in CSV format with the specified file name. |
{- "data": [
- {
- "id": "01a1e72c-138d-7454-b5dd-bc1097648113",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "isaac-675",
- "created_by_name": "isaac-675",
- "project_code": "opc",
- "project_name": "OpsChain",
- "environment_code": null,
- "environment_name": null,
- "template_id": "01a1e72c-131b-775a-be48-eb42a3a29165",
- "template_code": "soa",
- "template_name": "Oracle SOA template",
- "git_remote_name": "github",
- "template_version_id": "01a1e72c-1352-7da8-b19a-1e1b3d6aa41f",
- "template_version": "2023_Q4_2",
- "template_version_state": "ready",
- "template_version_archived": false,
- "template_version_locked": false,
- "float_git_rev": false,
- "has_mintmodel": true,
- "latest_version": true,
- "latest_version_id": "01a1e72c-1352-7da8-b19a-1e1b3d6aa41f",
- "latest_version_name": "2023_Q4_2",
- "latest_commit": true,
- "active_commit_sha": "79f6a47c2b79c529d7ae0338b1b3020584a966bd",
- "template_version_commit_sha": "79f6a47c2b79c529d7ae0338b1b3020584a966bd",
- "git_rev": "primary",
- "generate_actions_status": "success",
- "task_active": false,
- "template_version_history_id": "01a1e72c-13b0-7be6-bbc8-e7bf3b5a19eb",
- "last_change_id": "01a1e72c-14f9-79a3-9a76-86bc77d45959",
- "last_change_status": "success",
- "created_at": "2026-11-17T01:43:07.916044Z",
- "updated_at": "2026-11-17T01:43:07.916044Z",
- "version_assigned_at": "2026-11-17T01:43:07.950297Z",
- "actions_refreshed_at": "2026-11-17T01:43:07.987346Z",
- "last_change_created_at": "2026-11-17T01:43:08.280098Z",
- "last_change_finished_at": "2026-11-17T01:39:28.902471Z"
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "parent": "/api/projects/opc"
}, - "meta": {
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Lists all assets (including archived assets) that belong to the project.
Each asset in the response includes a link to:
changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this asset. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this asset. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this asset. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this asset's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this asset's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[name_eq]=Test API filtering guide. Named filters: |
| download | string Example: download=assets.csv Download the project assets in CSV format with the specified file name. The assets will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e72f-974f-7d99-a62f-2254a6f96486",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "douglass-2366",
- "created_by_name": "douglass-2366",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9756-7df9-b68b-5dca30451360",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9756-7df9-b68b-5dca30451360"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-96a6-7797-baea-605e2c9ab56a",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-9765-7b1c-9b5d-1695a1308464",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-9765-7b1c-9b5d-1695a1308464"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-96a6-7797-baea-605e2c9ab56a",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-96a6-7797-baea-605e2c9ab56a",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-9713-75aa-82d4-97e4fdd9168e",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-96da-792f-85c6-7a9cd6cab5c2/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "01a1e72f-9791-73f9-95bc-4591e3a4189a",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "01a1e72f-96da-792f-85c6-7a9cd6cab5c2",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-96da-792f-85c6-7a9cd6cab5c2"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-977b-7142-b735-c1538d64386a",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "actions": "/api/projects/opc/assets/prj_soa/actions",
- "artifacts": "/api/projects/opc/assets/prj_soa/artifacts",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Creates an asset belonging to the project.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "template_code": "soa",
- "template_version": "2023_Q4_2"
}
}
}{- "data": {
- "id": "01a1e72f-9a05-7539-bf25-91d51f8104ff",
- "type": "asset",
- "attributes": {
- "code": "zq67r",
- "name": "enim694",
- "description": "Et et in vel.",
- "archived": false,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "task_active": true
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9a0c-73d0-8522-66d9e9c401c0",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9a0c-73d0-8522-66d9e9c401c0"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-988a-741d-98fc-fd8a3ad6a0c9",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-9a1d-7f23-a5b7-22fb1b5a2ec9",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-9a1d-7f23-a5b7-22fb1b5a2ec9"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-988a-741d-98fc-fd8a3ad6a0c9",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-988a-741d-98fc-fd8a3ad6a0c9",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-99a2-7a5c-b6ba-04b3b64b28a2",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-996d-7cbd-88f1-d4b50ff46aba/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "01a1e72f-996d-7cbd-88f1-d4b50ff46aba",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-996d-7cbd-88f1-d4b50ff46aba"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-9a32-7e78-9dd6-e93a9cb50ef8",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/zq67r",
- "actions": "/api/projects/opc/assets/zq67r/actions",
- "artifacts": "/api/projects/opc/assets/zq67r/artifacts",
- "bookmarks": "/api/projects/opc/assets/zq67r/bookmarks",
- "changes": "/api/projects/opc/assets/zq67r/changes",
- "scheduled_activities": "/api/projects/opc/assets/zq67r/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/zq67r/converged_properties",
- "mintmodels": "/api/projects/opc/assets/zq67r/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/zq67r/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/zq67r/node_background_tasks",
- "version_history": "/api/projects/opc/assets/zq67r/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Shows an asset belonging to a project.
The response includes a link to:
changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this asset. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this asset. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this asset. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this asset's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this asset's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": {
- "id": "01a1e72f-9f56-7839-b7b4-f845ee9bc57f",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "dwight-2394",
- "created_by_name": "dwight-2394",
- "mintmodel_valid": true,
- "mintmodel_invalid_reason": null,
- "erb_file_content": "<MintModel erb file contents>",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9f5e-7899-abdc-28916c671a51",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9f5e-7899-abdc-28916c671a51"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-9e98-7694-9b1c-619958995f9e",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-9f73-706b-b56a-1c3f05a077ac",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-9f73-706b-b56a-1c3f05a077ac"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-9e98-7694-9b1c-619958995f9e",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-9e98-7694-9b1c-619958995f9e",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-9f0b-77dd-aa61-54385f9dfee5",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-9ecf-7b54-9a00-ecaf48477ff1/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "01a1e72f-9faa-7eef-a623-77ffebeff956",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "01a1e72f-9ecf-7b54-9a00-ecaf48477ff1",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-9ecf-7b54-9a00-ecaf48477ff1"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-9f92-7610-91e9-e46d706452e2",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "actions": "/api/projects/opc/assets/prj_soa/actions",
- "artifacts": "/api/projects/opc/assets/prj_soa/artifacts",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": false
}, - "self": {
- "update": true,
- "delete": true
}
}, - "secret_vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true,
- "credential": null,
- "registrable": true,
- "store_policy": false
}
}
}, - "included": [
- {
- "id": "01a1e72f-9e98-7694-9b1c-619958995f9e",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "caleb_hoeger-2392",
- "created_by_name": "caleb_hoeger-2392"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9e9c-73a8-a47c-8abdbb638408",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9e9c-73a8-a47c-8abdbb638408"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e72f-9eab-7de8-abd3-a5473c465014",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-9eab-7de8-abd3-a5473c465014"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e72f-9f56-7839-b7b4-f845ee9bc57f",
- "type": "asset"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}, - {
- "id": "01a1e72f-9faa-7eef-a623-77ffebeff956",
- "type": "bookmark",
- "attributes": {
- "description": "SOA administration console",
- "created_by": "shelby_lubowitz-2396",
- "created_by_name": "shelby_lubowitz-2396",
- "created_at": "2026-11-17T01:47:00.394088Z",
- "updated_at": "2026-11-17T01:47:00.394088Z"
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e72f-9f56-7839-b7b4-f845ee9bc57f",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a1e72f-9faa-7eef-a623-77ffebeff956",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}, - {
- "id": "01a1e72f-9ecf-7b54-9a00-ecaf48477ff1",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-11-17T01:47:00.174861Z",
- "updated_at": "2026-11-17T01:47:00.174861Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9ed8-7496-aed6-6391019b0197",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9ed8-7496-aed6-6391019b0197"
}
}, - "settings": {
- "data": {
- "id": "01a1e72f-9ee9-72f2-b6ca-61623f84bcf7",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-9ee9-72f2-b6ca-61623f84bcf7"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e72f-9ebb-732a-90e8-dd268cf58da9",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [
- {
- "id": "01a1e72f-9f0b-77dd-aa61-54385f9dfee5",
- "type": "template_version"
}
]
}, - "nodes": {
- "data": [
- {
- "id": "01a1e72f-9f56-7839-b7b4-f845ee9bc57f",
- "type": "asset"
}
]
}, - "project": {
- "data": {
- "id": "01a1e72f-9e98-7694-9b1c-619958995f9e",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e72f-9ecf-7b54-9a00-ecaf48477ff1",
- "template_versions": "/api/projects/opc/templates/01a1e72f-9ecf-7b54-9a00-ecaf48477ff1/versions",
- "project": "/api/projects/opc"
}
}, - {
- "id": "01a1e72f-9f0b-77dd-aa61-54385f9dfee5",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "scottie.daniel-2393",
- "created_by_name": "scottie.daniel-2393",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:47:00.234437Z",
- "updated_at": "2026-11-17T01:47:00.234437Z",
- "committed_at": null,
- "has_mintmodel": true,
- "git_rev": "optical",
- "commit_sha": "f81824f3200232c94a668c493b201fe5720232ad",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-9f12-7587-a805-606613546d48",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-9f12-7587-a805-606613546d48"
}
}, - "settings": {
- "data": {
- "id": "01a1e72f-9f22-7804-95c7-0412e682523b",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-9f22-7804-95c7-0412e682523b"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-9e98-7694-9b1c-619958995f9e",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e72f-9ecf-7b54-9a00-ecaf48477ff1",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e72f-9ecf-7b54-9a00-ecaf48477ff1/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e72f-9ecf-7b54-9a00-ecaf48477ff1"
}
}
]
}Updates an asset belonging to a project.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated asset",
- "archived": false
}
}
}{- "data": {
- "id": "01a1e72f-a323-74b0-bfc8-0528690ca886",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "facilis708",
- "description": "Vel rerum esse beatae.",
- "archived": true,
- "created_by": "trenton_schowalter-2404",
- "created_by_name": "trenton_schowalter-2404",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-a32a-7c50-841d-984d68ffbe92",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-a32a-7c50-841d-984d68ffbe92"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72f-a21d-7655-8523-6ac3aa90a78a",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72f-a33d-7069-9863-da5e8e8fc661",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72f-a33d-7069-9863-da5e8e8fc661"
}
}, - "parent": {
- "data": {
- "id": "01a1e72f-a21d-7655-8523-6ac3aa90a78a",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72f-a21d-7655-8523-6ac3aa90a78a",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72f-a2e4-7ec0-9145-905666b2653f",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-a297-7f7b-90e6-5645dde5114a/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "01a1e72f-a36d-7e3e-a127-8161df347a78",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "01a1e72f-a297-7f7b-90e6-5645dde5114a",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72f-a297-7f7b-90e6-5645dde5114a"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e72f-a356-750f-860c-e363a60ba6d7",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "actions": "/api/projects/opc/assets/prj_soa/actions",
- "artifacts": "/api/projects/opc/assets/prj_soa/artifacts",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
}Archives an asset belonging to a project.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| ignore_in_use | boolean When true and the requesting user is a superuser, bypasses in use checks and force-destroys the asset. |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the asset",
- "detail": "Your authorisation rules let you view the asset but not delete it."
}
]
}Show the converged settings for this asset, merged from the project, environment and asset settings. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "prj_soa",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Show the converged properties as they will appear to actions run on this asset. i.e. the endpoint will
The API response will also include all the individual repository and database properties that were included in the result.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| converge_date | string Example: converge_date=2026-11-17T01:42:02+00:00 Specify the date (and optionally time), to derive the active template version and asset properties from. |
| exclude_layers[] | string Example: exclude_layers[]=template Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. |
{- "data": {
- "id": "prj_soa",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "repo": "project_properties",
- "common": "property",
- "project": "property",
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [
- {
- "id": "properties/properties.yaml",
- "type": "repository_properties"
}, - {
- "id": "properties/projects/opc/properties.yaml",
- "type": "repository_properties"
}
]
}, - "properties": {
- "data": [
- {
- "id": "01a1e72f-bb49-723c-ad16-4255cbbdc92e",
- "type": "properties_version"
}, - {
- "id": "01a1e72f-bbcf-7b24-952c-2063d76548d6",
- "type": "properties_version"
}, - {
- "id": "01a1e72f-bc07-7ca7-b6e1-aaff2c1f6f36",
- "type": "properties_version"
}, - {
- "id": "01a1e72f-bc51-7ce0-9e3c-f7fbee6644e8",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "repo": "Repository: .opschain/properties/projects/opc/properties.yaml",
- "common": "Repository: .opschain/properties/properties.yaml",
- "project": "Repository: .opschain/properties/projects/opc/properties.yaml",
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "sources": [
- {
- "group": "repository",
- "id": "properties/properties.yaml",
- "layer": "repo_common",
- "human": "Repository: .opschain/properties/properties.yaml"
}, - {
- "group": "repository",
- "id": "properties/projects/opc/properties.yaml",
- "layer": "project",
- "human": "Repository: .opschain/properties/projects/opc/properties.yaml"
}, - {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "template",
- "layer": "template",
- "human": "Template: Oracle SOA template (soa)"
}, - {
- "group": "database",
- "id": "template_version",
- "layer": "template_version",
- "human": "Template version: Oracle SOA template (2023_Q4_2)"
}, - {
- "group": "database",
- "id": "asset",
- "layer": "asset",
- "human": "Asset: Project asset (prj_soa)"
}
]
}, - "property_layers": [
- {
- "id": "repo_common",
- "human": "Common",
- "groups": [
- {
- "group": "repository",
- "included": true
}
]
}, - {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "repository",
- "included": true
}, - {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template",
- "human": "Template",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template_version",
- "human": "Template version",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "asset",
- "human": "Asset",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e72f-bb49-723c-ad16-4255cbbdc92e",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:47:07.464131Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-bb37-722f-b48b-6e3693f6d1f7",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-bb37-722f-b48b-6e3693f6d1f7"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-bb37-722f-b48b-6e3693f6d1f7/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e72f-bb37-722f-b48b-6e3693f6d1f7/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e72f-bbcf-7b24-952c-2063d76548d6",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:47:07.598735Z",
- "owner_type": "Template"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-bbc6-7ad6-b69b-6c799936d0b5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-bbc6-7ad6-b69b-6c799936d0b5"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-bbc6-7ad6-b69b-6c799936d0b5/versions",
- "owner": "/api/projects/opc/templates/01a1e72f-bbbf-7617-b962-a53e235a3cb8",
- "self": "/api/properties/01a1e72f-bbc6-7ad6-b69b-6c799936d0b5/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e72f-bc07-7ca7-b6e1-aaff2c1f6f36",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:47:07.654880Z",
- "owner_type": "Template version"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-bbfe-7dbd-88ed-f811eeb55836",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-bbfe-7dbd-88ed-f811eeb55836"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-bbfe-7dbd-88ed-f811eeb55836/versions",
- "owner": "/api/projects/opc/templates/01a1e72f-bbbf-7617-b962-a53e235a3cb8/versions/2023_Q4_2",
- "self": "/api/properties/01a1e72f-bbfe-7dbd-88ed-f811eeb55836/versions/1"
}, - "meta": {
- "template_versions": {
- "2023_Q4_2": "01a1e72f-bbf7-707c-80b9-df7614662079"
}
}
}, - {
- "id": "01a1e72f-bc51-7ce0-9e3c-f7fbee6644e8",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:47:07.728940Z",
- "owner_type": "Asset"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72f-bc47-7bf6-a196-0785c113f119",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72f-bc47-7bf6-a196-0785c113f119"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72f-bc47-7bf6-a196-0785c113f119/versions",
- "owner": "/api/projects/opc/assets/prj_soa",
- "self": "/api/properties/01a1e72f-bc47-7bf6-a196-0785c113f119/versions/1"
}, - "meta": {
- "template_versions": {
- "2023_Q4_2": "01a1e72f-bbf7-707c-80b9-df7614662079"
}
}
}, - {
- "id": "properties/properties.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "base_properties",
- "common": "property"
}
}, - "links": {
- "repository_path": ".opschain/properties/properties.yaml"
}
}, - {
- "id": "properties/projects/opc/properties.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "project_properties",
- "project": "property"
}
}, - "links": {
- "repository_path": ".opschain/properties/projects/opc/properties.yaml"
}
}
]
}List the log lines generated while building an image and querying the actions available for this asset / template version combination.
Note: See the list filtered log lines API docs for filtering options.
| node_background_task_id required | string Example: node_background_task_id=01a1e72a-f444-7621-999d-3ba87fb77fb9 |
| filter[<query/sort filter>]= | |
| download | string Example: download=change.log Download the log lines with the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
| limit | integer [ 1 .. 10000 ] Default: 10000 Example: limit=50 Limit the number of log lines returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72f-c009-7848-b4ad-9eb0dd44ee30",
- "type": "node_background_task_log_line",
- "attributes": {
- "message": "Possimus ut est est.",
- "category": "action",
- "template_version_history_id": "01a1e72f-bfab-7f84-bc5f-859581413367",
- "node_background_task_id": "01a1e72f-bfc9-78d7-ad57-ae4b6d9da74d",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Create a request to refresh the actions list for an asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
required | object |
{- "data": {
- "attributes": {
- "build_without_cache": false
}
}
}{- "data": {
- "id": "01a1e72f-cb19-7038-94fd-6904c40fe7a1",
- "type": "node_background_task",
- "attributes": {
- "request_number": 3,
- "status_code": "initializing",
- "error_message": null,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "actions_count": 0,
- "task_type": "GenerateActionsRequest",
- "created_at": "2026-11-17T01:47:11.511964Z",
- "updated_at": "2026-11-17T01:47:11.511964Z",
- "build_without_cache": false
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72f-c9c8-743a-8925-eb5aa4604a9a",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72f-c936-7b91-9272-1673ccfe7531",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72f-c686-7ef2-8b64-21e8c71c9797/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a1e72f-cb19-7038-94fd-6904c40fe7a1",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72f-cb19-7038-94fd-6904c40fe7a1"
}
}
}Lists all generate actions requests made for the asset's current template version.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[request_number_eq]=1 API filtering guide. Named filters: |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of requests returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72f-d60d-7b27-a04b-3705ef332234",
- "type": "node_background_task",
- "attributes": {
- "request_number": 2,
- "status_code": "error",
- "error_message": "- failed to concretise this asset's MintModel",
- "created_by": "marleen-2523",
- "created_by_name": "marleen-2523",
- "actions_count": 0,
- "task_type": "MintModelConcretiseTask",
- "created_at": "2026-11-17T01:47:14.316840Z",
- "updated_at": "2026-11-17T01:47:14.319526Z",
- "render_logs": {
- "context": {
- "asset": "opc/soa1",
- "template_version": "2023_Q4_2"
}, - "exception": "MintPress::ConcretisationError: unable to resolve property @db_host",
- "exception_backtrace": [
- "/opt/opschain/lib/mintpress/model.rb:214:in `concretise'"
], - "property_converge_failure": "the property @db_host is not defined for this asset"
}
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72f-d5d0-7d51-9250-2e2071d55f8e",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72f-d5a0-7dc1-a81c-33c788d05886",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72f-d429-7e8f-b35e-649212d81baa/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a1e72f-d60d-7b27-a04b-3705ef332234",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72f-d60d-7b27-a04b-3705ef332234"
}
}, - {
- "id": "01a1e72f-d5de-774b-8955-7eda4ef82783",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "charlie-2521",
- "created_by_name": "charlie-2521",
- "actions_count": 1,
- "task_type": "GenerateActionsRequest",
- "created_at": "2026-11-17T01:47:14.269346Z",
- "updated_at": "2026-11-17T01:47:14.283341Z",
- "build_without_cache": false
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72f-d5d0-7d51-9250-2e2071d55f8e",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72f-d5a0-7dc1-a81c-33c788d05886",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72f-d429-7e8f-b35e-649212d81baa/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a1e72f-d5de-774b-8955-7eda4ef82783",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72f-d5de-774b-8955-7eda4ef82783"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}, - "partial_response": false
}
}Show a specific actions generation request.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| node_background_task_id required | string Example: 01a1e72a-f444-7621-999d-3ba87fb77fb9 generate actions request id |
{- "data": {
- "id": "01a1e72f-da0a-763f-8509-9b22a3e4f364",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "jacalyn.nolan-2529",
- "created_by_name": "jacalyn.nolan-2529",
- "actions": [
- {
- "action": "deploy",
- "children": [
- {
- "action": "deploy:configure",
- "children": [ ],
- "pre_reqs": [ ],
- "full_path": "deploy/configure",
- "step_name": "configure",
- "stage_step": false,
- "description": "Configure the asset",
- "ignore_failure": false,
- "reload_actions": false,
- "mintmodel_placeholder": false
}
], - "pre_reqs": [ ],
- "full_path": "deploy",
- "step_name": "deploy",
- "stage_step": false,
- "description": "Deploy the asset",
- "ignore_failure": false,
- "child_execution_strategy": "sequential"
}
], - "actions_count": 1,
- "task_type": "GenerateActionsRequest",
- "created_at": "2026-11-17T01:47:15.337117Z",
- "updated_at": "2026-11-17T01:47:15.351223Z",
- "build_without_cache": false
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72f-d9fc-74f2-9af5-d07008706060",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72f-d9d1-7d15-888b-b7c597297332",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72f-d8df-737a-94eb-c0337bb3631d/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a1e72f-da0a-763f-8509-9b22a3e4f364",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72f-da0a-763f-8509-9b22a3e4f364"
}
}
}Cancels the generate actions request.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| node_background_task_id required | string Example: 01a1e72a-f444-7621-999d-3ba87fb77fb9 generate actions request id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to cancel the generate actions request",
- "detail": "Your authorisation rules let you view the generate actions request but not cancel it."
}
]
}Lists all properties versions and template versions for the asset and its parents.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "01a1e730-99bd-7db4-a205-2153b360b729",
- "type": "project",
- "attributes": {
- "level": 0,
- "code": "opc",
- "name": "OpsChain",
- "properties_versions": [
- {
- "version": 1,
- "start_date": "2026-11-17T01:48:04Z"
}
]
}
}, - {
- "id": "01a1e730-99f7-7f85-9571-afd45b61ef9d",
- "type": "template",
- "attributes": {
- "level": 1,
- "code": "soa",
- "name": "Oracle SOA template",
- "properties_versions": [
- {
- "version": 1,
- "start_date": "2026-11-17T01:48:04Z"
}
]
}
}, - {
- "id": "01a1e730-9a70-7ebd-85c5-bfc54a1ee508",
- "type": "asset",
- "attributes": {
- "level": 3,
- "code": "prj_soa",
- "name": "Project asset",
- "properties_versions": [
- {
- "version": 1,
- "start_date": "2026-11-17T01:48:04Z"
}
], - "template_versions": [ ]
}
}
]
}Lists the template versions that have been assigned to the asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[name_eq]=Test API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e731-ebaa-7802-bc06-fa9d558adcca",
- "type": "template_version_history",
- "attributes": {
- "created_by": "zachery-3695",
- "created_by_name": "zachery-3695",
- "commit_sha": "192b93762475de5fdd7b6b6fc6f25d870f8e4df9",
- "active_from": "2026-11-17T01:49:30.919017Z",
- "active_to": null
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e731-eb7a-7f2e-8879-fbaac0ed9317",
- "type": "asset"
}
}, - "template_version": {
- "data": {
- "id": "01a1e731-eb2c-7460-a23d-00a902852646",
- "type": "template_version"
}
}, - "node_background_tasks": {
- "data": [
- {
- "id": "01a1e731-ebb9-7a00-851c-acb6184db66f",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e731-eadb-71c0-a63c-d842be9a9f89/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/version_history/01a1e731-ebaa-7802-bc06-fa9d558adcca",
- "asset": "/api/projects/opc/assets/prj_soa"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Shows a specific project asset's template version history record.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| id required | string Example: 01a1e72a-f3c3-7e71-950d-91cd9e27ca6b version history id |
{- "data": {
- "id": "01a1e731-ee95-7a39-acfd-f4481c4a81df",
- "type": "template_version_history",
- "attributes": {
- "created_by": "isiah-3702",
- "created_by_name": "isiah-3702",
- "commit_sha": "3edbb60f626b9864f327f26879d5373442994b68",
- "active_from": "2026-11-17T01:49:31.667779Z",
- "active_to": null
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e731-ee5f-7396-b3d3-badeb0ae77ef",
- "type": "asset"
}
}, - "template_version": {
- "data": {
- "id": "01a1e731-ee1d-7b18-9ae9-9fd292e31981",
- "type": "template_version"
}
}, - "node_background_tasks": {
- "data": [
- {
- "id": "01a1e731-eea2-7ba1-8fea-20656586f10a",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e731-ede0-7a73-8c47-568fa55b4121/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/version_history/01a1e731-ee95-7a39-acfd-f4481c4a81df",
- "asset": "/api/projects/opc/assets/prj_soa"
}
}, - "included": [
- {
- "id": "01a1e731-ee5f-7396-b3d3-badeb0ae77ef",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "isiah-3702",
- "created_by_name": "isiah-3702",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-ee67-74f2-becc-5ad3ac70b962",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-ee67-74f2-becc-5ad3ac70b962"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e731-eda6-7cfb-872b-e0585e3dd00d",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e731-ee78-7e87-bcdf-0191902cbe25",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-ee78-7e87-bcdf-0191902cbe25"
}
}, - "parent": {
- "data": {
- "id": "01a1e731-eda6-7cfb-872b-e0585e3dd00d",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e731-eda6-7cfb-872b-e0585e3dd00d",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e731-ee1d-7b18-9ae9-9fd292e31981",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e731-ede0-7a73-8c47-568fa55b4121/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "01a1e731-eebb-76e5-8d02-f5c719723d38",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "01a1e731-ede0-7a73-8c47-568fa55b4121",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e731-ede0-7a73-8c47-568fa55b4121"
}
}, - "latest_node_background_tasks": {
- "data": [
- {
- "id": "01a1e731-eea2-7ba1-8fea-20656586f10a",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "actions": "/api/projects/opc/assets/prj_soa/actions",
- "artifacts": "/api/projects/opc/assets/prj_soa/artifacts",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}, - {
- "id": "01a1e731-ee1d-7b18-9ae9-9fd292e31981",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "belinda-3701",
- "created_by_name": "belinda-3701",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:31.548608Z",
- "updated_at": "2026-11-17T01:49:31.548608Z",
- "committed_at": null,
- "has_mintmodel": true,
- "git_rev": "online",
- "commit_sha": "3edbb60f626b9864f327f26879d5373442994b68",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-ee25-709a-a7d1-6bca9d2403a1",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-ee25-709a-a7d1-6bca9d2403a1"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-ee35-7d77-9043-eff7de0ccef7",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-ee35-7d77-9043-eff7de0ccef7"
}
}, - "project": {
- "data": {
- "id": "01a1e731-eda6-7cfb-872b-e0585e3dd00d",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e731-ede0-7a73-8c47-568fa55b4121",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-ede0-7a73-8c47-568fa55b4121/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e731-ede0-7a73-8c47-568fa55b4121"
}
}
]
}Endpoints to query the action step trees available for a templated node.
Notes:
action name or their
step_name. Child actions are not individually addressable - they are included in each action's
children attribute by the show endpoint, and by the list endpoint when include_children is set.Lists every action available for the asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| include_children | boolean Example: include_children=true By default each action is returned without its |
{- "data": [
- {
- "id": "deploy",
- "type": "action",
- "links": {
- "self": "/api/projects/opc/assets/prj_soa/actions/deploy"
}, - "attributes": {
- "action": "deploy",
- "pre_reqs": [ ],
- "full_path": "deploy",
- "step_name": "deploy",
- "stage_step": false,
- "description": "Deploy the asset",
- "ignore_failure": false,
- "child_execution_strategy": "sequential"
}
}, - {
- "id": "provision",
- "type": "action",
- "links": {
- "self": "/api/projects/opc/assets/prj_soa/actions/provision"
}, - "attributes": {
- "action": "provision",
- "step_name": "provision",
- "full_path": "provision",
- "description": "Provision resource on existing hardware",
- "child_execution_strategy": "sequential",
- "stage_step": true,
- "ignore_failure": false,
- "pre_reqs": [ ]
}
}
]
}Shows the step tree of one of the asset's actions. The action can be identified by its action name or its step_name.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| id required | string Example: deploy action name or step name |
{- "data": {
- "id": "deploy",
- "type": "action",
- "links": {
- "self": "/api/projects/opc/assets/prj_soa/actions/deploy"
}, - "attributes": {
- "action": "deploy",
- "children": [
- {
- "action": "deploy:configure",
- "children": [ ],
- "pre_reqs": [ ],
- "full_path": "deploy/configure",
- "step_name": "configure",
- "stage_step": false,
- "description": "Configure the asset",
- "ignore_failure": false,
- "reload_actions": false,
- "mintmodel_placeholder": false
}
], - "pre_reqs": [ ],
- "full_path": "deploy",
- "step_name": "deploy",
- "stage_step": false,
- "description": "Deploy the asset",
- "ignore_failure": false,
- "child_execution_strategy": "sequential"
}
}
}Templates provide the available actions and a base set of repository properties that will be used to configure the asset.
Create a template.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "template_type": "asset",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "git_remote_name": "github"
}
}
}{- "data": {
- "id": "01a1e731-b20f-770b-99b4-55353fea2024",
- "type": "template",
- "attributes": {
- "code": "ypvo7",
- "name": "fernando",
- "description": "Repellendus et explicabo eveniet.",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-11-17T01:49:16.174443Z",
- "updated_at": "2026-11-17T01:49:16.174443Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-b218-78a7-8c17-0cbfe574ce9b",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-b218-78a7-8c17-0cbfe574ce9b"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-b22d-7701-83c5-64a8b8e93bd2",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-b22d-7701-83c5-64a8b8e93bd2"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e731-b19b-7e75-8d28-1f4477217b43",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e731-b171-7e6b-8e56-3de548829c2f",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-b20f-770b-99b4-55353fea2024",
- "template_versions": "/api/projects/opc/templates/01a1e731-b20f-770b-99b4-55353fea2024/versions",
- "project": "/api/projects/opc"
}
}
}Lists all templates for a project.
| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | |
| exclude_archived_nodes | boolean Example: exclude_archived_nodes=true when true, excludes archived nodes from each template's nodes relationship |
{- "data": [
- {
- "id": "01a1e731-b83c-748b-b5f9-315dd29eadc2",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-11-17T01:49:17.755463Z",
- "updated_at": "2026-11-17T01:49:17.755463Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-b844-7582-9543-15eadd594e7d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-b844-7582-9543-15eadd594e7d"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-b855-7b3b-8453-f3b316def35d",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-b855-7b3b-8453-f3b316def35d"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e731-b829-7479-a9ef-e45c47e66003",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e731-b806-78a3-a848-019d4c53a785",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-b83c-748b-b5f9-315dd29eadc2",
- "template_versions": "/api/projects/opc/templates/01a1e731-b83c-748b-b5f9-315dd29eadc2/versions",
- "project": "/api/projects/opc"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Archives the versions of a project's templates that have not been used for a period.
Notes:
filters.template_versions.unused_for_days days. A version is never archived while an asset points at it (archived assets included), an unfinished change uses it, it is locked, or an unarchived version of an unarchived workflow names a template version with the same name. Archived versions keep their name reserved.filters.template_versions.unused_for_days is required and must be a whole number of days from 1 to 365, otherwise the request is rejected with a 422 error on filters. filters.template_versions.keep_latest keeps the newest N versions of each template by creation date, counting versions in use, and the other template_versions keys are ransack filters, e.g. template_id_in to limit the request to selected templates or version_cont to match version names.meta object. meta.template_versions lists the path of each archived version and meta.archived_count counts them. The result is also recorded in an info:data_cleanup:template_versions event on the project, whose id is returned in meta.event_id.| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "filters": {
- "template_versions": {
- "unused_for_days": 180,
- "keep_latest": 3,
- "template_id_in": [
- "01a1e72a-f150-7b02-b744-c5bfc406c905"
]
}
}
}
}
}{- "data": null,
- "meta": {
- "archived_count": 0,
- "template_versions": [ ],
- "event_id": "01a1e731-bae2-71a0-b9d5-a91c3592ec93"
}
}Lists the versions of a project's templates that the archive_unused_versions endpoint would archive, without archiving anything.
Notes:
filters.template_versions.unused_for_days days. A version is never archived while an asset points at it (archived assets included), an unfinished change uses it, it is locked, or an unarchived version of an unarchived workflow names a template version with the same name. Archived versions keep their name reserved.filters.template_versions.unused_for_days is required and must be a whole number of days from 1 to 365, otherwise the request is rejected with a 422 error on filters. filters.template_versions.keep_latest keeps the newest N versions of each template by creation date, counting versions in use, and the other template_versions keys are ransack filters, e.g. template_id_in to limit the request to selected templates or version_cont to match version names.meta object. meta.template_versions lists the path of each version that a request at the same time would archive, and meta.total counts them.| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "filters": {
- "template_versions": {
- "unused_for_days": 180,
- "keep_latest": 3,
- "template_id_in": [
- "01a1e72a-f150-7b02-b744-c5bfc406c905"
]
}
}
}
}
}{- "data": null,
- "meta": {
- "template_versions": [ ],
- "total": 0
}
}Shows a project template.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| exclude_archived_nodes | boolean Example: exclude_archived_nodes=true when true, excludes archived nodes from each template's nodes relationship |
{- "data": {
- "id": "01a1e731-ccf3-7526-85c6-f89ff22d43e5",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-11-17T01:49:23.058426Z",
- "updated_at": "2026-11-17T01:49:23.058426Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-ccfa-7bcb-a84d-1531859e05ef",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-ccfa-7bcb-a84d-1531859e05ef"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-cd08-74d0-86ce-5882c793c18f",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-cd08-74d0-86ce-5882c793c18f"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e731-cce0-741c-8477-36814c8bc671",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e731-ccbf-76af-ac94-fb5313214423",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-ccf3-7526-85c6-f89ff22d43e5",
- "template_versions": "/api/projects/opc/templates/01a1e731-ccf3-7526-85c6-f89ff22d43e5/versions",
- "project": "/api/projects/opc"
}
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Archives/unarchives a template.
| project_code required | string Example: opc project code |
| id_to_archive required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
required | object |
{- "data": {
- "attributes": {
- "archived": true
}
}
}{- "data": {
- "id": "01a1e731-d1b3-7651-b600-5d71e3c2f392",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": true,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-11-17T01:49:24.274546Z",
- "updated_at": "2026-11-17T01:49:24.354200Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-d1bc-7972-8284-ca7ace1eaea0",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-d1bc-7972-8284-ca7ace1eaea0"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-d1cf-73dc-ba29-a97b463743cf",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-d1cf-73dc-ba29-a97b463743cf"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e731-d19c-7f3f-97cf-67e2771c4839",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e731-d178-7341-ad01-3d44c4e8d12b",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-d1b3-7651-b600-5d71e3c2f392",
- "template_versions": "/api/projects/opc/templates/01a1e731-d1b3-7651-b600-5d71e3c2f392/versions",
- "project": "/api/projects/opc"
}
}
}Update a templates details.
| project_code required | string Example: opc project code |
| id_to_update required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
required | object |
{- "data": {
- "attributes": {
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "git_remote_name": "github",
- "disabled": false
}
}
}{- "data": {
- "id": "01a1e731-d77c-7b43-b02d-754413ce3fc5",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "updated_name",
- "description": "updated_description",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-11-17T01:49:25.755904Z",
- "updated_at": "2026-11-17T01:49:25.821891Z"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-d785-7572-8107-20a9a27cb0a8",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-d785-7572-8107-20a9a27cb0a8"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-d796-71c7-8454-acc0b96dae24",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-d796-71c7-8454-acc0b96dae24"
}
}, - "git_remote": {
- "data": {
- "id": "01a1e731-d769-7a68-b99a-247c8364bdfb",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e731-d748-7a20-b74b-3f3eda4d451e",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-d77c-7b43-b02d-754413ce3fc5",
- "template_versions": "/api/projects/opc/templates/01a1e731-d77c-7b43-b02d-754413ce3fc5/versions",
- "project": "/api/projects/opc"
}
}
}Deletes a project template. A template cannot be deleted while it is assigned to a node or referenced by a change.
| project_code required | string Example: opc project code |
| id_to_delete required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the template",
- "detail": "Your authorisation rules let you view the template but not delete it."
}
]
}Show the converged settings for this template, merged from the global, project and template settings. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "01a1e731-e52a-7d12-a397-4ce05b739426",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-e52a-7d12-a397-4ce05b739426/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Show the converged properties for this template, merged from the global, project and template settings, merged from the database properties of the project and the template.
The API response will also include the individual database properties that were included in the result.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| converge_date | string Example: converge_date=2026-11-17T01:42:03+00:00 Specify the date (and optionally time), to derive the active properties from. |
{- "data": {
- "id": "01a1e731-e838-7edf-af61-dfaf5f6736d0",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "01a1e731-e800-7cfa-878f-0da694b35c5e",
- "type": "properties_version"
}, - {
- "id": "01a1e731-e84a-7d98-895e-324a2469541b",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-e838-7edf-af61-dfaf5f6736d0/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "sources": [
- {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "template",
- "layer": "template",
- "human": "Template: Oracle SOA template (soa)"
}
]
}, - "property_layers": [
- {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template",
- "human": "Template",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e731-e800-7cfa-878f-0da694b35c5e",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:49:29.983929Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-e7f8-7da4-a012-727a36483c8b",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-e7f8-7da4-a012-727a36483c8b"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-e7f8-7da4-a012-727a36483c8b/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e731-e7f8-7da4-a012-727a36483c8b/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e731-e84a-7d98-895e-324a2469541b",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:49:30.057808Z",
- "owner_type": "Template"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-e840-7b25-84f8-51ee8890e330",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-e840-7b25-84f8-51ee8890e330"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-e840-7b25-84f8-51ee8890e330/versions",
- "owner": "/api/projects/opc/templates/01a1e731-e838-7edf-af61-dfaf5f6736d0",
- "self": "/api/properties/01a1e731-e840-7b25-84f8-51ee8890e330/versions/1"
}, - "meta": { }
}
]
}Lists all versions of a specific template.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[version_cont]=1.0 API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e731-f05d-7683-bc1d-3be9483be487",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "oscar-3708",
- "created_by_name": "oscar-3708",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:32.124328Z",
- "updated_at": "2026-11-17T01:49:32.124328Z",
- "committed_at": null,
- "has_mintmodel": true,
- "git_rev": "redundant",
- "commit_sha": "294ec8a719b7f8f1616cf91842d0b58d4b700826",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-f066-7623-b31a-6ff0004d3363",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-f066-7623-b31a-6ff0004d3363"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-f078-7827-8e0b-5c8953a90ab3",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-f078-7827-8e0b-5c8953a90ab3"
}
}, - "project": {
- "data": {
- "id": "01a1e731-efd3-7fab-9c13-658d14aa712b",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e731-f015-703e-af2b-80b495f29bf6",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-f015-703e-af2b-80b495f29bf6/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e731-f015-703e-af2b-80b495f29bf6"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Create or update a template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
required | object |
object |
{- "data": {
- "attributes": {
- "description": "Added additional configuration options",
- "git_rev": "open-source",
- "archived": "false",
- "locked": "false",
- "float_git_rev": "false"
}
}, - "meta": {
- "ignore_in_use": false,
- "fetch_revision": false
}
}{- "data": {
- "id": "01a1e731-f46b-7c94-9099-92bfdfbdef1e",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Cupiditate non odit in autem eveniet enim nisi qui sed sit dolor ea voluptatibus",
- "state": "initializing",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:33.162758Z",
- "updated_at": "2026-11-17T01:49:33.162758Z",
- "committed_at": null,
- "has_mintmodel": false,
- "git_rev": "cross-platform",
- "commit_sha": null,
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-f472-7fcf-aea6-d0c84c4f1469",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-f472-7fcf-aea6-d0c84c4f1469"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-f482-78d1-b25b-822804b67b63",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-f482-78d1-b25b-822804b67b63"
}
}, - "project": {
- "data": {
- "id": "01a1e731-f305-7f26-acfd-bc0164cee9de",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e731-f33c-7ad8-8647-0a8592f99d14",
- "type": "template"
}
}, - "pending_commit": {
- "data": {
- "id": "01a1e731-f460-74a4-b0c0-4e129cc44586",
- "type": "commit"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-f33c-7ad8-8647-0a8592f99d14/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e731-f33c-7ad8-8647-0a8592f99d14"
}
}
}Shows a specific template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
{- "data": {
- "id": "01a1e731-fc9f-73a4-a2ef-dbc2806db78d",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "shawna-3746",
- "created_by_name": "shawna-3746",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:35.262278Z",
- "updated_at": "2026-11-17T01:49:35.262278Z",
- "committed_at": null,
- "has_mintmodel": true,
- "git_rev": "virtual",
- "commit_sha": "8119fe97250695c40f361c1e6836806d74221908",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-fca5-7930-bcfc-4e6a438101e7",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-fca5-7930-bcfc-4e6a438101e7"
}
}, - "settings": {
- "data": {
- "id": "01a1e731-fcb4-71b4-ac65-7bbe93250b94",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-fcb4-71b4-ac65-7bbe93250b94"
}
}, - "project": {
- "data": {
- "id": "01a1e731-fc35-7f44-87f4-045418e0c4c8",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e731-fc68-79ef-bf86-1ab3e814b38d",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e731-fc68-79ef-bf86-1ab3e814b38d/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e731-fc68-79ef-bf86-1ab3e814b38d"
}
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Delete or archive a template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
{- "data": {
- "id": "01a1e732-01e9-7795-95d8-fc53f0cc98f7",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "janett_harber-3758",
- "created_by_name": "janett_harber-3758",
- "archived": true,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:36.616544Z",
- "updated_at": "2026-11-17T01:49:37.215954Z",
- "committed_at": null,
- "has_mintmodel": true,
- "git_rev": "redundant",
- "commit_sha": "9b5da1d4eafdb4ea12b23589fe3b693863ea72ba",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e732-01f0-79ce-b0a4-43c1bfae7ff4",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e732-01f0-79ce-b0a4-43c1bfae7ff4"
}
}, - "settings": {
- "data": {
- "id": "01a1e732-01ff-75d3-aac0-7d9b1d9cf61c",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e732-01ff-75d3-aac0-7d9b1d9cf61c"
}
}, - "project": {
- "data": {
- "id": "01a1e732-0182-77a0-9af2-ed40b919355e",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e732-01b4-7593-8d49-d91f7558bee4",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e732-01b4-7593-8d49-d91f7558bee4/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e732-01b4-7593-8d49-d91f7558bee4"
}
}
}Assign assets to the template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
required | object |
{- "data": {
- "attributes": {
- "asset_paths": [
- "/projects/opc/assets/prj_soa"
]
}
}
}{- "data": {
- "id": "01a1e732-1201-73c1-b5c5-c46f84fe4616",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "fairy-3785",
- "created_by_name": "fairy-3785",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:40.736411Z",
- "updated_at": "2026-11-17T01:49:40.736411Z",
- "committed_at": null,
- "has_mintmodel": true,
- "git_rev": "cross-platform",
- "commit_sha": "e9a373e99fc8ef8ad23c7031ecdf29637c2d0cc4",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e732-1206-7e53-b1a3-953849e1d23c",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e732-1206-7e53-b1a3-953849e1d23c"
}
}, - "settings": {
- "data": {
- "id": "01a1e732-1214-7528-ae7e-e74ff0eae671",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e732-1214-7528-ae7e-e74ff0eae671"
}
}, - "project": {
- "data": {
- "id": "01a1e732-119d-768d-a1dd-2709379ac186",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e732-11d1-73a0-8a8d-e8ae0f3c00fb",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e732-11d1-73a0-8a8d-e8ae0f3c00fb/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/01a1e732-11d1-73a0-8a8d-e8ae0f3c00fb"
}
}
}Cancel an in-progress Git SHA refresh for the template version. When the version was previously resolved it is returned to that commit, otherwise the version is left broken.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
{- "data": {
- "id": "01a1e732-1d6a-7274-9ec8-755c0dbd2c5a",
- "type": "template_version",
- "attributes": {
- "version": "r397e",
- "description": "Est consequatur optio tempora amet tenetur pariatur quaerat rem",
- "state": "ready",
- "created_by": "sidney_hoeger-3814",
- "created_by_name": "sidney_hoeger-3814",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "float_git_rev": false,
- "float_refresh_error": null,
- "created_at": "2026-11-17T01:49:43.657164Z",
- "updated_at": "2026-11-17T01:49:43.747400Z",
- "committed_at": null,
- "has_mintmodel": false,
- "git_rev": "online",
- "commit_sha": "bb2c9d06a4bba1d9ff9cc660015fa1b2ef93461c",
- "git_remote_name": "lynda_schinner"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e732-1d70-7adc-b01f-7d57b240ac16",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e732-1d70-7adc-b01f-7d57b240ac16"
}
}, - "settings": {
- "data": {
- "id": "01a1e732-1d8e-7582-9034-f42129a00b57",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e732-1d8e-7582-9034-f42129a00b57"
}
}, - "project": {
- "data": {
- "id": "01a1e732-1c96-7d53-abd3-0f948922cd4e",
- "type": "project"
}
}, - "template": {
- "data": {
- "id": "01a1e732-1cf5-7056-8a81-e33be0ae15fd",
- "type": "template"
}
}, - "pending_commit": {
- "data": null
}
}, - "links": {
- "self": "/api/projects/xfdi2/templates/01a1e732-1cf5-7056-8a81-e33be0ae15fd/versions/r397e",
- "template": "/api/projects/xfdi2/templates/01a1e732-1cf5-7056-8a81-e33be0ae15fd"
}
}
}Show the converged settings for this template version, merged from the global, project, template and template version settings. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "2023_Q4_2",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e732-2455-7dac-a532-c7bbccaf747a/versions/2023_Q4_2/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Show the converged properties for this template version, merged from the global, project, template and template version settings, merged from the database properties of the project and the template and template version.
The API response will also include the individual database properties that were included in the result.
| project_code required | string Example: opc project code |
| template_id required | string Example: 01a1e72a-f150-7b02-b744-c5bfc406c905 template id |
| version required | string Example: 2023_Q4_2 template version |
| converge_date | string Example: converge_date=2026-11-17T01:42:03+00:00 Specify the date (and optionally time), to derive the active properties from. |
{- "data": {
- "id": "2023_Q4_2",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "01a1e732-29df-7cd8-bb31-48119e3c246a",
- "type": "properties_version"
}, - {
- "id": "01a1e732-2a1f-78d9-85ab-0a4ddcf8a78c",
- "type": "properties_version"
}, - {
- "id": "01a1e732-2a5b-789a-b661-eeb8d1fe6fef",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/templates/01a1e732-2a0c-7dda-9779-2e844f1b9d5a/versions/2023_Q4_2/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "sources": [
- {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "template",
- "layer": "template",
- "human": "Template: Oracle SOA template (soa)"
}, - {
- "group": "database",
- "id": "template_version",
- "layer": "template_version",
- "human": "Template version: Oracle SOA template (2023_Q4_2)"
}
]
}, - "property_layers": [
- {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template",
- "human": "Template",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "template_version",
- "human": "Template version",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e732-29df-7cd8-bb31-48119e3c246a",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:49:46.846336Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e732-29d6-7e72-9675-4963f8b1793a",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e732-29d6-7e72-9675-4963f8b1793a"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e732-29d6-7e72-9675-4963f8b1793a/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e732-29d6-7e72-9675-4963f8b1793a/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e732-2a1f-78d9-85ab-0a4ddcf8a78c",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:49:46.910331Z",
- "owner_type": "Template"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e732-2a15-77a5-8110-25f84f9282a3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e732-2a15-77a5-8110-25f84f9282a3"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e732-2a15-77a5-8110-25f84f9282a3/versions",
- "owner": "/api/projects/opc/templates/01a1e732-2a0c-7dda-9779-2e844f1b9d5a",
- "self": "/api/properties/01a1e732-2a15-77a5-8110-25f84f9282a3/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e732-2a5b-789a-b661-eeb8d1fe6fef",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:49:46.970491Z",
- "owner_type": "Template version"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e732-2a51-76d0-b34c-4781047a95ef",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e732-2a51-76d0-b34c-4781047a95ef"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e732-2a51-76d0-b34c-4781047a95ef/versions",
- "owner": "/api/projects/opc/templates/01a1e732-2a0c-7dda-9779-2e844f1b9d5a/versions/2023_Q4_2",
- "self": "/api/properties/01a1e732-2a51-76d0-b34c-4781047a95ef/versions/1"
}, - "meta": {
- "template_versions": { }
}
}
]
}Endpoints to interact with git remotes.
Create a project Git remote.
For HTTP(S) remotes provide the user and password credentials. For SSH remotes provide the ssh_key_data private key and, if the key is encrypted, its passphrase. Supplying password for an SSH remote (or passphrase for an HTTP(S) remote) is rejected.
When meta.add_known_host is true and the remote uses an SSH URL, OpsChain scans the host with ssh-keyscan and stores the fetched host key in the global known_hosts setting before validating the connection, so the same request - and all future fetches - trust the host. On success the response meta.known_hosts_added lists the registered host key lines. This requires superuser access (a non-superuser receives a 403). The scanned key is trusted on first use (TOFU); verify the reported host key out of band.
| project_code required | string Example: opc project code |
required | object |
object |
{- "data": {
- "attributes": {
- "name": "github",
- "user": "limepoint",
- "password": "password",
- "passphrase": "ssh-key-passphrase",
- "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n",
- "periodic_fetch_interval": 900
}
}, - "meta": {
- "add_known_host": false
}
}{- "data": {
- "id": "01a1e72f-1389-7198-b7c1-0239cc2c5022",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "public_url": null,
- "archived": false,
- "disabled": false,
- "periodic_fetch_interval": null,
- "created_at": "2026-11-17T01:46:24.519963Z",
- "updated_at": "2026-11-17T01:46:24.519963Z",
- "user": null,
- "ssh_key_data": null,
- "password": null,
- "passphrase": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-1328-7110-bd8a-da628f16ef7c",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/01a1e72f-1389-7198-b7c1-0239cc2c5022"
}, - "meta": null
}
}Lists all Git remotes for a project.
| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= |
{- "data": [
- {
- "id": "01a1e72f-1c4d-78c5-9fd8-4468da62c160",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "periodic_fetch_interval": 900,
- "created_at": "2026-11-17T01:46:26.755119Z",
- "updated_at": "2026-11-17T01:46:26.755119Z",
- "user": "{{hidden}}",
- "ssh_key_data": null,
- "password": "{{hidden}}",
- "passphrase": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-1ba0-7fba-af54-af0cf916f1e1",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/01a1e72f-1c4d-78c5-9fd8-4468da62c160"
}, - "meta": null
}, - {
- "id": "01a1e72f-1c6d-7d22-9295-9459ea057efd",
- "type": "git_remote",
- "attributes": {
- "name": "github_ssh",
- "url": "ssh://github.com/LimePoint/opschain-getting-started.git",
- "public_url": null,
- "archived": false,
- "disabled": false,
- "periodic_fetch_interval": null,
- "created_at": "2026-11-17T01:46:26.790402Z",
- "updated_at": "2026-11-17T01:46:26.790402Z",
- "user": "{{hidden}}",
- "ssh_key_data": "{{hidden}}",
- "password": null,
- "passphrase": "{{hidden}}"
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-1ba0-7fba-af54-af0cf916f1e1",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github_ssh",
- "self": "/api/projects/opc/git_remotes/01a1e72f-1c6d-7d22-9295-9459ea057efd"
}, - "meta": null
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}, - "default_periodic_fetch_interval": 900
}
}Shows a project Git remote.
Note: Git remote credentials are obfuscated for security reasons.
| project_code required | string Example: opc project code |
| remote_id required | string Example: 01a1e72a-f0cc-7a86-9dad-3fda525db936 remote id |
{- "data": {
- "id": "01a1e72f-2595-7452-a161-e901859ebdc6",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "periodic_fetch_interval": 900,
- "created_at": "2026-11-17T01:46:29.135668Z",
- "updated_at": "2026-11-17T01:46:29.135668Z",
- "user": "{{hidden}}",
- "ssh_key_data": null,
- "password": "{{hidden}}",
- "passphrase": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-24cc-71a7-8629-7cb4e6d9d6d1",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/01a1e72f-2595-7452-a161-e901859ebdc6"
}, - "meta": null
}
}Archives/unarchives a project Git remote.
| project_code required | string Example: opc project code |
| id_to_archive required | string Example: 01a1e72a-f0cc-7a86-9dad-3fda525db936 remote id |
required | object |
{- "data": {
- "attributes": {
- "archived": true
}
}
}{- "data": {
- "id": "01a1e72f-2ad2-7550-83e9-82e6cf3a0d08",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": true,
- "disabled": false,
- "periodic_fetch_interval": 900,
- "created_at": "2026-11-17T01:46:30.480989Z",
- "updated_at": "2026-11-17T01:46:30.523379Z",
- "user": "{{hidden}}",
- "ssh_key_data": null,
- "password": "{{hidden}}",
- "passphrase": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-2a9d-7aa2-8134-8fff18e17412",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/01a1e72f-2ad2-7550-83e9-82e6cf3a0d08"
}, - "meta": null
}
}Update the URL and/or credentials of a project Git remote. The remote must be active (not archived), and OpsChain verifies the remote is reachable with the updated values before saving. The URL may only be edited to change its credentials, scheme, or port - the host and path cannot change (delete and recreate the remote to point at a different repository).
For HTTP(S) remotes provide the user and password credentials. For SSH remotes provide the ssh_key_data private key and, if the key is encrypted, its passphrase. Supplying password for an SSH remote (or passphrase for an HTTP(S) remote) is rejected. Changing a remote's protocol clears the existing credentials - supply the new protocol's credentials in the same request.
When meta.add_known_host is true and the request changes the URL to an SSH URL, OpsChain scans the new host with ssh-keyscan and stores the fetched host key in the global known_hosts setting before validating the connection. On success the response meta.known_hosts_added lists the registered host key lines. This requires superuser access (a non-superuser receives a 403). The scanned key is trusted on first use (TOFU); verify the reported host key out of band.
| project_code required | string Example: opc project code |
| id_to_update required | string Example: 01a1e72a-f0cc-7a86-9dad-3fda525db936 remote id |
required | object |
object |
{- "data": {
- "attributes": {
- "user": "limepoint",
- "password": "password",
- "passphrase": "ssh-key-passphrase",
- "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n",
- "periodic_fetch_interval": 900
}
}, - "meta": {
- "add_known_host": false
}
}{- "data": {
- "id": "01a1e72f-3411-7424-a42d-0f0acad47310",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "periodic_fetch_interval": 900,
- "created_at": "2026-11-17T01:46:32.847772Z",
- "updated_at": "2026-11-17T01:46:32.893189Z",
- "user": "{{hidden}}",
- "ssh_key_data": null,
- "password": "{{hidden}}",
- "passphrase": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-33c6-78cc-b55e-d1df81b10d5f",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/01a1e72f-3411-7424-a42d-0f0acad47310"
}, - "meta": null
}
}Deletes a project Git remote if it has no changes, otherwise it removes the credentials.
| project_code required | string Example: opc project code |
| id_to_delete required | string Example: 01a1e72a-f0cc-7a86-9dad-3fda525db936 remote id |
{- "data": {
- "id": "01a1e72f-3f73-74e3-9a68-765aaab82216",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": true,
- "disabled": false,
- "periodic_fetch_interval": 900,
- "created_at": "2026-11-17T01:46:35.761354Z",
- "updated_at": "2026-11-17T01:46:36.355742Z",
- "user": null,
- "ssh_key_data": null,
- "password": null,
- "passphrase": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}, - "project": {
- "data": {
- "id": "01a1e72f-3f52-781b-a96e-01c3e6aa47ae",
- "type": "project"
}
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/01a1e72f-3f73-74e3-9a68-765aaab82216"
}, - "meta": {
- "credentials_removed": true,
- "messages": [
- "This Git remote cannot be deleted as it is used by a change, its credentials have been removed."
]
}
}
}Endpoints to interact with bookmarks.
Notes:
/<path/to/bookmark/owner>/bookmarks path. The example endpoints in this section reflect bookmarks owned
by a project asset.Create a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
required | object |
{- "data": {
- "attributes": {
- "description": "SOA administration console"
}
}
}{- "data": {
- "id": "01a1e72d-0f52-7b6b-96b3-c345a4eb2e6a",
- "type": "bookmark",
- "attributes": {
- "description": "Consequatur nostrum ducimus libero. 1",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:44:12.369358Z",
- "updated_at": "2026-11-17T01:44:12.369358Z"
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e72d-0d43-7d82-81ee-47019397eb26",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a1e72d-0f52-7b6b-96b3-c345a4eb2e6a",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
}Lists all bookmarks for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[description_cont]=server API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e72d-2221-784a-ab8f-8bcc92dde5f6",
- "type": "bookmark",
- "attributes": {
- "description": "SOA administration console",
- "created_by": "aleshia-1376",
- "created_by_name": "aleshia-1376",
- "created_at": "2026-11-17T01:44:17.184157Z",
- "updated_at": "2026-11-17T01:44:17.184157Z"
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e72d-21cc-7bfe-b485-501fea6910b1",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a1e72d-2221-784a-ab8f-8bcc92dde5f6",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Show a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| bookmark_id required | string Example: 01a1e72a-f4bc-7668-879e-e5460a929fb9 bookmark id |
{- "data": {
- "id": "01a1e72d-2620-7daa-9e49-8f646741c338",
- "type": "bookmark",
- "attributes": {
- "description": "SOA administration console",
- "created_by": "vicente-1383",
- "created_by_name": "vicente-1383",
- "created_at": "2026-11-17T01:44:18.205064Z",
- "updated_at": "2026-11-17T01:44:18.205064Z"
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e72d-2570-7163-9585-a04364d86339",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a1e72d-2620-7daa-9e49-8f646741c338",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
}Update a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| bookmark_id required | string Example: 01a1e72a-f4bc-7668-879e-e5460a929fb9 bookmark id |
required | object |
{- "data": {
- "attributes": {
- "description": "Updated server console path"
}
}
}{- "data": {
- "id": "01a1e72d-2f38-72f6-b048-1ec283deedf6",
- "type": "bookmark",
- "attributes": {
- "description": "Updated server console path",
- "created_by": "hee-1397",
- "created_by_name": "hee-1397",
- "created_at": "2026-11-17T01:44:20.534850Z",
- "updated_at": "2026-11-17T01:44:20.585109Z"
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e72d-2ec6-7811-9857-bfa26949433f",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a1e72d-2f38-72f6-b048-1ec283deedf6",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
}Delete a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| bookmark_id required | string Example: 01a1e72a-f4bc-7668-879e-e5460a929fb9 bookmark id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the bookmark",
- "detail": "Your authorisation rules let you view the bookmark but not delete it."
}
]
}Endpoints to query and generate MintModels for assets.
Notes:
parent_mintmodel_history link in the API response to access the
asset's MintModel history.Lists the asset's MintModel history.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[created_at_gteq]=2026-01-01 |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of MintModel history records returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72f-5589-77a1-937f-0ea6dbbfc9dc",
- "type": "mintmodel_history",
- "attributes": {
- "created_at": "2026-11-17T01:46:41.416660Z",
- "updated_at": "2026-11-17T01:46:41.416660Z"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72f-5468-7c4e-aaa8-91758be73c6f",
- "type": "project"
}, - {
- "id": "01a1e72f-552b-7359-8888-638bd4fc06ae",
- "type": "asset"
}
]
}, - "mintmodel": {
- "data": {
- "id": "01a1e72f-5586-7130-92e2-d8780a092ebc",
- "type": "mintmodel"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/mintmodels/01a1e72f-5586-7130-92e2-d8780a092ebc"
}
}, - "opschain_changes": {
- "data": [ ]
}, - "template_version": {
- "data": {
- "id": "01a1e72f-54d9-79a0-a901-653c2eda52f8",
- "type": "template_version"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/01a1e72f-5589-77a1-937f-0ea6dbbfc9dc"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows an asset's MintModel history record.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| id required | string Example: 01a1e72b-130a-7e21-9cc3-6d6aefc88ae4 MintModel history id |
{- "data": {
- "id": "01a1e72f-582b-7271-aaa2-4e2376b17095",
- "type": "mintmodel_history",
- "attributes": {
- "created_at": "2026-11-17T01:46:42.090426Z",
- "updated_at": "2026-11-17T01:46:42.090426Z"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72f-56e6-734c-86bd-4d59315620a1",
- "type": "project"
}, - {
- "id": "01a1e72f-57ad-77bb-83a4-00a1db691d32",
- "type": "asset"
}
]
}, - "mintmodel": {
- "data": {
- "id": "01a1e72f-5823-7fdb-9d06-d8b2041d19ca",
- "type": "mintmodel"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/mintmodels/01a1e72f-5823-7fdb-9d06-d8b2041d19ca"
}
}, - "opschain_changes": {
- "data": [ ]
}, - "template_version": {
- "data": {
- "id": "01a1e72f-5768-7560-b85a-5e63e54b1295",
- "type": "template_version"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/01a1e72f-582b-7271-aaa2-4e2376b17095"
}
}, - "included": [
- {
- "id": "01a1e72f-5823-7fdb-9d06-d8b2041d19ca",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-11-17T01:46:42.083033Z",
- "updated_at": "2026-11-17T01:46:42.083033Z",
- "render_logs": {
- "mintmodel_api": [
- "MintPress renderer output"
]
}, - "phase_output": { }
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "01a1e72f-582b-7271-aaa2-4e2376b17095",
- "type": "mintmodel_history"
}, - {
- "id": "01a1e72f-5826-7f31-849d-3ae0bda8fb46",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/01a1e72f-5823-7fdb-9d06-d8b2041d19ca",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
]
}List all MintModels for an asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| version | string Example: version=2023_Q4_2 Return only the unique MintModels that have been generated for the asset while this version of its template was assigned. Returns an error if the version has never been assigned to the asset. |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[created_at_gteq]=2026-01-01 |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of MintModels returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72f-58e2-7275-885b-8ded173623bb",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-11-17T01:46:42.273337Z",
- "updated_at": "2026-11-17T01:46:42.273337Z",
- "render_logs": {
- "mintmodel_api": [
- "MintPress renderer output"
]
}, - "phase_output": { }
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "01a1e72f-5a14-737a-85ae-8f06859a0042",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/01a1e72f-58e2-7275-885b-8ded173623bb",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Generate a MintModel of the differences between two existing MintModels.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| old_mintmodel_id required | string Example: 01a1e72b-0d72-7e31-b132-498591860a2f old MintModel id |
| new_mintmodel_id required | string Example: 01a1e72b-0d89-7d2d-a901-66f3aff31d8d new MintModel id |
{- "data": {
- "id": "MintModelDiff",
- "type": "diff_mintmodel",
- "attributes": {
- "diff_mintmodel": {
- "id": "01a1e72f-5dbd-7214-93cc-64ec31b72463",
- "data": {
- "internalVariables": {
- "environmentName": "d1",
- "assetCode": "obpodi",
- "stageRootDir": "/oracle/stage",
- "autoBaseline": "true",
- "projectUri": "D1OBPODI2025MAY301254"
}, - "projectName": "d1_obpodi2025May30_1254",
- "site": {
- "hostList": [
- {
- "id": "custwprd1odi01",
- "address": "custwprd1odi01.limepoint.engineering",
- "attributes": {
- "basename": "custwprd1odi01",
- "user": "oracle",
- "password": "unused-key-auth",
- "targetTempDir": "/oracle/app/binaries/obpodi/tmp"
}, - "targetAttributes": {
- "oracle.install.username": "oinstall",
- "target.tmp.dir": "/oracle/app/binaries/obpodi/tmp"
}
}, - {
- "id": "db_server",
- "address": "custwprd1db.limepoint.engineering",
- "attributes": {
- "scaleout": "false",
- "basename": "custwprd1db",
- "user": "oracle",
- "password": "unused-key-auth",
- "targetTempDir": "/oracle/app/binaries/obpodi/tmp"
}, - "targetAttributes": {
- "oracle.install.username": "oinstall",
- "target.tmp.dir": "/oracle/app/binaries/obpodi/tmp"
}
}, - {
- "id": "custwprd1odi02",
- "address": "custwprd1odi02.limepoint.engineering",
- "attributes": {
- "basename": "custwprd1odi02",
- "user": "oracle",
- "password": "unused-key-auth",
- "targetTempDir": "/oracle/app/binaries/obpodi/tmp"
}, - "targetAttributes": {
- "oracle.install.username": "oinstall",
- "target.tmp.dir": "/oracle/app/binaries/obpodi/tmp"
}
}
], - "installationList": [
- {
- "name": "jdk",
- "product": "OracleJava",
- "version": "1.8.0_341",
- "installPath": "/oracle/app/binaries/obpodi/java",
- "softwareStage": "/oracle/stage/jdk/jdk-8u341-linux-x64.tar.gz",
- "attributes": {
- "newworld": "true",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInstallGroup": "oinstall",
- "OracleJava": {
- "java_home": "/oracle/app/binaries/obpodi/java",
- "owner": "oracle",
- "group": "oinstall"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}, - "patchset": [ ]
}, - {
- "name": "fmwinfra",
- "product": "OracleFMWInfrastructure",
- "version": "12.2.1.4",
- "softwareStage": "/oracle/stage/fmwinfra/12.2.1.4/fmw_12.2.1.4.0_infrastructure.jar",
- "installPath": "/oracle/app/binaries/obpodi/fmw",
- "dependsonList": [
- "jdk"
], - "patchset": [
- {
- "targetOracleHome": "/oracle/app/binaries/obpodi/fmw/odi",
- "softwareStage": "/oracle/stage/cumulative_patches",
- "name": "3774133",
- "aru": "37741315",
- "attributes": {
- "required_opatch_version": "13.9.4.2.13",
- "opatch_autoupdate_file": "/oracle/stage/OPatch/13.9.4.2.10/p28186730_1394219_Generic.zip",
- "action": "rollback"
}
}
], - "attributes": {
- "newworld": "true",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "oracleInstallGroup": "oinstall",
- "OracleFMWInfrastructure": {
- "inventory_location": "/oracle/app/binaries/obpodi/oraInventory",
- "fmw_home": "/oracle/app/binaries/obpodi/fmw",
- "owner": "oracle",
- "group": "oinstall"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}
}, - {
- "name": "oracleclient",
- "product": "OracleDatabaseClient",
- "version": "12.2.0.1",
- "installPath": "/oracle/app/binaries/obpodi/dbclient",
- "softwareStage": "/oracle/stage/rdbms/12.2.0.1/client",
- "dependsonList": [
- "jdk"
], - "attributes": {
- "newworld": "true",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInstallGroup": "oinstall",
- "OracleDatabaseClient": {
- "inventory_location": "/oracle/app/binaries/obpodi/oraInventory",
- "owner": "oracle",
- "group": "oinstall",
- "oracle_home": "/oracle/app/binaries/obpodi/dbclient",
- "oracle_base": "/oracle/app/binaries/obpodi",
- "install_type": "Administrator"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}, - "patchset": [ ]
}, - {
- "name": "odi",
- "product": "OracleDataIntegrator",
- "version": "12.2.1.4",
- "installPath": "/oracle/app/binaries/obpodi/fmw/odi",
- "softwareStage": "/oracle/stage/odi/12.2.1.4/fmw_12.2.1.4.0_odi.jar",
- "dependsonList": [
- "fmwinfra",
- "oracleclient"
], - "patchset": [
- {
- "targetOracleHome": "/oracle/app/binaries/obpodi/fmw/odi",
- "softwareStage": "/oracle/stage/cumulative_patches",
- "name": "37741316",
- "aru": "37741315",
- "attributes": {
- "required_opatch_version": "13.9.4.2.13",
- "opatch_autoupdate_file": "/oracle/stage/OPatch/13.9.4.2.10/p28186730_1394219_Generic.zip",
- "action": "rollback"
}
}
], - "attributes": {
- "newworld": "true",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInstallGroup": "oinstall",
- "OracleDataIntegrator": {
- "inventory_location": "/oracle/app/binaries/obpodi/oraInventory",
- "fmw_home": "/oracle/app/binaries/obpodi/fmw",
- "java_home": "/oracle/app/binaries/obpodi/java",
- "database_client_home": "/oracle/app/binaries/obpodi/dbclient",
- "owner": "oracle",
- "group": "oinstall"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}
}
], - "databaseList": [
- {
- "name": "d1obpodidb",
- "port": "1521",
- "serviceName": "CUSTWPD1_INT_PRIM",
- "hostIdentifier": "db_server",
- "schemaList": [
- {
- "name": "SYS",
- "password": "{AES2}TBg8KMlIiNzASfnaMO9iww=={/IV}ThoJT1+ps+2NtkzPjniGrRKwOu9f0fmuKS2GJPG0/LbU="
}
], - "attributes": {
- "jdbcUrl": "jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(Host=custwprd1db.limepoint.engineering)(Port=1521))(CONNECT_DATA=(SERVER = DEDICATED)(SERVICE_NAME=CUSTWPD1_INT_PRIM)))",
- "rcu": {
- "datafile.initialsize": "200M",
- "extra.parameters": " -encryptTablespace false"
}
}
}
], - "resourceList": [
- {
- "name": "WeblogicUser_wlsmonitors",
- "type": "User",
- "attributes": {
- "name": "wlsmonitor",
- "password": "{AES2}cSYn1SEsZCScuAK+fj8vVQ=={/IV}T89zXOBEdWngdxqJ9rihn+uy2lgiqJx5J6fGDfPbHsys=",
- "description": "User with Weblogic Monitor Role",
- "groupList": "monitors"
}
}, - {
- "name": "AdminStartupParameter",
- "type": "StartupParameter",
- "attributes": {
- "1": "-Xms1g -Xmx4g",
- "2": "",
- "3": "",
- "4": "-Dweblogic.ProductionModeEnabled=true",
- "5": "-Dappdynamics.agent.tierName=OBP-ADMIN",
- "c1": "-Dweblogic.Stdout=/oracle/app/logs/obpodi/obpodi_domain/%Name%/%Name%.out",
- "c2": "-Dweblogic.Stderr=/oracle/app/logs/obpodi/obpodi_domain/%Name%/%Name%.err",
- "c3": "-Xloggc:/oracle/app/logs/obpodi/obpodi_domain/%Name%/%Name%_gc.out -XX:+UseParNewGC -XX:+CMSParallelRemarkEnabled -XX:+UseConcMarkSweepGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+ScavengeBeforeFullGC -XX:+CMSScavengeBeforeRemark -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseGCLogFileRotation -XX:GCLogFileSize=300M -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCDateStamps -XX:+UnlockCommercialFeatures -XX:+FlightRecorder",
- "c4": "-Djava.security.debug=failure -Djava.net.preferIPv4Stack=true -Doracle.ons.maxconnections=2 -Dweblogic.security.disableNullCipher=true",
- "c5": "-Dweblogic.MaxMessageSize=500000000 -Dweblogic.Chunksize=65536 -Djava.security.egd=file:///dev/urandom",
- "s1": "-Dweblogic.security.SSL.minimumProtocolVersion=TLSv1.2 -Dweblogic.security.SSL.protocolVersion=TLSv1.2",
- "s2": "-Dweblogic.management.disableManagedServerNotifications=true",
- "s3": "-Dweblogic.security.SSL.allowUnencryptedNullCipher=false",
- "s4": "-Dweblogic.security.SSL.enableJSSE=true",
- "s4a": "-Dweblogic.security.SSL.nojce=true -Dweblogic.jdbc.remoteEnabled=true",
- "s5": "-Dweblogic.ssl.JSSEEnabled=true -Dweblogic.rjvm.enableprotocolswitch=true",
- "s6": "-Dweblogic.net.ssl.trustStore=/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "s7": "-Djavax.net.ssl.trustStore=/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "s8": "-Dweblogic.webservice.client.ssl.trustedcertfile=/oracle/app/runtime/d1/certs/cacerts.pem",
- "s9": "-Dweblogic.security.audit.auditLogDir=/oracle/app/logs/obpodi/obpodi_domain",
- "s10": "-Dweblogic.ssl.SSLv2HelloEnabled=false",
- "Auto22": "-Dweblogic.MuxerClass=weblogic.socket.PosixSocketMuxer"
}
}
], - "environmentName": "d1",
- "mwTopologyList": [
- {
- "attributes": {
- "targetPlatform": "x86-64"
}
}
], - "topologyName": "obpodi",
- "hostInstallationList": [
- {
- "installationName": "odi",
- "hostIdentifierList": [
- "custwprd1odi01",
- "custwprd1odi02"
]
}
], - "transferList": [
- {
- "name": "d1_obpodi_keystores",
- "hostIdentifierList": [
- "custwprd1odi01"
], - "sourceFile": "/oracle/stage/customer/wp/csh/certs/d1/custwprd1odi.jks",
- "destinationFile": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "permissions": "600",
- "transferWhenList": [
- "pre-online"
], - "attributes": {
- "scaleout": "false"
}
}
], - "executeList": [
- {
- "name": "DeployHealthCheck",
- "hostIdentifierList": [
- "custwprd1odi01"
], - "sourceFile": "/oracle/app/binaries/obpodi/fmw/oracle_common/common/bin/wlst.sh /oracle/stage/customer/wp/csh/scripts/common/deployApplication.py weblogic {AES2}gJ/boWTt1SiokXU8r5kR/w=={/IV}THBDYBplASG16qRhzfue+o4yOtJPAu4RCzOKq4C7V5Os= t3://custwprd1odi-padm.limepoint.engineering:17001 HealthCheck /oracle/app/runtime/obpodi/domains/applications/obpodi_domain/HealthCheck.war obpodi_cluster nostage 650",
- "executeWhenList": [
- "pre-online"
], - "attributes": {
- "execute.weblogicAdminPassword": "{AES2}gJ/boWTt1SiokXU8r5kR/w=={/IV}THBDYBplASG16qRhzfue+o4yOtJPAu4RCzOKq4C7V5Os=",
- "scaleout": "false"
}
}
], - "domainList": [
- {
- "name": "obpodi_domain",
- "locationPath": "/oracle/app/runtime/obpodi/domains",
- "adminUser": "weblogic",
- "adminPassword": "{AES2}gJ/boWTt1SiokXU8r5kR/w=={/IV}THBDYBplASG16qRhzfue+o4yOtJPAu4RCzOKq4C7V5Os=",
- "adminServer": {
- "name": "AdminServer",
- "machineName": "custwprd1odi01-prv.limepoint.engineering",
- "listenAddress": "custwprd1odi-padm.limepoint.engineering",
- "listenAddressPort": "17001",
- "listenAddressPortSSL": "18001",
- "targetName": "odiAdminServer"
}, - "machineList": [
- {
- "name": "custwprd1odi01-prv.limepoint.engineering",
- "nodeManagerName": "nm-custwprd1odi01"
}, - {
- "name": "custwprd1odi02-prv.limepoint.engineering",
- "nodeManagerName": "nm-custwprd1odi02"
}
], - "clusterList": [
- {
- "name": "obpodi_cluster",
- "messageMode": "Unicast"
}
], - "managedServerList": [
- {
- "name": "ODI_server1",
- "machineName": "custwprd1odi01-prv.limepoint.engineering",
- "clusterName": "obpodi_cluster",
- "listenAddress": "custwprd1odi01-prv.limepoint.engineering",
- "listenAddressPort": "17002",
- "listenAddressPortSSL": "18002",
- "targetName": "ODI_server1",
- "attributes": {
- "nodeid": "1",
- "serverid": "1",
- "nodeonserver": "1"
}
}, - {
- "name": "ODI_server2",
- "machineName": "custwprd1odi02-prv.limepoint.engineering",
- "clusterName": "obpodi_cluster",
- "listenAddress": "custwprd1odi02-prv.limepoint.engineering",
- "listenAddressPort": "17003",
- "listenAddressPortSSL": "18003",
- "targetName": "ODI_server2",
- "attributes": {
- "nodeid": "2",
- "serverid": "2",
- "nodeonserver": "1"
}
}
], - "systemComponentList": [
- {
- "name": "OracleDISAgent1",
- "machineName": "custwprd1odi01-prv.limepoint.engineering",
- "componentType": "OracleDataIntegrator",
- "attributes": {
- "nodeid": "1",
- "serverid": "1",
- "nodeonserver": "1",
- "OracleDataIntegrator": {
- "SupervisorPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "AgentProtocol": "https",
- "AgentHostname": "custwprd1odi01-prv.limepoint.engineering",
- "AgentPort": "2091",
- "PrivateKeyAlias": "custwprd1odi01",
- "PrivateKeyPassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "IdentityKeyStore": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "IdentityKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "TrustKeyStore": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "TrustKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}, - {
- "name": "OracleDISAgent2",
- "machineName": "custwprd1odi02-prv.limepoint.engineering",
- "componentType": "OracleDataIntegrator",
- "attributes": {
- "nodeid": "2",
- "serverid": "2",
- "nodeonserver": "1",
- "OracleDataIntegrator": {
- "SupervisorPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "AgentProtocol": "https",
- "AgentHostname": "custwprd1odi02-prv.limepoint.engineering",
- "AgentPort": "2091",
- "PrivateKeyAlias": "custwprd1odi02",
- "PrivateKeyPassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "IdentityKeyStore": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "IdentityKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "TrustKeyStore": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "TrustKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}
], - "middlewareList": [
- {
- "installationName": "odi",
- "targetList": [
- {
- "type": "Cluster",
- "names": [
- "obpodi_cluster"
]
}
]
}
], - "configurationList": [
- {
- "resourceName": "AdminStartupParameter",
- "type": "StartupParameter",
- "targets": [
- {
- "type": "SERVER",
- "names": [
- "AdminServer"
]
}
]
}, - {
- "resourceName": "WeblogicUser_wlsmonitors",
- "type": "User",
- "attributes": {
- "authenticatorName": "DefaultAuthenticator"
}
}
], - "templateList": [
- {
- "name": "OracleDataIntegrator::CombinedTemplateSet",
- "attributes": {
- "OracleDataIntegrator::CombinedTemplateSet": {
- "SupervisorPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "WorkRepositoryName": "workrep1",
- "WorkRepositoryPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "WorkRepositoryType": "E",
- "AgentHostname": "custwpd1odi.limepoint.engineering",
- "AgentPort": "18002",
- "AgentProtocol": "https"
}
}
}
], - "repositoryList": [
- {
- "componentList": [
- "ODI"
], - "id": "rcu01",
- "dbName": "d1obpodidb",
- "prefix": "OBPODI",
- "dbUser": "SYS",
- "schemaPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "defaultRepository": "true"
}
], - "attributes": {
- "serverStartMode": "prod",
- "backupEnvironmentName": "d1",
- "environment.name": "d1",
- "tlogsLocationPath": "/oracle/app/runtime/obpodi/domains/obpodi_domain",
- "odlLogLocation": "/oracle/app/logs/obpodi/obpodi_domain",
- "defaultJMSLogLocation": "/oracle/app/logs/obpodi/obpodi_domain",
- "managedTopLocation": "/oracle/app/binaries/runtime/obpodi/domains",
- "nodeid": "1",
- "nodeonserver": "1",
- "serverid": "1",
- "wls": {
- "production.mode": "prod",
- "tlogs.location.path": "/oracle/app/runtime/obpodi/domains/obpodi_domain",
- "admin.listen.port.admin": "19001",
- "domain.managed.top": "/oracle/app/binaries/runtime/obpodi/domains",
- "odl": {
- "log": {
- "location": "/oracle/app/logs/obpodi/obpodi_domain",
- "retentionPeriod": "5d"
}
}
}, - "mintpress": {
- "startup.server_exclude": "OracleDISAgent*",
- "startup_parallel": "10"
}
}
}
], - "nodeManagerList": [
- {
- "name": "nm-custwprd1odi01",
- "listenAddress": "custwprd1odi01-prv.limepoint.engineering",
- "listenPort": "16001",
- "hostIdentifier": "custwprd1odi01",
- "attributes": {
- "wlInstallationName": "fmwinfra",
- "nodemanagerTop": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager",
- "type": "SSL",
- "wls": {
- "nodemanager": {
- "log.path": "/oracle/app/logs/obpodi/custwprd1odi01",
- "identityname": "custwprd1odi01",
- "identitystorefile": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "wildcardcertificate": "true",
- "domainbased": "true",
- "shared.domain.dir": "true",
- "top": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager"
}
}
}, - "targetAttributes": {
- "wls": {
- "nodemanager": {
- "secure.listener": "true",
- "setidentity": "true",
- "usejsse": "true",
- "crashrecovery": "false",
- "umask": "022",
- "truststorefile": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "identitystorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "truststorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "identitypassphrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}
}, - {
- "name": "nm-custwprd1odi02",
- "listenAddress": "custwprd1odi02-prv.limepoint.engineering",
- "listenPort": "16001",
- "hostIdentifier": "custwprd1odi02",
- "attributes": {
- "wlInstallationName": "fmwinfra",
- "nodemanagerTop": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager",
- "type": "SSL",
- "wls": {
- "nodemanager": {
- "log.path": "/oracle/app/logs/obpodi/custwprd1odi02",
- "identityname": "custwprd1odi02",
- "identitystorefile": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "wildcardcertificate": "true",
- "domainbased": "true",
- "shared.domain.dir": "true",
- "top": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager"
}
}
}, - "targetAttributes": {
- "wls": {
- "nodemanager": {
- "secure.listener": "true",
- "setidentity": "true",
- "usejsse": "true",
- "crashrecovery": "false",
- "umask": "022",
- "truststorefile": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "identitystorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "truststorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "identitypassphrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}
}
]
}
}, - "sha256": "901ad813694fa591bd0c6c9ec172f1d97e35daaa14c1c9010cbef45f44338483",
- "created_at": "2026-11-17T01:46:43.515Z",
- "updated_at": "2026-11-17T01:46:43.515Z",
- "render_logs": {
- "render_logs": [
- "Generated by deriving the difference between Mintmodel 01a1e72f-5d89-773e-81fd-8749a059ef76 and MintModel 01a1e72f-5d97-7cde-9cbd-52e2cf6d9d3a"
]
}, - "phase_output": { }
}, - "step_trees": [
- {
- "action": "mintmodel:binaries",
- "description": "bpm -- Binaries",
- "child_execution_strategy": "sequential",
- "children": [
- {
- "action": "mintmodel:install_software_binaries",
- "mintpress_ctl_cmdline": "run the mintpress command!",
- "step_name": "Install Software Binaries",
- "description": null,
- "full_path": "Binaries/Install Software Binaries"
}
], - "step_name": "Binaries",
- "full_path": "Binaries"
}
]
}, - "links": {
- "old_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/01a1e72f-5d89-773e-81fd-8749a059ef76",
- "new_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/01a1e72f-5d97-7cde-9cbd-52e2cf6d9d3a",
- "parent": "/projects/opc/assets/prj_soa"
}
}
}Shows an asset MintModel.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| mintmodel_id required | string Example: 01a1e72a-f4ec-7e39-90fa-4eb14b08fdab MintModel id |
{- "data": {
- "id": "01a1e72f-615b-7dca-b8b6-05f7e6ecc427",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-11-17T01:46:44.441512Z",
- "updated_at": "2026-11-17T01:46:44.441512Z",
- "render_logs": {
- "mintmodel_api": [
- "MintPress renderer output"
]
}, - "phase_output": { }
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "01a1e72f-648e-76a1-982a-17cebb218faa",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/01a1e72f-615b-7dca-b8b6-05f7e6ecc427",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
}Concretise the MintModel for this asset in the background, using the latest properties and template version.
Note: This enqueues a MintModel concretisation task and returns it immediately. Poll the returned task to track its progress; the concretised MintModel is assigned to the asset once the task completes successfully.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": {
- "id": "01a1e72f-69ef-7042-99ca-4d9d099d46de",
- "type": "node_background_task",
- "attributes": {
- "request_number": 2,
- "status_code": "initializing",
- "error_message": null,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "actions_count": 0,
- "task_type": "MintModelConcretiseTask",
- "created_at": "2026-11-17T01:46:46.637603Z",
- "updated_at": "2026-11-17T01:46:46.637603Z"
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "01a1e72f-699c-78ef-b3fd-47030f0ff08d",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "01a1e72f-6978-7214-b411-c22f1f16a944",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/01a1e72f-68ee-7286-9701-e5cbb7fe900a/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a1e72f-69ef-7042-99ca-4d9d099d46de",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1e72f-69ef-7042-99ca-4d9d099d46de"
}
}
}Lists all workflows for a project.
| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[name_cont]=deploy API filtering guide. Named filters: |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of workflows returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e736-74a1-7094-9a7e-3aeb104997d3",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "shanae_bayer-6068",
- "created_by_name": "shanae_bayer-6068",
- "created_at": "2026-11-17T01:54:28.128203Z",
- "updated_at": "2026-11-17T01:54:28.128203Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "latest_version": 2,
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-713f-7a0e-b401-87101909fe6d",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "01a1e736-74f6-7f59-a15c-ab0b965893e1",
- "type": "workflow_version"
}, - {
- "id": "01a1e736-74ea-7b7a-a20e-44e7e4d14c44",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}, - "partial_response": false
}
}Create a workflow
| project_code required | string Example: opc project code |
required | object |
object |
{- "data": {
- "attributes": {
- "code": "ypfez",
- "archived": false,
- "name": "ziihv8jvbk",
- "description": "You can't connect the matrix without quantifying the wireless SDD microchip!",
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/evhjr/environments/uxp8l/assets/98msb",
- "/projects/wgr31/environments/xg8i9/assets/n7za0"
], - "action": "generate",
- "template_versions": [
- "cr4k9",
- "57h94"
], - "run_as": "sequential",
- "name": "non"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/fup6j/workflows/koory",
- "version": 1,
- "name": "labore",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "run_as": "parallel",
- "name": "dolor",
- "children": [
- {
- "type": "change",
- "target": "/projects/znq7k/environments/ruggk/assets/uus46",
- "action": "input",
- "template_version": "k4201",
- "name": "beatae",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "type": "wait",
- "name": "quia"
}, - {
- "type": "workflow",
- "target": "/projects/pqxvm/workflows/rtabe",
- "version": null,
- "name": "ut",
- "start_time": null
}
]
}, - {
- "run_as": "sequential",
- "name": "autem",
- "children": [
- {
- "type": "change",
- "target": "/projects/rcidx/environments/sp0lv/assets/kmrey",
- "action": "synthesize",
- "template_version": "m9seu",
- "name": "molestias",
- "start_time": "2026-11-18T01:42:09Z"
}, - {
- "type": "wait",
- "name": "inventore"
}, - {
- "type": "workflow",
- "target": "/projects/brqio/workflows/zq2rm",
- "version": 1,
- "name": "dolorem",
- "start_time": "2026-11-18T01:42:10Z"
}
]
}
], - "draft": true
}
}
}{- "data": {
- "id": "01a1e736-79e6-7d0f-91b7-e07526797a4a",
- "type": "workflow",
- "attributes": {
- "code": "assets_new",
- "name": "assets workflow_new",
- "description": null,
- "draft": false,
- "archived": false,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:54:29.478005Z",
- "updated_at": "2026-11-17T01:54:29.478005Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": { },
- "latest_version": 1,
- "latest_published_version": 1
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-7729-7dad-b6ec-bd420569c799",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "01a1e736-7a0a-7644-9dc5-43f89bae368d",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets_new",
- "runs": "/api/projects/opc/workflows/assets_new/runs",
- "versions": "/api/projects/opc/workflows/assets_new/versions",
- "latest_version": "/api/projects/opc/workflows/assets_new/versions/1",
- "latest_published_version": "/api/projects/opc/workflows/assets_new/versions/1"
}
}
}Shows a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": {
- "id": "01a1e736-8885-7dda-b3b3-5215924e33c7",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "isa-6117",
- "created_by_name": "isa-6117",
- "created_at": "2026-11-17T01:54:33.221133Z",
- "updated_at": "2026-11-17T01:54:33.221133Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "latest_version": 2,
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-8733-7f70-b707-897bfc5a31bc",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "01a1e736-88a5-7802-8570-5f58d61c93ce",
- "type": "workflow_version"
}, - {
- "id": "01a1e736-889e-7103-a8bf-21bcc386b309",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
}Update a workflow.
Once the workflow has been run (or scheduled to run), its steps, source YAML and draft state can no longer be changed. A validation request that supplies custom sample properties (property_overrides with validate_flag set) is still permitted, so the stored steps can be validated against those properties.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
required | object |
object |
{- "data": {
- "attributes": {
- "archived": false,
- "name": "kqwskvaupr",
- "description": "Try to copy the GB alarm, maybe it will synthesize the neural port!",
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/evhjr/environments/uxp8l/assets/98msb",
- "/projects/wgr31/environments/xg8i9/assets/n7za0"
], - "action": "generate",
- "template_versions": [
- "cr4k9",
- "57h94"
], - "run_as": "sequential",
- "name": "non"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/fup6j/workflows/koory",
- "version": 1,
- "name": "labore",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "run_as": "parallel",
- "name": "dolor",
- "children": [
- {
- "type": "change",
- "target": "/projects/znq7k/environments/ruggk/assets/uus46",
- "action": "input",
- "template_version": "k4201",
- "name": "beatae",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "type": "wait",
- "name": "quia"
}, - {
- "type": "workflow",
- "target": "/projects/pqxvm/workflows/rtabe",
- "version": null,
- "name": "ut",
- "start_time": null
}
]
}, - {
- "run_as": "sequential",
- "name": "autem",
- "children": [
- {
- "type": "change",
- "target": "/projects/rcidx/environments/sp0lv/assets/kmrey",
- "action": "synthesize",
- "template_version": "m9seu",
- "name": "molestias",
- "start_time": "2026-11-18T01:42:09Z"
}, - {
- "type": "wait",
- "name": "inventore"
}, - {
- "type": "workflow",
- "target": "/projects/brqio/workflows/zq2rm",
- "version": 1,
- "name": "dolorem",
- "start_time": "2026-11-18T01:42:10Z"
}
]
}
], - "draft": true
}
}
}{- "data": {
- "id": "01a1e736-8d18-78fd-8db4-f4e7f869ed34",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "new workflow name",
- "description": "new description",
- "draft": false,
- "archived": false,
- "created_by": "sam-6135",
- "created_by_name": "sam-6135",
- "created_at": "2026-11-17T01:54:34.391379Z",
- "updated_at": "2026-11-17T01:54:34.504288Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa",
- "source": "steps/1",
- "change_parent": {
- "id": "01a1e736-8c9b-71ca-8c19-b65715b7dd0a",
- "path": "/projects/opc/assets/prj_soa",
- "parent_path": "/projects/opc",
- "project_id": "01a1e736-8be2-7981-ad86-5b3cdcae770f",
- "node_type": "asset",
- "parent_id": "01a1e736-8be2-7981-ad86-5b3cdcae770f",
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_at": "2026-11-17T01:54:34.266Z",
- "updated_at": "2026-11-17T01:54:34.266Z",
- "template_version_id": "01a1e736-8c54-7da9-8575-8477ce9d580b",
- "created_by_id": "01a1e736-8c81-7bd9-a254-350bfc1f69c5",
- "settings_generation": 1
}, - "action_template_version": {
- "id": "01a1e736-8c54-7da9-8575-8477ce9d580b",
- "commit_id": "01a1e736-8c43-71c0-ac2f-8252e9277dbd",
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "created_at": "2026-11-17T01:54:34.195Z",
- "updated_at": "2026-11-17T01:54:34.195Z",
- "state": "ready",
- "archived": false,
- "has_mintmodel": true,
- "template_id": "01a1e736-8c19-7a97-a178-a7082a5e736e",
- "locked": false,
- "pending_commit_id": null,
- "float_git_rev": false,
- "created_by_id": "01a1e736-8c47-736a-9a95-fcd660e6a5dc"
}
}
], - "sample_properties": {
- "sample": null
}, - "latest_version": 2,
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-8be2-7981-ad86-5b3cdcae770f",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "01a1e736-8d38-76ea-bbb8-41592a2a3574",
- "type": "workflow_version"
}, - {
- "id": "01a1e736-8d31-7bb8-8ec0-e64f5aebfa05",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
}Delete or archive a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the workflow",
- "detail": "Your authorisation rules let you view the workflow but not delete it."
}
]
}Lists all versions for a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": [
- {
- "id": "01a1e736-a3b9-7d07-803e-02705f410565",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "edyth-6215",
- "created_by_name": "edyth-6215",
- "created_at": "2026-11-17T01:54:40.184780Z",
- "updated_at": "2026-11-17T01:54:40.208721Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-a26f-7867-b282-73d87d48e921",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "01a1e736-a3b3-7374-b29a-6553520dd842",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "angelic-6216",
- "created_by_name": "angelic-6216",
- "created_at": "2026-11-17T01:54:40.131592Z",
- "updated_at": "2026-11-17T01:54:40.131613Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 1
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-a26f-7867-b282-73d87d48e921",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/1",
- "runs": "/api/projects/opc/workflows/assets/versions/1/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true,
- "execute": true
}
}
}Deletes all draft versions of a workflow.
Note: At least one version will remain. If all versions are drafts, the latest draft version will be kept.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": {
- "id": "01a1e736-aecc-74d4-9b8a-abc20eaff84a",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "eboni_zemlak-6242",
- "created_by_name": "eboni_zemlak-6242",
- "created_at": "2026-11-17T01:54:43.019486Z",
- "updated_at": "2026-11-17T01:54:43.019486Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "latest_version": 2,
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-acb0-7b08-8d7c-9e1111865778",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "01a1e736-af01-7361-ac22-51c19b7b9c1e",
- "type": "workflow_version"
}, - {
- "id": "01a1e736-aef5-7007-b1ee-0cdcf8c83d4d",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
}Shows a workflow version.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| version required | string Example: 2 version |
{- "data": {
- "id": "01a1e736-b95e-771a-a1ca-9312639c3e57",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "devorah_kuhn-6282",
- "created_by_name": "devorah_kuhn-6282",
- "created_at": "2026-11-17T01:54:45.725484Z",
- "updated_at": "2026-11-17T01:54:45.752572Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-b813-7fe3-85ff-a49f1bf6af87",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
}Update a workflow version.
Once the workflow version has been run (or scheduled to run), its steps, source YAML and draft state can no longer be changed. A validation request that supplies custom sample properties (property_overrides with validate_flag set) is still permitted, so the stored steps can be validated against those properties.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| version required | string Example: 2 version |
required | object |
object |
{- "data": {
- "attributes": {
- "code": "wdq9c",
- "node_id": "01a1e72b-44e9-755d-94fa-414cc56a51cc",
- "archived": false,
- "name": "gbaewzmwif",
- "description": "Connecting the microchip won't do anything, we need to bypass the wireless ai monitor!",
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/evhjr/environments/uxp8l/assets/98msb",
- "/projects/wgr31/environments/xg8i9/assets/n7za0"
], - "action": "generate",
- "template_versions": [
- "cr4k9",
- "57h94"
], - "run_as": "sequential",
- "name": "non"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/fup6j/workflows/koory",
- "version": 1,
- "name": "labore",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "run_as": "parallel",
- "name": "dolor",
- "children": [
- {
- "type": "change",
- "target": "/projects/znq7k/environments/ruggk/assets/uus46",
- "action": "input",
- "template_version": "k4201",
- "name": "beatae",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "type": "wait",
- "name": "quia"
}, - {
- "type": "workflow",
- "target": "/projects/pqxvm/workflows/rtabe",
- "version": null,
- "name": "ut",
- "start_time": null
}
]
}, - {
- "run_as": "sequential",
- "name": "autem",
- "children": [
- {
- "type": "change",
- "target": "/projects/rcidx/environments/sp0lv/assets/kmrey",
- "action": "synthesize",
- "template_version": "m9seu",
- "name": "molestias",
- "start_time": "2026-11-18T01:42:09Z"
}, - {
- "type": "wait",
- "name": "inventore"
}, - {
- "type": "workflow",
- "target": "/projects/brqio/workflows/zq2rm",
- "version": 1,
- "name": "dolorem",
- "start_time": "2026-11-18T01:42:10Z"
}
]
}
], - "draft": true
}
}
}{- "data": {
- "id": "01a1e736-c382-7baa-bba7-877f892ebe89",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "new workflow name",
- "description": "new description",
- "draft": true,
- "archived": false,
- "created_by": "ramiro_lueilwitz-6318",
- "created_by_name": "ramiro_lueilwitz-6318",
- "created_at": "2026-11-17T01:54:48.321690Z",
- "updated_at": "2026-11-17T01:54:48.389082Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/evhjr/environments/uxp8l/assets/98msb",
- "/projects/wgr31/environments/xg8i9/assets/n7za0"
], - "action": "generate",
- "template_versions": [
- "cr4k9",
- "57h94"
], - "run_as": "sequential",
- "name": "non"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/fup6j/workflows/koory",
- "version": 1,
- "name": "labore",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "run_as": "parallel",
- "name": "dolor",
- "children": [
- {
- "type": "change",
- "target": "/projects/znq7k/environments/ruggk/assets/uus46",
- "action": "input",
- "template_version": "k4201",
- "name": "beatae",
- "start_time": "2026-11-18T01:42:08Z"
}, - {
- "type": "wait",
- "name": "quia"
}, - {
- "type": "workflow",
- "target": "/projects/pqxvm/workflows/rtabe",
- "version": null,
- "name": "ut",
- "start_time": null
}
]
}, - {
- "run_as": "sequential",
- "name": "autem",
- "children": [
- {
- "type": "change",
- "target": "/projects/rcidx/environments/sp0lv/assets/kmrey",
- "action": "synthesize",
- "template_version": "m9seu",
- "name": "molestias",
- "start_time": "2026-11-18T01:42:09Z"
}, - {
- "type": "wait",
- "name": "inventore"
}, - {
- "type": "workflow",
- "target": "/projects/brqio/workflows/zq2rm",
- "version": 1,
- "name": "dolorem",
- "start_time": "2026-11-18T01:42:10Z"
}
]
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e736-c217-7ca6-99ec-51125789081f",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
}Delete or archive a workflow version.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| version required | string Example: 2 version |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the workflow version",
- "detail": "Your authorisation rules let you view the workflow version but not delete it."
}
]
}Clones an environment's properties, settings and assets, or a single asset's properties and settings, into a new or existing node of the same type in the same project. Assets may be cloned between the project and its environments. Nothing is removed from the target, and nothing is written if any node fails validation.
Secrets in the cloned documents are cloned as they are, and listed by key path in warnings.
Set dry_run to see the report without writing anything. Actions for created assets are generated in the
background after the clone returns.
required | object |
{- "data": {
- "attributes": {
- "source_path": "/projects/opc/environments/dev",
- "target_path": "/projects/opc/environments/uat",
- "target": {
- "name": "string",
- "description": "string"
}, - "properties": "skip",
- "settings": "skip",
- "assets": {
- "codes": [
- "string"
], - "existing": "skip",
- "properties": "skip",
- "settings": "skip"
}, - "dry_run": false
}
}
}{- "data": {
- "id": "/projects/opc/environments/dev:/projects/opc/environments/uat",
- "type": "node_clone",
- "attributes": {
- "source_path": "/projects/opc/environments/dev",
- "target_path": "/projects/opc/environments/uat",
- "dry_run": true,
- "summary": {
- "created": 2,
- "updated": 0,
- "skipped": 0
}, - "nodes": [
- {
- "path": "/projects/opc/environments/uat",
- "source_path": "/projects/opc/environments/dev",
- "node_type": "environment",
- "code": "uat",
- "name": "UAT",
- "result": "created",
- "documents": [
- "properties",
- "settings"
], - "reason": null,
- "message": null
}, - {
- "path": "/projects/opc/environments/uat/assets/env_soa",
- "source_path": "/projects/opc/environments/dev/assets/env_soa",
- "node_type": "asset",
- "code": "env_soa",
- "name": "Environment asset",
- "result": "created",
- "documents": [
- "properties",
- "settings"
], - "reason": null,
- "message": null
}
], - "warnings": [ ]
}
}
}Endpoints to interact with properties.
Shows the current properties JSON and its version.
| properties_id required | string Example: 01a1e72a-f052-70c4-8e7b-0be691c20308 properties id |
{- "data": {
- "id": "01a1e730-9d6b-7e9d-9057-f81787b1184a",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:48:05.354482Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/01a1e730-9d6b-7e9d-9057-f81787b1184a",
- "current_version": "/api/properties/01a1e730-9d6b-7e9d-9057-f81787b1184a/versions/1",
- "versions": "/api/properties/01a1e730-9d6b-7e9d-9057-f81787b1184a/versions"
}
}
}Updates a properties JSON if the included version matches the current properties version.
| id_to_update required | string Example: 01a1e72a-f052-70c4-8e7b-0be691c20308 properties id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1
}
}
}{- "data": {
- "id": "01a1e730-a1de-7662-936e-9b47b2891a3a",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 2,
- "created_at": "2026-11-17T01:48:06.492650Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/01a1e730-a1de-7662-936e-9b47b2891a3a",
- "current_version": "/api/properties/01a1e730-a1de-7662-936e-9b47b2891a3a/versions/2",
- "versions": "/api/properties/01a1e730-a1de-7662-936e-9b47b2891a3a/versions"
}
}
}Updates a properties JSON, without any version checking (always updates).
| id_to_set required | string Example: 01a1e72a-f052-70c4-8e7b-0be691c20308 properties id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}
}
}{- "data": {
- "id": "01a1e730-a821-7ecb-9856-49ac1a00e8f1",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 2,
- "created_at": "2026-11-17T01:48:08.096874Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/01a1e730-a821-7ecb-9856-49ac1a00e8f1",
- "current_version": "/api/properties/01a1e730-a821-7ecb-9856-49ac1a00e8f1/versions/2",
- "versions": "/api/properties/01a1e730-a821-7ecb-9856-49ac1a00e8f1/versions"
}
}
}Create or update a file property in the properties.
Notes:
meta.secret_vault_credential_required lists the vault a credential is needed for.| properties_id required | string Example: 01a1e72a-f052-70c4-8e7b-0be691c20308 properties id |
| file_path | string (Path to write the file within /opt/opschain) |
| mode | string (Linux octal file mode) |
| format | string (How the file content is serialised (default: 'raw')) Enum: "base64" "json" "raw" |
| replace_file | string (Replace the file property if it exists (default: false)) |
| secret_path | string (Path to write the secret key into) |
| secret_key | string |
| replace_secret | string (Replace the secret vault value if it exists (default: false)) |
| file | string <binary> File to use. The filename is ignored. |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="mode" 0600 ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file_path" /opt/opschain/sample.txt ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="format" raw ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="replace_file" true ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="sample.txt" content-type: text/plain content-length: 21 Sample file property ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "01a1e730-b023-7ebb-9633-980f9c148118",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "opschain": {
- "files": {
- "/opt/opschain/sample.txt": {
- "mode": "0600",
- "format": "raw",
- "content": "Sample file property\n"
}
}
}
}, - "version": 2,
- "created_at": "2026-11-17T01:48:10.117553Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/01a1e730-b023-7ebb-9633-980f9c148118",
- "current_version": "/api/properties/01a1e730-b023-7ebb-9633-980f9c148118/versions/2",
- "versions": "/api/properties/01a1e730-b023-7ebb-9633-980f9c148118/versions"
}
}
}Endpoints to interact with the version history for properties.
Lists all versions of an OpsChain properties.
| properties_id required | string Example: 01a1e72a-f052-70c4-8e7b-0be691c20308 properties id |
| limit | integer [ 1 .. 10000 ] Default: 1000 Example: limit=50 Limit the number of properties versions returned. When more records match than the limit a 206 response is returned and |
| exclude_data | boolean Default: false Example: exclude_data=true Exclude the |
{- "data": [
- {
- "id": "01a1e730-b539-76e5-adaf-059ab4f51d51",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:48:11.448576Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-b532-779b-9783-706720bceb76",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-b532-779b-9783-706720bceb76"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e730-b532-779b-9783-706720bceb76/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e730-b532-779b-9783-706720bceb76/versions/1"
}, - "meta": { }
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows the properties JSON for this properties version.
| properties_id required | string Example: 01a1e72a-f052-70c4-8e7b-0be691c20308 properties id |
| version_number required | integer Example: 1 version number |
{- "data": {
- "id": "01a1e730-b6de-732b-b847-792bc209e6ad",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:48:11.869247Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e730-b6d6-7c43-aef8-148b12e94509",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e730-b6d6-7c43-aef8-148b12e94509"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e730-b6d6-7c43-aef8-148b12e94509/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e730-b6d6-7c43-aef8-148b12e94509/versions/1"
}, - "meta": { }
}
}Lists all activities (changes and workflow runs) accessible to the user.
| limit | integer [ 1 .. 1000 ] Default: 100 Example: limit=100 The maximum number of activities to return. When more records match than the limit a 206 response is returned and |
| exact_count | boolean Example: exact_count=true By default |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[created_by_cont]=opschain API filtering guide. Named filters: |
| download | string Example: download=activities.csv Download activities in CSV format with the specified file name. The activities will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order or limit requested. |
{- "data": [
- {
- "id": "01a1e72b-6046-7370-8c33-ef43c065ced5",
- "type": "workflow_run",
- "attributes": {
- "scheduled": false,
- "created_by": "yuki_effertz-333",
- "created_by_name": "yuki_effertz-333",
- "id": "01a1e72b-6046-7370-8c33-ef43c065ced5",
- "project_name": "doloremque116",
- "scheduled_activity_id": null,
- "paused": false,
- "pause_state": "none",
- "created_at": "2026-11-17T01:42:22.020858Z",
- "updated_at": "2026-11-17T01:42:22.039068Z",
- "started_at": "2026-11-17T01:34:29.055054Z",
- "finished_at": "2026-11-17T01:37:24.254976Z",
- "paused_at": null,
- "status_code": "success",
- "cancel_requested": false,
- "arms_taken": [ ],
- "metadata": {
- "Otcom": "3.92",
- "Bamity": "1.2.3",
- "Y-find": "0.52",
- "Bitwolf": "1.9.3",
- "Flexidy": "5.9.6",
- "Pannier": "1.24",
- "Sonsing": "0.3.9",
- "Alphazap": "3.03",
- "Wrapsafe": "0.5.5"
}, - "paused_by": [ ],
- "parents": [
- {
- "id": "01a1e72b-5fad-75d0-a891-a4ef5ed0bfe1",
- "code": "e5veb",
- "name": "doloremque116",
- "type": "project",
- "links": {
- "self": "/projects/e5veb"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}
], - "workflow_version": {
- "version": 1,
- "links": {
- "self": "/projects/e5veb/workflows/child/versions/1"
}
}, - "workflow": {
- "code": "child",
- "name": "child workflow"
}
}, - "links": {
- "self": "/api/projects/e5veb/workflows/child/runs/01a1e72b-6046-7370-8c33-ef43c065ced5",
- "parent": "/api/projects/e5veb",
- "workflow_version": "/api/projects/e5veb/workflows/child/versions/1"
}, - "meta": {
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}, - {
- "id": "01a1e72b-5f31-784c-968e-dc4e46e45d51",
- "type": "change",
- "attributes": {
- "scheduled": false,
- "created_by": "gregg-329",
- "created_by_name": "gregg-329",
- "id": "01a1e72b-5f31-784c-968e-dc4e46e45d51",
- "project_name": "consequatur114",
- "scheduled_activity_id": null,
- "paused": false,
- "pause_state": "none",
- "created_at": "2026-11-17T01:42:21.743843Z",
- "updated_at": "2026-11-17T01:42:21.755766Z",
- "started_at": "2026-11-17T01:35:50.471323Z",
- "finished_at": "2026-11-17T01:37:38.731257Z",
- "paused_at": null,
- "status_code": "success",
- "cancel_requested": false,
- "arms_taken": [ ],
- "metadata": {
- "capacitor": "parsing"
}, - "paused_by": [ ],
- "parents": [
- {
- "id": "01a1e72b-5cec-73c8-bb17-40906ba0bd34",
- "code": "ocush",
- "name": "consequatur114",
- "type": "project",
- "links": {
- "self": "/projects/ocush"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}, - {
- "id": "01a1e72b-5d82-79c7-a1a0-5d299c1edbb8",
- "code": "hcgil",
- "name": "voluptas115",
- "type": "environment",
- "links": {
- "self": "/projects/ocush/environments/hcgil"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}, - {
- "id": "01a1e72b-5ecb-7c51-9d64-8e81b456764c",
- "code": "kyepn",
- "name": "ullam113",
- "type": "asset",
- "links": {
- "self": "/projects/ocush/environments/hcgil/assets/kyepn"
}, - "template": {
- "code": "kqcy2",
- "name": "lennie_kohler"
}, - "template_version": {
- "version": "claeg"
}
}
], - "action": "quantify",
- "commit_sha": "7ab224f383ac660af71784483984d932852e71c7",
- "git_remote_name": "homer_russel",
- "git_rev": "optical"
}, - "links": {
- "self": "/api/projects/ocush/environments/hcgil/assets/kyepn/changes/01a1e72b-5f31-784c-968e-dc4e46e45d51",
- "parent": "/api/projects/ocush/environments/hcgil/assets/kyepn"
}, - "meta": {
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}, - {
- "id": "01a1e72b-5bb1-75a6-a03f-c3502d5ca137",
- "type": "change",
- "attributes": {
- "scheduled": false,
- "created_by": "vern_rau-323",
- "created_by_name": "vern_rau-323",
- "id": "01a1e72b-5bb1-75a6-a03f-c3502d5ca137",
- "project_name": "similique111",
- "scheduled_activity_id": null,
- "paused": false,
- "pause_state": "none",
- "created_at": "2026-11-17T01:42:20.846238Z",
- "updated_at": "2026-11-17T01:42:20.871895Z",
- "started_at": "2026-11-17T01:34:36.048232Z",
- "finished_at": "2026-11-17T01:38:24.035874Z",
- "paused_at": null,
- "status_code": "success",
- "cancel_requested": false,
- "arms_taken": [ ],
- "metadata": {
- "driver": "copying"
}, - "paused_by": [ ],
- "parents": [
- {
- "id": "01a1e72b-59f6-7618-a12a-a6466a8ae5ad",
- "code": "btbvo",
- "name": "similique111",
- "type": "project",
- "links": {
- "self": "/projects/btbvo"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}, - {
- "id": "01a1e72b-5a31-7d26-9b98-64425ce63b58",
- "code": "1snyj",
- "name": "eum112",
- "type": "environment",
- "links": {
- "self": "/projects/btbvo/environments/1snyj"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}, - {
- "id": "01a1e72b-5b2c-7bce-a5c1-a9371fed6c2c",
- "code": "y2b5s",
- "name": "nulla110",
- "type": "asset",
- "links": {
- "self": "/projects/btbvo/environments/1snyj/assets/y2b5s"
}, - "template": {
- "code": "shxkl",
- "name": "matilda"
}, - "template_version": {
- "version": "y2ikp"
}
}
], - "action": "connect",
- "commit_sha": "2138cfe57af6072ec140bd0d7548c94602a18c25",
- "git_remote_name": "jonah",
- "git_rev": "mobile"
}, - "links": {
- "self": "/api/projects/btbvo/environments/1snyj/assets/y2b5s/changes/01a1e72b-5bb1-75a6-a03f-c3502d5ca137",
- "parent": "/api/projects/btbvo/environments/1snyj/assets/y2b5s"
}, - "meta": {
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}, - {
- "id": "01a1e72b-59a8-7d4c-8015-931109604214",
- "type": "workflow_run",
- "attributes": {
- "scheduled": false,
- "created_by": "cordia-316",
- "created_by_name": "cordia-316",
- "id": "01a1e72b-59a8-7d4c-8015-931109604214",
- "project_name": "OpsChain",
- "scheduled_activity_id": null,
- "paused": false,
- "pause_state": "none",
- "created_at": "2026-11-17T01:42:20.327444Z",
- "updated_at": "2026-11-17T01:42:20.347417Z",
- "started_at": "2026-11-17T01:32:41.811872Z",
- "finished_at": "2026-11-17T01:40:18.098486Z",
- "paused_at": null,
- "status_code": "success",
- "cancel_requested": false,
- "arms_taken": [ ],
- "metadata": {
- "Viva": "0.83",
- "Alpha": "5.7",
- "Asoka": "3.69",
- "Opela": "6.4",
- "Otcom": "7.2.3",
- "Hatity": "0.12",
- "Fixflex": "0.8.5",
- "Konklab": "9.1.6",
- "Holdlamis": "2.98",
- "Ventosanzap": "0.4.2"
}, - "paused_by": [ ],
- "parents": [
- {
- "id": "01a1e72b-5651-73af-ac11-ba190c3fdb35",
- "code": "opc",
- "name": "OpsChain",
- "type": "project",
- "links": {
- "self": "/projects/opc"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}
], - "workflow_version": {
- "version": 2,
- "links": {
- "self": "/projects/opc/workflows/assets/versions/2"
}
}, - "workflow": {
- "code": "assets",
- "name": "assets workflow"
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e72b-59a8-7d4c-8015-931109604214",
- "parent": "/api/projects/opc",
- "workflow_version": "/api/projects/opc/workflows/assets/versions/2"
}, - "meta": {
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}, - {
- "id": "01a1e72b-5719-7b82-b8c1-e10df874d5b0",
- "type": "change",
- "attributes": {
- "scheduled": false,
- "created_by": "erasmo-309",
- "created_by_name": "erasmo-309",
- "id": "01a1e72b-5719-7b82-b8c1-e10df874d5b0",
- "project_name": "OpsChain",
- "scheduled_activity_id": null,
- "paused": false,
- "pause_state": "none",
- "created_at": "2026-11-17T01:42:19.671946Z",
- "updated_at": "2026-11-17T01:42:19.692258Z",
- "started_at": "2026-11-17T01:34:38.512385Z",
- "finished_at": "2026-11-17T01:35:41.257454Z",
- "paused_at": null,
- "status_code": "success",
- "cancel_requested": false,
- "arms_taken": [ ],
- "metadata": {
- "pixel": "compressing"
}, - "paused_by": [ ],
- "parents": [
- {
- "id": "01a1e72b-5651-73af-ac11-ba190c3fdb35",
- "code": "opc",
- "name": "OpsChain",
- "type": "project",
- "links": {
- "self": "/projects/opc"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}, - {
- "id": "01a1e72b-569c-7776-b3f2-bf10e4910ef7",
- "code": "dev",
- "name": "Development",
- "type": "environment",
- "links": {
- "self": "/projects/opc/environments/dev"
}, - "template": {
- "code": null,
- "name": null
}, - "template_version": {
- "version": null
}
}
], - "action": "hack",
- "commit_sha": "22f4be6ed371a220231e9e6dbf8f2b6a6335ff61",
- "git_remote_name": "github",
- "git_rev": "main"
}, - "links": {
- "self": "/api/projects/opc/environments/dev/changes/01a1e72b-5719-7b82-b8c1-e10df874d5b0",
- "parent": "/api/projects/opc/environments/dev"
}, - "meta": {
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "has_any": true,
- "total_matching_filter": 5,
- "total_matching_filter_exact": true
}
}Endpoints to interact with changes.
The pod's memory in use and limit, and the memory held by each of the change's processes, as the executor last sampled them. The executor refreshes the snapshot every few seconds while the change runs. data is null before its first sample and once the change has finished.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
{- "data": {
- "id": "01a1e72d-4aff-7f01-916a-087dfb0ac738",
- "type": "change_memory_snapshot",
- "attributes": {
- "sampled_at": "2025-11-13T02:13:20Z",
- "used_bytes": 3221225472,
- "limit_bytes": 4294967296,
- "processes": [
- {
- "name": "step-2e3f4a5b",
- "title": "OpsChain action server - deploy",
- "private_bytes": 2147483648
}, - {
- "name": "ruby",
- "title": "OpsChain runner",
- "private_bytes": 52428800
}
]
}
}
}Lists all changes.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[environment_code_eq]=dev API filtering guide. Named filters: |
| download | string Example: download=changes.csv Download changes in CSV format with the specified file name. The changes will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
| include | string Example: include=steps,parents Include the change steps and parents in the response |
| fields[<resource_type>] | |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of changes returned. When more records match than the limit a 206 response is returned and |
| include_children | boolean Example: include_children=true Only applies when the changes are being listed for a node - via a node path or |
| total_count | boolean Example: total_count=true Report the number of changes matching the filter in |
| exact_count | boolean Example: exact_count=true Report |
{- "data": [
- {
- "id": "01a1e72d-5124-7b62-a959-46af18af4106",
- "type": "change",
- "attributes": {
- "created_by": "eloisa.emard-1465",
- "created_by_name": "eloisa.emard-1465",
- "step_name": "connect",
- "action": "connect",
- "build_without_cache": false,
- "auto_continue_wait_steps": false,
- "initial_step_tree": { },
- "metadata": {
- "interface": "overriding"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:44:29.225395Z",
- "started_at": "2026-11-17T01:44:29.225395Z"
}
}, - "state_timing_summary": { },
- "notify": { },
- "skip_steps": [ ],
- "starting_step": null,
- "cluster_name": null,
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:44:29.215456Z",
- "started_at": "2026-11-17T01:35:57.884505Z",
- "finished_at": "2026-11-17T01:38:21.463705Z",
- "updated_at": "2026-11-17T01:44:29.238015Z",
- "paused_at": null,
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": "b32d338114d1ed4b3a2a614fffdee1c082d3d2c7",
- "requires_approval_from": null
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-525d-7635-aa45-a716a09a392c",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-525d-7635-aa45-a716a09a392c"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72d-4fe1-71f7-ba5d-f31312317cb6",
- "type": "project"
}, - {
- "id": "01a1e72d-5092-7324-9aad-ef3843a438f8",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "01a1e72d-512b-7518-a02c-f83808ff8644",
- "type": "step"
}, - "links": {
- "related": "/api/steps/01a1e72d-512b-7518-a02c-f83808ff8644"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e72d-512b-7518-a02c-f83808ff8644",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "01a1e72d-5144-79fc-99c1-86f755663eb3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-5144-79fc-99c1-86f755663eb3"
}
}, - "override_settings": {
- "data": {
- "id": "01a1e72d-5154-7a04-8724-8836ad6f4616",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-5154-7a04-8724-8836ad6f4616"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72d-50c4-7135-8755-4f1a6bedd81d",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/01a1e72d-5124-7b62-a959-46af18af4106",
- "log_lines": "/api/changes/01a1e72d-5124-7b62-a959-46af18af4106/log_lines"
}, - "meta": { }
}
], - "included": [
- {
- "id": "01a1e72d-512b-7518-a02c-f83808ff8644",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "connect",
- "change_id": "01a1e72d-5124-7b62-a959-46af18af4106",
- "child_execution_strategy": "sequential",
- "full_path": "connect",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:44:29.225395Z",
- "started_at": "2026-11-17T01:44:29.225395Z"
}
}, - "step_sequence": 1,
- "step_type": "standard",
- "description": null,
- "timeout": null,
- "step_name": "connect",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:34:57.884505Z",
- "started_at": "2026-11-17T01:35:57.884505Z",
- "finished_at": "2026-11-17T01:38:21.463705Z",
- "updated_at": "2026-11-17T01:44:29.238015Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-525d-7635-aa45-a716a09a392c",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-525d-7635-aa45-a716a09a392c"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e72d-4fee-70e3-b7ed-0ae502e145c0",
- "type": "properties_version"
}, - {
- "id": "01a1e72d-50a9-73bc-9ad4-d12f2dc3a1ca",
- "type": "properties_version"
}, - {
- "id": "01a1e72d-514e-715c-b294-ec253c0dba7c",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e72d-5124-7b62-a959-46af18af4106",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e72d-5124-7b62-a959-46af18af4106",
- "change": "/api/projects/opc/environments/dev/changes/01a1e72d-5124-7b62-a959-46af18af4106",
- "log_lines": "/api/steps/01a1e72d-512b-7518-a02c-f83808ff8644/log_lines",
- "self": "/api/steps/01a1e72d-512b-7518-a02c-f83808ff8644"
}, - "meta": { }
}, - {
- "id": "01a1e72d-4fe1-71f7-ba5d-f31312317cb6",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "estefana-1462",
- "created_by_name": "estefana-1462"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-4fe5-77e2-83ed-17730bb07273",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-4fe5-77e2-83ed-17730bb07273"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e72d-4ff6-7058-883f-c9a98e8b5acf",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-4ff6-7058-883f-c9a98e8b5acf"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}, - {
- "id": "01a1e72d-5092-7324-9aad-ef3843a438f8",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "abram.fritsch-1463",
- "created_by_name": "abram.fritsch-1463"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-509e-714b-8c03-0019465190db",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-509e-714b-8c03-0019465190db"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72d-4fe1-71f7-ba5d-f31312317cb6",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72d-50b4-71e2-9699-84c894856848",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-50b4-71e2-9699-84c894856848"
}
}, - "parent": {
- "data": {
- "id": "01a1e72d-4fe1-71f7-ba5d-f31312317cb6",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72d-4fe1-71f7-ba5d-f31312317cb6",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "artifacts": "/api/projects/opc/environments/dev/artifacts",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true,
- "execute": true
}, - "partial_response": false,
- "has_any": true
}
}Creates a change in a specific project, environment or asset.
Notes:
changes path
(e.g. POST to /api/projects/{project_code}/changes) the parent_path request attributes must not be supplied
as the parent will be derived from the path./api/projects/{project_code}/assets/{asset_code}/changes)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.retry attribute (together with a change relationship) retries an existing change that finished in an
error, cancelled or aborted state instead of creating a change from scratch. The retry creates a new change that
reuses the original change's action, commit, properties and step tree; steps that already succeeded are preserved
and are not run again. The original change is left untouched.required | object |
{- "data": {
- "attributes": {
- "metadata": {
- "program": "transmitting"
}, - "scheduled_activity_id": null,
- "build_without_cache": false,
- "pod_per_step": true,
- "action_path": null,
- "static_settings": { },
- "state_timing_summary": { },
- "notify": { },
- "api_key_id": null,
- "skip_steps": [ ],
- "auto_continue_wait_steps": false,
- "starting_step": null,
- "generate_actions_request_id": null,
- "paused_at": null,
- "executor_queue_name": null,
- "action": "calculate",
- "parent_path": "/projects/opc/environments/dev/assets/env_soa",
- "template_version": "2023_Q4_2"
}
}
}{- "data": {
- "id": "01a1e72d-5dba-7084-a69b-635f74b0f457",
- "type": "change",
- "attributes": {
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "step_name": "reboot",
- "action": "reboot",
- "build_without_cache": false,
- "auto_continue_wait_steps": false,
- "initial_step_tree": { },
- "metadata": {
- "feed": "overriding"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "state_timing": {
- "initializing": {
- "ended_at": null,
- "started_at": "2026-11-17T01:44:32.445086Z"
}
}, - "state_timing_summary": { },
- "notify": { },
- "skip_steps": [ ],
- "starting_step": null,
- "cluster_name": null,
- "pause_state": "none",
- "status_code": "initializing",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:44:32.440749Z",
- "started_at": "2026-11-17T01:44:32.378695Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:44:32.453312Z",
- "paused_at": null,
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": null,
- "requires_approval_from": null
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72d-577a-78e0-9e3a-fe881918f2ca",
- "type": "project"
}, - {
- "id": "01a1e72d-58ba-7769-98e0-8484bfedc633",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "01a1e72d-5dbf-7b87-b39a-9898fde68b23",
- "type": "step"
}, - "links": {
- "related": "/api/steps/01a1e72d-5dbf-7b87-b39a-9898fde68b23"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e72d-5dbf-7b87-b39a-9898fde68b23",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "01a1e72d-5dcd-7e61-b0f6-0d581607a2f5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-5dcd-7e61-b0f6-0d581607a2f5"
}
}, - "override_settings": {
- "data": {
- "id": "01a1e72d-5dda-7e59-a06f-fbe8fe7df627",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-5dda-7e59-a06f-fbe8fe7df627"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72d-597d-797e-b183-ff62b36fd045",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/01a1e72d-5dba-7084-a69b-635f74b0f457",
- "log_lines": "/api/changes/01a1e72d-5dba-7084-a69b-635f74b0f457/log_lines",
- "pause": "/api/changes/01a1e72d-5dba-7084-a69b-635f74b0f457/pause"
}, - "meta": { }
}, - "included": [
- {
- "id": "01a1e72d-5dbf-7b87-b39a-9898fde68b23",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "reboot",
- "change_id": "01a1e72d-5dba-7084-a69b-635f74b0f457",
- "child_execution_strategy": "sequential",
- "full_path": "reboot",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "initializing": {
- "ended_at": null,
- "started_at": "2026-11-17T01:44:32.445086Z"
}
}, - "step_sequence": 1,
- "step_type": "standard",
- "description": null,
- "timeout": null,
- "step_name": "reboot",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:44:32.445086Z",
- "started_at": "2026-11-17T01:44:32.378695Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:44:32.453312Z",
- "status_code": "initializing"
}, - "relationships": {
- "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [ ]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e72d-5dba-7084-a69b-635f74b0f457",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e72d-5dba-7084-a69b-635f74b0f457",
- "change": "/api/projects/opc/environments/dev/changes/01a1e72d-5dba-7084-a69b-635f74b0f457",
- "log_lines": "/api/steps/01a1e72d-5dbf-7b87-b39a-9898fde68b23/log_lines",
- "self": "/api/steps/01a1e72d-5dbf-7b87-b39a-9898fde68b23"
}, - "meta": { }
}
]
}Shows a change, including it's parent nodes.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
| include | string Example: include=steps,parents Include the change steps and parents in the response |
| fields[<resource_type>] |
{- "data": {
- "id": "01a1e72d-728a-7c4a-b533-67870026d5f9",
- "type": "change",
- "attributes": {
- "created_by": "wilbur_schiller-1501",
- "created_by_name": "wilbur_schiller-1501",
- "step_name": "override",
- "action": "override",
- "build_without_cache": false,
- "auto_continue_wait_steps": false,
- "initial_step_tree": { },
- "metadata": {
- "matrix": "parsing"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:44:37.780515Z",
- "started_at": "2026-11-17T01:44:37.780515Z"
}
}, - "state_timing_summary": { },
- "notify": { },
- "skip_steps": [ ],
- "starting_step": null,
- "cluster_name": null,
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:44:37.768748Z",
- "started_at": "2026-11-17T01:39:11.212718Z",
- "finished_at": "2026-11-17T01:39:25.791202Z",
- "updated_at": "2026-11-17T01:44:37.792443Z",
- "paused_at": null,
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": "b73d05779fbc5e604ac637e1580274498cca4b7a",
- "requires_approval_from": null
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-7358-73e3-b6d3-5224954b28e4",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-7358-73e3-b6d3-5224954b28e4"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72d-6fd0-7dfc-972f-c5552d8b44ae",
- "type": "project"
}, - {
- "id": "01a1e72d-70ec-7fd5-8738-dff220f48615",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "01a1e72d-7296-706b-a029-0b37999c80d7",
- "type": "step"
}, - "links": {
- "related": "/api/steps/01a1e72d-7296-706b-a029-0b37999c80d7"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e72d-7296-706b-a029-0b37999c80d7",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "01a1e72d-72ca-74a7-94db-f6806cd48af5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-72ca-74a7-94db-f6806cd48af5"
}
}, - "override_settings": {
- "data": {
- "id": "01a1e72d-72d3-7377-bd0d-6d53351c0991",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-72d3-7377-bd0d-6d53351c0991"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72d-71a5-7f83-9466-118a34238e83",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/01a1e72d-728a-7c4a-b533-67870026d5f9",
- "log_lines": "/api/changes/01a1e72d-728a-7c4a-b533-67870026d5f9/log_lines"
}, - "meta": {
- "wait_queue": [ ],
- "blocking_queue": [ ],
- "authorisations": {
- "execute": true,
- "delete": true
}, - "comparable": true
}
}, - "included": [
- {
- "id": "01a1e72d-7296-706b-a029-0b37999c80d7",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "override",
- "change_id": "01a1e72d-728a-7c4a-b533-67870026d5f9",
- "child_execution_strategy": "sequential",
- "full_path": "override",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:44:37.780515Z",
- "started_at": "2026-11-17T01:44:37.780515Z"
}
}, - "step_sequence": 1,
- "step_type": "standard",
- "description": null,
- "timeout": null,
- "step_name": "override",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:38:11.212718Z",
- "started_at": "2026-11-17T01:39:11.212718Z",
- "finished_at": "2026-11-17T01:39:25.791202Z",
- "updated_at": "2026-11-17T01:44:37.792443Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-7358-73e3-b6d3-5224954b28e4",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-7358-73e3-b6d3-5224954b28e4"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e72d-7023-7f1d-974f-f760269a5943",
- "type": "properties_version"
}, - {
- "id": "01a1e72d-7144-7488-aefc-cdc199331088",
- "type": "properties_version"
}, - {
- "id": "01a1e72d-72ce-761f-99e2-a7db3957a560",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e72d-728a-7c4a-b533-67870026d5f9",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e72d-728a-7c4a-b533-67870026d5f9",
- "change": "/api/projects/opc/environments/dev/changes/01a1e72d-728a-7c4a-b533-67870026d5f9",
- "log_lines": "/api/steps/01a1e72d-7296-706b-a029-0b37999c80d7/log_lines",
- "self": "/api/steps/01a1e72d-7296-706b-a029-0b37999c80d7"
}, - "meta": { }
}, - {
- "id": "01a1e72d-6fd0-7dfc-972f-c5552d8b44ae",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "filomena.toy-1498",
- "created_by_name": "filomena.toy-1498"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-6fda-7e2c-9c78-27f750de1cc7",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-6fda-7e2c-9c78-27f750de1cc7"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e72d-7036-7e33-99ea-c2567a74dd37",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-7036-7e33-99ea-c2567a74dd37"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}, - {
- "id": "01a1e72d-70ec-7fd5-8738-dff220f48615",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "reinaldo-1499",
- "created_by_name": "reinaldo-1499"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-7102-7467-a86e-7930b52de645",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-7102-7467-a86e-7930b52de645"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72d-6fd0-7dfc-972f-c5552d8b44ae",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72d-714a-7f10-8abd-788b50bfc6b0",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-714a-7f10-8abd-788b50bfc6b0"
}
}, - "parent": {
- "data": {
- "id": "01a1e72d-6fd0-7dfc-972f-c5552d8b44ae",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72d-6fd0-7dfc-972f-c5552d8b44ae",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "artifacts": "/api/projects/opc/environments/dev/artifacts",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
]
}Cancels a change.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to cancel the change",
- "detail": "Your authorisation rules let you view the change but not cancel it."
}
]
}Pauses a running change. Steps already running finish, but no further steps are dispatched until the change is resumed.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
object |
{- "data": {
- "attributes": {
- "reason": "Holding this change until the database maintenance window closes"
}
}
}{- "data": {
- "id": "01a1e72d-8f66-7019-b7f9-6e5124697521",
- "type": "change",
- "attributes": {
- "created_by": "marge.walker-1535",
- "created_by_name": "marge.walker-1535",
- "step_name": "override",
- "action": "override",
- "build_without_cache": false,
- "auto_continue_wait_steps": false,
- "initial_step_tree": { },
- "metadata": {
- "card": "synthesizing"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "state_timing": {
- "running": {
- "ended_at": null,
- "started_at": "2026-11-17T01:44:45.171810Z"
}
}, - "state_timing_summary": { },
- "notify": { },
- "skip_steps": [ ],
- "starting_step": null,
- "cluster_name": null,
- "pause_state": "pausing",
- "status_code": "running",
- "paused": true,
- "cancel_requested": false,
- "paused_by": [
- {
- "username": "logged_in_user",
- "action": "pause",
- "message": "Holding this change until the database maintenance window closes",
- "date": "2026-11-17T01:44:45.806450Z"
}
], - "created_at": "2026-11-17T01:44:45.146203Z",
- "started_at": "2026-11-17T01:36:59.695674Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:44:45.194497Z",
- "paused_at": "2026-11-17T01:44:45.782047Z",
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": "a84f89ba0fb188c7eb15cd3cf94e120165e5c044",
- "requires_approval_from": null
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-9106-7b0a-a673-b140b918b6e8",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-9106-7b0a-a673-b140b918b6e8"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72d-8b64-7459-b513-2b8589fd90f2",
- "type": "project"
}, - {
- "id": "01a1e72d-8d60-7d60-9e08-f32495b5fad1",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "01a1e72d-8f79-78fc-8c52-1a1d116d3656",
- "type": "step"
}, - "links": {
- "related": "/api/steps/01a1e72d-8f79-78fc-8c52-1a1d116d3656"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e72d-8f79-78fc-8c52-1a1d116d3656",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "01a1e72d-8fbc-77b7-ae4a-8279e886dbe8",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-8fbc-77b7-ae4a-8279e886dbe8"
}
}, - "override_settings": {
- "data": {
- "id": "01a1e72d-9004-7739-a89a-c20616422e87",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-9004-7739-a89a-c20616422e87"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72d-8e4c-7aee-a1d6-d3eda60e4c94",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/01a1e72d-8f66-7019-b7f9-6e5124697521",
- "log_lines": "/api/changes/01a1e72d-8f66-7019-b7f9-6e5124697521/log_lines",
- "resume": "/api/changes/01a1e72d-8f66-7019-b7f9-6e5124697521/resume"
}, - "meta": { }
}
}Resumes a paused change, dispatching the steps that were held while it was paused.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
object |
{- "data": {
- "attributes": {
- "reason": "Maintenance window closed"
}
}
}{- "data": {
- "id": "01a1e72d-aac7-7c00-9d4a-90c23f7b05a4",
- "type": "change",
- "attributes": {
- "created_by": "margarete_predovic-1563",
- "created_by_name": "margarete_predovic-1563",
- "step_name": "navigate",
- "action": "navigate",
- "build_without_cache": false,
- "auto_continue_wait_steps": false,
- "initial_step_tree": { },
- "metadata": {
- "bandwidth": "generating"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "state_timing": {
- "running": {
- "ended_at": null,
- "started_at": "2026-11-17T01:44:52.173687Z"
}
}, - "state_timing_summary": { },
- "notify": { },
- "skip_steps": [ ],
- "starting_step": null,
- "cluster_name": null,
- "pause_state": "none",
- "status_code": "running",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [
- {
- "username": "logged_in_user",
- "action": "resume",
- "message": "Maintenance window closed",
- "date": "2026-11-17T01:44:52.639602Z"
}
], - "created_at": "2026-11-17T01:44:52.148912Z",
- "started_at": "2026-11-17T01:38:40.713372Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:44:52.191106Z",
- "paused_at": null,
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": "3a446bfe44af0a1a2b071086377428040611a166",
- "requires_approval_from": null
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-aba1-7a67-8b14-eaa9ee74675d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-aba1-7a67-8b14-eaa9ee74675d"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72d-a80d-770c-a06f-b3eb4fe5fcdb",
- "type": "project"
}, - {
- "id": "01a1e72d-a8fc-769a-a921-a1eac26375d8",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "01a1e72d-aad4-740d-b0ff-01c0106007c6",
- "type": "step"
}, - "links": {
- "related": "/api/steps/01a1e72d-aad4-740d-b0ff-01c0106007c6"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e72d-aad4-740d-b0ff-01c0106007c6",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "01a1e72d-ab11-7fdb-a93f-871b554be52f",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-ab11-7fdb-a93f-871b554be52f"
}
}, - "override_settings": {
- "data": {
- "id": "01a1e72d-ab2d-772a-a917-cc278810a9ff",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72d-ab2d-772a-a917-cc278810a9ff"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72d-a9be-7404-82c6-eb1657691988",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/01a1e72d-aac7-7c00-9d4a-90c23f7b05a4",
- "log_lines": "/api/changes/01a1e72d-aac7-7c00-9d4a-90c23f7b05a4/log_lines",
- "pause": "/api/changes/01a1e72d-aac7-7c00-9d4a-90c23f7b05a4/pause"
}, - "meta": { }
}
}Show the converged settings for a change, including any change-specific setting overrides merged on top of the asset's settings hierarchy. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "01a1e72d-c120-7569-a94c-e3255d1067c6",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "dockerfile": "Dockerfile_custom",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "dockerfile": "Change",
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Converge the root step properties for a change.
The optional action_stage argument can be:
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
| action_stage | string Example: action_stage=pre Converge the pre or post action properties |
| exclude_layers[] | string Example: exclude_layers[]=template Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. |
{- "data": {
- "id": "calculate (post)",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "transmitter": "overriding"
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "01a1e72d-cddd-71bb-a95e-bdba83290188",
- "type": "properties_version"
}, - {
- "id": "01a1e72d-ce84-7685-aba8-e073d9fa91ce",
- "type": "properties_version"
}, - {
- "id": "01a1e72d-cf20-7a57-90d5-a5038209af9e",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}, - "transmitter": "Change: Change properties"
}, - "sources": [
- {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "environment",
- "layer": "environment",
- "human": "Environment: Development (dev)"
}, - {
- "group": "database",
- "id": "change",
- "layer": "change",
- "human": "Change: Change properties"
}
]
}, - "property_layers": [
- {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "environment",
- "human": "Environment",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "change",
- "human": "Change",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e72d-cddd-71bb-a95e-bdba83290188",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:45:01.148214Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-cdd1-749a-af71-a8b56b820ae1",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-cdd1-749a-af71-a8b56b820ae1"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72d-cdd1-749a-af71-a8b56b820ae1/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e72d-cdd1-749a-af71-a8b56b820ae1/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e72d-ce84-7685-aba8-e073d9fa91ce",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:45:01.308404Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-ce57-7764-896c-6b77b7ada90f",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-ce57-7764-896c-6b77b7ada90f"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72d-ce57-7764-896c-6b77b7ada90f/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/01a1e72d-ce57-7764-896c-6b77b7ada90f/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e72d-cf20-7a57-90d5-a5038209af9e",
- "type": "properties_version",
- "attributes": {
- "data": {
- "transmitter": "overriding"
}, - "version": 1,
- "created_at": "2026-11-17T01:45:01.471414Z",
- "owner_type": "Change"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72d-cf1a-7d96-8a9e-c88ee101756b",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72d-cf1a-7d96-8a9e-c88ee101756b"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e72d-cf1a-7d96-8a9e-c88ee101756b/versions",
- "owner": "/api/projects/opc/environments/dev/changes/01a1e72d-cf07-7fb1-95cf-7f8f93949f09",
- "self": "/api/properties/01a1e72d-cf1a-7d96-8a9e-c88ee101756b/versions/1"
}, - "meta": { }
}
]
}Builds a zip archive of the information LimePoint support needs to diagnose a change: the change and its steps, its logs, the properties and settings in effect, its template and MintModel, server version information, recent runs of the same action and recent events. Each item is collected using the requesting user's permissions, so anything they cannot read is omitted or redacted. Items that could not be collected are listed in the archive's manifest.json and SUMMARY.md rather than failing the request.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
object |
{- "data": {
- "attributes": {
- "log_limit": 2000,
- "step_logs": "failed",
- "time_zone": "Australia/Melbourne",
- "client": {
- "name": "opschain-cli",
- "version": "2026-10-08",
- "commit": "abc1234",
- "built": "2026-10-08T00:00:00Z"
}
}
}
}<binary data>
Lists all scheduled activities.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[project_code_eq]=opc API filtering guide. Named filters: |
| include | string Example: include=parents Include the scheduled change parents in the response |
| fields[<resource_type>] | |
| include_children | boolean Example: include_children=true Only applies when the scheduled activities are being listed for a node - via a node path or |
{- "data": [
- {
- "id": "01a1e72c-a55c-7176-b12f-9e1c0f99287d",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "buddy_hagenes-1093",
- "created_by_disabled": false,
- "created_by_name": "buddy_hagenes-1093",
- "cron_schedule": "32 3 3 12 4",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "allow_parallel_execution": false,
- "metadata": {
- "interface": "hacking"
}, - "property_overrides": {
- "transmitter": "bypassing"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "labels": [
- "nightly",
- "production"
], - "created_at": "2026-11-17T01:43:45.241573Z",
- "updated_at": "2026-11-17T01:43:45.241573Z",
- "next_run_at": "2026-12-02T16:32:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "override",
- "new_commits_only": true,
- "git_rev": "multi-byte",
- "auto_continue_wait_steps": false,
- "commit_file_patterns": [
- {
- "match": "**/*.rb",
- "negate": false
}, - {
- "match": "docs/**/*",
- "negate": true
}
], - "commit_file_pattern_match": "any",
- "enabled": true,
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72c-a472-7809-b090-cd2bab81e5fc",
- "type": "project"
}, - {
- "id": "01a1e72c-a4d1-7eb7-a92a-3ccb87fcbb3e",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72c-a524-7ea8-bd49-01d45f2ee9df",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/01a1e72c-a55c-7176-b12f-9e1c0f99287d"
}
}, - {
- "id": "01a1e72c-a935-79b4-8167-9bdffb03f98f",
- "type": "scheduled_workflow",
- "attributes": {
- "created_by": "salvatore-1100",
- "created_by_disabled": false,
- "created_by_name": "salvatore-1100",
- "cron_schedule": "20 16 6 4 4",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "allow_parallel_execution": false,
- "metadata": {
- "hard drive": "programming"
}, - "property_overrides": {
- "panel": "programming"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "labels": [
- "weekly"
], - "created_at": "2026-11-17T01:43:46.227798Z",
- "updated_at": "2026-11-17T01:43:46.227798Z",
- "next_run_at": "2027-04-01T05:20:00.000000Z",
- "run_at": null,
- "end_at": null,
- "workflow_code": "assets",
- "version": 2,
- "enabled": true,
- "project_name": "OpsChain",
- "project_code": "opc"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72c-a472-7809-b090-cd2bab81e5fc",
- "type": "project"
}
]
}
}, - "links": {
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc",
- "self": "/api/scheduled_activities/01a1e72c-a935-79b4-8167-9bdffb03f98f",
- "workflow": "/api/projects/opc/workflows/assets",
- "workflow_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
], - "included": [
- {
- "id": "01a1e72c-a472-7809-b090-cd2bab81e5fc",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "almeda_breitenberg-1091",
- "created_by_name": "almeda_breitenberg-1091"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72c-a476-7c94-b8e9-de942ac56c36",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72c-a476-7c94-b8e9-de942ac56c36"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e72c-a4a2-7d8e-acb3-65f5d51295d5",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72c-a4a2-7d8e-acb3-65f5d51295d5"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e72c-a4d1-7eb7-a92a-3ccb87fcbb3e",
- "type": "environment"
}, - {
- "id": "01a1e72c-a63c-7536-928c-b86d962e471e",
- "type": "asset"
}, - {
- "id": "01a1e72c-a8a7-7405-8ac1-dd006074637b",
- "type": "asset"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}, - {
- "id": "01a1e72c-a4d1-7eb7-a92a-3ccb87fcbb3e",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "jaqueline-1092",
- "created_by_name": "jaqueline-1092"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72c-a4dc-7f84-8541-882e1a1b1c94",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72c-a4dc-7f84-8541-882e1a1b1c94"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72c-a472-7809-b090-cd2bab81e5fc",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72c-a50f-737b-94c6-c60f2e4b4da9",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72c-a50f-737b-94c6-c60f2e4b4da9"
}
}, - "parent": {
- "data": {
- "id": "01a1e72c-a472-7809-b090-cd2bab81e5fc",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72c-a472-7809-b090-cd2bab81e5fc",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "artifacts": "/api/projects/opc/environments/dev/artifacts",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}, - "has_any": true
}
}Creates a scheduled activity in a specific project, environment or asset.
Notes:
When creating scheduled activities via a project, environment or asset scheduled_activities path
(e.g. POST to /api/projects/{project_code}/scheduled_activities) the parent_path request attributes must not be supplied
as the parent will be derived from the path.
When creating scheduled activities for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/scheduled_activities)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.
See the various payload examples to understand the required fields for each possible request to this endpoint.
required | object |
{- "data": {
- "attributes": {
- "git_rev": "master",
- "action": "install_os",
- "cron_schedule": "31 19 14 10 *",
- "new_commits_only": false,
- "repeat": true,
- "metadata": {
- "hard drive": "overriding"
}, - "run_at": null,
- "run_count": 0,
- "maximum_run_count": null,
- "end_at": null,
- "allow_parallel_execution": false,
- "property_overrides": {
- "system": "synthesizing"
}, - "settings_overrides": {
- "dockerfile": "quantifying"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "auto_continue_wait_steps": false,
- "commit_file_patterns": [ ],
- "commit_file_pattern_match": "any",
- "enabled": true,
- "labels": [ ],
- "parent_path": "/projects/opc/environments/dev",
- "git_remote_name": "github"
}
}
}{- "data": {
- "id": "01a1e72a-fd2a-71bd-a8ab-5baf985e5539",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "chae.connelly-22",
- "created_by_disabled": false,
- "created_by_name": "chae.connelly-22",
- "cron_schedule": "26 1 19 12 4",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "allow_parallel_execution": false,
- "metadata": {
- "application": "indexing"
}, - "property_overrides": {
- "card": "indexing"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "labels": [
- "nightly",
- "production"
], - "created_at": "2026-11-17T01:41:56.647797Z",
- "updated_at": "2026-11-17T01:41:56.647797Z",
- "next_run_at": "2026-12-02T14:26:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "navigate",
- "new_commits_only": true,
- "git_rev": "optical",
- "auto_continue_wait_steps": false,
- "commit_file_patterns": [
- {
- "match": "**/*.rb",
- "negate": false
}, - {
- "match": "docs/**/*",
- "negate": true
}
], - "commit_file_pattern_match": "any",
- "enabled": true,
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72a-f049-77ab-992b-01351732a1a3",
- "type": "project"
}, - {
- "id": "01a1e72a-f7f1-7858-95ce-493be7ec5234",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72a-f0cc-7a86-9dad-3fda525db936",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/01a1e72a-fd2a-71bd-a8ab-5baf985e5539"
}
}
}Shows a scheduled activity.
| scheduled_change_id required | string Example: 01a1e72a-fd2a-71bd-a8ab-5baf985e5539 scheduled change id |
| include | string Example: include=parents Include the scheduled change parents in the response |
| fields[<resource_type>] |
{- "data": {
- "id": "01a1e72a-fd2a-71bd-a8ab-5baf985e5539",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "chae.connelly-22",
- "created_by_disabled": false,
- "created_by_name": "chae.connelly-22",
- "cron_schedule": "26 1 19 12 4",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "allow_parallel_execution": false,
- "metadata": {
- "application": "indexing"
}, - "property_overrides": {
- "card": "indexing"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "labels": [
- "nightly",
- "production"
], - "created_at": "2026-11-17T01:41:56.647797Z",
- "updated_at": "2026-11-17T01:41:56.647797Z",
- "next_run_at": "2026-12-02T14:26:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "navigate",
- "new_commits_only": true,
- "git_rev": "optical",
- "auto_continue_wait_steps": false,
- "commit_file_patterns": [
- {
- "match": "**/*.rb",
- "negate": false
}, - {
- "match": "docs/**/*",
- "negate": true
}
], - "commit_file_pattern_match": "any",
- "enabled": true,
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72a-f049-77ab-992b-01351732a1a3",
- "type": "project"
}, - {
- "id": "01a1e72a-f7f1-7858-95ce-493be7ec5234",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72a-f0cc-7a86-9dad-3fda525db936",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/01a1e72a-fd2a-71bd-a8ab-5baf985e5539"
}
}
}Updates a scheduled activity in a specific project, environment or asset.
Notes:
parent_path, project_code,
environment_code and asset_code attributes must not be supplied - create a new scheduled activity against the
required parent instead./api/projects/{project_code}/assets/{asset_code}/scheduled_activities/{id})
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.| scheduled_change_id required | string Example: 01a1e72a-fd2a-71bd-a8ab-5baf985e5539 scheduled change id |
required | object |
{- "data": {
- "attributes": {
- "git_rev": "master",
- "action": "install_os",
- "cron_schedule": "14 18 19 2 5",
- "new_commits_only": false,
- "repeat": true,
- "metadata": {
- "capacitor": "bypassing"
}, - "run_at": null,
- "run_count": 0,
- "maximum_run_count": null,
- "end_at": null,
- "allow_parallel_execution": false,
- "property_overrides": {
- "card": "calculating"
}, - "settings_overrides": {
- "dockerfile": "hacking"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "auto_continue_wait_steps": false,
- "commit_file_patterns": [ ],
- "commit_file_pattern_match": "any",
- "enabled": true,
- "labels": [ ],
- "git_remote_name": "github"
}
}
}{- "data": {
- "id": "01a1e72a-fd2a-71bd-a8ab-5baf985e5539",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "chae.connelly-22",
- "created_by_disabled": false,
- "created_by_name": "chae.connelly-22",
- "cron_schedule": "26 1 19 12 4",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "allow_parallel_execution": false,
- "metadata": {
- "application": "indexing"
}, - "property_overrides": {
- "card": "indexing"
}, - "notify": {
- "events": [
- "success"
], - "ldap_groups": [
- "admin"
]
}, - "skip_steps": [ ],
- "labels": [
- "nightly",
- "production"
], - "created_at": "2026-11-17T01:41:56.647797Z",
- "updated_at": "2026-11-17T01:41:56.647797Z",
- "next_run_at": "2026-12-02T14:26:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "navigate",
- "new_commits_only": true,
- "git_rev": "optical",
- "auto_continue_wait_steps": false,
- "commit_file_patterns": [
- {
- "match": "**/*.rb",
- "negate": false
}, - {
- "match": "docs/**/*",
- "negate": true
}
], - "commit_file_pattern_match": "any",
- "enabled": true,
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "01a1e72a-f049-77ab-992b-01351732a1a3",
- "type": "project"
}, - {
- "id": "01a1e72a-f7f1-7858-95ce-493be7ec5234",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/01a1e72a-f0cc-7a86-9dad-3fda525db936",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/01a1e72a-fd2a-71bd-a8ab-5baf985e5539"
}
}
}Delete a scheduled activity.
| scheduled_change_id required | string Example: 01a1e72a-fd2a-71bd-a8ab-5baf985e5539 scheduled change id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the scheduled change",
- "detail": "Your authorisation rules let you view the scheduled change but not delete it."
}
]
}Endpoints to interact with change steps.
Lists all steps.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[action_eq]=provision API filtering guide. Named filters: |
| limit | integer [ 1 .. 1000 ] Default: 1000 Example: limit=50 Limit the number of steps returned |
{- "data": [
- {
- "id": "01a1e731-4e30-7db8-870f-4eaa4265ebd8",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "compress",
- "change_id": "01a1e731-4e2b-7f4d-99b2-fc75241eed90",
- "child_execution_strategy": "sequential",
- "full_path": "compress",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:48:50.607089Z",
- "started_at": "2026-11-17T01:48:50.607089Z"
}
}, - "step_sequence": 1,
- "step_type": "standard",
- "description": "Deploy the release to the environment",
- "timeout": null,
- "step_name": "compress",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:39:18.096579Z",
- "started_at": "2026-11-17T01:40:18.096579Z",
- "finished_at": "2026-11-17T01:42:05.732870Z",
- "updated_at": "2026-11-17T01:48:50.676679Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-4e6c-79c3-aca0-6150dffd34ff",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-4e6c-79c3-aca0-6150dffd34ff"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e731-4db5-7b2f-b28f-f08b386f8c9f",
- "type": "properties_version"
}, - {
- "id": "01a1e731-4df2-7a94-b1a5-8731f6913821",
- "type": "properties_version"
}, - {
- "id": "01a1e731-4e41-7b9c-aecc-e6f1ddef589f",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e731-4e2b-7f4d-99b2-fc75241eed90",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e731-4e2b-7f4d-99b2-fc75241eed90",
- "change": "/api/projects/opc/environments/dev/changes/01a1e731-4e2b-7f4d-99b2-fc75241eed90",
- "log_lines": "/api/steps/01a1e731-4e30-7db8-870f-4eaa4265ebd8/log_lines",
- "self": "/api/steps/01a1e731-4e30-7db8-870f-4eaa4265ebd8"
}, - "meta": { }
}
], - "meta": {
- "partial_response": false
}
}Shows a change step.
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c step id |
{- "data": {
- "id": "01a1e731-4fe5-70c2-8333-6aa736d0cc0c",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "override",
- "change_id": "01a1e731-4fe0-7bca-843c-ffcc8478f2ad",
- "child_execution_strategy": "sequential",
- "full_path": "override",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:48:51.043536Z",
- "started_at": "2026-11-17T01:48:51.043536Z"
}
}, - "step_sequence": 1,
- "step_type": "standard",
- "description": "Deploy the release to the environment",
- "timeout": null,
- "step_name": "override",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:41:23.843556Z",
- "started_at": "2026-11-17T01:42:23.843556Z",
- "finished_at": "2026-11-17T01:45:50.083658Z",
- "updated_at": "2026-11-17T01:48:51.113390Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-5020-7661-bb79-bed6573b1b4d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-5020-7661-bb79-bed6573b1b4d"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e731-4f6e-7867-b4b9-6e2f0d4ba939",
- "type": "properties_version"
}, - {
- "id": "01a1e731-4faa-7371-bd3f-6eddb38c4c82",
- "type": "properties_version"
}, - {
- "id": "01a1e731-4ff4-779d-9690-80f81c604154",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e731-4fe0-7bca-843c-ffcc8478f2ad",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e731-4fe0-7bca-843c-ffcc8478f2ad",
- "change": "/api/projects/opc/environments/dev/changes/01a1e731-4fe0-7bca-843c-ffcc8478f2ad",
- "log_lines": "/api/steps/01a1e731-4fe5-70c2-8333-6aa736d0cc0c/log_lines",
- "self": "/api/steps/01a1e731-4fe5-70c2-8333-6aa736d0cc0c"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}, - "card": "Change: Change properties"
}, - "sources": [
- {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "environment",
- "layer": "environment",
- "human": "Environment: Development (dev)"
}, - {
- "group": "database",
- "id": "change",
- "layer": "change",
- "human": "Change: Change properties"
}
]
}
}
}, - "included": [
- {
- "id": "01a1e731-4f6e-7867-b4b9-6e2f0d4ba939",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:48:50.925675Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-4f66-768c-afbd-f78167700fef",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-4f66-768c-afbd-f78167700fef"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-4f66-768c-afbd-f78167700fef/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e731-4f66-768c-afbd-f78167700fef/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e731-4faa-7371-bd3f-6eddb38c4c82",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:48:50.985397Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-4fa0-718d-bc50-7a699612c593",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-4fa0-718d-bc50-7a699612c593"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-4fa0-718d-bc50-7a699612c593/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/01a1e731-4fa0-718d-bc50-7a699612c593/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e731-4ff4-779d-9690-80f81c604154",
- "type": "properties_version",
- "attributes": {
- "data": {
- "card": "hacking"
}, - "version": 1,
- "created_at": "2026-11-17T01:48:51.059690Z",
- "owner_type": "Change"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-4ff0-770b-a48d-af081bf5e079",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-4ff0-770b-a48d-af081bf5e079"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-4ff0-770b-a48d-af081bf5e079/versions",
- "owner": "/api/projects/opc/environments/dev/changes/01a1e731-4fe0-7bca-843c-ffcc8478f2ad",
- "self": "/api/properties/01a1e731-4ff0-770b-a48d-af081bf5e079/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e731-5020-7661-bb79-bed6573b1b4d",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "card": "hacking"
}, - "version": 1,
- "created_at": "2026-11-17T01:48:51.103375Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/steps/01a1e731-4fe5-70c2-8333-6aa736d0cc0c"
}
}
}, - "links": {
- "self": "/api/properties/01a1e731-5020-7661-bb79-bed6573b1b4d",
- "current_version": "/api/properties/01a1e731-5020-7661-bb79-bed6573b1b4d/versions/1",
- "versions": "/api/properties/01a1e731-5020-7661-bb79-bed6573b1b4d/versions"
}
}
]
}Continues a "waiting" change step.
| step_id required | string Example: 01a1e72b-17e5-7538-8a73-339322229a24 step id |
object |
{- "data": {
- "attributes": {
- "message": "Manually removed from load balancer.",
- "input_arguments": {
- "name": "John",
- "date": "2026-07-23"
}, - "choice": "promote"
}
}
}{- "data": {
- "id": "01a1e731-539e-7cfa-92c1-553e99caf7d6",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "opschain_wait_step_2",
- "change_id": "01a1e731-539a-73c2-98f6-564ea50d17fb",
- "child_execution_strategy": "sequential",
- "full_path": "opschain_wait_step_2",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "success": {
- "ended_at": "2026-11-17T01:48:52.322381Z",
- "started_at": "2026-11-17T01:48:52.322381Z"
}, - "waiting": {
- "ended_at": "2026-11-17T01:48:52.322381Z",
- "started_at": "2026-11-17T01:48:51.997164Z"
}
}, - "step_sequence": 1,
- "step_type": "wait_step",
- "description": "Deploy the release to the environment",
- "timeout": null,
- "step_name": "opschain_wait_step_2",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:40:57.092687Z",
- "started_at": "2026-11-17T01:41:57.092687Z",
- "finished_at": "2026-11-17T01:48:52.405781Z",
- "updated_at": "2026-11-17T01:48:52.612769Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-53f0-7d80-88df-f16874ca66ee",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-53f0-7d80-88df-f16874ca66ee"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e731-5324-7b32-9d19-e66c95254e6a",
- "type": "properties_version"
}, - {
- "id": "01a1e731-5360-74e3-9ffc-6b8f5a160109",
- "type": "properties_version"
}, - {
- "id": "01a1e731-53b5-74e4-8ef5-ee6034586d9a",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e731-539a-73c2-98f6-564ea50d17fb",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e731-539a-73c2-98f6-564ea50d17fb",
- "change": "/api/projects/opc/environments/dev/changes/01a1e731-539a-73c2-98f6-564ea50d17fb",
- "log_lines": "/api/steps/01a1e731-539e-7cfa-92c1-553e99caf7d6/log_lines",
- "self": "/api/steps/01a1e731-539e-7cfa-92c1-553e99caf7d6"
}, - "meta": { }
}
}Re-runs a failed change step, and the steps below it that failed or did not run, on the existing step records while the rest of the change keeps running.
Only a step that failed directly below a step that is still running can be retried, and only while the change is active and not paused. The step's retry link is present when it can be retried.
Steps below it that succeeded are not re-run. The retry is logged at the start of the step's log, after the output of the failed attempt.
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c step id |
object |
{- "data": {
- "attributes": {
- "message": "Network share restored."
}
}
}{- "data": {
- "id": "01a1e731-62f9-7af6-bcb7-ff9875cae428",
- "type": "step",
- "attributes": {
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "deploy_server",
- "change_id": "01a1e731-62a9-7ce1-a0eb-5376e005e451",
- "child_execution_strategy": "sequential",
- "full_path": "hack/deploy_server",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "queued": {
- "ended_at": null,
- "started_at": "2026-11-17T01:48:56.051518Z"
}, - "pending": {
- "ended_at": "2026-11-17T01:48:56.051518Z",
- "started_at": "2026-11-17T01:48:56.007630Z"
}
}, - "step_sequence": 1,
- "step_type": "standard",
- "description": null,
- "timeout": null,
- "step_name": "deploy_server",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:39:52.207085Z",
- "started_at": "2026-11-17T01:40:52.207000Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:48:56.094415Z",
- "status_code": "queued"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-6313-748c-8b12-1ab7eee75441",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-6313-748c-8b12-1ab7eee75441"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e731-6232-78d9-918b-2ed85ae591a5",
- "type": "properties_version"
}, - {
- "id": "01a1e731-6271-73a2-95d7-97fb8c4b6b47",
- "type": "properties_version"
}, - {
- "id": "01a1e731-62bd-7290-a651-ae47577182f0",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e731-62a9-7ce1-a0eb-5376e005e451",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/steps/01a1e731-62ae-73dc-aebd-3b4e9ea02cb0",
- "change": "/api/projects/opc/environments/dev/changes/01a1e731-62a9-7ce1-a0eb-5376e005e451",
- "log_lines": "/api/steps/01a1e731-62f9-7af6-bcb7-ff9875cae428/log_lines",
- "self": "/api/steps/01a1e731-62f9-7af6-bcb7-ff9875cae428"
}, - "meta": {
- "previous_run": {
- "step_id": "01a1e731-62f9-7af6-bcb7-ff9875cae428",
- "change_id": "01a1e731-62a9-7ce1-a0eb-5376e005e451"
}
}
}
}Approves a change step that needs approval.
| step_id required | string Example: 01a1e72b-17e5-7538-8a73-339322229a24 step id |
object |
{- "data": {
- "attributes": {
- "message": "As per CR 7 👍",
- "choice": "promote"
}
}
}{- "data": {
- "id": "01a1e731-7042-7a03-b3ca-d7dd9dc83752",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": [
- {
- "ldap_groups": [
- "an-ldap-group"
], - "approved_by": null
}
], - "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "opschain_wait_step_6",
- "change_id": "01a1e731-703c-73d7-b64d-b82404f1f318",
- "child_execution_strategy": "sequential",
- "full_path": "opschain_wait_step_6",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "queued": {
- "ended_at": null,
- "started_at": "2026-11-17T01:48:59.548853Z"
}, - "waiting": {
- "ended_at": "2026-11-17T01:48:59.548853Z",
- "started_at": "2026-11-17T01:48:59.328642Z"
}
}, - "step_sequence": 1,
- "step_type": "wait_step",
- "description": "Deploy the release to the environment",
- "timeout": null,
- "step_name": "opschain_wait_step_6",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:38:36.666587Z",
- "started_at": "2026-11-17T01:39:36.666587Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:48:59.575689Z",
- "status_code": "queued"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-70b5-7c71-8ee7-4a6682f60bfc",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-70b5-7c71-8ee7-4a6682f60bfc"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e731-6f65-7a81-8aa1-b0eb4e0769ba",
- "type": "properties_version"
}, - {
- "id": "01a1e731-6fe3-76f0-9cbf-498250c51bbe",
- "type": "properties_version"
}, - {
- "id": "01a1e731-7057-7e43-bb93-d9c308f21a70",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e731-703c-73d7-b64d-b82404f1f318",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e731-703c-73d7-b64d-b82404f1f318",
- "change": "/api/projects/opc/environments/dev/changes/01a1e731-703c-73d7-b64d-b82404f1f318",
- "log_lines": "/api/steps/01a1e731-7042-7a03-b3ca-d7dd9dc83752/log_lines",
- "self": "/api/steps/01a1e731-7042-7a03-b3ca-d7dd9dc83752"
}, - "meta": { }
}
}Rejects a change step that needs approval.
| step_id required | string Example: 01a1e72b-17e5-7538-8a73-339322229a24 step id |
object |
{- "data": {
- "attributes": {
- "message": "Failed user acceptance testing"
}
}
}{- "data": {
- "id": "01a1e731-7f08-7de6-9847-832262216e35",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": [
- {
- "ldap_groups": [
- "an-ldap-group"
], - "approved_by": null
}
], - "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "arm": null,
- "choices": null,
- "default": null,
- "branch": null,
- "retry_from": null,
- "recover": null,
- "reset_on_retry": null,
- "run_if": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "action": "opschain_wait_step_10",
- "change_id": "01a1e731-7f04-7797-b76e-700b1ebb3bd6",
- "child_execution_strategy": "sequential",
- "full_path": "opschain_wait_step_10",
- "ignore_failure": false,
- "input_arguments": [ ],
- "state_timing": {
- "aborted": {
- "ended_at": "2026-11-17T01:49:03.232515Z",
- "started_at": "2026-11-17T01:49:03.232515Z"
}, - "waiting": {
- "ended_at": "2026-11-17T01:49:03.232515Z",
- "started_at": "2026-11-17T01:49:03.111258Z"
}
}, - "step_sequence": 1,
- "step_type": "wait_step",
- "description": "Deploy the release to the environment",
- "timeout": null,
- "step_name": "opschain_wait_step_10",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:18.825621Z",
- "started_at": "2026-11-17T01:43:18.825621Z",
- "finished_at": "2026-11-17T01:49:03.237876Z",
- "updated_at": "2026-11-17T01:49:03.256557Z",
- "status_code": "aborted"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-7f49-70e9-a8fc-08369073e29d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-7f49-70e9-a8fc-08369073e29d"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "01a1e731-7e6b-700e-83f9-44cd24cd8eea",
- "type": "properties_version"
}, - {
- "id": "01a1e731-7eca-7f13-a784-e738ab57e342",
- "type": "properties_version"
}, - {
- "id": "01a1e731-7f19-75c4-bb0e-84b230f4eb53",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "01a1e731-7f04-7797-b76e-700b1ebb3bd6",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/01a1e731-7f04-7797-b76e-700b1ebb3bd6",
- "change": "/api/projects/opc/environments/dev/changes/01a1e731-7f04-7797-b76e-700b1ebb3bd6",
- "log_lines": "/api/steps/01a1e731-7f08-7de6-9847-832262216e35/log_lines",
- "self": "/api/steps/01a1e731-7f08-7de6-9847-832262216e35"
}, - "meta": { }
}
}Show the converged settings for the change containing this step, including any change-specific setting overrides. Unless include_global=true is passed, only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.
The response includes a setting_sources meta object that attributes each setting value to its originating source.
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c step id |
| include_global | boolean Example: include_global=true Also return the settings whose converged value matches the global settings |
{- "data": {
- "id": "01a1e731-88da-7985-a555-93274874a196",
- "type": "converged_settings",
- "attributes": {
- "data": {
- "dockerfile": "Dockerfile_custom",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_settings"
}, - "meta": {
- "setting_sources": {
- "by_setting": {
- "dockerfile": "Change",
- "requires_approval_from": "Project: OpsChain (opc)"
}
}
}
}
}Converge the properties for a step.
The optional action_stage argument can be:
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c step id |
| action_stage | string Example: action_stage=pre Converge the pre or post action properties |
| exclude_layers[] | string Example: exclude_layers[]=template Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. |
{- "data": {
- "id": "generate (post)",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "capacitor": "backing up"
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "01a1e731-8c5a-7511-bda9-229a25dc9547",
- "type": "properties_version"
}, - {
- "id": "01a1e731-8ca7-7ea2-a10f-a5f09ce9212c",
- "type": "properties_version"
}, - {
- "id": "01a1e731-8d04-71a3-836e-533492056d5c",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}, - "capacitor": "Change: Change properties"
}, - "sources": [
- {
- "group": "database",
- "id": "project",
- "layer": "project",
- "human": "Project: OpsChain (opc)"
}, - {
- "group": "database",
- "id": "environment",
- "layer": "environment",
- "human": "Environment: Development (dev)"
}, - {
- "group": "database",
- "id": "change",
- "layer": "change",
- "human": "Change: Change properties"
}
]
}, - "property_layers": [
- {
- "id": "project",
- "human": "Project",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "environment",
- "human": "Environment",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}, - {
- "id": "change",
- "human": "Change",
- "groups": [
- {
- "group": "database",
- "included": true
}
]
}
]
}
}, - "included": [
- {
- "id": "01a1e731-8c5a-7511-bda9-229a25dc9547",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-11-17T01:49:06.521379Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-8c51-7f7e-bd07-ad91bdcdfd31",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-8c51-7f7e-bd07-ad91bdcdfd31"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-8c51-7f7e-bd07-ad91bdcdfd31/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/01a1e731-8c51-7f7e-bd07-ad91bdcdfd31/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e731-8ca7-7ea2-a10f-a5f09ce9212c",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-11-17T01:49:06.598958Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-8c9b-7212-86e4-d64502306639",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-8c9b-7212-86e4-d64502306639"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-8c9b-7212-86e4-d64502306639/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/01a1e731-8c9b-7212-86e4-d64502306639/versions/1"
}, - "meta": { }
}, - {
- "id": "01a1e731-8d04-71a3-836e-533492056d5c",
- "type": "properties_version",
- "attributes": {
- "data": {
- "capacitor": "backing up"
}, - "version": 1,
- "created_at": "2026-11-17T01:49:06.691137Z",
- "owner_type": "Change"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-8cff-7cc4-9b5c-c712d41dc4a8",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-8cff-7cc4-9b5c-c712d41dc4a8"
}
}
}, - "links": {
- "versions": "/api/properties/01a1e731-8cff-7cc4-9b5c-c712d41dc4a8/versions",
- "owner": "/api/projects/opc/environments/dev/changes/01a1e731-8ce9-7d72-90f9-ba22a5fc68cb",
- "self": "/api/properties/01a1e731-8cff-7cc4-9b5c-c712d41dc4a8/versions/1"
}, - "meta": { }
}
]
}List the log lines for a change.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 |
| filter[<query/sort filter>]= | |
| download | string Example: download=change.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e731-46a1-77a1-bf51-2b8eac322602",
- "type": "log_line",
- "attributes": {
- "message": "Facilis culpa distinctio aliquid.",
- "category": "action",
- "change_id": "01a1e731-4655-7748-9306-5f5fa10d9320",
- "step_id": "01a1e731-465a-7f1c-a180-51ad3296d913",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List the log lines for a change step.
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c |
| include_child_steps | boolean Example: include_child_steps=true Whether to include logs for steps that are children of this step |
| filter[<query/sort filter>]= | |
| download | string Example: download=step.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e731-49ab-7abf-a120-e09c07d1d527",
- "type": "log_line",
- "attributes": {
- "message": "Iure ipsam similique velit.",
- "category": "action",
- "change_id": "01a1e731-4950-7f73-97d8-80a360ffce79",
- "step_id": "01a1e731-4956-70bc-a976-40c2f7412c1d",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List filtered log lines.
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. 10000 ] Default: 10000 Example: limit=50 Limit the number of log lines returned |
| download | string Example: download=opschain.log Download the filtered log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e731-4cff-79e8-b64b-b9f32393ec69",
- "type": "log_line",
- "attributes": {
- "message": "Dolorem cum possimus ex.",
- "category": "action",
- "change_id": "01a1e731-4cb0-7013-a63b-691cc6640ae3",
- "step_id": "01a1e731-4cb4-7a47-9bc8-39f393bb9c59",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List the workflow run log lines for a workflow run.
| workflow_run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 |
| filter[<query/sort filter>]= | |
| download | string Example: download=workflow_run.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e732-bec0-7f70-90ff-b110008661be",
- "type": "log_line",
- "attributes": {
- "message": "Optio dolorem quis laboriosam.",
- "category": "action",
- "workflow_run_id": "01a1e732-b6ea-7de7-80a3-1430cb71f7e4",
- "workflow_step_id": "01a1e732-b722-7fd4-9a73-1da3098c6fbd",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List the log lines for a workflow step.
| workflow_step_id required | string Example: 01a1e72b-1a7b-7e67-9b4d-e3e7057f14f7 |
| include_child_steps | boolean Example: include_child_steps=true Whether to include logs for steps that are children of this step |
| filter[<query/sort filter>]= | |
| download | string Example: download=workflow_step.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e732-e096-793f-9b7e-a23ee55f0255",
- "type": "log_line",
- "attributes": {
- "message": "Est omnis nihil ut.",
- "category": "action",
- "workflow_run_id": "01a1e732-d931-7e87-a7a7-d69874dae872",
- "workflow_step_id": "01a1e732-d93b-79e6-8fba-603a52d87071",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List filtered workflow run log lines for a workflow run or workflow step.
| workflow_run_id | string Example: workflow_run_id=01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 The workflow run to list log lines for. Required unless |
| workflow_step_id | string Example: workflow_step_id=01a1e72b-1a7b-7e67-9b4d-e3e7057f14f7 The workflow step to list log lines for. Required unless |
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. 10000 ] Default: 10000 Example: limit=50 Limit the number of workflow run log lines returned |
| download | string Example: download=opschain.log Download the filtered log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "01a1e732-fa91-7430-ad04-0a1ab7ce5c6b",
- "type": "log_line",
- "attributes": {
- "message": "Ea eum cum animi.",
- "category": "action",
- "workflow_run_id": "01a1e732-f2cd-79ad-8a57-1535e980780f",
- "workflow_step_id": "01a1e732-f2d8-7002-8150-8d7fcef8f07f",
- "logged_at": "2026-11-16T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Endpoints to store, list and retrieve artifacts. Every artifacts and artifact_loads path also answers on its artefacts and artefact_loads spelling, and responses always use artifacts.
Lists the artifact versions loaded by a specific change (across all of its steps), newest first by default. Every load is recorded, so a version loaded more than once appears once per load. Use include=artifact to include the loaded artifact versions (include=artefact is also accepted).
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
| include | string Example: include=artifact Comma-separated relationships to include: |
| limit | integer >= 1 Example: limit=50 Limit the number of loads returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-9979-7406-83de-e902d2c93f6f",
- "type": "artifact_load",
- "attributes": {
- "created_at": "2026-11-17T01:42:36.664135Z"
}, - "relationships": {
- "artifact": {
- "data": {
- "id": "01a1e72b-9896-7154-a9aa-49723a671a50",
- "type": "artifact"
}
}, - "step": {
- "data": {
- "id": "01a1e72b-9913-73f0-b16a-ab15807fc0bf",
- "type": "step"
}
}
}
}
], - "included": [
- {
- "id": "01a1e72b-9896-7154-a9aa-49723a671a50",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Consequatur quis cum consequatur.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:42:36.437218Z",
- "purged_at": null,
- "byte_size": null,
- "content_type": null,
- "filename": null
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-982f-7f6b-8163-32886d3475e5",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-9896-7154-a9aa-49723a671a50"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Lists the artifact versions loaded by a specific step, newest first by default. Every load is recorded, so a version loaded more than once appears once per load. Use include=artifact to include the loaded artifact versions (include=artefact is also accepted).
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c step id |
| include | string Example: include=artifact Comma-separated relationships to include: |
| limit | integer >= 1 Example: limit=50 Limit the number of loads returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-9f6b-7adf-8f28-996dcdb0eec0",
- "type": "artifact_load",
- "attributes": {
- "created_at": "2026-11-17T01:42:38.186824Z"
}, - "relationships": {
- "artifact": {
- "data": {
- "id": "01a1e72b-9ebf-7345-a7c6-ee67d69227d3",
- "type": "artifact"
}
}, - "step": {
- "data": {
- "id": "01a1e72b-9f1f-768f-9271-9678c08cc540",
- "type": "step"
}
}
}
}
], - "included": [
- {
- "id": "01a1e72b-9ebf-7345-a7c6-ee67d69227d3",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Itaque blanditiis laudantium vitae.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:42:38.014363Z",
- "purged_at": null,
- "byte_size": null,
- "content_type": null,
- "filename": null
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-9e64-7597-a8a7-b3bd528bb62e",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-9ebf-7345-a7c6-ee67d69227d3"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Lists the artifacts of every project, environment and asset the user can read, newest first by default. An artifact is only listed when the user can read both its project, environment or asset and that node's artifacts. meta.has_any reports whether the user can read any artifact at all, regardless of the filter. meta.total_matching_filter counts the artifacts matching the filter, stopping at 1000 (or one past the returned page, when the limit is larger) - meta.total_matching_filter_exact reports whether the count is exact.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[parent_path_eq]=/projects/web API filtering guide. Named filters: |
| limit | integer [ 1 .. 1000 ] Example: limit=50 Limit the number of artifacts returned (default 100, maximum 1000). When more records match than the limit a 206 response is returned and |
| include | string Example: include=node Include the project, environment or asset each artifact belongs to with |
{- "data": [
- {
- "id": "01a1e72b-a4d8-7972-b2eb-e1b3262df080",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Magnam laboriosam veniam dicta.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:42:39.575610Z",
- "purged_at": null,
- "byte_size": 24,
- "content_type": "application/octet-stream",
- "filename": "app.war"
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-a47a-7d7e-8e32-b7ac7521b0b5",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-a4d8-7972-b2eb-e1b3262df080"
}
}
], - "included": [
- {
- "id": "01a1e72b-a47a-7d7e-8e32-b7ac7521b0b5",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "hollis-462",
- "created_by_name": "hollis-462",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e72b-a484-7f25-8c4f-ad5b4798d515",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e72b-a484-7f25-8c4f-ad5b4798d515"
}
}, - "parents": {
- "data": [
- {
- "id": "01a1e72b-a3ca-7502-84b8-e81f09a58a50",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "01a1e72b-a494-739b-a007-49ad48e5349f",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e72b-a494-739b-a007-49ad48e5349f"
}
}, - "parent": {
- "data": {
- "id": "01a1e72b-a3ca-7502-84b8-e81f09a58a50",
- "type": "project"
}
}, - "project": {
- "data": {
- "id": "01a1e72b-a3ca-7502-84b8-e81f09a58a50",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "01a1e72b-a43d-7278-8adc-c30327265a6e",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72b-a405-7f5b-a9a1-be23e33334c7/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "01a1e72b-a4c5-7d1e-a02d-070524d613cc",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "01a1e72b-a405-7f5b-a9a1-be23e33334c7",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/01a1e72b-a405-7f5b-a9a1-be23e33334c7"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "actions": "/api/projects/opc/assets/prj_soa/actions",
- "artifacts": "/api/projects/opc/assets/prj_soa/artifacts",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "has_any": true,
- "total_matching_filter": 1,
- "total_matching_filter_exact": true
}
}Manually uploads an artifact for a specific project, environment or asset - for example, publishing a hand-built hotfix outside of a change.
| data | string JSON-encoded object with code, node_id and optional labels (at most 20, each at most 100 characters and containing no commas) and description (maximum 1000 characters) attributes |
| file | string <binary> the artifact file content |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="data" {"code":"hotfix","node_id":"01a1e72b-aa8a-7d7f-a762-13249ae392da","labels":["hotfix-2026-09-22"],"description":"Hand-built hotfix for the September release"} ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="sample.txt" content-type: text/plain content-length: 21 Sample file property ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "01a1e72b-abff-7902-b43b-123015d7c7d1",
- "type": "artifact",
- "attributes": {
- "code": "hotfix",
- "description": "Hand-built hotfix for the September release",
- "labels": [
- "hotfix-2026-09-22"
], - "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:42:41.406553Z",
- "purged_at": null,
- "byte_size": 21,
- "content_type": "text/plain",
- "filename": "sample.txt"
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-aa8a-7d7f-a762-13249ae392da",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-abff-7902-b43b-123015d7c7d1"
}
}
}Creates an artifact record and returns a signed direct upload target for its content. PUT the file content to meta.upload_url, sending the meta.upload_headers, to complete the upload.
| data | string JSON-encoded object with code, node_id, filename, byte_size, checksum and content_type attributes, and optional labels (at most 20, each at most 100 characters and containing no commas), description (maximum 1000 characters) and step_id attributes |
data=%7B%22code%22%3A%22hotfix%22%2C%22node_id%22%3A%2201a1e72b-adc7-77cd-b547-37bf03ef840d%22%2C%22labels%22%3A%5B%22hotfix-2026-09-22%22%5D%2C%22description%22%3A%22Hand-built+hotfix+for+the+September+release%22%2C%22filename%22%3A%22sample.txt%22%2C%22byte_size%22%3A21%2C%22checksum%22%3A%229V61v4%2FdxeJDNTy0baxWzQ%3D%3D%22%2C%22content_type%22%3A%22text%2Fplain%22%7D
{- "data": {
- "id": "01a1e72b-aea1-7335-8866-c8fca3d3bd17",
- "type": "artifact",
- "attributes": {
- "code": "hotfix",
- "description": "Hand-built hotfix for the September release",
- "labels": [
- "hotfix-2026-09-22"
], - "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:42:42.080608Z",
- "purged_at": null,
- "byte_size": null,
- "content_type": null,
- "filename": null
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-adc7-77cd-b547-37bf03ef840d",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-aea1-7335-8866-c8fca3d3bd17"
}
}, - "meta": {
- "signed_id": "eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBDdz09IiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--51438c092038e81de0c279216dd00b324c18699f",
- "upload_url": "/api/artifact_direct_uploads/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDam9JYTJWNVNTSWhObU5sWjNSdGFucG5kemh6YUdkellXRndiM052TVdSd1pHRTJkQVk2QmtWR09oRmpiMjUwWlc1MFgzUjVjR1ZKSWc5MFpYaDBMM0JzWVdsdUJqc0dWRG9OWTJobFkydHpkVzFKSWgwNVZqWXhkalF2WkhobFNrUk9WSGt3WW1GNFYzcFJQVDBHT3daVU9nNXlaV052Y21SZmFXUkpJaWt3TVdFeFpUY3lZaTFoWldFeExUY3pNelV0T0RnMk5pMWpPR1pqWVROa00ySmtNVGNHT3daVU9oRnpaWEoyYVdObFgyNWhiV1U2R25CdmMzUm5jbVZ6WDJ4aGNtZGxiMkpxWldOMGN3PT0iLCJleHAiOiIyMDI2LTExLTE3VDAxOjQ3OjQyLjA4N1oiLCJwdXIiOiJibG9iX3Rva2VuIn19--46284ea5264ea39773595ce346a98af99134c38b",
- "upload_headers": {
- "Content-Type": "text/plain"
}
}
}Show an artifact.
| artifact_id required | string Example: 01a1e72a-faae-7b91-8578-2409a095a84d artifact id |
{- "data": {
- "id": "01a1e72b-b167-7710-9c07-d5ce653ad410",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Alias et ut expedita.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:42:42.790489Z",
- "purged_at": null,
- "byte_size": 24,
- "content_type": "application/octet-stream",
- "filename": "app.war"
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-b09d-7a53-86bd-01dae4ab88b6",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-b167-7710-9c07-d5ce653ad410"
}
}
}Returns a signed, time-limited URL to download the artifact file content from.
| artifact_id required | string Example: 01a1e72a-faae-7b91-8578-2409a095a84d artifact id |
| step_id | string records an artifact load against this step. Only accepted when the request is authenticated with the API key of the change that owns the step |
{- "meta": {
- "download_url": "/api/artifact_blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWhOMmRuT1hZMGFHb3hNMjFrYjNsME9ETTBPV3BpTVhOamFqbDFiZ1k2QmtWVU9oQmthWE53YjNOcGRHbHZia2tpUFdGMGRHRmphRzFsYm5RN0lHWnBiR1Z1WVcxbFBTSmhjSEF1ZDJGeUlqc2dabWxzWlc1aGJXVXFQVlZVUmkwNEp5ZGhjSEF1ZDJGeUJqc0dWRG9SWTI5dWRHVnVkRjkwZVhCbFNTSWRZWEJ3YkdsallYUnBiMjR2YjJOMFpYUXRjM1J5WldGdEJqc0dWRG9SYzJWeWRtbGpaVjl1WVcxbE9ocHdiM04wWjNKbGMxOXNZWEpuWlc5aWFtVmpkSE09IiwiZXhwIjoiMjAyNi0xMS0xN1QwMTo0Nzo0Ny44NzhaIiwicHVyIjoiYmxvYl9rZXkifX0=--96adfc87deac40ed24534670efbbfbb51a84531e/app.war",
- "download_headers": { }
}
}Returns a signed, time-limited URL to download the newest complete artifact with the supplied code (and labels) from the supplied project, environment or asset.
| node_id | string Example: node_id=01a1e72a-f330-7343-a642-2c7505170dd4 id of the project, environment or asset the artifact belongs to |
| code | string Example: code=war artifact code |
| labels | string Example: labels=v1.2.3 comma-separated labels the artifact must carry - when several are supplied, the artifact must carry all of them |
| step_id | string records an artifact load against this step. Only accepted when the request is authenticated with the API key of the change that owns the step |
{- "meta": {
- "download_url": "/api/artifact_blobs/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaDdDVG9JYTJWNVNTSWhabWRvYUdwa01tTjZjR2syZG14MGJ6RndhR3AxTkhCbk9YUnBjZ1k2QmtWVU9oQmthWE53YjNOcGRHbHZia2tpUFdGMGRHRmphRzFsYm5RN0lHWnBiR1Z1WVcxbFBTSmhjSEF1ZDJGeUlqc2dabWxzWlc1aGJXVXFQVlZVUmkwNEp5ZGhjSEF1ZDJGeUJqc0dWRG9SWTI5dWRHVnVkRjkwZVhCbFNTSWRZWEJ3YkdsallYUnBiMjR2YjJOMFpYUXRjM1J5WldGdEJqc0dWRG9SYzJWeWRtbGpaVjl1WVcxbE9ocHdiM04wWjNKbGMxOXNZWEpuWlc5aWFtVmpkSE09IiwiZXhwIjoiMjAyNi0xMS0xN1QwMTo0Nzo1MS4xMTZaIiwicHVyIjoiYmxvYl9rZXkifX0=--db4c78f0e0c65d1d90f265436cde7e44ab5ce5c4/app.war",
- "download_headers": { }
}
}Streams the file content of the newest complete artifact with the supplied code (and labels) from the supplied project, environment or asset.
| node_id | string Example: node_id=01a1e72a-f330-7343-a642-2c7505170dd4 id of the project, environment or asset the artifact belongs to |
| code | string Example: code=war artifact code |
| labels | string Example: labels=v1.2.3 comma-separated labels the artifact must carry - when several are supplied, the artifact must carry all of them |
<binary data>
Uploads the file content for an artifact created by POST /artifacts/upload_target. This is the meta.upload_url that endpoint returns - the signed id authorises the request, so no further authentication is required. The content must match the declared checksum.
| signed_id required | string the signed id from the |
Streams the artifact file content. This is the meta.download_url returned by the download target endpoints - the signed id authorises the request, so no further authentication is required.
| signed_id required | string the signed id from the |
| filename required | string Example: app.war the artifact filename |
<binary data>
Lists all artifacts for a specific project, environment or asset, newest first by default. Use filter[latest_per_code]=true to list one row per code (the newest complete version, falling back to the newest purged version), each carrying a versions_count attribute. meta.total_matching_filter counts the artifacts matching the filter, stopping at 1000 (or one past the returned page, when the limit is larger) - meta.total_matching_filter_exact reports whether the count is exact.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=war API filtering guide. Named filters: |
| limit | integer >= 1 Example: limit=50 Limit the number of artifacts returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-eaf2-7e3f-9dc2-e9dc945ed8f3",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Molestiae iusto doloremque et.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:42:57.521779Z",
- "purged_at": null,
- "byte_size": 24,
- "content_type": "application/octet-stream",
- "filename": "app.war"
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-ea96-7e86-ba81-7b023a6ec12c",
- "type": "asset"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-eaf2-7e3f-9dc2-e9dc945ed8f3"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "total_matching_filter": 1,
- "total_matching_filter_exact": true
}
}Lists all artifacts for a specific change (the artefacts produced by its steps), newest first by default. Use filter[latest_per_code]=true to list one row per code (the newest complete version, falling back to the newest purged version), each carrying a versions_count attribute. meta.total_matching_filter counts the artifacts matching the filter, stopping at 1000 (or one past the returned page, when the limit is larger) - meta.total_matching_filter_exact reports whether the count is exact.
| change_id required | string Example: 01a1e72a-f8ec-78fe-b4ca-5e5595b30df0 change id |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=war API filtering guide. Named filters: |
| limit | integer >= 1 Example: limit=50 Limit the number of artifacts returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-f66c-7bd0-aed4-d6e2992f1642",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Omnis animi veniam necessitatibus.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:43:00.459619Z",
- "purged_at": null,
- "byte_size": 24,
- "content_type": "application/octet-stream",
- "filename": "app.war"
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-f5a5-769c-9047-3d66d348e3e5",
- "type": "asset"
}
}, - "step": {
- "data": {
- "id": "01a1e72b-f7a4-7e80-a91a-c60f23239099",
- "type": "step"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-f66c-7bd0-aed4-d6e2992f1642"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "total_matching_filter": 1,
- "total_matching_filter_exact": true
}
}Lists all artifacts for a specific step (the artefacts it produced), newest first by default. Use filter[latest_per_code]=true to list one row per code (the newest complete version, falling back to the newest purged version), each carrying a versions_count attribute. meta.total_matching_filter counts the artifacts matching the filter, stopping at 1000 (or one past the returned page, when the limit is larger) - meta.total_matching_filter_exact reports whether the count is exact.
| step_id required | string Example: 01a1e72a-f98c-73b4-93d3-76233e836c5c step id |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=war API filtering guide. Named filters: |
| limit | integer >= 1 Example: limit=50 Limit the number of artifacts returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e72b-ffb7-7452-b757-f78772a59e5d",
- "type": "artifact",
- "attributes": {
- "code": "war",
- "description": "Sunt veniam praesentium totam.",
- "labels": [
- "v1.2.3"
], - "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:43:02.838449Z",
- "purged_at": null,
- "byte_size": 24,
- "content_type": "application/octet-stream",
- "filename": "app.war"
}, - "relationships": {
- "node": {
- "data": {
- "id": "01a1e72b-ff62-73bd-9ba6-f5c42f87f95a",
- "type": "asset"
}
}, - "step": {
- "data": {
- "id": "01a1e72c-0019-7c1f-9d72-4048bb1c24de",
- "type": "step"
}
}
}, - "links": {
- "self": "/api/artifacts/01a1e72b-ffb7-7452-b757-f78772a59e5d"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "total_matching_filter": 1,
- "total_matching_filter_exact": true
}
}Endpoints to interact with workflow runs
Notes:
/workflow_runs - will return all workflow runs accessible to the user./project/{project_code}/workflow_runs - will return all workflow runs for all this project's workflows./project/{project_code}/workflows/{workflow_code}/workflow_runs - will return all workflow runs this workflow./<path/to/asset>/workflow_runs - will return all workflow runs that include a change for this asset.Lists all workflow runs.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[created_by_cont]=opschain API filtering guide. Named filters: |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of workflow runs returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e733-07a2-70df-b475-83f3640163f1",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-07b9-7465-a5c2-7127984b5a4f",
- "name": "consectetur",
- "type": "workflow_noop_step",
- "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Tin": "0.7.4",
- "Bamity": "0.9.2",
- "Sonair": "0.66",
- "Y-find": "1.7.7",
- "Fintone": "3.2",
- "Pannier": "3.49",
- "Domainer": "8.1.6",
- "Overhold": "0.9.9",
- "Voyatouch": "9.7",
- "Stringtough": "0.4.1"
}, - "created_by": "daryl_feeney-4091",
- "created_by_name": "daryl_feeney-4091",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:50:43.616480Z",
- "started_at": "2026-11-17T01:42:56.253071Z",
- "finished_at": "2026-11-17T01:47:05.978901Z",
- "updated_at": "2026-11-17T01:50:43.659518Z",
- "paused_at": null,
- "project_name": "nemo1345",
- "workflow_code": "child"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-0746-7e6a-bec1-70e050c57c10",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-06f7-7605-945d-0c6f86ea854b",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": {
- "id": "01a1e733-07dd-749c-88c0-ca7b078e3a8e",
- "type": "workflow_workflow_step"
}
}, - "root_step": {
- "data": {
- "id": "01a1e733-07b9-7465-a5c2-7127984b5a4f",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-07b9-7465-a5c2-7127984b5a4f",
- "type": "workflow_noop_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-07a9-748a-be0a-56cca2296ed8",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-07a9-748a-be0a-56cca2296ed8"
}
}
}, - "links": {
- "parent": "/api/projects/bgmtj",
- "self": "/api/projects/bgmtj/workflows/child/runs/01a1e733-07a2-70df-b475-83f3640163f1",
- "log_lines": "/api/workflow_runs/01a1e733-07a2-70df-b475-83f3640163f1/log_lines"
}, - "meta": { }
}, - {
- "id": "01a1e733-01e7-7be7-a6b3-1d99b2d33a38",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-01f1-7b61-a16d-589e98cd272e",
- "name": "quis",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-0200-70f7-96f5-9505f8b04367",
- "name": "laborum",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-038a-7526-87e9-33ebea0c5c24",
- "name": "reboot",
- "type": "workflow_change_step",
- "action": "reboot",
- "target": "/projects/tkzrf/environments/dgtjk/assets/pkjxs"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "01a1e733-052a-7b4b-a76b-69ad8258ae44",
- "name": "bypass",
- "type": "workflow_change_step",
- "action": "bypass",
- "target": "/projects/jphew/environments/rm3hx/assets/wpmi6"
}, - {
- "id": "01a1e733-0560-7636-bd51-ff0a12f215f8",
- "name": "Approval",
- "type": "workflow_wait_step",
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}
}, - {
- "id": "01a1e733-07dd-749c-88c0-ca7b078e3a8e",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/bgmtj/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Span": "9.28",
- "Viva": "3.31",
- "Latlux": "0.18",
- "Zoolab": "0.8.2",
- "Bitchip": "4.1.7",
- "Cookley": "4.8",
- "Veribet": "1.0",
- "Gembucket": "6.4.8",
- "Solarbreeze": "0.29",
- "Toughjoyfax": "7.3.7"
}, - "created_by": "emmie-4074",
- "created_by_name": "emmie-4074",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:50:42.150586Z",
- "started_at": "2026-11-17T01:44:51.962004Z",
- "finished_at": "2026-11-17T01:45:01.588575Z",
- "updated_at": "2026-11-17T01:50:42.166393Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-0152-7fbc-8e94-7b9d49144783",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-0133-7e4b-849f-b7d47a7acd33",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e733-01f1-7b61-a16d-589e98cd272e",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-01f1-7b61-a16d-589e98cd272e",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-0200-70f7-96f5-9505f8b04367",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-052a-7b4b-a76b-69ad8258ae44",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e733-0560-7636-bd51-ff0a12f215f8",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e733-07dd-749c-88c0-ca7b078e3a8e",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e733-038a-7526-87e9-33ebea0c5c24",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-01d1-7545-8d73-8c463d977931",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-01d1-7545-8d73-8c463d977931"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-01e7-7be7-a6b3-1d99b2d33a38",
- "log_lines": "/api/workflow_runs/01a1e733-01e7-7be7-a6b3-1d99b2d33a38/log_lines"
}, - "meta": { }
}
], - "included": [
- {
- "id": "01a1e733-0746-7e6a-bec1-70e050c57c10",
- "type": "workflow_version",
- "attributes": {
- "code": "child",
- "name": "child workflow",
- "description": "child workflow",
- "draft": false,
- "archived": false,
- "created_by": "quinn.schoen-4090",
- "created_by_name": "quinn.schoen-4090",
- "created_at": "2026-11-17T01:50:43.319342Z",
- "updated_at": "2026-11-17T01:50:43.319373Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run child action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run child action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 1
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e733-05f2-791d-915f-c43f1d52afc5",
- "type": "project"
}, - "links": {
- "related": "/api/projects/bgmtj"
}
}
}, - "links": {
- "self": "/api/projects/bgmtj/workflows/child/versions/1",
- "runs": "/api/projects/bgmtj/workflows/child/versions/1/runs",
- "workflow": "/api/projects/bgmtj/workflows/child"
}
}, - {
- "id": "01a1e733-0152-7fbc-8e94-7b9d49144783",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "luanne-4072",
- "created_by_name": "luanne-4072",
- "created_at": "2026-11-17T01:50:42.002016Z",
- "updated_at": "2026-11-17T01:50:42.027570Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e732-fc98-76a7-ab77-e46ab32254c3",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true,
- "execute": true
}, - "partial_response": false
}
}Runs a pre-defined workflow.
Supplying the retry attribute (together with a workflow_run relationship) retries an existing workflow run that
finished in an error, cancelled or aborted state instead of running a workflow from scratch. The retry creates a
new workflow run; the original workflow run is left untouched.
required | object |
{- "data": {
- "attributes": {
- "project_code": "opc",
- "workflow_code": "assets"
}
}
}{- "data": {
- "id": "01a1e733-1df9-77e3-bf74-0524a039cf19",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-1e0c-75f3-89d8-ba05e95b52f0",
- "name": "assets workflow",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-1e1c-77ab-9606-15c01d6552e3",
- "name": "run asset action",
- "type": "workflow_change_step",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": { },
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "pending",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:50:49.336372Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:50:49.361784Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-0ede-7950-b80c-868330b3697d",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-0ebb-7ed7-b2ef-377ce04124ef",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e733-1e0c-75f3-89d8-ba05e95b52f0",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-1e0c-75f3-89d8-ba05e95b52f0",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-1e1c-77ab-9606-15c01d6552e3",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-1dfd-76b5-9d1c-d77e6e3d07c5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-1dfd-76b5-9d1c-d77e6e3d07c5"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19",
- "log_lines": "/api/workflow_runs/01a1e733-1df9-77e3-bf74-0524a039cf19/log_lines",
- "pause": "/api/workflow_runs/01a1e733-1df9-77e3-bf74-0524a039cf19/pause"
}, - "meta": { }
}, - "included": [
- {
- "id": "01a1e733-0ede-7950-b80c-868330b3697d",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "moises.moen-4100",
- "created_by_name": "moises.moen-4100",
- "created_at": "2026-11-17T01:50:45.469551Z",
- "updated_at": "2026-11-17T01:50:45.499446Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa",
- "source": "steps/1",
- "change_parent": {
- "id": "01a1e733-0d7b-7acf-8be6-bd356804d5e4",
- "path": "/projects/opc/assets/prj_soa",
- "parent_path": "/projects/opc",
- "project_id": "01a1e733-0a78-70f2-b590-f3c4291b9d06",
- "node_type": "asset",
- "parent_id": "01a1e733-0a78-70f2-b590-f3c4291b9d06",
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_at": "2026-11-17T01:50:45.114Z",
- "updated_at": "2026-11-17T01:50:45.114Z",
- "template_version_id": "01a1e733-0bbb-7bc7-824e-e8f37a679c83",
- "created_by_id": "01a1e733-0c2d-7769-ad37-d63d7da47be2",
- "settings_generation": 1
}, - "action_template_version": {
- "id": "01a1e733-0bbb-7bc7-824e-e8f37a679c83",
- "commit_id": "01a1e733-0b91-7578-a189-bbb6c866e554",
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "created_at": "2026-11-17T01:50:44.666Z",
- "updated_at": "2026-11-17T01:50:44.666Z",
- "state": "ready",
- "archived": false,
- "has_mintmodel": true,
- "template_id": "01a1e733-0b0a-7920-a780-151692dd538b",
- "locked": false,
- "pending_commit_id": null,
- "float_git_rev": false,
- "created_by_id": "01a1e733-0ba8-7d88-9a66-747e06009a52"
}
}
], - "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e733-0a78-70f2-b590-f3c4291b9d06",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "01a1e733-1e0c-75f3-89d8-ba05e95b52f0",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "name": "assets workflow",
- "step_sequence": 1,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:50:49.353966Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:50:49.361784Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e733-1df9-77e3-bf74-0524a039cf19",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e733-1e1c-77ab-9606-15c01d6552e3",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19/steps/01a1e733-1e0c-75f3-89d8-ba05e95b52f0",
- "log_lines": "/api/workflow_steps/01a1e733-1e0c-75f3-89d8-ba05e95b52f0/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19"
}
}, - {
- "id": "01a1e733-1e1c-77ab-9606-15c01d6552e3",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "name": "run asset action",
- "step_sequence": 1,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:50:49.369508Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:50:49.379512Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "run",
- "property_overrides": { }
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "01a1e733-0d7b-7acf-8be6-bd356804d5e4",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e733-0bbb-7bc7-824e-e8f37a679c83",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e733-1df9-77e3-bf74-0524a039cf19",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19/steps/01a1e733-1e1c-77ab-9606-15c01d6552e3",
- "log_lines": "/api/workflow_steps/01a1e733-1e1c-77ab-9606-15c01d6552e3/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19/steps/01a1e733-1e0c-75f3-89d8-ba05e95b52f0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-1df9-77e3-bf74-0524a039cf19"
}
}
]
}Shows a workflow run.
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
{- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "name": "vel",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-58e1-7107-a84b-1b0fa3beb575",
- "name": "voluptates",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-5d65-7abc-8987-4d0841d50f5f",
- "name": "reboot",
- "type": "workflow_change_step",
- "action": "reboot",
- "target": "/projects/cyjm9/environments/eiy1o/assets/ubpzz"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "01a1e733-6023-7a2e-b566-300b24e39696",
- "name": "program",
- "type": "workflow_change_step",
- "action": "program",
- "target": "/projects/joo9l/environments/w9h03/assets/pwiwz"
}, - {
- "id": "01a1e733-6040-7849-8d58-a85e7b2ed58b",
- "name": "Approval",
- "type": "workflow_wait_step",
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}
}, - {
- "id": "01a1e733-616e-7b8d-a62c-512ebbe7984d",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/vftgv/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Span": "2.5.7",
- "Tresom": "3.8.3",
- "Zoolab": "3.07",
- "Veribet": "0.41",
- "Domainer": "7.76",
- "Tempsoft": "6.1",
- "Daltfresh": "2.79",
- "Lotstring": "0.37",
- "Trippledex": "0.85",
- "Voltsillam": "8.9"
}, - "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:51:04.332051Z",
- "started_at": "2026-11-17T01:41:17.891227Z",
- "finished_at": "2026-11-17T01:47:16.201336Z",
- "updated_at": "2026-11-17T01:51:04.386281Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-5758-77b5-bbfa-c6e698617a90",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-572c-7b57-96a3-6715fee036dc",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-58e1-7107-a84b-1b0fa3beb575",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-6023-7a2e-b566-300b24e39696",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e733-6040-7849-8d58-a85e7b2ed58b",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e733-616e-7b8d-a62c-512ebbe7984d",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e733-5d65-7abc-8987-4d0841d50f5f",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-585f-795c-aa93-42dc4294030d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-585f-795c-aa93-42dc4294030d"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a",
- "log_lines": "/api/workflow_runs/01a1e733-5891-7362-9a9f-538a6150200a/log_lines"
}, - "meta": {
- "wait_queue": [ ],
- "blocking_queue": [ ],
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}, - "included": [
- {
- "id": "01a1e733-5758-77b5-bbfa-c6e698617a90",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "so-4244",
- "created_by_name": "so-4244",
- "created_at": "2026-11-17T01:51:04.023330Z",
- "updated_at": "2026-11-17T01:51:04.086218Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e733-559c-718b-92f9-9c8dc19c2533",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "name": "vel",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:51:04.364257Z",
- "started_at": "2026-11-17T01:41:17.891227Z",
- "finished_at": "2026-11-17T01:47:16.201336Z",
- "updated_at": "2026-11-17T01:51:04.386281Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e733-58e1-7107-a84b-1b0fa3beb575",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-6023-7a2e-b566-300b24e39696",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e733-6040-7849-8d58-a85e7b2ed58b",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e733-616e-7b8d-a62c-512ebbe7984d",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "log_lines": "/api/workflow_steps/01a1e733-58b2-70ad-be1c-813e4f0419a6/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a"
}
}, - {
- "id": "01a1e733-58e1-7107-a84b-1b0fa3beb575",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "name": "voluptates",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:44:42.921389Z",
- "started_at": "2026-11-17T01:45:42.921389Z",
- "finished_at": "2026-11-17T01:49:54.291130Z",
- "updated_at": "2026-11-17T01:51:05.499989Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e733-5d65-7abc-8987-4d0841d50f5f",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58e1-7107-a84b-1b0fa3beb575",
- "log_lines": "/api/workflow_steps/01a1e733-58e1-7107-a84b-1b0fa3beb575/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a"
}
}, - {
- "id": "01a1e733-6023-7a2e-b566-300b24e39696",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "name": "program",
- "step_sequence": 2,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:41:13.323860Z",
- "started_at": "2026-11-17T01:42:13.323860Z",
- "finished_at": "2026-11-17T01:43:28.018958Z",
- "updated_at": "2026-11-17T01:51:06.280442Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "program",
- "property_overrides": {
- "monitor": "programming"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e733-5ffb-7dfd-aa5d-b7b7d7067b9a",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e733-5f71-7ab7-8144-951923b78a4b",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e733-5f2d-78cf-a5e0-c9641879cd9c",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-6023-7a2e-b566-300b24e39696",
- "log_lines": "/api/workflow_steps/01a1e733-6023-7a2e-b566-300b24e39696/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a"
}
}, - {
- "id": "01a1e733-6040-7849-8d58-a85e7b2ed58b",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}, - "lock_version": 1,
- "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "name": "Approval",
- "step_sequence": 3,
- "status_code": "approved",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:40:39.231941Z",
- "started_at": "2026-11-17T01:41:39.231941Z",
- "finished_at": "2026-11-17T01:47:21.585580Z",
- "updated_at": "2026-11-17T01:51:06.309965Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-6040-7849-8d58-a85e7b2ed58b",
- "log_lines": "/api/workflow_steps/01a1e733-6040-7849-8d58-a85e7b2ed58b/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a"
}
}, - {
- "id": "01a1e733-616e-7b8d-a62c-512ebbe7984d",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "name": "child workflow",
- "step_sequence": 4,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:43:35.413663Z",
- "started_at": "2026-11-17T01:44:35.413663Z",
- "finished_at": "2026-11-17T01:46:31.798763Z",
- "updated_at": "2026-11-17T01:51:06.613577Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "01a1e733-60ff-731f-b18e-bbc185af5af0",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": {
- "id": "01a1e733-6151-770d-8c9d-eeb3a88244b7",
- "type": "workflow_run"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-616e-7b8d-a62c-512ebbe7984d",
- "log_lines": "/api/workflow_steps/01a1e733-616e-7b8d-a62c-512ebbe7984d/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58b2-70ad-be1c-813e4f0419a6",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a"
}
}, - {
- "id": "01a1e733-5d65-7abc-8987-4d0841d50f5f",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "waylon.daugherty-4246",
- "created_by_name": "waylon.daugherty-4246",
- "name": "reboot",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:44:08.413469Z",
- "started_at": "2026-11-17T01:45:08.413469Z",
- "finished_at": "2026-11-17T01:48:03.625201Z",
- "updated_at": "2026-11-17T01:51:05.578564Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "reboot",
- "property_overrides": {
- "driver": "quantifying"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e733-5d3f-779e-872a-093178fb52c6",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e733-5cb8-7225-87d2-4e6cb840ee94",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e733-5bea-7d4a-a65f-ae00d32b115a",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e733-5891-7362-9a9f-538a6150200a",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-5d65-7abc-8987-4d0841d50f5f",
- "log_lines": "/api/workflow_steps/01a1e733-5d65-7abc-8987-4d0841d50f5f/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a/steps/01a1e733-58e1-7107-a84b-1b0fa3beb575",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e733-5891-7362-9a9f-538a6150200a"
}
}
]
}Cancels a workflow run.
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to cancel the workflow run",
- "detail": "Your authorisation rules let you view the workflow run but not cancel it."
}
]
}Pauses a running workflow run. Steps already running finish, but no further steps are dispatched until the run is resumed.
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
object |
{- "data": {
- "attributes": {
- "reason": "Holding this run until the database maintenance window closes"
}
}
}{- "data": {
- "id": "01a1e733-969b-74c1-8772-3224f75fd457",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-96a5-7d29-a708-8a6bc31df8e6",
- "name": "itaque",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-96b5-7afc-9ebc-c99df8fc48df",
- "name": "quo",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-985f-701f-8a2f-444910c89bd7",
- "name": "override",
- "type": "workflow_change_step",
- "action": "override",
- "target": "/projects/4xcoh/environments/gxy9c/assets/cyd0o"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "01a1e733-9a1d-7897-891c-3a872c7aba90",
- "name": "navigate",
- "type": "workflow_change_step",
- "action": "navigate",
- "target": "/projects/9klhi/environments/o5ozp/assets/qopko"
}, - {
- "id": "01a1e733-9a2d-7c59-af0c-0cc4a453071a",
- "name": "Approval",
- "type": "workflow_wait_step",
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}
}, - {
- "id": "01a1e733-9ad6-77f8-ad5f-6d41d16202e0",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/1lmf0/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Viva": "1.06",
- "Biodex": "0.60",
- "Duobam": "0.7.2",
- "Kanlam": "4.40",
- "Lotlux": "1.15",
- "Y-find": "0.43",
- "Fixflex": "0.5.8",
- "Prodder": "4.64",
- "Tempsoft": "5.1",
- "Ronstring": "0.2.1"
}, - "created_by": "numbers.spencer-4378",
- "created_by_name": "numbers.spencer-4378",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "paused",
- "status_code": "running",
- "paused": true,
- "cancel_requested": false,
- "paused_by": [
- {
- "username": "logged_in_user",
- "action": "pause",
- "message": "Holding this run until the database maintenance window closes",
- "date": "2026-11-17T01:51:21.402275Z"
}
], - "created_at": "2026-11-17T01:51:20.218105Z",
- "started_at": "2026-11-17T01:44:09.257540Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:51:20.235553Z",
- "paused_at": "2026-11-17T01:51:21.386622Z",
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-9633-7bb7-9db5-4e1d45c035c5",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-9614-7953-9c5e-d42c5298d8cd",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e733-96a5-7d29-a708-8a6bc31df8e6",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-96a5-7d29-a708-8a6bc31df8e6",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-96b5-7afc-9ebc-c99df8fc48df",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-9a1d-7897-891c-3a872c7aba90",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e733-9a2d-7c59-af0c-0cc4a453071a",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e733-9ad6-77f8-ad5f-6d41d16202e0",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e733-985f-701f-8a2f-444910c89bd7",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-9683-7a5b-8cf7-e6b7529bb75a",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-9683-7a5b-8cf7-e6b7529bb75a"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-969b-74c1-8772-3224f75fd457",
- "log_lines": "/api/workflow_runs/01a1e733-969b-74c1-8772-3224f75fd457/log_lines",
- "resume": "/api/workflow_runs/01a1e733-969b-74c1-8772-3224f75fd457/resume"
}, - "meta": { }
}
}Resumes a paused workflow run, dispatching the steps that were held while it was paused.
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
object |
{- "data": {
- "attributes": {
- "reason": "Maintenance window closed"
}
}
}{- "data": {
- "id": "01a1e733-c7c3-7f87-b51d-27002c97fd3c",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-c7cf-70d6-ae08-36113965ab53",
- "name": "quis",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-c7f4-7095-b631-be773cc9505d",
- "name": "dicta",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-c9bf-741b-b697-da99f23593a2",
- "name": "navigate",
- "type": "workflow_change_step",
- "action": "navigate",
- "target": "/projects/iofik/environments/unwez/assets/wwb5b"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "01a1e733-cb80-7d6b-8746-01d4f7bbc939",
- "name": "hack",
- "type": "workflow_change_step",
- "action": "hack",
- "target": "/projects/e68ri/environments/xhgr2/assets/kjcth"
}, - {
- "id": "01a1e733-cb98-78f8-8f56-4d4582d81fb1",
- "name": "Approval",
- "type": "workflow_wait_step",
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}
}, - {
- "id": "01a1e733-cc65-79f1-a44d-6e5923dbc6a6",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/vutm9/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "It": "0.1.8",
- "Temp": "9.0.5",
- "Otcom": "0.1.1",
- "Hatity": "6.03",
- "Sonair": "2.6.1",
- "Bytecard": "3.38",
- "Tampflex": "3.0",
- "Lotstring": "3.71",
- "Ronstring": "2.1",
- "Solarbreeze": "1.7.1"
}, - "created_by": "kayce-4482",
- "created_by_name": "kayce-4482",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "running",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [
- {
- "username": "logged_in_user",
- "action": "resume",
- "message": "Maintenance window closed",
- "date": "2026-11-17T01:51:34.145217Z"
}
], - "created_at": "2026-11-17T01:51:32.802541Z",
- "started_at": "2026-11-17T01:43:14.769103Z",
- "finished_at": null,
- "updated_at": "2026-11-17T01:51:32.820683Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-c6d0-71a4-b17f-548d14ebb1bf",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-c69c-7dc9-b6e7-1813e8251854",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e733-c7cf-70d6-ae08-36113965ab53",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-c7cf-70d6-ae08-36113965ab53",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-c7f4-7095-b631-be773cc9505d",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-cb80-7d6b-8746-01d4f7bbc939",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e733-cb98-78f8-8f56-4d4582d81fb1",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e733-cc65-79f1-a44d-6e5923dbc6a6",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e733-c9bf-741b-b697-da99f23593a2",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-c7a5-727e-8fae-33dc9d358a7e",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-c7a5-727e-8fae-33dc9d358a7e"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-c7c3-7f87-b51d-27002c97fd3c",
- "log_lines": "/api/workflow_runs/01a1e733-c7c3-7f87-b51d-27002c97fd3c/log_lines",
- "pause": "/api/workflow_runs/01a1e733-c7c3-7f87-b51d-27002c97fd3c/pause"
}, - "meta": { }
}
}Lists all runs for a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[created_by_cont]=opschain API filtering guide. Named filters: |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=50 Limit the number of workflow runs returned. When more records match than the limit a 206 response is returned and |
{- "data": [
- {
- "id": "01a1e733-f495-7a9c-8db3-47daccb79f25",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e733-f4a0-7b2c-954c-0187a43ddaf6",
- "name": "perferendis",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-f4b0-71df-b627-b73fcd6b1a23",
- "name": "et",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e733-f688-768f-ac83-1bf0f11d2574",
- "name": "calculate",
- "type": "workflow_change_step",
- "action": "calculate",
- "target": "/projects/5timc/environments/jdwck/assets/0jtnh"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "01a1e733-f811-7477-9429-26d45df2550f",
- "name": "quantify",
- "type": "workflow_change_step",
- "action": "quantify",
- "target": "/projects/tpdhf/environments/wsip0/assets/crgce"
}, - {
- "id": "01a1e733-f825-79ae-8ea5-fdf59a99f8fd",
- "name": "Approval",
- "type": "workflow_wait_step",
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}
}, - {
- "id": "01a1e733-f915-7cdf-be8d-c15afb4d2762",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/dtr0w/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Temp": "1.2",
- "Bamity": "7.06",
- "Andalax": "0.16",
- "Veribet": "9.7",
- "Bytecard": "8.2.3",
- "Home Ing": "8.56",
- "Tres-Zap": "1.0.7",
- "Wrapsafe": "6.5.7",
- "Gembucket": "9.9",
- "Stronghold": "1.9"
}, - "created_by": "lucilla.robel-4582",
- "created_by_name": "lucilla.robel-4582",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:51:44.276226Z",
- "started_at": "2026-11-17T01:42:59.395510Z",
- "finished_at": "2026-11-17T01:46:31.732039Z",
- "updated_at": "2026-11-17T01:51:44.293212Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-f411-7eed-ae76-258d076a583c",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-f3ea-722f-9aa9-d5568c046afe",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e733-f4a0-7b2c-954c-0187a43ddaf6",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e733-f4a0-7b2c-954c-0187a43ddaf6",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-f4b0-71df-b627-b73fcd6b1a23",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e733-f811-7477-9429-26d45df2550f",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e733-f825-79ae-8ea5-fdf59a99f8fd",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e733-f915-7cdf-be8d-c15afb4d2762",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e733-f688-768f-ac83-1bf0f11d2574",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e733-f47d-7655-a430-5fee21146aab",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e733-f47d-7655-a430-5fee21146aab"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e733-f495-7a9c-8db3-47daccb79f25",
- "log_lines": "/api/workflow_runs/01a1e733-f495-7a9c-8db3-47daccb79f25/log_lines"
}, - "meta": { }
}
], - "included": [
- {
- "id": "01a1e733-f411-7eed-ae76-258d076a583c",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "eustolia.ebert-4580",
- "created_by_name": "eustolia.ebert-4580",
- "created_at": "2026-11-17T01:51:44.144908Z",
- "updated_at": "2026-11-17T01:51:44.178849Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e733-f241-7358-94df-7392535c4a50",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true,
- "execute": true
}, - "partial_response": false
}
}Runs a pre-defined workflow
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
required | object |
{- "data": {
- "attributes": {
- "version": 2,
- "property_overrides": {
- "additional": "properties"
}, - "metadata": {
- "optional": "metadata"
}, - "notify": {
- "user_ids": [
- "01a1e72a-ed50-7440-a463-7b36d183d36e"
], - "ldap_groups": [
- "ldap_group_name"
], - "email_addresses": [
- "limepoint@opschain.com"
], - "events": "cancel"
}, - "skip_steps": [
- "steps/to/skip/**"
]
}
}
}{- "data": {
- "id": "01a1e734-0501-717a-864d-1f9bead08247",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e734-0520-7385-9ae9-9c4aec6fab29",
- "name": "assets workflow",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e734-052b-7397-88eb-c3f82a3becf7",
- "name": "run asset action",
- "type": "workflow_change_step",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": { },
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "pending",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:51:48.480059Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:51:48.517075Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e733-fdab-7486-a245-97c3b590fa43",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e733-fd83-718a-affa-06ce0bb8fbda",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e734-0520-7385-9ae9-9c4aec6fab29",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e734-0520-7385-9ae9-9c4aec6fab29",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e734-052b-7397-88eb-c3f82a3becf7",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e734-0506-74c5-a66b-423c6272e631",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e734-0506-74c5-a66b-423c6272e631"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247",
- "log_lines": "/api/workflow_runs/01a1e734-0501-717a-864d-1f9bead08247/log_lines",
- "pause": "/api/workflow_runs/01a1e734-0501-717a-864d-1f9bead08247/pause"
}, - "meta": { }
}, - "included": [
- {
- "id": "01a1e733-fdab-7486-a245-97c3b590fa43",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "roland.zulauf-4608",
- "created_by_name": "roland.zulauf-4608",
- "created_at": "2026-11-17T01:51:46.602315Z",
- "updated_at": "2026-11-17T01:51:46.636473Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa",
- "source": "steps/1",
- "change_parent": {
- "id": "01a1e733-fb7a-7a27-bf3b-fd851cf30087",
- "path": "/projects/opc/assets/prj_soa",
- "parent_path": "/projects/opc",
- "project_id": "01a1e733-fa99-71ea-9061-244788a182ee",
- "node_type": "asset",
- "parent_id": "01a1e733-fa99-71ea-9061-244788a182ee",
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_at": "2026-11-17T01:51:46.041Z",
- "updated_at": "2026-11-17T01:51:46.041Z",
- "template_version_id": "01a1e733-fb35-78f4-b59f-cb278b23c10a",
- "created_by_id": "01a1e733-fb5e-79dc-8358-92f2d502fb36",
- "settings_generation": 1
}, - "action_template_version": {
- "id": "01a1e733-fb35-78f4-b59f-cb278b23c10a",
- "commit_id": "01a1e733-fb21-76a2-994d-bed57acfa54c",
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "created_at": "2026-11-17T01:51:45.972Z",
- "updated_at": "2026-11-17T01:51:45.972Z",
- "state": "ready",
- "archived": false,
- "has_mintmodel": true,
- "template_id": "01a1e733-faf4-7dbb-b9bf-3b3bcdf44772",
- "locked": false,
- "pending_commit_id": null,
- "float_git_rev": false,
- "created_by_id": "01a1e733-fb29-73e7-b05e-169dd28aece7"
}
}
], - "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e733-fa99-71ea-9061-244788a182ee",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "01a1e734-0520-7385-9ae9-9c4aec6fab29",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "name": "assets workflow",
- "step_sequence": 1,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:51:48.510623Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:51:48.517075Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-0501-717a-864d-1f9bead08247",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e734-052b-7397-88eb-c3f82a3becf7",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247/steps/01a1e734-0520-7385-9ae9-9c4aec6fab29",
- "log_lines": "/api/workflow_steps/01a1e734-0520-7385-9ae9-9c4aec6fab29/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247"
}
}, - {
- "id": "01a1e734-052b-7397-88eb-c3f82a3becf7",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "name": "run asset action",
- "step_sequence": 1,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:51:48.521558Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:51:48.530246Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "run",
- "property_overrides": { }
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "01a1e733-fb7a-7a27-bf3b-fd851cf30087",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e733-fb35-78f4-b59f-cb278b23c10a",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-0501-717a-864d-1f9bead08247",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247/steps/01a1e734-052b-7397-88eb-c3f82a3becf7",
- "log_lines": "/api/workflow_steps/01a1e734-052b-7397-88eb-c3f82a3becf7/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247/steps/01a1e734-0520-7385-9ae9-9c4aec6fab29",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-0501-717a-864d-1f9bead08247"
}
}
]
}Shows a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
{- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "name": "voluptas",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e734-2c65-7e27-9f34-7115aaabedbe",
- "name": "maiores",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "01a1e734-2f69-76b9-81d8-160ff893e5cf",
- "name": "program",
- "type": "workflow_change_step",
- "action": "program",
- "target": "/projects/av4wg/environments/ogqeu/assets/jdm11"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "01a1e734-328c-7725-9cff-4c202108aca7",
- "name": "index",
- "type": "workflow_change_step",
- "action": "index",
- "target": "/projects/5hnbp/environments/dmddh/assets/i2htp"
}, - {
- "id": "01a1e734-32a4-7a45-b47c-fe54089df7fb",
- "name": "Approval",
- "type": "workflow_wait_step",
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}
}, - {
- "id": "01a1e734-33f1-7d33-900c-0bada589d42f",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/zghui/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Opela": "0.2.8",
- "Regrant": "0.6.4",
- "Sonsing": "0.2.8",
- "Zontrax": "6.6.3",
- "Bytecard": "3.5",
- "Greenlam": "0.49",
- "Home Ing": "0.7.9",
- "Daltfresh": "7.6"
}, - "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "cancelled_by": null,
- "notify": { },
- "skip_steps": [ ],
- "pause_state": "none",
- "status_code": "success",
- "paused": false,
- "cancel_requested": false,
- "paused_by": [ ],
- "created_at": "2026-11-17T01:51:58.535607Z",
- "started_at": "2026-11-17T01:45:56.560079Z",
- "finished_at": "2026-11-17T01:47:41.664552Z",
- "updated_at": "2026-11-17T01:51:58.556468Z",
- "paused_at": null,
- "project_name": "OpsChain",
- "workflow_code": "assets"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "01a1e734-2bdd-7909-ac77-66520c7244ed",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "01a1e734-2bb1-712a-b19a-2e0aa169d743",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e734-2c65-7e27-9f34-7115aaabedbe",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e734-328c-7725-9cff-4c202108aca7",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e734-32a4-7a45-b47c-fe54089df7fb",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e734-33f1-7d33-900c-0bada589d42f",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e734-2f69-76b9-81d8-160ff893e5cf",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "01a1e734-2c33-74f1-b728-e29c814f50ca",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e734-2c33-74f1-b728-e29c814f50ca"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "log_lines": "/api/workflow_runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/log_lines"
}, - "meta": {
- "wait_queue": [ ],
- "blocking_queue": [ ],
- "authorisations": {
- "execute": true,
- "delete": true
}
}
}, - "included": [
- {
- "id": "01a1e734-2bdd-7909-ac77-66520c7244ed",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "paz-4724",
- "created_by_name": "paz-4724",
- "created_at": "2026-11-17T01:51:58.428610Z",
- "updated_at": "2026-11-17T01:51:58.454973Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": null
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "01a1e734-2a72-7a2c-a58e-69e42b8c14c4",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "name": "voluptas",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:51:58.546659Z",
- "started_at": "2026-11-17T01:45:56.560079Z",
- "finished_at": "2026-11-17T01:47:41.664552Z",
- "updated_at": "2026-11-17T01:51:58.556468Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e734-2c65-7e27-9f34-7115aaabedbe",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e734-328c-7725-9cff-4c202108aca7",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e734-32a4-7a45-b47c-fe54089df7fb",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e734-33f1-7d33-900c-0bada589d42f",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "log_lines": "/api/workflow_steps/01a1e734-2c55-719e-a9cd-ec92c6d8c1db/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8"
}
}, - {
- "id": "01a1e734-2c65-7e27-9f34-7115aaabedbe",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "name": "maiores",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:45:41.367401Z",
- "started_at": "2026-11-17T01:46:41.367401Z",
- "finished_at": "2026-11-17T01:47:24.678606Z",
- "updated_at": "2026-11-17T01:51:59.047449Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e734-2f69-76b9-81d8-160ff893e5cf",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c65-7e27-9f34-7115aaabedbe",
- "log_lines": "/api/workflow_steps/01a1e734-2c65-7e27-9f34-7115aaabedbe/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8"
}
}, - {
- "id": "01a1e734-328c-7725-9cff-4c202108aca7",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "name": "index",
- "step_sequence": 2,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:41:01.967644Z",
- "started_at": "2026-11-17T01:42:01.967644Z",
- "finished_at": "2026-11-17T01:42:37.377212Z",
- "updated_at": "2026-11-17T01:52:00.145283Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "index",
- "property_overrides": {
- "bus": "hacking"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e734-3268-7c8b-8955-9aca31630c0a",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e734-31ff-7ea9-ab59-2b66729df72f",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e734-3169-75df-8684-42ec0678faef",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-328c-7725-9cff-4c202108aca7",
- "log_lines": "/api/workflow_steps/01a1e734-328c-7725-9cff-4c202108aca7/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8"
}
}, - {
- "id": "01a1e734-32a4-7a45-b47c-fe54089df7fb",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}, - "lock_version": 1,
- "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "name": "Approval",
- "step_sequence": 3,
- "status_code": "approved",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:10.220949Z",
- "started_at": "2026-11-17T01:43:10.220949Z",
- "finished_at": "2026-11-17T01:46:04.286729Z",
- "updated_at": "2026-11-17T01:52:00.169059Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-32a4-7a45-b47c-fe54089df7fb",
- "log_lines": "/api/workflow_steps/01a1e734-32a4-7a45-b47c-fe54089df7fb/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8"
}
}, - {
- "id": "01a1e734-33f1-7d33-900c-0bada589d42f",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "name": "child workflow",
- "step_sequence": 4,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:43:16.656104Z",
- "started_at": "2026-11-17T01:44:16.656104Z",
- "finished_at": "2026-11-17T01:46:30.484193Z",
- "updated_at": "2026-11-17T01:52:00.505966Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "01a1e734-335e-7cf5-b437-9221049b9cb8",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": {
- "id": "01a1e734-3398-786e-bb72-8c4373ed6fee",
- "type": "workflow_run"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-33f1-7d33-900c-0bada589d42f",
- "log_lines": "/api/workflow_steps/01a1e734-33f1-7d33-900c-0bada589d42f/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c55-719e-a9cd-ec92c6d8c1db",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8"
}
}, - {
- "id": "01a1e734-2f69-76b9-81d8-160ff893e5cf",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "ricky-4726",
- "created_by_name": "ricky-4726",
- "name": "program",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:43:26.532454Z",
- "started_at": "2026-11-17T01:44:26.532454Z",
- "finished_at": "2026-11-17T01:48:46.815675Z",
- "updated_at": "2026-11-17T01:51:59.355892Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "program",
- "property_overrides": {
- "interface": "generating"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e734-2f03-715e-a338-0e2d8ae1781b",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e734-2dbd-73ad-8397-67c59f85faf9",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e734-2d7a-7494-a1e6-8f729b9d1fb1",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-2c48-7c7c-b015-e295f2ed4da8",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2f69-76b9-81d8-160ff893e5cf",
- "log_lines": "/api/workflow_steps/01a1e734-2f69-76b9-81d8-160ff893e5cf/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8/steps/01a1e734-2c65-7e27-9f34-7115aaabedbe",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-2c48-7c7c-b015-e295f2ed4da8"
}
}
]
}Cancels a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to cancel the workflow run",
- "detail": "Your authorisation rules let you view the workflow run but not cancel it."
}
]
}Lists all workflow steps.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[status_code_eq]=running API filtering guide. Named filters: |
| limit | integer [ 1 .. 1000 ] Default: 1000 Example: limit=50 Limit the number of workflow steps returned |
{- "data": [
- {
- "id": "01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "necessitatibus",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:52:13.732884Z",
- "started_at": "2026-11-17T01:46:50.912017Z",
- "finished_at": "2026-11-17T01:49:10.220284Z",
- "updated_at": "2026-11-17T01:52:13.739582Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e734-67b7-714d-acc6-ce5a60c833b9",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e734-7100-7b60-9e51-623361c3b5fd",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e734-711b-7119-ab1a-d24ee7161eba",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e734-72e7-79dc-98ee-22c2fc1d3d5f",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e734-786c-7f9b-906e-6dfc641bec7c",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e734-7890-7e73-9dd0-c699a7b49495",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e734-78bc-78cf-9312-4b725d9c8840",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "log_lines": "/api/workflow_steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-67b7-714d-acc6-ce5a60c833b9",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "et",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:11.821891Z",
- "started_at": "2026-11-17T01:43:11.821891Z",
- "finished_at": "2026-11-17T01:50:54.693512Z",
- "updated_at": "2026-11-17T01:52:14.982185Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e734-6cfb-7119-bcf5-a9fb83f40740",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67b7-714d-acc6-ce5a60c833b9",
- "log_lines": "/api/workflow_steps/01a1e734-67b7-714d-acc6-ce5a60c833b9/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-7100-7b60-9e51-623361c3b5fd",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "copy",
- "step_sequence": 2,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:46:12.561905Z",
- "started_at": "2026-11-17T01:47:12.561905Z",
- "finished_at": "2026-11-17T01:50:05.508155Z",
- "updated_at": "2026-11-17T01:52:16.135737Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "copy",
- "property_overrides": {
- "application": "quantifying"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e734-70c0-768b-be15-0a847a65cfa3",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e734-7028-7414-b69c-27e1b3b08f2b",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e734-6fb6-7cfb-a581-455e3910cb84",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-7100-7b60-9e51-623361c3b5fd",
- "log_lines": "/api/workflow_steps/01a1e734-7100-7b60-9e51-623361c3b5fd/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-711b-7119-ab1a-d24ee7161eba",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}, - "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "Approval",
- "step_sequence": 3,
- "status_code": "approved",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:16.949509Z",
- "started_at": "2026-11-17T01:43:16.949509Z",
- "finished_at": "2026-11-17T01:43:40.488605Z",
- "updated_at": "2026-11-17T01:52:16.159887Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-711b-7119-ab1a-d24ee7161eba",
- "log_lines": "/api/workflow_steps/01a1e734-711b-7119-ab1a-d24ee7161eba/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-72e7-79dc-98ee-22c2fc1d3d5f",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "child workflow",
- "step_sequence": 4,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:44:10.573926Z",
- "started_at": "2026-11-17T01:45:10.573926Z",
- "finished_at": "2026-11-17T01:49:32.995411Z",
- "updated_at": "2026-11-17T01:52:16.621368Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "01a1e734-721b-7f30-bea7-2cddeed348fc",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": {
- "id": "01a1e734-72c0-7fd9-8c40-7ea44faeeaef",
- "type": "workflow_run"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-72e7-79dc-98ee-22c2fc1d3d5f",
- "log_lines": "/api/workflow_steps/01a1e734-72e7-79dc-98ee-22c2fc1d3d5f/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-786c-7f9b-906e-6dfc641bec7c",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "reboot",
- "step_sequence": 5,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:52:18.023660Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:52:18.035292Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "reboot",
- "property_overrides": {
- "matrix": "backing up"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "01a1e734-7730-79b5-b9dd-6fb69013a318",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e734-761d-7fd7-b238-cdf1adfb0672",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-786c-7f9b-906e-6dfc641bec7c",
- "log_lines": "/api/workflow_steps/01a1e734-786c-7f9b-906e-6dfc641bec7c/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-7890-7e73-9dd0-c699a7b49495",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "Wait",
- "step_sequence": 6,
- "status_code": "continued",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:27.121802Z",
- "started_at": "2026-11-17T01:43:27.121802Z",
- "finished_at": "2026-11-17T01:45:24.085143Z",
- "updated_at": "2026-11-17T01:52:18.074820Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-7890-7e73-9dd0-c699a7b49495",
- "log_lines": "/api/workflow_steps/01a1e734-7890-7e73-9dd0-c699a7b49495/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-78bc-78cf-9312-4b725d9c8840",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "child workflow",
- "step_sequence": 7,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:52:18.100892Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:52:18.118434Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "01a1e734-721b-7f30-bea7-2cddeed348fc",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-78bc-78cf-9312-4b725d9c8840",
- "log_lines": "/api/workflow_steps/01a1e734-78bc-78cf-9312-4b725d9c8840/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67a6-7dbc-bcd2-4066671aaf4e",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-6cfb-7119-bcf5-a9fb83f40740",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "jake.hegmann-4858",
- "created_by_name": "jake.hegmann-4858",
- "name": "back_up",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:54.896045Z",
- "started_at": "2026-11-17T01:43:54.896045Z",
- "finished_at": "2026-11-17T01:50:51.529805Z",
- "updated_at": "2026-11-17T01:52:15.110638Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "back_up",
- "property_overrides": {
- "driver": "transmitting"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e734-6ca2-79ae-8b25-65626d6c8c96",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e734-6b1d-7b66-b638-6fc14e07a24c",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e734-6a9f-73ac-bd7b-8027c1bf4582",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e734-679c-7f52-971c-6659d5ba0ba4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-6cfb-7119-bcf5-a9fb83f40740",
- "log_lines": "/api/workflow_steps/01a1e734-6cfb-7119-bcf5-a9fb83f40740/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4/steps/01a1e734-67b7-714d-acc6-ce5a60c833b9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-679c-7f52-971c-6659d5ba0ba4"
}
}, - {
- "id": "01a1e734-72d9-76e6-9578-bbd0a56a522a",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "sharolyn_welch-4875",
- "created_by_name": "sharolyn_welch-4875",
- "name": "dicta",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:52:16.599734Z",
- "started_at": "2026-11-17T01:46:25.215485Z",
- "finished_at": "2026-11-17T01:50:10.963642Z",
- "updated_at": "2026-11-17T01:52:16.609155Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-72c0-7fd9-8c40-7ea44faeeaef",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/gsbhf/workflows/child/runs/01a1e734-72c0-7fd9-8c40-7ea44faeeaef/steps/01a1e734-72d9-76e6-9578-bbd0a56a522a",
- "log_lines": "/api/workflow_steps/01a1e734-72d9-76e6-9578-bbd0a56a522a/log_lines",
- "parent": "/api/projects/gsbhf/workflows/child/runs/01a1e734-72c0-7fd9-8c40-7ea44faeeaef",
- "workflow_run": "/api/projects/gsbhf/workflows/child/runs/01a1e734-72c0-7fd9-8c40-7ea44faeeaef"
}
}
], - "meta": {
- "authorisations": {
- "update": false,
- "execute": false
}, - "partial_response": false
}
}Shows a workflow step.
| step_id required | string Example: 01a1e72b-23c3-731d-95eb-68f3a8a65358 workflow step id |
{- "data": {
- "id": "01a1e72b-23c3-731d-95eb-68f3a8a65358",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "tandra-133",
- "created_by_name": "tandra-133",
- "name": "generate",
- "step_sequence": 5,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:06.528354Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:42:06.535518Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "generate",
- "property_overrides": {
- "program": "copying"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "01a1e72b-2367-7d60-b5b1-8b88f842b6a5",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e72b-2330-732a-8a82-b1140462f0d2",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e72b-1a64-7c6b-b8c4-3371ce2c0837",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e72b-1a64-7c6b-b8c4-3371ce2c0837/steps/01a1e72b-23c3-731d-95eb-68f3a8a65358",
- "log_lines": "/api/workflow_steps/01a1e72b-23c3-731d-95eb-68f3a8a65358/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e72b-1a64-7c6b-b8c4-3371ce2c0837/steps/01a1e72b-1a7b-7e67-9b4d-e3e7057f14f7",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e72b-1a64-7c6b-b8c4-3371ce2c0837"
}
}
}Continues a "waiting" workflow step. To approve/reject a workflow step that needs approval see the approve workflow step API endpoint.
| step_id required | string Example: 01a1e72b-2465-7836-b0ec-61772bf4f6c9 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Done sanity checks. Ok to continue.",
- "choice": "string"
}
}
}{- "data": {
- "id": "01a1e734-bdaf-7c59-9a30-4fdf1718117d",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [
- {
- "username": "logged_in_user",
- "message": null,
- "date": "2026-11-17T01:52:35Z"
}
], - "requires_approval_from": null,
- "lock_version": 3,
- "created_by": "clyde.ziemann-4957",
- "created_by_name": "clyde.ziemann-4957",
- "name": "Wait",
- "step_sequence": 8,
- "status_code": "continued",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:46:26.703378Z",
- "started_at": "2026-11-17T01:47:26.703378Z",
- "finished_at": "2026-11-17T01:52:35.880702Z",
- "updated_at": "2026-11-17T01:52:35.938240Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e734-acb3-7d3c-bcc3-1b49a77144fc",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e734-acb3-7d3c-bcc3-1b49a77144fc/steps/01a1e734-bdaf-7c59-9a30-4fdf1718117d",
- "log_lines": "/api/workflow_steps/01a1e734-bdaf-7c59-9a30-4fdf1718117d/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e734-acb3-7d3c-bcc3-1b49a77144fc/steps/01a1e734-acd1-7240-af37-88d5a35bf2cd",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e734-acb3-7d3c-bcc3-1b49a77144fc"
}
}
}Approve a workflow step that requires approval. To continue a workflow step that does need approval see the continue workflow step API endpoint
| step_id required | string Example: 01a1e72b-24b3-7c26-8bc5-aaaafac710dc workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed.",
- "choice": "string"
}
}
}{- "data": {
- "id": "01a1e735-1e7a-7743-8c15-cb7e1ad2bf3c",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [
- {
- "username": "logged_in_user",
- "message": null,
- "date": "2026-11-17T01:53:00Z"
}
], - "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": {
- "ldap_groups": [
- "an-ldap-group"
]
}, - "lock_version": 3,
- "created_by": "bridget_treutel-5126",
- "created_by_name": "bridget_treutel-5126",
- "name": "Approval",
- "step_sequence": 8,
- "status_code": "approved",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:45:43.800828Z",
- "started_at": "2026-11-17T01:46:43.800828Z",
- "finished_at": "2026-11-17T01:53:00.572742Z",
- "updated_at": "2026-11-17T01:53:00.602122Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-125c-7548-b664-877bea912607",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-125c-7548-b664-877bea912607/steps/01a1e735-1e7a-7743-8c15-cb7e1ad2bf3c",
- "log_lines": "/api/workflow_steps/01a1e735-1e7a-7743-8c15-cb7e1ad2bf3c/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-125c-7548-b664-877bea912607/steps/01a1e735-1267-77c9-ba24-dae59790c608",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-125c-7548-b664-877bea912607"
}
}
}Reject a workflow step that requires approval.
| step_id required | string Example: 01a1e72b-23dd-762f-8a0d-a28a90ef5fc1 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed."
}
}
}{- "data": {
- "id": "01a1e735-7436-7c2d-98ed-6d2b82cd34f3",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [
- {
- "username": "logged_in_user",
- "message": null,
- "date": "2026-11-17T01:53:22Z"
}
], - "continued_by": [ ],
- "requires_approval_from": {
- "ldap_groups": [
- "an-ldap-group"
]
}, - "lock_version": 3,
- "created_by": "emile-5295",
- "created_by_name": "emile-5295",
- "name": "Approval",
- "step_sequence": 8,
- "status_code": "rejected",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:45:03.542919Z",
- "started_at": "2026-11-17T01:46:03.542919Z",
- "finished_at": "2026-11-17T01:53:22.534056Z",
- "updated_at": "2026-11-17T01:53:22.547203Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-64d2-7ef5-a113-066de214ce72",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-64d2-7ef5-a113-066de214ce72/steps/01a1e735-7436-7c2d-98ed-6d2b82cd34f3",
- "log_lines": "/api/workflow_steps/01a1e735-7436-7c2d-98ed-6d2b82cd34f3/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-64d2-7ef5-a113-066de214ce72/steps/01a1e735-64e1-7092-a3e1-0b902713ce7a",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-64d2-7ef5-a113-066de214ce72"
}
}
}Lists all steps in a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
| limit | integer [ 1 .. 1000 ] Default: 1000 Example: limit=50 Limit the number of workflow steps returned |
{- "data": [
- {
- "id": "01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "corrupti",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:53:35.641975Z",
- "started_at": "2026-11-17T01:43:58.971106Z",
- "finished_at": "2026-11-17T01:44:08.502282Z",
- "updated_at": "2026-11-17T01:53:35.649469Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e735-a7ac-7159-99a8-2c306cde68fa",
- "type": "workflow_noop_step"
}, - {
- "id": "01a1e735-aae8-7ee8-91fc-f814bc1df71f",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e735-ab1d-7be9-a892-6b71c7794e87",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e735-ad5f-7fc4-ab8a-c780d33e3a52",
- "type": "workflow_workflow_step"
}, - {
- "id": "01a1e735-af53-7ad1-95eb-dda93715e406",
- "type": "workflow_change_step"
}, - {
- "id": "01a1e735-af69-784f-8443-fb03785f0f67",
- "type": "workflow_wait_step"
}, - {
- "id": "01a1e735-af7f-7824-9e51-b62bb9cf74c8",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "log_lines": "/api/workflow_steps/01a1e735-a79b-7d4f-a151-494b3d6953d0/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-a7ac-7159-99a8-2c306cde68fa",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "quaerat",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:47:10.079710Z",
- "started_at": "2026-11-17T01:48:10.079710Z",
- "finished_at": "2026-11-17T01:48:20.895314Z",
- "updated_at": "2026-11-17T01:53:36.016361Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "child_execution_strategy": "sequential",
- "ignore_failure": false
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "01a1e735-a94d-7bef-8d1d-3d521825da73",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a7ac-7159-99a8-2c306cde68fa",
- "log_lines": "/api/workflow_steps/01a1e735-a7ac-7159-99a8-2c306cde68fa/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-aae8-7ee8-91fc-f814bc1df71f",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "synthesize",
- "step_sequence": 2,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:46:29.495110Z",
- "started_at": "2026-11-17T01:47:29.495110Z",
- "finished_at": "2026-11-17T01:50:59.480517Z",
- "updated_at": "2026-11-17T01:53:36.503830Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "synthesize",
- "property_overrides": {
- "hard drive": "connecting"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e735-aac2-7429-ba07-e2a02b621eb8",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e735-aa33-753b-81a1-ccdc1ff53903",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e735-aa05-73cf-8a29-0647dea1b7c3",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-aae8-7ee8-91fc-f814bc1df71f",
- "log_lines": "/api/workflow_steps/01a1e735-aae8-7ee8-91fc-f814bc1df71f/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-ab1d-7be9-a892-6b71c7794e87",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": {
- "user_names": [
- "opschain"
]
}, - "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "Approval",
- "step_sequence": 3,
- "status_code": "approved",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:43:05.189290Z",
- "started_at": "2026-11-17T01:44:05.189290Z",
- "finished_at": "2026-11-17T01:47:00.002077Z",
- "updated_at": "2026-11-17T01:53:36.547749Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-ab1d-7be9-a892-6b71c7794e87",
- "log_lines": "/api/workflow_steps/01a1e735-ab1d-7be9-a892-6b71c7794e87/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-ad5f-7fc4-ab8a-c780d33e3a52",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "child workflow",
- "step_sequence": 4,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:45:33.288274Z",
- "started_at": "2026-11-17T01:46:33.288274Z",
- "finished_at": "2026-11-17T01:51:18.750618Z",
- "updated_at": "2026-11-17T01:53:37.136554Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "01a1e735-ac85-7c1d-bf3e-68877a070d0a",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": {
- "id": "01a1e735-ad1a-713e-b15f-ed28b0f708e2",
- "type": "workflow_run"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-ad5f-7fc4-ab8a-c780d33e3a52",
- "log_lines": "/api/workflow_steps/01a1e735-ad5f-7fc4-ab8a-c780d33e3a52/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-af53-7ad1-95eb-dda93715e406",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "input",
- "step_sequence": 5,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:53:37.615781Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:53:37.625546Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "input",
- "property_overrides": {
- "feed": "compressing"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "01a1e735-aed9-7df5-bc8c-69a5b44fefb8",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e735-aea3-7080-8c5f-7335560a6561",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-af53-7ad1-95eb-dda93715e406",
- "log_lines": "/api/workflow_steps/01a1e735-af53-7ad1-95eb-dda93715e406/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-af69-784f-8443-fb03785f0f67",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "Wait",
- "step_sequence": 6,
- "status_code": "continued",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:59.989959Z",
- "started_at": "2026-11-17T01:43:59.989959Z",
- "finished_at": "2026-11-17T01:46:54.557959Z",
- "updated_at": "2026-11-17T01:53:37.646939Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-af69-784f-8443-fb03785f0f67",
- "log_lines": "/api/workflow_steps/01a1e735-af69-784f-8443-fb03785f0f67/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-af7f-7824-9e51-b62bb9cf74c8",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "child workflow",
- "step_sequence": 7,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:53:37.659289Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:53:37.668517Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "01a1e735-ac85-7c1d-bf3e-68877a070d0a",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-af7f-7824-9e51-b62bb9cf74c8",
- "log_lines": "/api/workflow_steps/01a1e735-af7f-7824-9e51-b62bb9cf74c8/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a79b-7d4f-a151-494b3d6953d0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}, - {
- "id": "01a1e735-a94d-7bef-8d1d-3d521825da73",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "michelina-5464",
- "created_by_name": "michelina-5464",
- "name": "back_up",
- "step_sequence": 1,
- "status_code": "success",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:44:47.287214Z",
- "started_at": "2026-11-17T01:45:47.287214Z",
- "finished_at": "2026-11-17T01:47:58.472862Z",
- "updated_at": "2026-11-17T01:53:36.082212Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "back_up",
- "property_overrides": {
- "transmitter": "indexing"
}
}, - "relationships": {
- "change": {
- "data": {
- "id": "01a1e735-a92b-7da0-98f0-382b1a8b8aab",
- "type": "change"
}
}, - "change_parent": {
- "data": {
- "id": "01a1e735-a8c8-7078-b0cd-ffd7ec5497c8",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e735-a88e-7008-b66a-61c4df756ee2",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e735-a790-7570-be97-ab08d158c6f9",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a94d-7bef-8d1d-3d521825da73",
- "log_lines": "/api/workflow_steps/01a1e735-a94d-7bef-8d1d-3d521825da73/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9/steps/01a1e735-a7ac-7159-99a8-2c306cde68fa",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-a790-7570-be97-ab08d158c6f9"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "execute": true
}, - "partial_response": false
}
}Shows a step of a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
| step_id required | string Example: 01a1e72b-23c3-731d-95eb-68f3a8a65358 workflow step id |
{- "data": {
- "id": "01a1e72b-23c3-731d-95eb-68f3a8a65358",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "tandra-133",
- "created_by_name": "tandra-133",
- "name": "generate",
- "step_sequence": 5,
- "status_code": "pending",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:06.528354Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-11-17T01:42:06.535518Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": false,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null,
- "ignore_failure": false,
- "action": "generate",
- "property_overrides": {
- "program": "copying"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "01a1e72b-2367-7d60-b5b1-8b88f842b6a5",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "01a1e72b-2330-732a-8a82-b1140462f0d2",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "01a1e72b-1a64-7c6b-b8c4-3371ce2c0837",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e72b-1a64-7c6b-b8c4-3371ce2c0837/steps/01a1e72b-23c3-731d-95eb-68f3a8a65358",
- "log_lines": "/api/workflow_steps/01a1e72b-23c3-731d-95eb-68f3a8a65358/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e72b-1a64-7c6b-b8c4-3371ce2c0837/steps/01a1e72b-1a7b-7e67-9b4d-e3e7057f14f7",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e72b-1a64-7c6b-b8c4-3371ce2c0837"
}
}
}Continues a "waiting" workflow step. To approve/reject a workflow step that needs approval see the approve workflow step API endpoint.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
| step_id required | string Example: 01a1e72b-2465-7836-b0ec-61772bf4f6c9 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Done sanity checks. Ok to continue.",
- "choice": "string"
}
}
}{- "data": {
- "id": "01a1e735-cba0-7e6a-a88e-ea1a41f16223",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [
- {
- "username": "logged_in_user",
- "message": null,
- "date": "2026-11-17T01:53:44Z"
}
], - "requires_approval_from": null,
- "lock_version": 3,
- "created_by": "hallie.kub-5563",
- "created_by_name": "hallie.kub-5563",
- "name": "Wait",
- "step_sequence": 8,
- "status_code": "continued",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:42:48.154405Z",
- "started_at": "2026-11-17T01:43:48.154405Z",
- "finished_at": "2026-11-17T01:53:44.916645Z",
- "updated_at": "2026-11-17T01:53:44.944989Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e735-c616-7c5a-8c74-9cf0b59e4df5",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e735-c616-7c5a-8c74-9cf0b59e4df5/steps/01a1e735-cba0-7e6a-a88e-ea1a41f16223",
- "log_lines": "/api/workflow_steps/01a1e735-cba0-7e6a-a88e-ea1a41f16223/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e735-c616-7c5a-8c74-9cf0b59e4df5/steps/01a1e735-c61f-79c4-9254-28ea1a704134",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e735-c616-7c5a-8c74-9cf0b59e4df5"
}
}
}Approve a workflow step that requires approval. To continue a workflow step that does need approval see the continue workflow step API endpoint
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
| step_id required | string Example: 01a1e72b-24b3-7c26-8bc5-aaaafac710dc workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed.",
- "choice": "string"
}
}
}{- "data": {
- "id": "01a1e736-0b02-7bce-b3c4-e0891ed28db6",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [
- {
- "username": "logged_in_user",
- "message": null,
- "date": "2026-11-17T01:54:01Z"
}
], - "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": {
- "ldap_groups": [
- "an-ldap-group"
]
}, - "lock_version": 3,
- "created_by": "ronny-5732",
- "created_by_name": "ronny-5732",
- "name": "Approval",
- "step_sequence": 8,
- "status_code": "approved",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:44:00.252287Z",
- "started_at": "2026-11-17T01:45:00.252287Z",
- "finished_at": "2026-11-17T01:54:01.280153Z",
- "updated_at": "2026-11-17T01:54:01.372492Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e736-02ce-7146-ad3e-2492d0fd0891",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e736-02ce-7146-ad3e-2492d0fd0891/steps/01a1e736-0b02-7bce-b3c4-e0891ed28db6",
- "log_lines": "/api/workflow_steps/01a1e736-0b02-7bce-b3c4-e0891ed28db6/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e736-02ce-7146-ad3e-2492d0fd0891/steps/01a1e736-02db-7487-969f-896eef10a34c",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e736-02ce-7146-ad3e-2492d0fd0891"
}
}
}Reject a workflow step that requires approval.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 01a1e72b-1a64-7c6b-b8c4-3371ce2c0837 workflow run id |
| step_id required | string Example: 01a1e72b-23dd-762f-8a0d-a28a90ef5fc1 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed."
}
}
}{- "data": {
- "id": "01a1e736-4312-7c42-aa3a-f6051598af6a",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [
- {
- "username": "logged_in_user",
- "message": null,
- "date": "2026-11-17T01:54:15Z"
}
], - "continued_by": [ ],
- "requires_approval_from": {
- "ldap_groups": [
- "an-ldap-group"
]
}, - "lock_version": 3,
- "created_by": "clifton.armstrong-5901",
- "created_by_name": "clifton.armstrong-5901",
- "name": "Approval",
- "step_sequence": 8,
- "status_code": "rejected",
- "cancel_requested": false,
- "skip_requested": false,
- "created_at": "2026-11-17T01:47:31.436088Z",
- "started_at": "2026-11-17T01:48:31.436088Z",
- "finished_at": "2026-11-17T01:54:15.503548Z",
- "updated_at": "2026-11-17T01:54:15.514452Z",
- "skip_reason": null,
- "selected_arm": null,
- "arm_reason": null,
- "reset_on_retry": true,
- "arm": null,
- "choices": null,
- "branch": null,
- "default": null,
- "recover": null,
- "retry_from": null,
- "abort_on_reject": null,
- "abort_on_cancel": null,
- "when": null
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "01a1e736-3ca8-7c06-8198-e8acf2626965",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/01a1e736-3ca8-7c06-8198-e8acf2626965/steps/01a1e736-4312-7c42-aa3a-f6051598af6a",
- "log_lines": "/api/workflow_steps/01a1e736-4312-7c42-aa3a-f6051598af6a/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/01a1e736-3ca8-7c06-8198-e8acf2626965/steps/01a1e736-3cb3-71fa-92e4-702a116851a3",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1e736-3ca8-7c06-8198-e8acf2626965"
}
}
}Endpoints to interact with events.
Lists all events.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[query_param_code_eq]=opc API filtering guide. Named filters: |
| limit | integer [ 1 .. 1000 ] Default: 10 Example: limit=50 Limit the number of events returned |
{- "data": [
- {
- "id": "01a1e72e-baf7-7ffd-aebd-c4c7333e35c4",
- "type": "event",
- "attributes": {
- "nested": {
- "key": "nested value"
}, - "any_key": "with a value",
- "another_key": "with a different value",
- "username": "benita_adams",
- "system": false,
- "type": "my custom event",
- "event_node_path": "/projects/opc",
- "created_at": "2026-11-17T01:46:01.846874Z"
}, - "relationships": {
- "source": {
- "links": {
- "source": "/api/projects/opc"
}, - "data": {
- "id": "01a1e72e-bac7-7155-ac80-2be0aa2c2e0b",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/events/01a1e72e-baf7-7ffd-aebd-c4c7333e35c4"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Creates an event. Attributes other than type become the event data, apart from a <source>_id or <source>_path attribute (e.g. node_path, change_id), which sets the event source instead. Supply a source object naming exactly one resource (e.g. {"node_path": "/projects/bank"}) to set the source explicitly; an unknown key is rejected. Supply a data object to store it as the event data exactly as sent, so its keys are never taken as the source.
required | object |
{- "data": {
- "attributes": {
- "type": "custom event",
- "source": {
- "node_path": "/projects/web/environments/prod/assets/app"
}, - "data": {
- "version": "1.2.3"
}, - "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}
}{- "data": {
- "id": "01a1e72e-bce9-7ca5-8bc6-04fa98dfae71",
- "type": "event",
- "attributes": {
- "some": "event data",
- "username": "logged_in_user",
- "system": false,
- "type": "my event",
- "event_node_path": null,
- "created_at": "2026-11-17T01:46:02.344664Z"
}, - "relationships": {
- "source": {
- "links": {
- "source": null
}
}
}, - "links": {
- "self": "/api/events/01a1e72e-bce9-7ca5-8bc6-04fa98dfae71"
}
}
}Shows an event.
| event_id required | string Example: 01a1e72b-1197-7f8a-b85a-f40b962e12aa event id |
{- "data": {
- "id": "01a1e72e-c2b1-7cde-8612-4bf01c27e0fe",
- "type": "event",
- "attributes": {
- "nested": {
- "key": "nested value"
}, - "any_key": "with a value",
- "another_key": "with a different value",
- "username": "samatha",
- "system": false,
- "type": "my custom event",
- "event_node_path": "/projects/opc",
- "created_at": "2026-11-17T01:46:03.824695Z"
}, - "relationships": {
- "source": {
- "links": {
- "source": "/api/projects/opc"
}, - "data": {
- "id": "01a1e72e-c278-75e7-8f83-37cf2a706583",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/events/01a1e72e-c2b1-7cde-8612-4bf01c27e0fe"
}
}
}Lists all event filters.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=changes_success API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e72e-a0a8-742d-91e6-ac423616eb2e",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "eq",
- "/projects/opc/environments/dev"
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [ ]
}, - "code": "change_success",
- "description": "Filter for successful changes in dev",
- "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:45:55.111220Z",
- "updated_at": "2026-11-17T01:45:55.111220Z"
}, - "links": {
- "self": "/api/event_filters/change_success",
- "subscribers": "/api/event_filters/change_success/event_subscribers"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Create an event filter.
required | object |
{- "data": {
- "attributes": {
- "code": "change_success",
- "description": "Filter for successful changes in dev",
- "rules": {
- "event_rules": [
- {
- "attribute": "type",
- "predicate": "eq",
- "value": "api:changes:success"
}, - {
- "attribute": "system",
- "predicate": "true"
}, - {
- "attribute": "event_node_path",
- "predicate": "eq",
- "value": "/projects/demo/environments/dev"
}
], - "source_rules": [
- {
- "attribute": "action",
- "predicate": "eq",
- "value": "default"
}
]
}
}
}
}{- "data": {
- "id": "01a1e72e-a272-7957-b0ab-73a6b4b3f8a2",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "eq",
- "/projects/demo/environments/dev"
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [
- [
- "action",
- "eq",
- "default"
]
]
}, - "code": "3uasb",
- "description": "Voluptatibus ab omnis ut.",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:45:55.569272Z",
- "updated_at": "2026-11-17T01:45:55.569272Z"
}, - "links": {
- "self": "/api/event_filters/3uasb",
- "subscribers": "/api/event_filters/3uasb/event_subscribers"
}
}
}Show an event filter.
| event_filter_code required | string Example: change_success event filter code |
{- "data": {
- "id": "01a1e72e-a8e1-795a-bdc9-2b727fba5649",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "eq",
- "/projects/opc/environments/dev"
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [ ]
}, - "code": "change_success",
- "description": "Filter for successful changes in dev",
- "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:45:57.216585Z",
- "updated_at": "2026-11-17T01:45:57.216585Z"
}, - "links": {
- "self": "/api/event_filters/change_success",
- "subscribers": "/api/event_filters/change_success/event_subscribers"
}
}
}Update an event filter.
| event_filter_code required | string Example: change_success event filter code |
required | object |
{- "data": {
- "attributes": {
- "rules": {
- "event_rules": [
- {
- "attribute": "type",
- "predicate": "eq",
- "value": "api:changes:error"
}
], - "source_rules": [
- {
- "attribute": "action",
- "predicate": "eq",
- "value": "hello_world"
}
]
}, - "description": "hello world errors filter"
}
}
}{- "data": {
- "id": "01a1e72e-aba5-760c-8dbe-6e21dc63ed89",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "type",
- "eq",
- "api:changes:error"
]
], - "source_rules": [
- [
- "action",
- "eq",
- "hello_world"
]
]
}, - "code": "change_success",
- "description": "hello world errors filter",
- "created_by": "opschain",
- "created_by_name": "opschain",
- "created_at": "2026-11-17T01:45:57.924402Z",
- "updated_at": "2026-11-17T01:45:57.941153Z"
}, - "links": {
- "self": "/api/event_filters/change_success",
- "subscribers": "/api/event_filters/change_success/event_subscribers"
}
}
}Delete an event filter.
| event_filter_code required | string Example: change_success event filter code |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the event filter",
- "detail": "Your authorisation rules let you view the event filter but not delete it."
}
]
}Lists all event subscribers.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[enabled_eq]=true API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e72e-c714-7f04-a183-086b98cfba41",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "elenora_mckenzie-1954",
- "created_by_name": "elenora_mckenzie-1954",
- "channel_kwargs": { },
- "created_at": "2026-11-17T01:46:04.947797Z",
- "updated_at": "2026-11-17T01:46:04.947797Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e72e-c674-7a3d-a272-c8183c68b619",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/change_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e72e-c706-7c2c-82ed-af3570789eb1",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/system_configuration/notification_channels/system_email"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e72e-c714-7f04-a183-086b98cfba41"
}, - "meta": { }
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Create an event subscriber without a node in the path.
The subscriber is still attached to a node - channel_parent_path names the node owning the notification channel, and the event filter supplies the node the subscription applies to.
required | object |
{- "data": {
- "attributes": {
- "event_filter_code": "change_success",
- "channel_parent_path": "/system_configuration",
- "channel_code": "system_email",
- "channel_kwargs": {
- "additional": {
- "job": {
- "kwarg": "values"
}
}
}, - "enabled": true
}
}
}{- "data": {
- "id": "01a1e72e-cd07-7bd6-a399-3f797b7599fe",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "hello": "world"
}, - "created_at": "2026-11-17T01:46:06.470460Z",
- "updated_at": "2026-11-17T01:46:06.470460Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e72e-c952-7aa8-988b-3a521e9b1964",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/cmewz"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e72e-ccb3-767d-9bab-ebabcd5191a5",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/notification_channels/dnzql"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e72e-cd07-7bd6-a399-3f797b7599fe"
}, - "meta": { }
}
}List event subscribers for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[enabled_eq]=true API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e72e-dd7f-789c-9374-d0695b4953af",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "scottie.white-2008",
- "created_by_name": "scottie.white-2008",
- "channel_kwargs": { },
- "created_at": "2026-11-17T01:46:10.684936Z",
- "updated_at": "2026-11-17T01:46:10.684936Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e72e-dc40-7143-82e8-3d8b8cf41c52",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/change_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e72e-dd69-7e26-8982-e4b3b4aadc3a",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/system_configuration/notification_channels/system_email"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e72e-dd7f-789c-9374-d0695b4953af"
}, - "meta": { }
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Create an event subscriber.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
required | object |
{- "data": {
- "attributes": {
- "event_filter_code": "change_success",
- "channel_parent_path": "/system_configuration",
- "channel_code": "system_email",
- "channel_kwargs": {
- "additional": {
- "job": {
- "kwarg": "values"
}
}
}, - "enabled": true
}
}
}{- "data": {
- "id": "01a1e72e-e39b-7789-8b59-ece4d04eb727",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "hello": "world"
}, - "created_at": "2026-11-17T01:46:12.250277Z",
- "updated_at": "2026-11-17T01:46:12.250277Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e72e-e22a-742d-a722-4bec6bba5271",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/mnno1"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e72e-e37e-77db-aad7-4bf429f2f2e7",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/notification_channels/ibc2h"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e72e-e39b-7789-8b59-ece4d04eb727"
}, - "meta": { }
}
}Show an event subscriber.
| event_subscriber_id required | string Example: 01a1e72b-126e-77ca-a5db-b92d9f996c5a event subscriber id |
{- "data": {
- "id": "01a1e72e-f77b-7317-b98c-f92c10ac56e1",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "tanesha.feest-2062",
- "created_by_name": "tanesha.feest-2062",
- "channel_kwargs": { },
- "created_at": "2026-11-17T01:46:17.338024Z",
- "updated_at": "2026-11-17T01:46:17.338024Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e72e-f6ff-713b-9bb2-f8d3781d3bb2",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/change_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e72e-f772-7284-be86-67d1d15318cf",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/system_configuration/notification_channels/system_email"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e72e-f77b-7317-b98c-f92c10ac56e1"
}, - "meta": { }
}
}Update an event subscriber. A subscriber to a node event filter (a trigger) may be updated by its creator, or by anyone who can update the node.
| event_subscriber_id required | string Example: 01a1e72b-126e-77ca-a5db-b92d9f996c5a event subscriber id |
required | object |
{- "data": {
- "attributes": {
- "event_filter_code": "change_success",
- "channel_parent_path": "/projects/opc",
- "channel_code": "project_direct",
- "channel_kwargs": {
- "hello": "world"
}, - "enabled": false
}
}
}{- "data": {
- "id": "01a1e72e-fb8b-7d50-877f-a7352afbf026",
- "type": "event_subscriber",
- "attributes": {
- "enabled": false,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "hello": "world"
}, - "created_at": "2026-11-17T01:46:18.378346Z",
- "updated_at": "2026-11-17T01:46:18.437875Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e72e-faeb-7cb5-8a69-4b0c98bddb2b",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/change_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e72e-fba1-7748-80e7-acb3d7bf6996",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/projects/opc/notification_channels/project_direct"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e72e-fb8b-7d50-877f-a7352afbf026"
}, - "meta": { }
}
}Delete an event subscriber. A subscriber to a node event filter (a trigger) may be deleted by its creator, or by anyone who can delete on the node, and its event filter is deleted too when no other subscriber uses it.
| event_subscriber_id required | string Example: 01a1e72b-126e-77ca-a5db-b92d9f996c5a event subscriber id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find EventSubscriber"
}
}
]
}List the triggers that fire for events on a project, environment or asset: those created on the node and on its ancestors. Each trigger is an event subscriber, returned with its event filter and notification channel included. The response's meta.authorisations says whether the current user may update, delete and execute on this node, and each trigger's meta.authorisations.edit whether they may change what it does (its rules, channel or kwargs): only its creator or a superuser may.
| project_code required | string Example: opc project code |
{- "data": [
- {
- "id": "01a1e732-30e9-7403-8c6c-8f76cd90c118",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "action": "smoke_test"
}, - "created_at": "2026-11-17T01:49:48.647748Z",
- "updated_at": "2026-11-17T01:49:48.647748Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e732-30e3-7b7a-a45a-b96a6cf8efef",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/smoke_test_on_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e732-30dd-7170-b33f-920f339188b8",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/projects/opc/notification_channels/run_change"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e732-30e9-7403-8c6c-8f76cd90c118"
}, - "meta": {
- "authorisations": {
- "edit": true
}
}
}
], - "included": [
- {
- "id": "01a1e732-30e3-7b7a-a45a-b96a6cf8efef",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "matches_any",
- [
- "^/projects/opc$",
- "^/projects/opc/"
]
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [ ]
}, - "code": "smoke_test_on_success",
- "description": "Distinctio minus aliquid esse.",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:49:48.642520Z",
- "updated_at": "2026-11-17T01:49:48.642520Z"
}, - "links": {
- "self": "/api/event_filters/smoke_test_on_success",
- "subscribers": "/api/event_filters/smoke_test_on_success/event_subscribers"
}
}, - {
- "id": "01a1e732-30dd-7170-b33f-920f339188b8",
- "type": "notification_channel",
- "attributes": {
- "format": null,
- "code": "run_change",
- "description": "Hic minima omnis perspiciatis.",
- "default_channel": false,
- "internal": false,
- "enabled": true,
- "created_by": "emily-3850",
- "created_by_name": "emily-3850",
- "created_at": "2026-11-17T01:49:48.635956Z",
- "updated_at": "2026-11-17T01:49:48.635956Z",
- "kwargs": { },
- "job_code": "create_change_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e732-2f5b-726d-be5b-e8403e4b624b",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/create_change_job"
}
}
}, - "links": {
- "self": "/api/projects/opc/notification_channels/run_change",
- "parent": "/api/projects/opc"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true,
- "execute": true
}
}
}Create a trigger on a project, environment or asset: an event filter and an event subscriber, in one request. The trigger fires for events on the node and the nodes below it; the filter's event_node_path rule is written from the node, replacing any supplied. The filter also gets a system rule: true when its event type is one OpsChain raises (one starting api:, audit:, error:, info:, opschain:, warn: or warning:), so an event a user posts with that type cannot fire it, and false for a custom event type. A supplied system rule that disagrees is refused, as is a type rule naming both kinds of event type. It runs as its creator, and only its creator (or a superuser) may later change what it does.
Set create_channel_for_job to create_change_job or create_workflow_run_job to run a change or a workflow. The trigger then uses OpsChain's system-wide channel for that job; no channel is created. Creating such a trigger needs execute access on its target rather than update access to the node: on the change's action (parent_path and action in channel_kwargs) or on the workflow (project_code and code). A target that uses Mustache is not checked when the trigger is created; the trigger still runs as its creator, so the change or workflow is refused when it fires if the creator cannot execute it.
Alternatively name an existing notification channel with channel_parent_path and channel_code, which needs update access to the node. A trigger sending to a webhook channel also needs execute access on that channel, because it sends event data outside OpsChain.
channel_kwargs holds the values this trigger passes to the channel's job, for example the parent_path and action of the change to run. Values may use Mustache to read the event that fired the trigger, for example {{event.event_node_path}} or {{event.type}}. A key the channel's own kwargs already set is refused, because the channel's value would win.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "smoke_test_on_success",
- "description": "Smoke test after a successful change",
- "enabled": true,
- "rules": {
- "event_rules": [
- {
- "attribute": "type",
- "predicate": "eq",
- "value": "api:changes:success"
}
], - "source_rules": [
- {
- "attribute": "action",
- "predicate": "eq",
- "value": "deploy"
}
]
}, - "channel_parent_path": "/projects/opc",
- "channel_code": "run_change",
- "create_channel_for_job": "create_change_job",
- "channel_kwargs": {
- "parent_path": "{{event.event_node_path}}",
- "action": "smoke_test"
}
}
}
}{- "data": {
- "id": "01a1e732-3293-787e-9a52-c533e441e34f",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "parent_path": "/projects/opc",
- "action": "smoke_test"
}, - "created_at": "2026-11-17T01:49:49.074294Z",
- "updated_at": "2026-11-17T01:49:49.074294Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e732-3289-7883-a42c-4327277346fa",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/smoke_test_on_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e732-31d8-79be-90c0-3b75e1f70982",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/system_configuration/notification_channels/create_change_channel"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e732-3293-787e-9a52-c533e441e34f"
}, - "meta": { }
}, - "included": [
- {
- "id": "01a1e732-3289-7883-a42c-4327277346fa",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "matches_any",
- [
- "^/projects/opc$",
- "^/projects/opc/"
]
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [
- [
- "action",
- "eq",
- "deploy"
]
]
}, - "code": "smoke_test_on_success",
- "description": "Smoke test after a successful change",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:49:49.064519Z",
- "updated_at": "2026-11-17T01:49:49.064519Z"
}, - "links": {
- "self": "/api/event_filters/smoke_test_on_success",
- "subscribers": "/api/event_filters/smoke_test_on_success/event_subscribers"
}
}, - {
- "id": "01a1e732-31d8-79be-90c0-3b75e1f70982",
- "type": "notification_channel",
- "attributes": {
- "format": null,
- "code": "create_change_channel",
- "description": "[INTERNAL] Global run a change trigger channel",
- "default_channel": true,
- "internal": true,
- "enabled": true,
- "created_by": "opschain_internal",
- "created_by_name": "opschain_internal",
- "created_at": "2026-11-17T01:49:48.887232Z",
- "updated_at": "2026-11-17T01:49:48.887232Z",
- "kwargs": { },
- "job_code": "create_change_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e732-3165-794f-9b7e-9faeb9275a8b",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/create_change_job"
}
}
}, - "links": {
- "self": "/api/system_configuration/notification_channels/create_change_channel",
- "parent": "/api/system_configuration"
}
}
]
}Show a trigger created on this node, with its event filter and notification channel included. The response's meta.authorisations says whether the current user may update, delete and execute on this node, and the trigger's own meta.authorisations.edit whether they may change what it does (its rules, channel or kwargs): only its creator or a superuser may.
| project_code required | string Example: opc project code |
| trigger_id required | string Example: 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b trigger (event subscriber) id |
{- "data": {
- "id": "01a1e732-4c89-7bf0-b829-c362784758db",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "action": "smoke_test"
}, - "created_at": "2026-11-17T01:49:55.720400Z",
- "updated_at": "2026-11-17T01:49:55.720400Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e732-4c85-70b2-8bef-3c2b52c3bbc4",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/smoke_test_on_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e732-4c7e-7119-8686-bafac755758f",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/projects/opc/notification_channels/run_change"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e732-4c89-7bf0-b829-c362784758db"
}, - "meta": {
- "authorisations": {
- "edit": true
}
}
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true,
- "execute": true
}
}, - "included": [
- {
- "id": "01a1e732-4c85-70b2-8bef-3c2b52c3bbc4",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "matches_any",
- [
- "^/projects/opc$",
- "^/projects/opc/"
]
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [ ]
}, - "code": "smoke_test_on_success",
- "description": "Provident quidem rerum odit.",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:49:55.715982Z",
- "updated_at": "2026-11-17T01:49:55.715982Z"
}, - "links": {
- "self": "/api/event_filters/smoke_test_on_success",
- "subscribers": "/api/event_filters/smoke_test_on_success/event_subscribers"
}
}, - {
- "id": "01a1e732-4c7e-7119-8686-bafac755758f",
- "type": "notification_channel",
- "attributes": {
- "format": null,
- "code": "run_change",
- "description": "Voluptates qui quas odit.",
- "default_channel": false,
- "internal": false,
- "enabled": true,
- "created_by": "shani.volkman-3870",
- "created_by_name": "shani.volkman-3870",
- "created_at": "2026-11-17T01:49:55.708683Z",
- "updated_at": "2026-11-17T01:49:55.708683Z",
- "kwargs": { },
- "job_code": "create_change_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e732-4898-76ed-83a6-5a30aba3866c",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/create_change_job"
}
}
}, - "links": {
- "self": "/api/projects/opc/notification_channels/run_change",
- "parent": "/api/projects/opc"
}
}
]
}Update a trigger created on this node. The filter keeps its event_node_path rule, Leave out the system rule; OpsChain sets it from the event types. A supplied one that disagrees is refused. Anyone other than its creator needs update access to the node to change it in any way; its creator may enable or disable it without that access. Only its creator (or a superuser) may change its rules, channel or kwargs. For a trigger that runs a change or a workflow, that change needs the creator's execute access on the target instead of update access to the node, unless the target uses Mustache; for any other trigger it needs update access to the node. Re-enabling a trigger that runs a change or a workflow needs its creator to still have execute access on the target, unless it uses Mustache; re-enabling a webhook trigger needs its creator to still have execute access on the channel.
channel_kwargs holds the values this trigger passes to the channel's job, for example the parent_path and action of the change to run. Values may use Mustache to read the event that fired the trigger, for example {{event.event_node_path}} or {{event.type}}. A key the channel's own kwargs already set is refused, because the channel's value would win.
| project_code required | string Example: opc project code |
| trigger_id required | string Example: 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b trigger (event subscriber) id |
required | object |
{- "data": {
- "attributes": {
- "description": "Run the full test after a successful change",
- "enabled": false,
- "rules": {
- "event_rules": [
- {
- "attribute": "type",
- "predicate": "eq",
- "value": "api:changes:success"
}
], - "source_rules": [
- {
- "attribute": "action",
- "predicate": "eq",
- "value": "deploy"
}
]
}, - "channel_parent_path": "/projects/opc",
- "channel_code": "run_change",
- "create_channel_for_job": "create_change_job",
- "channel_kwargs": {
- "parent_path": "{{event.event_node_path}}",
- "action": "smoke_test"
}
}
}
}{- "data": {
- "id": "01a1e732-527b-7547-b587-31689f6058da",
- "type": "event_subscriber",
- "attributes": {
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "channel_kwargs": {
- "action": "full_test"
}, - "created_at": "2026-11-17T01:49:57.242008Z",
- "updated_at": "2026-11-17T01:49:57.274642Z"
}, - "relationships": {
- "event_filter": {
- "data": {
- "id": "01a1e732-5276-7fe8-9689-dd68067f6b35",
- "type": "event_filter"
}, - "links": {
- "related": "/api/event_filters/smoke_test_on_success"
}
}, - "notification_channel": {
- "data": {
- "id": "01a1e732-5270-7e0c-a627-5dcc6b1b76c1",
- "type": "notification_channel"
}, - "links": {
- "related": "/api/projects/opc/notification_channels/run_change"
}
}
}, - "links": {
- "self": "/api/event_subscribers/01a1e732-527b-7547-b587-31689f6058da"
}, - "meta": { }
}, - "included": [
- {
- "id": "01a1e732-5276-7fe8-9689-dd68067f6b35",
- "type": "event_filter",
- "attributes": {
- "rules": {
- "event_rules": [
- [
- "event_node_path",
- "matches_any",
- [
- "^/projects/opc$",
- "^/projects/opc/"
]
], - [
- "system",
- "true",
- 1
], - [
- "type",
- "eq",
- "api:changes:success"
]
], - "source_rules": [
- [
- "action",
- "eq",
- "deploy"
]
]
}, - "code": "smoke_test_on_success",
- "description": "Maxime ut harum omnis.",
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:49:57.237909Z",
- "updated_at": "2026-11-17T01:49:57.268031Z"
}, - "links": {
- "self": "/api/event_filters/smoke_test_on_success",
- "subscribers": "/api/event_filters/smoke_test_on_success/event_subscribers"
}
}, - {
- "id": "01a1e732-5270-7e0c-a627-5dcc6b1b76c1",
- "type": "notification_channel",
- "attributes": {
- "format": null,
- "code": "run_change",
- "description": "Minima veniam cumque qui.",
- "default_channel": false,
- "internal": false,
- "enabled": true,
- "created_by": "monroe.orn-3877",
- "created_by_name": "monroe.orn-3877",
- "created_at": "2026-11-17T01:49:57.231761Z",
- "updated_at": "2026-11-17T01:49:57.231761Z",
- "kwargs": { },
- "job_code": "create_change_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e732-50de-7270-88e8-fcefed72c51d",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/create_change_job"
}
}
}, - "links": {
- "self": "/api/projects/opc/notification_channels/run_change",
- "parent": "/api/projects/opc"
}
}
]
}Delete a trigger created on this node, and its event filter when no other subscriber uses it. Its notification channel is kept. Its creator, or anyone who can delete on the node, may delete it.
| project_code required | string Example: opc project code |
| trigger_id required | string Example: 019a2b3c-4d5e-7f60-8a9b-0c1d2e3f4a5b trigger (event subscriber) id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find EventSubscriber"
}
}
]
}Lists all global notification channels.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=slack API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e730-10eb-77ca-977c-28c0d97bb447",
- "type": "notification_channel",
- "attributes": {
- "format": "html",
- "code": "system_email",
- "description": "System channel for email notifications",
- "default_channel": true,
- "internal": false,
- "enabled": true,
- "created_by": "moshe-2653",
- "created_by_name": "moshe-2653",
- "created_at": "2026-11-17T01:47:29.386237Z",
- "updated_at": "2026-11-17T01:47:29.386237Z",
- "kwargs": {
- "address": "smtp.gmail.com",
- "port": 587,
- "enable_starttls": true,
- "user_name": "user@gmail.com",
- "password": "{{hidden}}"
}, - "job_code": "email_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-10db-745a-b025-109345f68957",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/email_job"
}
}
}, - "links": {
- "self": "/api/system_configuration/notification_channels/system_email",
- "parent": "/api/system_configuration"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Create a global notification channel, available to every node in the instance.
required | object |
{- "data": {
- "attributes": {
- "code": "ops_team_slack",
- "notification_job_code": "direct_job",
- "format": "slack",
- "default_channel": false,
- "enabled": true,
- "description": "Slack channel for the operations team"
}
}
}{- "data": {
- "id": "01a1e730-130a-7634-b1d1-47571ff95e91",
- "type": "notification_channel",
- "attributes": {
- "format": "slack",
- "code": "ops_team_slack",
- "description": "Slack channel for the operations team",
- "default_channel": false,
- "internal": false,
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "created_at": "2026-11-17T01:47:29.929297Z",
- "updated_at": "2026-11-17T01:47:29.929297Z",
- "kwargs": {
- "url": "{{hidden}}"
}, - "job_code": "direct_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-1225-7596-b33d-f28fd0a43dc2",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/direct_job"
}
}
}, - "links": {
- "self": "/api/system_configuration/notification_channels/ops_team_slack",
- "parent": "/api/system_configuration"
}
}
}Sends a test notification through the channel and returns what the notification job reported.
The supplied attributes are merged over the channel's stored kwargs for this send only - nothing is saved - and supply whatever the job needs but the channel does not store, such as the to address of an email channel. The subject and body are always the test message, so subject and body attributes are ignored. Testing a channel requires permission to update it. Only email and direct message channels can be tested, and a disabled channel is rejected.
| notification_channel_code required | string Example: system_email notification channel code |
required | object |
{- "data": {
- "attributes": {
- "to": "ops-team@example.com"
}
}
}{- "data": {
- "id": "01a1e730-175b-70a4-ab23-34a111f5f63d",
- "type": "notification_channel_test",
- "attributes": {
- "result": [
- "Email sent successfully"
]
}
}
}Show a global notification channel.
| notification_channel_code required | string Example: system_email notification channel code |
{- "data": {
- "id": "01a1e730-1aba-7c7a-8e3a-00eeb6470602",
- "type": "notification_channel",
- "attributes": {
- "format": "html",
- "code": "system_email",
- "description": "System channel for email notifications",
- "default_channel": true,
- "internal": false,
- "enabled": true,
- "created_by": "dallas-2668",
- "created_by_name": "dallas-2668",
- "created_at": "2026-11-17T01:47:31.897560Z",
- "updated_at": "2026-11-17T01:47:31.897560Z",
- "kwargs": {
- "address": "smtp.gmail.com",
- "port": 587,
- "enable_starttls": true,
- "user_name": "user@gmail.com",
- "password": "{{hidden}}"
}, - "job_code": "email_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-1ab0-76c7-a0e8-926afcef8111",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/email_job"
}
}
}, - "links": {
- "self": "/api/system_configuration/notification_channels/system_email",
- "parent": "/api/system_configuration"
}
}
}Update a global notification channel.
| notification_channel_code required | string Example: system_email notification channel code |
required | object |
{- "data": {
- "attributes": {
- "notification_job_code": "direct_job",
- "format": "slack",
- "default_channel": false,
- "enabled": false,
- "description": "New channel description"
}
}
}{- "data": {
- "id": "01a1e730-1cfb-7750-a346-d2ae0bcb21ec",
- "type": "notification_channel",
- "attributes": {
- "format": "slack",
- "code": "system_email",
- "description": "New channel description",
- "default_channel": false,
- "internal": false,
- "enabled": false,
- "created_by": "jonie_schmeler-2670",
- "created_by_name": "jonie_schmeler-2670",
- "created_at": "2026-11-17T01:47:32.473841Z",
- "updated_at": "2026-11-17T01:47:32.583006Z",
- "kwargs": {
- "url": "{{hidden}}"
}, - "job_code": "direct_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-1c48-779a-a9ed-295ef81dc3d4",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/direct_job"
}
}
}, - "links": {
- "self": "/api/system_configuration/notification_channels/system_email",
- "parent": "/api/system_configuration"
}
}
}Delete a global notification channel.
| notification_channel_code required | string Example: system_email notification channel code |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the notification channel",
- "detail": "Your authorisation rules let you view the notification channel but not delete it."
}
]
}List notification channels for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_eq]=slack API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e730-2c7c-7289-b6f0-270951389723",
- "type": "notification_channel",
- "attributes": {
- "format": "slack",
- "code": "project_direct",
- "description": "Project specific channel for slack notifications",
- "default_channel": true,
- "internal": false,
- "enabled": true,
- "created_by": "isidra.kunze-2688",
- "created_by_name": "isidra.kunze-2688",
- "created_at": "2026-11-17T01:47:36.442503Z",
- "updated_at": "2026-11-17T01:47:36.442503Z",
- "kwargs": {
- "bot_name": "slack_bot",
- "token": "{{hidden}}"
}, - "job_code": "direct_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-2b28-7969-92de-6f9c8266b91f",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/direct_job"
}
}
}, - "links": {
- "self": "/api/projects/opc/notification_channels/project_direct",
- "parent": "/api/projects/opc"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Show a notification channel for a specific project, environment or asset..
| project_code required | string Example: opc project code |
| notification_channel_code required | string Example: system_email notification channel code |
{- "data": {
- "id": "01a1e730-2eda-71be-86a2-f67369d85747",
- "type": "notification_channel",
- "attributes": {
- "format": "slack",
- "code": "project_direct",
- "description": "Project specific channel for slack notifications",
- "default_channel": true,
- "internal": false,
- "enabled": true,
- "created_by": "rashida_rippin-2692",
- "created_by_name": "rashida_rippin-2692",
- "created_at": "2026-11-17T01:47:37.047598Z",
- "updated_at": "2026-11-17T01:47:37.047598Z",
- "kwargs": {
- "bot_name": "slack_bot",
- "token": "{{hidden}}"
}, - "job_code": "direct_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-2ddf-76e7-9948-ea1bb9fe90bc",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/direct_job"
}
}
}, - "links": {
- "self": "/api/projects/opc/notification_channels/project_direct",
- "parent": "/api/projects/opc"
}
}
}Update a notification channel for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| notification_channel_code required | string Example: system_email notification channel code |
required | object |
{- "data": {
- "attributes": {
- "notification_job_code": "direct_job",
- "format": "slack",
- "default_channel": false,
- "enabled": false,
- "description": "New channel description"
}
}
}{- "data": {
- "id": "01a1e730-33c9-7e25-8c08-02e6083a2a0e",
- "type": "notification_channel",
- "attributes": {
- "format": "slack",
- "code": "project_direct",
- "description": "New channel description",
- "default_channel": false,
- "internal": false,
- "enabled": false,
- "created_by": "arturo.sawayn-2700",
- "created_by_name": "arturo.sawayn-2700",
- "created_at": "2026-11-17T01:47:38.312781Z",
- "updated_at": "2026-11-17T01:47:38.338223Z",
- "kwargs": {
- "url": "{{hidden}}"
}, - "job_code": "direct_job"
}, - "relationships": {
- "notification_job": {
- "data": {
- "id": "01a1e730-3344-7e7d-8e38-a0d9941742ea",
- "type": "notification_job"
}, - "links": {
- "related": "/api/notification_jobs/direct_job"
}
}
}, - "links": {
- "self": "/api/projects/opc/notification_channels/project_direct",
- "parent": "/api/projects/opc"
}
}
}Delete a notification channel for a specific project, environment or asset..
| project_code required | string Example: opc project code |
| notification_channel_code required | string Example: system_email notification channel code |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the notification channel",
- "detail": "Your authorisation rules let you view the notification channel but not delete it."
}
]
}Lists all notification jobs.
kwargs_schema groups the keyword arguments a channel or trigger can pass to the job: required must all be given, optional may be given, and each entry of one_of needs at least one of its members, where a member that is itself a list is satisfied by any of its names.
| filter[<query/sort filter>]= |
{- "data": [
- {
- "id": "01a1e730-3d4b-7c26-9ca4-79a3b43d0060",
- "type": "notification_job",
- "attributes": {
- "job_class": "Notifications::SendEmailJob",
- "target_type": "smtp",
- "valid_formats": [
- "html",
- "text"
], - "code": "email_job",
- "description": "Send an email to the target user(s)",
- "created_at": "2026-11-17T01:47:40.746892Z",
- "updated_at": "2026-11-17T01:47:40.746892Z",
- "all_kwargs": [
- "address",
- "authentication",
- "bcc",
- "body",
- "cc",
- "content_type",
- "domain",
- "enable_starttls",
- "enable_starttls_auto",
- "event_id",
- "from",
- "model_class",
- "model_id",
- "open_timeout",
- "openssl_verify_mode",
- "password",
- "port",
- "read_timeout",
- "ssl",
- "subject",
- "test",
- "tls",
- "to",
- "user_name"
], - "kwargs_schema": {
- "required": [
- "body",
- "subject"
], - "optional": [
- "address",
- "authentication",
- "content_type",
- "domain",
- "enable_starttls",
- "enable_starttls_auto",
- "event_id",
- "from",
- "model_class",
- "model_id",
- "open_timeout",
- "openssl_verify_mode",
- "password",
- "port",
- "read_timeout",
- "ssl",
- "test",
- "tls",
- "user_name"
], - "one_of": [
- [
- "to",
- "cc",
- "bcc"
]
]
}
}, - "relationships": {
- "notification_channels": {
- "data": [ ],
- "links": {
- "related": "/api/notification_jobs/email_job/channels"
}
}
}, - "links": {
- "self": "/api/notification_jobs/email_job"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Show a notification job.
kwargs_schema groups the keyword arguments a channel or trigger can pass to the job: required must all be given, optional may be given, and each entry of one_of needs at least one of its members, where a member that is itself a list is satisfied by any of its names.
| notification_job_code required | string Example: email_job notification job code |
{- "data": {
- "id": "01a1e730-3e28-7825-9cfd-4175a4a53d07",
- "type": "notification_job",
- "attributes": {
- "job_class": "Notifications::SendEmailJob",
- "target_type": "smtp",
- "valid_formats": [
- "html",
- "text"
], - "code": "email_job",
- "description": "Send an email to the target user(s)",
- "created_at": "2026-11-17T01:47:40.965136Z",
- "updated_at": "2026-11-17T01:47:40.965136Z",
- "all_kwargs": [
- "address",
- "authentication",
- "bcc",
- "body",
- "cc",
- "content_type",
- "domain",
- "enable_starttls",
- "enable_starttls_auto",
- "event_id",
- "from",
- "model_class",
- "model_id",
- "open_timeout",
- "openssl_verify_mode",
- "password",
- "port",
- "read_timeout",
- "ssl",
- "subject",
- "test",
- "tls",
- "to",
- "user_name"
], - "kwargs_schema": {
- "required": [
- "body",
- "subject"
], - "optional": [
- "address",
- "authentication",
- "content_type",
- "domain",
- "enable_starttls",
- "enable_starttls_auto",
- "event_id",
- "from",
- "model_class",
- "model_id",
- "open_timeout",
- "openssl_verify_mode",
- "password",
- "port",
- "read_timeout",
- "ssl",
- "test",
- "tls",
- "user_name"
], - "one_of": [
- [
- "to",
- "cc",
- "bcc"
]
]
}
}, - "relationships": {
- "notification_channels": {
- "data": [ ],
- "links": {
- "related": "/api/notification_jobs/email_job/channels"
}
}
}, - "links": {
- "self": "/api/notification_jobs/email_job"
}
}
}Returns information about the jobs that are being processed by the OpsChain.
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. 1000 ] Default: 100 Example: limit=50 Limit the number of jobs returned |
| cursor | string Example: cursor=2026-11-10T01:02:03.456789Z,12345 Returns the jobs after this one. Jobs are always returned newest first, so the filter cannot include sorts. Use the next_cursor value from the previous page's meta |
{- "data": [
- {
- "id": "257556",
- "type": "job",
- "attributes": {
- "priority": 67,
- "job_class": "ChangeJob",
- "error_count": 1,
- "last_error_message": "ActiveRecord::LockWaitTimeout: could not obtain lock on row in relation \"steps\"",
- "queue": "default",
- "last_error_backtrace": "/opt/opschain/app/jobs/change_job.rb:24:in 'ChangeJob#run'",
- "data": "{}",
- "maximum_retry_count": 0,
- "node_id": "01a1e72f-4cc3-7e6d-b2d5-783584a5af42",
- "node_path": "/projects/opc/environments/dev",
- "status": "failed",
- "worker_hostname": "opschain-api-worker-7c4d8b9948-7bg6t",
- "args": "[]",
- "kwargs": "{}",
- "description": "Verifies if a change can be started based on its owner configuration and, if so, starts it.",
- "run_at": "2026-11-16T07:36:28.759371Z",
- "finished_at": "2026-11-17T01:46:39.205050Z",
- "expired_at": null
}
}, - {
- "id": "720074",
- "type": "job",
- "attributes": {
- "priority": 27,
- "job_class": "RefreshTemplateVersionActionsJob",
- "error_count": 3,
- "last_error_message": "Que::JobMethods::JobTimeoutError: job exceeded its maximum run time",
- "queue": "default",
- "last_error_backtrace": "/opt/opschain/app/jobs/refresh_template_version_actions_job.rb:18:in 'run'",
- "data": "{}",
- "maximum_retry_count": 0,
- "node_id": "01a1e72f-4cc3-7e6d-b2d5-783584a5af42",
- "node_path": "/projects/opc/environments/dev",
- "status": "failed",
- "worker_hostname": null,
- "args": "[]",
- "kwargs": "{}",
- "description": "No description available.",
- "run_at": "2026-11-16T06:18:22.133929Z",
- "finished_at": null,
- "expired_at": "2026-11-17T01:16:39.235204Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "has_any": true,
- "total_matching_filter": 2,
- "total_matching_filter_exact": true,
- "next_cursor": null
}
}Endpoints to interact with settings.
Lists the settings that set a setting, ordered by id, with the value each one sets.
Notes:
null. A setting whose value is an empty object is not set, but false, "" and [] are.vault matches settings that set vault.mount_path.owner to identify the project, environment, asset, template, template version, change or system configuration whose settings they are.filter[with_setting] filter on the list scheduled activities endpoint to find the scheduled activities whose settings overrides set it.required | object Use |
| limit | integer [ 1 .. 10000 ] Default: 100 Example: limit=100 The maximum number of settings to return. A 206 response is returned when more settings set the setting than the limit. |
| include | string Example: include=owner Include the settings owners in the response |
{- "data": [
- {
- "id": "01a1e731-3175-7691-8a73-89b95b7c5039",
- "type": "settings",
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1,
- "created_at": "2026-11-17T01:48:43.251834Z",
- "value": ".opschain"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e731-315c-715e-9456-7a4f3fcd77e9",
- "type": "node"
}, - "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/01a1e731-3175-7691-8a73-89b95b7c5039",
- "current_version": "/api/settings/01a1e731-3175-7691-8a73-89b95b7c5039/versions/1",
- "versions": "/api/settings/01a1e731-3175-7691-8a73-89b95b7c5039/versions"
}
}
], - "included": [
- {
- "id": "01a1e731-315c-715e-9456-7a4f3fcd77e9",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "warner-3273",
- "created_by_name": "warner-3273"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01a1e731-3160-7106-a679-dfe0581f5035",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-3160-7106-a679-dfe0581f5035"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "01a1e731-3175-7691-8a73-89b95b7c5039",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-3175-7691-8a73-89b95b7c5039"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "artifacts": "/api/projects/opc/artifacts",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true,
- "delete": true
}, - "git_remotes": {
- "read": true,
- "update": true,
- "delete": true
}, - "templates": {
- "read": true,
- "update": true,
- "delete": true
}, - "workflows": {
- "read": true,
- "update": true,
- "delete": true
}, - "changes": {
- "read": true,
- "execute": true,
- "delete": true
}, - "workflow_runs": {
- "read": true,
- "execute": true,
- "delete": true
}, - "environments": {
- "read": true,
- "update": true,
- "delete": true
}, - "assets": {
- "read": true,
- "update": true,
- "delete": true
}, - "agents": {
- "read": true,
- "update": true,
- "delete": true
}, - "secrets": {
- "settings": true,
- "properties": true,
- "mintmodel": true,
- "create": true
}, - "self": {
- "update": true,
- "delete": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows the current settings.
| settings_id required | string Example: 01a1e72a-f096-7a8b-8e2d-53d5ebc265fd settings id |
{- "data": {
- "id": "01a1e731-3491-7f54-957c-8481e520a688",
- "type": "settings",
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1,
- "created_at": "2026-11-17T01:48:44.048921Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/01a1e731-3491-7f54-957c-8481e520a688",
- "current_version": "/api/settings/01a1e731-3491-7f54-957c-8481e520a688/versions/1",
- "versions": "/api/settings/01a1e731-3491-7f54-957c-8481e520a688/versions"
}
}
}Updates a settings JSON if the included version matches the current settings version.
| id_to_update required | string Example: 01a1e72a-f096-7a8b-8e2d-53d5ebc265fd settings id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1
}
}
}{- "data": {
- "id": "01a1e731-37ff-7172-a5a4-53ae254d1654",
- "type": "settings",
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1,
- "created_at": "2026-11-17T01:48:44.925865Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/01a1e731-37ff-7172-a5a4-53ae254d1654",
- "current_version": "/api/settings/01a1e731-37ff-7172-a5a4-53ae254d1654/versions/1",
- "versions": "/api/settings/01a1e731-37ff-7172-a5a4-53ae254d1654/versions"
}
}
}Updates a settings JSON, without any version checking (always updates).
| id_to_set required | string Example: 01a1e72a-f096-7a8b-8e2d-53d5ebc265fd settings id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}
}
}
}{- "data": {
- "id": "01a1e731-3ddd-79fa-af79-6acac05e2d79",
- "type": "settings",
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1,
- "created_at": "2026-11-17T01:48:46.428405Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/01a1e731-3ddd-79fa-af79-6acac05e2d79",
- "current_version": "/api/settings/01a1e731-3ddd-79fa-af79-6acac05e2d79/versions/1",
- "versions": "/api/settings/01a1e731-3ddd-79fa-af79-6acac05e2d79/versions"
}
}
}Endpoints to interact with the version history for settings.
Lists all versions of an OpsChain settings.
| settings_id required | string Example: 01a1e72a-f096-7a8b-8e2d-53d5ebc265fd settings id |
| limit | integer [ 1 .. 10000 ] Default: 1000 Example: limit=50 Limit the number of settings versions returned. When more records match than the limit a 206 response is returned and |
| exclude_data | boolean Default: false Example: exclude_data=true Exclude the |
{- "data": [
- {
- "id": "01a1e731-4274-7234-b7ee-685b20b02337",
- "type": "settings_version",
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1,
- "created_at": "2026-11-17T01:48:47.603045Z"
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e731-426f-770c-b17d-4bb223b535b2",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-426f-770c-b17d-4bb223b535b2"
}
}
}, - "links": {
- "versions": "/api/settings/01a1e731-426f-770c-b17d-4bb223b535b2/versions",
- "owner": "/api/projects/opc",
- "self": "/api/settings/01a1e731-426f-770c-b17d-4bb223b535b2/versions/1"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows the settings values for this settings version.
| settings_id required | string Example: 01a1e72a-f096-7a8b-8e2d-53d5ebc265fd settings id |
| version_number required | integer Example: 1 version number |
{- "data": {
- "id": "01a1e731-447a-70c1-a320-c06a82f34977",
- "type": "settings_version",
- "attributes": {
- "data": {
- "repo_folder": ".opschain",
- "requires_approval_from": [
- {
- "change_filter": {
- "actions": "all"
}, - "user_names": [
- "opschain"
]
}
]
}, - "version": 1,
- "created_at": "2026-11-17T01:48:48.121227Z"
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e731-4476-74a7-b5c3-0b570c0ff4b7",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-4476-74a7-b5c3-0b570c0ff4b7"
}
}
}, - "links": {
- "versions": "/api/settings/01a1e731-4476-74a7-b5c3-0b570c0ff4b7/versions",
- "owner": "/api/projects/opc",
- "self": "/api/settings/01a1e731-4476-74a7-b5c3-0b570c0ff4b7/versions/1"
}
}
}List all authorisation tokens.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[description_cont]=automation |
{- "data": [
- {
- "id": "01a1e72c-1ab6-7bbd-9bf3-b4309cc5f146",
- "type": "authentication_token",
- "attributes": {
- "type": "AccessToken",
- "expires_at": "2026-11-17T05:43:09.000000Z",
- "created_at": "2026-11-17T01:43:09.662037Z",
- "updated_at": "2026-11-17T01:43:09.662037Z"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e72c-1932-77a3-b33a-af4b2632a10c",
- "type": "user"
}, - "links": {
- "owner": "/api/users/01a1e72c-1932-77a3-b33a-af4b2632a10c"
}
}
}, - "links": {
- "self": "/api/tokens/01a1e72c-1ab6-7bbd-9bf3-b4309cc5f146"
}
}, - {
- "id": "01a1e72c-1a4e-7822-8a4f-c9ea20db186f",
- "type": "authentication_token",
- "attributes": {
- "type": "ApiKeyToken",
- "description": "CI token for API access",
- "registered_vault_credentials": false,
- "secret_vault_access": false,
- "expires_at": "2027-05-17T01:43:09.638969Z",
- "created_at": "2026-11-17T01:43:09.643441Z",
- "updated_at": "2026-11-17T01:43:09.643441Z"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e72c-1932-77a3-b33a-af4b2632a10c",
- "type": "user"
}, - "links": {
- "owner": "/api/users/01a1e72c-1932-77a3-b33a-af4b2632a10c"
}
}
}, - "links": {
- "self": "/api/tokens/01a1e72c-1a4e-7822-8a4f-c9ea20db186f"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Creates an access token for the current user.
Notes:
token.enable_cookies setting is true (default) a new refresh_token cookie is set in the response and the supplied refresh token is rotated (destroyed and replaced). The response body contains only the access token.token.enable_cookies setting is false and the refresh token is supplied to authenticate the request a new refresh token is included in the response meta and the supplied refresh token is rotated (destroyed and replaced). The new refresh token JWT is available in data.meta.refresh_token.meta.warnings.secret_vault_session.meta.warnings.secret_vault_session is "Your secret vault session has ended - sign in again with your password to restore secret vault access".required | object |
{- "data": {
- "attributes": {
- "username": "username",
- "password": "password"
}
}
}{- "data": {
- "id": "01a1e72c-1c63-7cc9-94d8-d9f30647494c",
- "type": "authentication_token",
- "attributes": {
- "type": "AccessToken",
- "expires_at": "2026-11-17T05:43:10.000000Z",
- "created_at": "2026-11-17T01:43:10.030259Z",
- "updated_at": "2026-11-17T01:43:10.030259Z"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e72c-1b4a-79bb-98cf-77a022a798ef",
- "type": "user"
}, - "links": {
- "owner": "/api/users/01a1e72c-1b4a-79bb-98cf-77a022a798ef"
}
}
}, - "links": {
- "self": "/api/tokens/01a1e72c-1c63-7cc9-94d8-d9f30647494c"
}, - "meta": {
- "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWExZTcyYy0xYzYzLTdjYzktOTRkOC1kOWYzMDY0NzQ5NGMiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTc5NDg5NDE5MCwiaWF0IjoxNzk0ODc5NzkwfQ.oQFQs35KVs9mZ4Rj1ih9DdM3bLigkdDD6Qw-ObaLzD0"
}
}
}Creates an API key token for the current user.
Notes:
/api/user_system_credentials), resolved afresh on every request, so registering, replacing or deleting a credential changes the key's access at once. Its registered_vault_credentials attribute is true. API keys created before this attribute existed must be recreated with your password to gain it.secret_vault_access attribute shows whether the key holds one. The key keeps it for as long as the key is valid, and loses it if the owner's secret vault policies change or the owner is blocked - create a new API key with the password to restore it.meta.warnings.secret_vault_session. If the key also has no registered secret vault credential to use, meta.warnings.secret_vault_credential says so.| Authorization | string an access token, as |
required | object |
{- "data": {
- "attributes": {
- "username": "username",
- "password": "password",
- "description": "CI token for API access",
- "expiry_date": "2027-05-17T01:41:56.153923Z"
}
}
}{- "data": {
- "id": "01a1e72c-1e59-750b-97a2-a49f224ac0ec",
- "type": "authentication_token",
- "attributes": {
- "type": "ApiKeyToken",
- "description": "Dolor et fugiat voluptatum.",
- "registered_vault_credentials": true,
- "secret_vault_access": false,
- "expires_at": "2026-12-01T23:59:59.999999Z",
- "created_at": "2026-11-17T01:43:10.680254Z",
- "updated_at": "2026-11-17T01:43:10.680254Z"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e72c-1df1-7c1c-a588-26e94b4173a8",
- "type": "user"
}, - "links": {
- "owner": "/api/users/01a1e72c-1df1-7c1c-a588-26e94b4173a8"
}
}
}, - "links": {
- "self": "/api/tokens/01a1e72c-1e59-750b-97a2-a49f224ac0ec"
}, - "meta": {
- "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWExZTcyYy0xZTU5LTc1MGItOTdhMi1hNDlmMjI0YWMwZWMiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTc5NjE2OTU5OSwiaWF0IjoxNzk0ODc5NzkwfQ.ZslVQ8W3zWPgldzz-9CxWMxQfn-bWxLIIs0HMVe8B6Y"
}
}, - "meta": {
- "warnings": {
- "secret_vault_credential": "This API key uses your registered secret vault credentials, but you have none registered - register one using /api/user_system_credentials to give it secret vault access"
}
}
}Returns a URL that downloads the supplied API URL without an Authorization header, for use as a browser link.
Notes:
url must be a relative API URL that includes the download query parameter.download_token query parameter that is valid for 60 seconds, for that exact URL and only for as long as the access token used to create it remains valid.| Authorization required | string access token bearer authorisation |
required | object |
{- "data": {
- "attributes": {
- "url": "/api/activities?download=activities.csv"
}
}
}{- "meta": {
- "download_url": "/api/activities?download=activities.csv&download_token=eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW5faWQiOiIwMWExZTcyYy0yMTIwLTc3MzItYjM5Mi0zNDUxODExZWU1MTMiLCJhdWQiOiJvcHNjaGFpbl9kb3dubG9hZCIsImV4cCI6MTc5NDg3OTg1MSwiaWF0IjoxNzk0ODc5NzkxLCJyZXEiOiI0NDkxY2EwZjFiMjZkMzBmZjIxZWIzYmYzYzQ0ZGFhNzE0N2NmNWFhYmJjYzg1MzJhNDE3YWU1N2Q5MjU0YzNiIn0.h4D-1z5-Tm3DRpZ1oyREivcuVvIvNYFIMNFQ-_Ib6Rc"
}
}Show an authorisation token.
| token_id required | string Example: 01a1e72a-fb38-7267-84a4-cd7daeb9c791 authorisation token id |
{- "data": {
- "id": "01a1e72c-26ee-7e6c-b515-2b4b4ce2f120",
- "type": "authentication_token",
- "attributes": {
- "type": "ApiKeyToken",
- "description": "CI token for API access",
- "registered_vault_credentials": false,
- "secret_vault_access": false,
- "expires_at": "2027-05-17T01:43:12.870857Z",
- "created_at": "2026-11-17T01:43:12.876158Z",
- "updated_at": "2026-11-17T01:43:12.876158Z"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e72c-2496-70af-8b60-6cd151f9aff3",
- "type": "user"
}, - "links": {
- "owner": "/api/users/01a1e72c-2496-70af-8b60-6cd151f9aff3"
}
}
}, - "links": {
- "self": "/api/tokens/01a1e72c-26ee-7e6c-b515-2b4b4ce2f120"
}
}
}Shows the access token used to authenticate the request. When the request authenticates with a username and password instead of a token, returns an array of all the current user's access tokens.
{- "data": [
- {
- "id": "01a1e72c-2aed-7346-b578-d3a4b4153b42",
- "type": "authentication_token",
- "attributes": {
- "type": "AccessToken",
- "expires_at": "2026-11-17T05:43:13.000000Z",
- "created_at": "2026-11-17T01:43:13.811472Z",
- "updated_at": "2026-11-17T01:43:13.811472Z"
}, - "relationships": {
- "owner": {
- "data": {
- "id": "01a1e72c-2a47-7be4-9801-c768d1605b8b",
- "type": "user"
}, - "links": {
- "owner": "/api/users/01a1e72c-2a47-7be4-9801-c768d1605b8b"
}
}
}, - "links": {
- "self": "/api/tokens/01a1e72c-2aed-7346-b578-d3a4b4153b42"
}
}
]
}{- "data": [
- {
- "id": "01a1e732-79d8-75d4-817c-38fe678c32bf",
- "type": "user",
- "attributes": {
- "username": "logged_in_user",
- "groupnames": [
- "ldap-group-1",
- "ldap-group-2"
], - "auth_provider": "ldap",
- "email_address": "logged_in_user@limepoint.com",
- "display_name": null,
- "first_name": null,
- "last_name": null,
- "default_notification_methods": [
- "slack"
], - "direct_message_ids": {
- "slack": "IF55CJ0PE",
- "teams": "QK3E5HLR0"
}, - "created_at": "2026-11-17T01:50:07.312542Z",
- "updated_at": "2026-11-17T01:50:07.312542Z",
- "disabled_at": null
}, - "meta": { },
- "links": {
- "self": "/api/users/01a1e732-79d8-75d4-817c-38fe678c32bf"
}
}
]
}Show a user.
| user_id required | string Example: 01a1e72a-ed50-7440-a463-7b36d183d36e user id |
{- "data": {
- "id": "01a1e732-7cf1-7b7e-a12e-21c807eed973",
- "type": "user",
- "attributes": {
- "username": "logged_in_user",
- "groupnames": [
- "ldap-group-1",
- "ldap-group-2"
], - "auth_provider": "ldap",
- "email_address": "logged_in_user@limepoint.com",
- "display_name": null,
- "first_name": null,
- "last_name": null,
- "default_notification_methods": [
- "slack"
], - "direct_message_ids": {
- "slack": "DZ071FULY",
- "teams": "50SDMPJKR"
}, - "created_at": "2026-11-17T01:50:08.109015Z",
- "updated_at": "2026-11-17T01:50:08.109015Z",
- "disabled_at": null
}, - "meta": {
- "superuser": true
}, - "links": {
- "self": "/api/users/01a1e732-7cf1-7b7e-a12e-21c807eed973"
}
}
}Update a user's notification preferences, and a local user's names.
| user_id required | string Example: 01a1e72a-ed50-7440-a463-7b36d183d36e user id |
required | object |
{- "data": {
- "attributes": {
- "email_address": "user@limepoint.com",
- "display_name": "Jane Citizen",
- "first_name": "Jane",
- "last_name": "Citizen",
- "default_notification_methods": [
- "email",
- "slack"
], - "direct_message_ids": {
- "slack": "U12345678"
}
}
}
}{- "data": {
- "id": "01a1e732-85f1-7341-baf9-ae7d87591c15",
- "type": "user",
- "attributes": {
- "username": "logged_in_user",
- "groupnames": [
- "ldap-group-1",
- "ldap-group-2"
], - "auth_provider": "ldap",
- "email_address": "logged_in_user@limepoint.com",
- "display_name": null,
- "first_name": null,
- "last_name": null,
- "default_notification_methods": [
- "email",
- "slack"
], - "direct_message_ids": {
- "slack": "U12345678"
}, - "created_at": "2026-11-17T01:50:10.415083Z",
- "updated_at": "2026-11-17T01:50:10.587058Z",
- "disabled_at": null
}, - "meta": { },
- "links": {
- "self": "/api/users/01a1e732-85f1-7341-baf9-ae7d87591c15"
}
}
}{- "data": {
- "id": "01a1e732-8c67-719d-bbbb-04834979439d",
- "type": "user",
- "attributes": {
- "username": "logged_in_user",
- "groupnames": [
- "ldap-group-1",
- "ldap-group-2"
], - "auth_provider": "ldap",
- "email_address": "logged_in_user@limepoint.com",
- "display_name": null,
- "first_name": null,
- "last_name": null,
- "default_notification_methods": [
- "slack"
], - "direct_message_ids": {
- "slack": "5ZPKGQLLJ",
- "teams": "II1NXGZA0"
}, - "created_at": "2026-11-17T01:50:12.069773Z",
- "updated_at": "2026-11-17T01:50:12.069773Z",
- "disabled_at": null
}, - "meta": {
- "superuser": true
}, - "links": {
- "self": "/api/users/01a1e732-8c67-719d-bbbb-04834979439d"
}
}
}Endpoints to manage your own credentials for external systems such as the secret vault. OpsChain uses them to act as you, instead of with the system-wide credentials, when you store a value in the secret vault or retrieve one outside a change. A credential applies to the node path it is registered against and every node below it. Credential values are never returned, and only their owner can see or change them.
Register one of your own tokens for an external system. For the secret vault, log in to the vault yourself and create a token there under the
policies your vault administrators gave you; OpsChain never sees your password. external_vault_code names the vault the token is for - bundled
(the default) for the secret vault bundled with OpsChain, or the code of a registered external vault (see /api/external_vaults). A credential is
used wherever the settings assign its vault, whatever the mount path. You may hold one credential per system per vault. OpsChain checks the token
with that vault before storing it, and rejects a token the vault does not accept.
required | object |
{- "data": {
- "attributes": {
- "target_system": "secret_vault",
- "external_vault_code": "team_vault",
- "token": "hvs.CAESIJ"
}
}
}{- "data": {
- "id": "01a1e732-906c-7065-afc1-14b8bc3d29a8",
- "type": "user_system_credential",
- "attributes": {
- "target_system": "secret_vault",
- "vault": {
- "code": "team_vault",
- "name": "Team vault",
- "bundled": false
}, - "managed": false,
- "created_at": "2026-11-17T01:50:13.093793Z",
- "updated_at": "2026-11-17T01:50:13.093793Z"
}, - "links": {
- "self": "/api/user_system_credentials/01a1e732-906c-7065-afc1-14b8bc3d29a8"
}
}
}Lists your own system credentials. Tokens are never returned.
{- "data": [
- {
- "id": "01a1e732-9625-7a8d-95f5-fe16844ab3a2",
- "type": "user_system_credential",
- "attributes": {
- "target_system": "secret_vault",
- "vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true
}, - "managed": false,
- "created_at": "2026-11-17T01:50:14.564545Z",
- "updated_at": "2026-11-17T01:50:14.564545Z"
}, - "links": {
- "self": "/api/user_system_credentials/01a1e732-9625-7a8d-95f5-fe16844ab3a2"
}
}
]
}Show one of your own system credentials.
| credential_id required | string user system credential id |
{- "data": {
- "id": "01a1e732-96c7-7748-82d5-bc2397ce3dbb",
- "type": "user_system_credential",
- "attributes": {
- "target_system": "secret_vault",
- "vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true
}, - "managed": false,
- "created_at": "2026-11-17T01:50:14.726397Z",
- "updated_at": "2026-11-17T01:50:14.726397Z"
}, - "links": {
- "self": "/api/user_system_credentials/01a1e732-96c7-7748-82d5-bc2397ce3dbb"
}
}
}Replace the token of one of your own system credentials. A managed credential - the secret vault token OpsChain keeps for your session - cannot be updated, and is reported as not found. A new token is checked with the secret vault before it is stored.
| credential_id required | string user system credential id |
required | object |
{- "data": {
- "attributes": {
- "token": "hvs.CAESIJ"
}
}
}{- "data": {
- "id": "01a1e732-9881-77d1-9a0d-fe3538ab5c64",
- "type": "user_system_credential",
- "attributes": {
- "target_system": "secret_vault",
- "vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true
}, - "managed": false,
- "created_at": "2026-11-17T01:50:15.168249Z",
- "updated_at": "2026-11-17T01:50:15.329355Z"
}, - "links": {
- "self": "/api/user_system_credentials/01a1e732-9881-77d1-9a0d-fe3538ab5c64"
}
}
}Delete one of your own system credentials. A managed credential - the secret vault token OpsChain keeps for your session - cannot be deleted, and is reported as not found; sign out to revoke it.
| credential_id required | string user system credential id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find UserSystemCredential"
}
}
]
}Lists notifications the user has configured for a specific project, environment or asset (that do not reference a specific action or workflow).
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "01a1e730-4034-7d57-b99f-6ca36495a41f",
- "type": "change_notifications",
- "attributes": {
- "events": [
- "error",
- "success"
], - "include_children": false
}
}, - {
- "id": "01a1e730-4034-7d57-b99f-6ca36495a41f",
- "type": "settings_notifications",
- "attributes": {
- "events": [ ],
- "include_children": false
}
}, - {
- "id": "01a1e730-4034-7d57-b99f-6ca36495a41f",
- "type": "properties_notifications",
- "attributes": {
- "events": [ ],
- "include_children": false
}
}
]
}Lists all change specific notifications the user has configured for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": {
- "id": "01a1e730-47a0-7c56-b4ee-3dd4935ad63b",
- "type": "action_notifications",
- "attributes": {
- "custom_proj_action": {
- "events": [
- "error"
], - "include_children": false
}, - "proj_action_1": {
- "events": [
- "error"
], - "include_children": false
}, - "proj_action_2": {
- "events": [ ],
- "include_children": false
}, - "provision": {
- "events": [ ],
- "include_children": false
}
}
}
}Lists the events the user is notified of for each of the project's workflows, keyed by workflow code.
Workflow notifications belong to the project. An environment or asset path returns an empty set and cannot be updated.
| project_code required | string Example: opc project code |
{- "data": {
- "id": "01a1e730-4bb4-7e33-9676-45f9488dfbd3",
- "type": "workflow_run_notifications",
- "attributes": {
- "assets": [ ],
- "custom_workflow": [
- "start"
], - "workflow_2": [
- "start"
]
}
}
}Lists every notification the user has configured, across every node, keyed by node path.
A user may only list their own notifications - the id in the path must be the authenticated user's own.
| user_id required | string Example: 01a1e72a-ed50-7440-a463-7b36d183d36e user id |
{- "data": {
- "id": "01a1e730-4f62-7217-9716-c89a5c7f31a2",
- "type": "all_user_notifications",
- "attributes": {
- "/projects/opc/assets/prj_soa": {
- "node": {
- "changes": {
- "events": [
- "error",
- "success"
], - "include_children": false
}, - "settings": {
- "events": [ ],
- "include_children": false
}, - "properties": {
- "events": [ ],
- "include_children": false
}
}, - "changes": {
- "custom_proj_action": {
- "events": [
- "error"
], - "include_children": false
}, - "proj_action_1": {
- "events": [
- "error"
], - "include_children": false
}, - "proj_action_2": {
- "events": [ ],
- "include_children": false
}, - "provision": {
- "events": [ ],
- "include_children": false
}
}
}, - "/projects/opc/environments/dev/assets/env_soa": {
- "node": {
- "changes": {
- "events": [
- "cancel",
- "start"
], - "include_children": false
}, - "settings": {
- "events": [ ],
- "include_children": false
}, - "properties": {
- "events": [ ],
- "include_children": false
}
}, - "changes": {
- "env_action_1": {
- "events": [ ],
- "include_children": false
}, - "env_action_2": {
- "events": [ ],
- "include_children": false
}, - "provision": {
- "events": [ ],
- "include_children": false
}
}
}, - "/projects/opc": {
- "node": {
- "changes": {
- "events": [ ],
- "include_children": false
}, - "workflow_runs": {
- "events": [
- "cancel",
- "success"
], - "include_children": false
}, - "settings": {
- "events": [ ],
- "include_children": false
}, - "properties": {
- "events": [ ],
- "include_children": false
}
}, - "changes": {
- "whole_project": {
- "events": [
- "error"
], - "include_children": true
}
}, - "workflow_runs": {
- "assets": [ ],
- "custom_workflow": [
- "start"
], - "workflow_2": [
- "start"
]
}
}
}
}
}Lists the secret vaults a setting can assign through vault.code, and that a user can register a credential for: the bundled secret vault first, then every external vault in name order. Only the code and name of each vault are returned.
{- "data": [
- {
- "id": "bundled",
- "type": "external_vault_picker",
- "attributes": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true
}
}, - {
- "id": "team_vault",
- "type": "external_vault_picker",
- "attributes": {
- "code": "team_vault",
- "name": "Team vault",
- "bundled": false
}
}
]
}Returns the decrypted values of the supplied secrets
Notes:
results and reported instead as an error whose meta.source is the value as supplied. If some values resolve the response is a partial content (206) response containing both the data and the errors; if none resolve it is an unprocessable content (422) response containing only the errors.meta.secret_vault_credential_required lists the vault it needs one for. In a partial content response the same list is also returned in meta.secret_vault_credential_required.required | object |
{- "data": {
- "attributes": {
- "owner_type": "settings",
- "owner_id": "01a1e72a-f81a-78b4-be41-e2dfc1c97d81",
- "source": "settings",
- "mintmodel_owner_path": "/projects/opc/assets/prj_soa",
- "converge_date": "2026-11-17T01:42:03.286711Z",
- "values_to_decrypt": [
- "secret-vault://csh/infrastructure/files/oci_platform_configs.yaml",
- "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A=="
], - "key_paths": [
- "/files/oci_platform_configs",
- "/credentials/0"
]
}
}
}{- "data": {
- "id": "secrets",
- "type": "secrets",
- "attributes": {
- "results": [
- {
- "source": "secret-vault://csh/infrastructure/files/oci_platform_configs.yaml",
- "result": "decrypted value",
- "filename": null
}, - {
- "source": "secret-vault://csh/infrastructure/sshkeys/oci_new_key",
- "result": "decrypted value",
- "filename": null
}
]
}
}
}Returns the decrypted value of a secret resolved directly from the secret vault
Notes:
expected_vault_value, fails with an unprocessable content error.meta.secret_vault_credential_required lists the vault it needs one for.required | object |
{- "data": {
- "attributes": {
- "vault_owner_id": "01a1e72a-f7f1-7858-95ce-493be7ec5234",
- "vault_path": "secret-vault://path/to/vault/vault_key",
- "expected_vault_value": "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A=="
}
}
}{- "data": {
- "id": "secrets",
- "type": "secrets",
- "attributes": {
- "results": [
- {
- "source": "secret-vault://path/to/vault/vault_key",
- "result": "decrypted value",
- "filename": null
}
]
}
}
}Returns the OpsChain-encrypted form of the supplied value
Notes:
updatable permission on /secrets fails with an unprocessable content error.required | object |
{- "data": {
- "attributes": {
- "value_to_encrypt": "the value to encrypt"
}
}
}{- "data": {
- "id": "secrets",
- "type": "secrets",
- "attributes": {
- "results": [
- {
- "source": "the value to encrypt",
- "result": "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A==",
- "filename": null
}
]
}
}
}Creates a secret value in the secret vault at the supplied path
Notes:
vault_path must start with secret-vault:// and include a path and a key, otherwise the request fails with an unprocessable content error.updatable permission on the owning node's secrets path (or /secrets) fails with an unprocessable content error. A template or template version is authorised as its project.meta.secret_vault_credential_required lists the vault it needs one for.required | object |
object |
{- "data": {
- "attributes": {
- "vault_owner_id": "01a1e72a-f7f1-7858-95ce-493be7ec5234",
- "vault_owner_type": "node",
- "vault_path": "secret-vault://path/to/vault/vault_key",
- "vault_value": "the value to store"
}
}, - "meta": {
- "replace_secret": false
}
}{- "data": {
- "id": "secrets",
- "type": "secrets",
- "attributes": {
- "results": [
- {
- "source": "secret-vault://path/to/vault/vault_key",
- "result": "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A==",
- "filename": null
}
]
}
}
}Uploads a file and stores its contents in the secret vault at the supplied path
Notes:
vault_path must start with secret-vault:// and include a path and a key, otherwise the request fails with an unprocessable content error.updatable permission on the owning node's secrets path (or /secrets) fails with an unprocessable content error. A template or template version is authorised as its project.meta.secret_vault_credential_required lists the vault it needs one for.| vault_owner_id | string (Node, template or template version whose vault configuration is used to store the secret) |
| vault_owner_type | string (default: node) Enum: "node" "template" "template_version" Whether the vault_owner_id identifies a node, a template or a template version |
| vault_path | string |
| replace_secret | string (Replace the secret vault value if it exists (default: false)) |
| file | string <binary> The file whose contents are stored in the secret vault (binary content is base64 encoded automatically). The filename is ignored. |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="vault_owner_id" 01a1e731-2e9a-7624-9932-54780803698c ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="vault_path" secret-vault://path/to/vault/vault_key ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="sample.txt" content-type: text/plain content-length: 21 Sample file property ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "secrets",
- "type": "secrets",
- "attributes": {
- "results": [
- {
- "source": "secret-vault://path/to/vault/vault_key",
- "result": "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A==",
- "filename": "sample.txt"
}
]
}
}
}{- "data": {
- "id": "0",
- "type": "info",
- "attributes": {
- "cluster_name": "opschain-db",
- "version": "edge",
- "runner_image": "limepoint/opschain-runner-enterprise:edge",
- "db_version": "17.2",
- "api_version": "7.1.5.1",
- "ldap_available?": true,
- "banners": [ ],
- "instance_info": { },
- "licence_info": {
- "licence_issuer": "LimePoint Pty Ltd",
- "licence_issuer_contact": "support@limepoint.com",
- "licence_version": "1",
- "customer_identifier": "Engineering",
- "start_date": "2025-09-14T00:00:00Z",
- "end_date": "2026-09-14T00:00:00Z"
}, - "maintenance_mode": false,
- "maintenance_mode_exempts_superusers": false
}, - "links": {
- "self": "/api/info"
}, - "meta": {
- "authorisations": {
- "superuser": true,
- "secrets": {
- "global_decrypt": true,
- "global_encrypt": true,
- "global_store": false
}
}, - "secret_vault": {
- "code": "bundled",
- "name": "Bundled secret vault",
- "bundled": true,
- "credential": null,
- "registrable": true,
- "store_policy": false
}, - "service_credential_settings_paths": [
- [
- "ldap",
- "password"
], - [
- "vault",
- "token"
], - [
- "vault",
- "username"
], - [
- "vault",
- "password"
], - [
- "vault",
- "recovery_key"
], - [
- "vault",
- "runner_username"
], - [
- "vault",
- "runner_password"
], - [
- "vault_ldap_auth",
- "bind_password"
], - [
- "secret_vault_admin",
- "token"
], - [
- "secret_vault_admin",
- "recovery_key"
], - [
- "token",
- "secret_key"
], - [
- "token",
- "previous_secret_keys"
], - [
- "token",
- "verifier_secret"
], - [
- "token",
- "previous_verifier_secrets"
], - [
- "pguser"
], - [
- "pgpassword"
], - [
- "secret_vault_unseal_key"
]
]
}
}
}Lists certificates in the trust store.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[filename_cont]=root API filtering guide. Named filters: |
{- "data": [
- {
- "id": "ca_self.pem",
- "type": "certificate",
- "attributes": {
- "filename": "ca_self.pem",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "Main CA cert.",
- "created_at": "2026-11-17T01:50:02.212902Z",
- "updated_at": "2026-11-17T01:50:02.212902Z"
}, - "links": {
- "self": "/api/trust_store/ca_self.pem"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Creates a certificate in the trust store.
| description | string or null |
| file | string <binary> certificate file, the uploaded file's filename is used to name the new certificate |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="description" New certificate description ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="remote_system.crt" content-type: application/x-x509-ca-cert content-length: 1887 -----BEGIN CERTIFICATE----- MIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL BQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l ZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD DAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ KoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16 SOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE gdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5 RqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt dxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS GbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v iNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28 X8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH E+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf 0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI djd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW YlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV LjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD AQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk pjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX QKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0 R8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW xerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk NDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15 ZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW hcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR tMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd esPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5 AuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B WbrO/ELdag== -----END CERTIFICATE----- ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "remote_system.crt",
- "type": "certificate",
- "attributes": {
- "filename": "remote_system.crt",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "New certificate description",
- "created_at": "2026-11-17T01:50:02.763598Z",
- "updated_at": "2026-11-17T01:50:02.763598Z"
}, - "links": {
- "self": "/api/trust_store/remote_system.crt"
}
}
}Shows a certificate from the trust store.
| certificate_filename required | string Example: ca_self.pem certificate filename |
{- "data": {
- "id": "ca_self.pem",
- "type": "certificate",
- "attributes": {
- "filename": "ca_self.pem",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "Main CA cert.",
- "created_at": "2026-11-17T01:50:03.587984Z",
- "updated_at": "2026-11-17T01:50:03.587984Z"
}, - "links": {
- "self": "/api/trust_store/ca_self.pem"
}
}
}Delete certificate from the trust store.
| certificate_filename required | string Example: ca_self.pem certificate filename |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the certificate",
- "detail": "Your authorisation rules let you view the certificate but not delete it."
}
]
}Updates a certificate in the trust store.
| certificate_filename required | string Example: ca_self.pem certificate filename |
| description | string or null |
| file | string <binary> certificate file (the filename is ignored) |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="description" Updated certificate description ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="remote_system.crt" content-type: application/x-x509-ca-cert content-length: 1887 -----BEGIN CERTIFICATE----- MIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL BQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l ZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD DAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ KoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16 SOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE gdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5 RqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt dxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS GbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v iNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28 X8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH E+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf 0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI djd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW YlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV LjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD AQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk pjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX QKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0 R8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW xerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk NDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15 ZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW hcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR tMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd esPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5 AuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B WbrO/ELdag== -----END CERTIFICATE----- ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "remote_system.crt",
- "type": "certificate",
- "attributes": {
- "filename": "remote_system.crt",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "Updated certificate description",
- "created_at": "2026-11-17T01:50:05.859191Z",
- "updated_at": "2026-11-17T01:50:05.859191Z"
}, - "links": {
- "self": "/api/trust_store/remote_system.crt"
}
}
}Updates the system licence.
| licence | string |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="licence"; filename="expired_opschain.licence" content-type: application/json content-length: 924 {"data":{"license_issuer":"LimePoint Pty Ltd","license_issuer_contact":"support@limepoint.com","license_version":"1","customer_identifier":"Engineering","start_date":"2023-11-14T00:00:00Z","end_date":"2024-02-14T00:00:00Z"},"signature":"m/hevqjjrYYjOS8ZtgVGGerm028UpKWw/I1cGB4vcJCwI805OtAo1PmszCxWQGOXilgAqyLERLluimRBckFYVL8yx7+rTFxF4D13FqwbwRL5HcKKkV1wwGgzuMpaGE8JGpAq/CkBq6l3xL+jPv/CSYaEyE55+20UdmkZdkvR2vKoJtqDzA1q/4T9tiPA0YIKDjjxSasLBpqokl0iUuaDWksaIhXjdsKmj0FSPfVD2VyPyrBSc1sv0pR+qz98Ny9ef7t6/pIaphLo8Yaa2dnJykeXtAWiaLe+25/OWxEHZoZBvKjentD5dzvqiA8Xo1qhm/tMurTQq4BGJvWYK70LQY9EXlxd+1XLbFX0qdNBNFnzf+rjbGfrLIMw2NFhsODDordSh5P3xNGGG4JyXrwXVRPUaw30celB+uYK3vvDzis0DSBXSA+D9JV3E9YxbI4xuT9Kf+bl0+cr/BajEBhuzATk30a8y5Zqn2MfCBmMb1iLkoFWWvFA+cfUsKsWk3O4YDmR3paOz+HVrSA5HlwaOMOU/P15/q5YFfN6ZEz4DW28I+lfFE3PtgkCsjcPCd99Ca4ZSmiok/l55zRxxrYl6Xc1TNOuq58yp05U798VaEEvmCaVvp5Fk/+TrbGMWKUlPPvc86RzsOlI8Qkdn75SJM3WMEl931m4A52g6jF6+T0="} ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "expired_opschain.licence",
- "type": "licence",
- "attributes": {
- "licence": "licence data"
}
}
}Shows the current system configuration node.
| include | string Example: include=settings Include the settings in the response |
| fields[<resource_type>] |
{- "data": {
- "id": "01a1e731-afa7-79fa-8ac8-b9bb73d693db",
- "type": "system_configuration",
- "attributes": {
- "code": "system",
- "name": "System Configuration",
- "description": "System configuration node"
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e731-afc8-7479-9dc9-15917fa57b00",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e731-afc8-7479-9dc9-15917fa57b00"
}
}, - "properties": {
- "data": {
- "id": "01a1e731-afaf-73b5-a121-1686e9458d3a",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01a1e731-afaf-73b5-a121-1686e9458d3a"
}
}
}, - "links": {
- "self": "/api/system_configuration",
- "settings": "/api/settings/01a1e731-afc8-7479-9dc9-15917fa57b00",
- "properties": "/api/properties/01a1e731-afaf-73b5-a121-1686e9458d3a"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "can_have_actions": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": true,
- "create": true
}, - "self": {
- "update": true
}
}, - "secret_vault": {
- "mount_path": "secrets",
- "use_mint_encryption": true
}
}
}, - "included": [
- {
- "id": "01a1e731-afc8-7479-9dc9-15917fa57b00",
- "type": "settings",
- "attributes": {
- "data": {
- "allow_parallel": {
- "changes": true,
- "runs_of_same_change": false,
- "runs_of_same_workflow": false
}, - "artifact": {
- "max_file_size": "500Mi",
- "hard_max_file_size": "2Gi",
- "compression": "zstd",
- "compression_level": 3
}, - "auth_strategy": "ldap",
- "enable_basic_auth": true,
- "token": {
- "secret_key": "{AES2}L0lcEyJeGkah97O8dYzAww=={/IV}UKlgkQrYsn1xEQ94a6vQyzwRHwvYDlnMlTrsF2kYHpnFQb6YGZvYxVBiPR2+clrQDLQnKXV00i4R2DtUhcrEHXa8FF2RvrhxU3D0eh8iL49P9oOtFeYDcM/B5j7aUmMa0e6+xhrfKslBZTazVVOHO1WguJq9Aaq3tFR+Me3VeVXTLUwbOseeD0DGfbRk3wKV4",
- "verifier_secret": "{AES2}fxsJlym771quV/pyZOQukw=={/IV}U6yCsP6uGXOnrH3cCP/xIzdvDNPUwdxZ4Yi8ODV7xULmy5OO2VNJ1DgbGPe6q7uWSDHvtql6iGjhETPzNf+UEeb6FCv1HwB+sRKSV8GZnKs9NqgIsPNhP4dayInhFGp+vSJUTlB5hZWi8hWVnF8Q7daWCtNltcIwbtSQO/Y96wzPF2JV9f2bpUbcBa/GTenn6",
- "access_expiry": 240,
- "refresh_expiry": 10080,
- "enable_cookies": true
}, - "product_name": "OpsChain",
- "api_autoscaler": {
- "mode": "active",
- "min_workers": 3,
- "max_workers": 14
}, - "build_service": {
- "max_image_build_retries": 3,
- "max_concurrent_image_builds": 8,
- "image_build_throttle_delay": 2
}, - "concurrent": {
- "refresh_limit": 2,
- "runner_limit": 6,
- "agent_limit": 5
}, - "executor_pool": {
- "enabled": false,
- "filesystem_isolation_scope": "change",
- "hung_step_timeout": 900,
- "idle_timeout": 1800,
- "keep_alive": false,
- "max_idle_slots": 10,
- "separate_creators": false,
- "sharing_scope": "asset",
- "step_start_memory_percent": 75
}, - "git_remote": {
- "fetch_lock_timeout": 300,
- "fetch_stale_threshold": 3,
- "periodic_fetch_interval": 900,
- "periodic_fetch_summary": {
- "enabled": true,
- "interval": 86400
}, - "mountable": null,
- "ssh": {
- "connect_timeout": 10,
- "server_alive_interval": 30,
- "server_alive_count_max": 3
}
}, - "log_step_pod_events": false,
- "agent": {
- "repository": "limepoint",
- "name": "opschain-runner-enterprise",
- "image_tag": "local",
- "script_path": "/opt/opschain/agent.sh",
- "disable_host_alias": false
}, - "runner": {
- "repository": "limepoint",
- "name": "opschain-runner-enterprise",
- "image_tag": "local",
- "action_server_idle_timeout": 600,
- "node_selector": "{}",
- "reuse_actions_rb": true,
- "use_fork_for_mintpress_ctl_rb": true
}, - "parallel_change_worker_steps": 10,
- "repo_folder": ".opschain",
- "ldap": {
- "cache_ttl": 60,
- "refresh_interval": 14400,
- "search_timeout": 30,
- "refresh_search_timeout": 300,
- "hc_user": "{AES2}mn4PUnmeTY/pV1TxxJljaw=={/IV}U5DTvswBLwpw23+T+1zpZFw==",
- "enable_ssl": false,
- "host": "opschain-ldap",
- "port": 389,
- "password": "{AES2}LwoRoJE5HXafUhMJPA+Q/A=={/IV}Uf8EEbgm3GMzc3NWu63V0eQ==",
- "mail_attribute": "mail",
- "use_admin_to_bind": true,
- "groups_filter": "(objectClass=groupOfNames)",
- "users_filter": "(objectClass=inetOrgPerson)",
- "new_group_object_class": [
- "groupOfNames"
], - "new_user_object_class": [
- "inetOrgPerson",
- "top"
], - "new_org_unit_object_class": [
- "organizationalUnit",
- "top"
], - "logging_enabled": true,
- "admin": "cn=admin,dc=opschain,dc=io",
- "base_dn": "dc=opschain,dc=io",
- "group_attribute": "member",
- "group_base": "ou=groups,dc=opschain,dc=io",
- "user_attribute": "uid",
- "user_base": "ou=test,dc=opschain,dc=io",
- "display_name_attribute": "cn",
- "first_name_attribute": "givenName",
- "last_name_attribute": "sn"
}, - "diagnostics": {
- "memory_event_interval": 0
}, - "image_reuse": {
- "enabled": true,
- "ttl_days": 7,
- "build_relies_on_parents": false
}, - "licence": "",
- "maintenance_mode": "disabled",
- "max_concurrent_steps": 5,
- "log_aggregator_additional_output_settings": "",
- "log_email_events": false,
- "log_buffer_size": "256Mi",
- "log_forwarding": {
- "max_queued_lines": 2000000
}, - "pod_templates": {
- "change_worker": {
- "resources": {
- "requests": {
- "cpu": "100m",
- "memory": "256Mi"
}, - "limits": {
- "memory": "4Gi"
}
}
}, - "step_runner": {
- "resources": {
- "requests": {
- "cpu": "100m",
- "memory": "256Mi"
}, - "limits": {
- "memory": "4Gi"
}
}
}, - "generate_actions": {
- "resources": {
- "requests": {
- "cpu": "100m",
- "memory": "256Mi"
}, - "limits": {
- "memory": "4Gi"
}
}
}, - "agent": {
- "resources": {
- "requests": {
- "cpu": "100m",
- "memory": "256Mi"
}, - "limits": {
- "memory": "4Gi"
}
}
}
}, - "remote_runners": {
- "auto_upgrade": false,
- "auto_upgrade_concurrency": 1
}, - "resource_limits": {
- "max_pod_memory": "8Gi"
}, - "requires_approval_from": [ ],
- "scheduled_activity_max_waiting_runs": 5,
- "known_hosts": [ ],
- "include_git_history": false,
- "mintmodel_render_timeout": 300,
- "mintmodel_retry_out_of_memory": false,
- "pod_per_change_step": false,
- "poll_interval": 3,
- "vault": { },
- "version": "local",
- "zstd_compression_level": 3
}, - "version": 1,
- "created_at": "2026-11-17T01:49:15.590406Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/system_configuration"
}
}
}, - "links": {
- "self": "/api/settings/01a1e731-afc8-7479-9dc9-15917fa57b00",
- "current_version": "/api/settings/01a1e731-afc8-7479-9dc9-15917fa57b00/versions/1",
- "versions": "/api/settings/01a1e731-afc8-7479-9dc9-15917fa57b00/versions"
}
}
]
}Returns every database cluster that has registered itself, whether its workers are currently running work and how its copy of the database is keeping up. The replication status is either primary, streaming (up to date), lagging (behind and still catching up), disconnected (a replication slot exists but nothing is attached to it) or lost (too far behind to catch up, so its copy has to be rebuilt). It is only reported for what the primary database can see, so it is absent for a database cluster that streams from another replica rather than from the primary.
{- "data": [
- {
- "id": "opschain-db",
- "type": "cluster",
- "attributes": {
- "name": "opschain-db",
- "role": "primary",
- "cordon_reason": null,
- "consuming_work": true,
- "cordoned": false,
- "cordoned_by": null,
- "cordoned_by_name": null,
- "replication_status": "primary",
- "replication_lag_seconds": null,
- "work_in_progress": {
- "changes": 0,
- "agents": 0,
- "background_tasks": 0
}, - "last_worker_seen_at": "2026-11-17T01:42:22.794501Z",
- "api_started_at": "2026-11-17T01:42:22.775055Z",
- "cordoned_at": null
}
}
], - "meta": {
- "authorisations": {
- "cordon": true
}
}
}Cordons a site so it takes no new work, or uncordons it so it takes work again. Work already running in a cordoned site carries on there until it finishes, including its running agents, and is reported in each site's work_in_progress. A site cannot be cordoned while no other site is taking work.
| name required | string The name of the site (its database cluster) |
required | object |
{- "data": {
- "attributes": {
- "cordoned": true,
- "cordon_reason": "Disaster recovery test"
}
}
}{- "data": {
- "id": "opschain-db",
- "type": "cluster",
- "attributes": {
- "name": "opschain-db",
- "role": "primary",
- "cordon_reason": "Disaster recovery test",
- "consuming_work": true,
- "cordoned": true,
- "cordoned_by": "logged_in_user",
- "cordoned_by_name": "logged_in_user",
- "replication_status": "primary",
- "replication_lag_seconds": null,
- "work_in_progress": {
- "changes": 0,
- "agents": 0,
- "background_tasks": 0
}, - "last_worker_seen_at": "2026-11-17T01:42:23.187665Z",
- "api_started_at": "2026-11-17T01:42:23.186340Z",
- "cordoned_at": "2026-11-17T01:42:23.224158Z"
}
}
}Returns status information about the OpsChain database.
{- "data": [
- {
- "id": "0",
- "type": "database_status",
- "attributes": {
- "version": "18.6",
- "uptime": 71,
- "database_size": "16 MB",
- "connections": {
- "active": 3,
- "idle": 9,
- "max_configured": 100
}, - "connection_settings": {
- "pgdb": "opschain",
- "pghost": "opschain-db",
- "pgport": 5432
}, - "table_sizes": [
- {
- "name": "steps",
- "size": "248 kB"
}, - {
- "name": "changes",
- "size": "240 kB"
}, - {
- "name": "workflow_steps",
- "size": "232 kB"
}, - {
- "name": "nodes",
- "size": "216 kB"
}, - {
- "name": "node_background_tasks",
- "size": "184 kB"
}, - {
- "name": "que_job_history",
- "size": "168 kB"
}, - {
- "name": "que_jobs",
- "size": "144 kB"
}, - {
- "name": "template_versions",
- "size": "136 kB"
}, - {
- "name": "events",
- "size": "128 kB"
}, - {
- "name": "policy_assignments",
- "size": "128 kB"
}, - {
- "name": "workflow_runs",
- "size": "120 kB"
}, - {
- "name": "schema_migrations",
- "size": "120 kB"
}, - {
- "name": "template_version_history",
- "size": "112 kB"
}, - {
- "name": "workflows",
- "size": "112 kB"
}, - {
- "name": "templates",
- "size": "112 kB"
}, - {
- "name": "authorisation_rules",
- "size": "104 kB"
}, - {
- "name": "settings",
- "size": "104 kB"
}, - {
- "name": "users",
- "size": "104 kB"
}, - {
- "name": "policy_rules",
- "size": "104 kB"
}, - {
- "name": "workflow_versions",
- "size": "96 kB"
}, - {
- "name": "mintmodel_history",
- "size": "96 kB"
}, - {
- "name": "scheduled_activities",
- "size": "88 kB"
}, - {
- "name": "bookmarks",
- "size": "80 kB"
}, - {
- "name": "authorisation_policies",
- "size": "80 kB"
}, - {
- "name": "solid_cache_entries",
- "size": "80 kB"
}, - {
- "name": "step_properties_versions",
- "size": "72 kB"
}, - {
- "name": "commits",
- "size": "64 kB"
}, - {
- "name": "log_lines",
- "size": "56 kB"
}, - {
- "name": "properties_versions",
- "size": "48 kB"
}, - {
- "name": "remote_runner_assignments",
- "size": "48 kB"
}, - {
- "name": "properties",
- "size": "48 kB"
}, - {
- "name": "remote_runner_targets",
- "size": "48 kB"
}, - {
- "name": "asset_mintmodel_actions",
- "size": "48 kB"
}, - {
- "name": "cluster_registrations",
- "size": "48 kB"
}, - {
- "name": "ldap_directory_entries",
- "size": "48 kB"
}, - {
- "name": "git_remotes",
- "size": "48 kB"
}, - {
- "name": "mintmodels",
- "size": "48 kB"
}, - {
- "name": "notification_channels",
- "size": "48 kB"
}, - {
- "name": "settings_versions",
- "size": "48 kB"
}, - {
- "name": "agent_statuses",
- "size": "40 kB"
}, - {
- "name": "executor_pool_slots",
- "size": "40 kB"
}, - {
- "name": "base_event_subscribers",
- "size": "40 kB"
}, - {
- "name": "remote_runner_control_instructions",
- "size": "40 kB"
}, - {
- "name": "que_scheduler_audit_enqueued",
- "size": "40 kB"
}, - {
- "name": "artefacts",
- "size": "40 kB"
}, - {
- "name": "resource_slots",
- "size": "32 kB"
}, - {
- "name": "reusable_runner_images",
- "size": "32 kB"
}, - {
- "name": "vault_runner_credential_tags",
- "size": "32 kB"
}, - {
- "name": "change_memory_snapshots",
- "size": "32 kB"
}, - {
- "name": "certificates",
- "size": "32 kB"
}, - {
- "name": "que_job_worker_hostname",
- "size": "32 kB"
}, - {
- "name": "notification_jobs",
- "size": "32 kB"
}, - {
- "name": "ar_internal_metadata",
- "size": "32 kB"
}, - {
- "name": "pod_cap_claims",
- "size": "32 kB"
}, - {
- "name": "active_storage_postgres_large_objects",
- "size": "32 kB"
}, - {
- "name": "base_event_filters",
- "size": "32 kB"
}, - {
- "name": "que_lockers",
- "size": "32 kB"
}, - {
- "name": "user_system_credentials",
- "size": "32 kB"
}, - {
- "name": "git_remote_cluster_fetches",
- "size": "32 kB"
}, - {
- "name": "active_storage_attachments",
- "size": "32 kB"
}, - {
- "name": "active_storage_blobs",
- "size": "24 kB"
}, - {
- "name": "artefact_loads",
- "size": "24 kB"
}, - {
- "name": "active_storage_variant_records",
- "size": "24 kB"
}, - {
- "name": "background_data_migrations",
- "size": "24 kB"
}, - {
- "name": "background_schema_migrations",
- "size": "24 kB"
}, - {
- "name": "bundled_secret_vault_credentials",
- "size": "24 kB"
}, - {
- "name": "data_cleanup_definitions",
- "size": "24 kB"
}, - {
- "name": "change_resource_usages",
- "size": "24 kB"
}, - {
- "name": "external_vaults",
- "size": "24 kB"
}, - {
- "name": "rule_change_matches",
- "size": "24 kB"
}, - {
- "name": "remote_runner_target_scopes",
- "size": "24 kB"
}, - {
- "name": "user_preferences",
- "size": "24 kB"
}, - {
- "name": "step_status_events",
- "size": "24 kB"
}, - {
- "name": "vault_runner_credentials",
- "size": "24 kB"
}, - {
- "name": "rule_workflow_matches",
- "size": "16 kB"
}, - {
- "name": "authentication_tokens",
- "size": "16 kB"
}, - {
- "name": "step_resource_usages",
- "size": "16 kB"
}, - {
- "name": "log_line_batches",
- "size": "16 kB"
}, - {
- "name": "log_forward_queue",
- "size": "16 kB"
}, - {
- "name": "que_values",
- "size": "16 kB"
}, - {
- "name": "rule_node_matches",
- "size": "16 kB"
}, - {
- "name": "que_scheduler_audit",
- "size": "8192 bytes"
}, - {
- "name": "log_forwarding_state",
- "size": "8192 bytes"
}, - {
- "name": "change_parents",
- "size": "0 bytes"
}, - {
- "name": "queued_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "workflow_run_activities",
- "size": "0 bytes"
}, - {
- "name": "node_background_task_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "queued_mintmodel_step_jobs",
- "size": "0 bytes"
}, - {
- "name": "scheduled_activity_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "asset_summaries",
- "size": "0 bytes"
}, - {
- "name": "queued_step_jobs",
- "size": "0 bytes"
}, - {
- "name": "que_live_jobs",
- "size": "0 bytes"
}, - {
- "name": "log_lines_incoming",
- "size": "0 bytes"
}, - {
- "name": "jobs",
- "size": "0 bytes"
}, - {
- "name": "change_activities",
- "size": "0 bytes"
}, - {
- "name": "data_cleanup_definition_que_jobs",
- "size": "0 bytes"
}
], - "statistics_freshness": [
- {
- "name": "commits",
- "estimated_rows": null,
- "modifications_since_analyze": 36,
- "last_analyzed_at": null
}, - {
- "name": "git_remotes",
- "estimated_rows": null,
- "modifications_since_analyze": 34,
- "last_analyzed_at": null
}, - {
- "name": "templates",
- "estimated_rows": null,
- "modifications_since_analyze": 34,
- "last_analyzed_at": null
}, - {
- "name": "template_versions",
- "estimated_rows": null,
- "modifications_since_analyze": 34,
- "last_analyzed_at": null
}, - {
- "name": "workflow_steps",
- "estimated_rows": null,
- "modifications_since_analyze": 33,
- "last_analyzed_at": null
}, - {
- "name": "template_version_history",
- "estimated_rows": null,
- "modifications_since_analyze": 30,
- "last_analyzed_at": null
}, - {
- "name": "steps",
- "estimated_rows": null,
- "modifications_since_analyze": 16,
- "last_analyzed_at": null
}, - {
- "name": "changes",
- "estimated_rows": null,
- "modifications_since_analyze": 8,
- "last_analyzed_at": null
}, - {
- "name": "workflow_versions",
- "estimated_rows": null,
- "modifications_since_analyze": 8,
- "last_analyzed_at": null
}, - {
- "name": "workflows",
- "estimated_rows": null,
- "modifications_since_analyze": 6,
- "last_analyzed_at": null
}, - {
- "name": "step_properties_versions",
- "estimated_rows": null,
- "modifications_since_analyze": 6,
- "last_analyzed_at": null
}, - {
- "name": "mintmodel_history",
- "estimated_rows": null,
- "modifications_since_analyze": 5,
- "last_analyzed_at": null
}, - {
- "name": "rule_node_matches",
- "estimated_rows": null,
- "modifications_since_analyze": 5,
- "last_analyzed_at": null
}, - {
- "name": "mintmodels",
- "estimated_rows": null,
- "modifications_since_analyze": 3,
- "last_analyzed_at": null
}, - {
- "name": "workflow_runs",
- "estimated_rows": null,
- "modifications_since_analyze": 3,
- "last_analyzed_at": null
}, - {
- "name": "authorisation_rules",
- "estimated_rows": null,
- "modifications_since_analyze": 2,
- "last_analyzed_at": null
}, - {
- "name": "notification_channels",
- "estimated_rows": null,
- "modifications_since_analyze": 2,
- "last_analyzed_at": null
}, - {
- "name": "policy_rules",
- "estimated_rows": null,
- "modifications_since_analyze": 2,
- "last_analyzed_at": null
}, - {
- "name": "notification_jobs",
- "estimated_rows": null,
- "modifications_since_analyze": 2,
- "last_analyzed_at": null
}, - {
- "name": "scheduled_activities",
- "estimated_rows": null,
- "modifications_since_analyze": 2,
- "last_analyzed_at": null
}, - {
- "name": "bookmarks",
- "estimated_rows": null,
- "modifications_since_analyze": 2,
- "last_analyzed_at": null
}, - {
- "name": "log_lines",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "policy_assignments",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "data_cleanup_definitions",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "base_event_filters",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "events",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "artefacts",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "remote_runner_target_scopes",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "agent_statuses",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "authentication_tokens",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "authorisation_policies",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "certificates",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "remote_runner_targets",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "base_event_subscribers",
- "estimated_rows": null,
- "modifications_since_analyze": 1,
- "last_analyzed_at": null
}, - {
- "name": "user_preferences",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "step_status_events",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "remote_runner_assignments",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "ar_internal_metadata",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "log_forward_queue",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "schema_migrations",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "reusable_runner_images",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "active_storage_attachments",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "active_storage_postgres_large_objects",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "active_storage_blobs",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "asset_mintmodel_actions",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "artefact_loads",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "active_storage_variant_records",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "background_data_migrations",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "background_schema_migrations",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "bundled_secret_vault_credentials",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "git_remote_cluster_fetches",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "change_resource_usages",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "executor_pool_slots",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "cluster_registrations",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "change_memory_snapshots",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "que_job_history",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "que_job_worker_hostname",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "ldap_directory_entries",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "external_vaults",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "log_forwarding_state",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "log_line_batches",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "pod_cap_claims",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "que_scheduler_audit",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "que_lockers",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "que_values",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "que_scheduler_audit_enqueued",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "remote_runner_control_instructions",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "rule_change_matches",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "rule_workflow_matches",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "solid_cache_entries",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "vault_runner_credentials",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "step_resource_usages",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "vault_runner_credential_tags",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "resource_slots",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "user_system_credentials",
- "estimated_rows": null,
- "modifications_since_analyze": 0,
- "last_analyzed_at": null
}, - {
- "name": "node_background_tasks",
- "estimated_rows": null,
- "modifications_since_analyze": 12,
- "last_analyzed_at": "2026-11-17T01:42:16.117038+00:00"
}, - {
- "name": "nodes",
- "estimated_rows": null,
- "modifications_since_analyze": 8,
- "last_analyzed_at": "2026-11-17T01:42:16.131064+00:00"
}, - {
- "name": "users",
- "estimated_rows": null,
- "modifications_since_analyze": 25,
- "last_analyzed_at": "2026-11-17T01:42:16.148729+00:00"
}, - {
- "name": "properties",
- "estimated_rows": null,
- "modifications_since_analyze": 16,
- "last_analyzed_at": "2026-11-17T01:42:16.150414+00:00"
}, - {
- "name": "settings",
- "estimated_rows": null,
- "modifications_since_analyze": 16,
- "last_analyzed_at": "2026-11-17T01:42:16.160864+00:00"
}, - {
- "name": "settings_versions",
- "estimated_rows": null,
- "modifications_since_analyze": 16,
- "last_analyzed_at": "2026-11-17T01:42:16.165927+00:00"
}, - {
- "name": "que_jobs",
- "estimated_rows": null,
- "modifications_since_analyze": 29,
- "last_analyzed_at": "2026-11-17T01:42:16.176656+00:00"
}, - {
- "name": "properties_versions",
- "estimated_rows": null,
- "modifications_since_analyze": 16,
- "last_analyzed_at": "2026-11-17T01:42:16.185297+00:00"
}
]
}, - "links": {
- "self": "/api/admin/database"
}
}
]
}Returns whether the OpsChain instance is currently drained (no active changes, workflow runs, or node background tasks), along with the active count for each. Intended to be checked before proceeding with a maintenance-mode upgrade window, to confirm nothing is still in-flight.
{- "data": [
- {
- "id": "0",
- "type": "drain_status",
- "attributes": {
- "drained": true,
- "active_counts": {
- "changes": 0,
- "workflow_runs": 0,
- "node_background_tasks": 0
}
}, - "links": {
- "self": "/api/admin/drain_status"
}
}
]
}Returns every node background task (generate actions requests, MintModel concretise tasks, agent image builds, agent start/stop tasks) that has not yet finished, across all nodes.
{- "data": [ ]
}{- "data": [
- {
- "id": "opschain.limepoint.engineering",
- "type": "node_status",
- "attributes": {
- "name": "opschain.limepoint.engineering",
- "creation_timestamp": "2024-03-05T00:03:56Z",
- "kubelet_version": "v1.29.6+k3s2",
- "container_runtime_version": "docker://24.0.2",
- "os": "linux",
- "os_image": "Fedora Linux 36 (Server Edition)",
- "architecture": "amd64",
- "roles": [
- "control-plane",
- "master"
], - "metrics": {
- "cpu": "100m",
- "memory": "100Mi"
}, - "conditions": [
- {
- "type": "MemoryPressure",
- "status": "False",
- "reason": "KubeletHasSufficientMemory",
- "message": "kubelet has sufficient memory available",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}, - {
- "type": "DiskPressure",
- "status": "False",
- "reason": "KubeletHasNoDiskPressure",
- "message": "kubelet has no disk pressure",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}, - {
- "type": "PIDPressure",
- "status": "False",
- "reason": "KubeletHasSufficientPID",
- "message": "kubelet has sufficient PID available",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}, - {
- "type": "Ready",
- "status": "True",
- "reason": "KubeletReady",
- "message": "kubelet is posting ready status",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}
], - "capacity": {
- "cpu": "16",
- "memory": "131907404Ki",
- "pods": "110",
- "ephemeral_storage": "103757316Ki"
}, - "allocatable": {
- "cpu": "16",
- "memory": "131907404Ki",
- "pods": "110",
- "ephemeral_storage": "100935116926"
}, - "images": [
- {
- "names": [
- "registry.local.gd:3443/opschain/runner@sha256:256",
- "registry.local.gd:3443/opschain/runner:01234-id"
], - "size_bytes": 2615498231
}
]
}
}
]
}Returns the status of the OpsChain queues and details about their jobs. This covers the shared default queue and the per cluster queues, one for each cluster in the topology.
{- "data": [
- {
- "id": "default",
- "type": "queue_status",
- "attributes": {
- "name": "default",
- "summary": {
- "total": 10,
- "running": 2,
- "failed": 1,
- "scheduled": 3,
- "finished": 4,
- "pending": 1
}, - "jobs": [
- {
- "job_class": "ChangeJob",
- "total": 5,
- "running": 1,
- "failed": 1,
- "scheduled": 2,
- "finished": 3,
- "pending": 0,
- "next_run_at": "2026-11-17T13:42:26.725+11:00",
- "last_run_at": "2026-11-17T11:42:26.725+11:00",
- "highest_error_count": 2,
- "description": "Verifies if a change can be started based on its owner configuration and, if so, starts it."
}, - {
- "job_class": "DataCleanupJob",
- "total": 5,
- "running": 0,
- "failed": 0,
- "scheduled": 0,
- "finished": 0,
- "pending": 0,
- "next_run_at": "2026-11-17T13:42:26.725+11:00",
- "last_run_at": "2026-11-17T10:42:26.725+11:00",
- "highest_error_count": 0,
- "description": "Cleans up data based on a data cleanup definition."
}
]
}
}
]
}Returns the status of the actions_refresh, runner, mintmodel_concretise, and image_build slot pools, including per-slot occupancy.
{- "data": [
- {
- "id": "runner",
- "type": "resource_slot_pool",
- "attributes": {
- "pool": "runner",
- "configured_limit": 15,
- "row_count": 15,
- "claimed_count": 1,
- "free_count": 14,
- "slots": [
- {
- "slot_number": 1,
- "claimed_kind": "step_runner",
- "claimed_by_resource_id": "0efdb3e1-addd-442a-a459-03a962197547",
- "claimed_at": "2026-11-17T12:37:26.979+11:00",
- "node_path": "/projects/opc/environments/dev/assets/env_soa",
- "stale": false,
- "eligible": true
}, - {
- "slot_number": 2,
- "claimed_kind": null,
- "claimed_by_resource_id": null,
- "claimed_at": null,
- "node_path": null,
- "stale": null,
- "eligible": true
}
]
}
}
]
}Returns the status of all the OpsChain API workers in the configured namespace.
{- "data": [
- {
- "id": "opschain-api-worker-1",
- "type": "worker",
- "attributes": {
- "namespace": "opschain",
- "node": "node-1",
- "host_ip": "192.168.1.1",
- "pod_ip": "192.168.1.2",
- "start_time": "2021-01-01T00:00:00Z",
- "state": "Running",
- "image": "opschain-api-worker-image",
- "restart_count": 0,
- "uid": "b2c3d4e5-6f70-4a8b-9c0d-1e2f3a4b5c6d",
- "containers": [
- "opschain-api-worker"
], - "controlled_by": "ReplicaSet/opschain-api-worker-7d9f8b6c5d",
- "labels": {
- "app": "opschain-api-worker"
}
}, - "links": {
- "logs": "/api/admin/pods/opschain-api-worker-1/logs"
}
}
]
}Returns every deployment in the OpsChain Kubernetes namespace, including its replica counts, rollout status and the time it was last restarted.
Notes:
meta.max_replicas.meta.max_replicas is greater than 1 - carries a scale link. A client should use the presence of the link to decide whether to offer scaling, rather than matching on the deployment name.resources (requests and limits). The MintModel API deployment also reports its live meta.concurrency, meta.transformer_heap and meta.transformer_spares, and the smallest memory limit they need as meta.minimum_memory_limit, so a client can show the current sizing before changing it. These are read from the running deployment, so they include any change made through the resources endpoint.resources link. As with scaling, a client should use the presence of the link rather than the deployment name.meta.authorisations.resources, meta.authorisations.restart and meta.authorisations.scale report whether the user may perform those operations, allowing a client to hide the controls it cannot use.{- "data": [
- {
- "id": "opschain-api",
- "type": "deployment",
- "attributes": {
- "namespace": "opschain",
- "uid": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "creation_timestamp": "2021-01-01T00:00:00Z",
- "generation": 3,
- "replicas": 2,
- "strategy": "RollingUpdate",
- "current_replicas": 2,
- "ready_replicas": 2,
- "available_replicas": 2,
- "updated_replicas": 2,
- "observed_generation": 3,
- "revision": "2",
- "restarted_at": "2021-01-02T00:00:00.000Z",
- "labels": {
- "app": "opschain-api"
}, - "selector": {
- "app": "opschain-api"
}, - "containers": [
- {
- "name": "opschain-api",
- "image": "opschain-api-image",
- "resources": {
- "requests": {
- "cpu": "500m",
- "memory": "1Gi"
}, - "limits": {
- "memory": "2Gi"
}
}
}
], - "conditions": [
- {
- "type": "Available",
- "status": "True",
- "reason": "MinimumReplicasAvailable",
- "message": "Deployment has minimum availability.",
- "last_transition_time": "2021-01-01T00:00:00Z",
- "last_update_time": "2021-01-01T00:00:00Z"
}, - {
- "type": "Progressing",
- "status": "True",
- "reason": "NewReplicaSetAvailable",
- "message": "ReplicaSet \"opschain-api-7d4b9c\" has successfully progressed.",
- "last_transition_time": "2021-01-02T00:00:00Z",
- "last_update_time": "2021-01-02T00:00:00Z"
}
]
}, - "links": { },
- "meta": {
- "max_replicas": 1
}
}, - {
- "id": "opschain-api-worker",
- "type": "deployment",
- "attributes": {
- "namespace": "opschain",
- "uid": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "creation_timestamp": "2021-01-01T00:00:00Z",
- "generation": 3,
- "replicas": 3,
- "strategy": "RollingUpdate",
- "current_replicas": 2,
- "ready_replicas": 2,
- "available_replicas": 2,
- "updated_replicas": 2,
- "observed_generation": 3,
- "revision": "2",
- "restarted_at": "2021-01-02T00:00:00.000Z",
- "labels": {
- "app": "opschain-api"
}, - "selector": {
- "app": "opschain-api"
}, - "containers": [
- {
- "name": "opschain-api",
- "image": "opschain-api-image",
- "resources": {
- "requests": {
- "cpu": "500m",
- "memory": "1Gi"
}, - "limits": {
- "memory": "2Gi"
}
}
}
], - "conditions": [
- {
- "type": "Available",
- "status": "True",
- "reason": "MinimumReplicasAvailable",
- "message": "Deployment has minimum availability.",
- "last_transition_time": "2021-01-01T00:00:00Z",
- "last_update_time": "2021-01-01T00:00:00Z"
}, - {
- "type": "Progressing",
- "status": "True",
- "reason": "NewReplicaSetAvailable",
- "message": "ReplicaSet \"opschain-api-7d4b9c\" has successfully progressed.",
- "last_transition_time": "2021-01-02T00:00:00Z",
- "last_update_time": "2021-01-02T00:00:00Z"
}
]
}, - "links": {
- "scale": "/api/admin/deployments/opschain-api-worker/scale"
}, - "meta": {
- "max_replicas": 10
}
}, - {
- "id": "opschain-mintmodel-api",
- "type": "deployment",
- "attributes": {
- "namespace": "opschain",
- "uid": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "creation_timestamp": "2021-01-01T00:00:00Z",
- "generation": 3,
- "replicas": 2,
- "strategy": "RollingUpdate",
- "current_replicas": 2,
- "ready_replicas": 2,
- "available_replicas": 2,
- "updated_replicas": 2,
- "observed_generation": 3,
- "revision": "2",
- "restarted_at": "2021-01-02T00:00:00.000Z",
- "labels": {
- "app": "opschain-mintmodel-api"
}, - "selector": {
- "app": "opschain-mintmodel-api"
}, - "containers": [
- {
- "name": "opschain-mintmodel-api",
- "image": "opschain-mintmodel-api-image",
- "resources": {
- "requests": {
- "memory": "512Mi"
}, - "limits": {
- "memory": "6400Mi"
}
}
}
], - "conditions": [
- {
- "type": "Available",
- "status": "True",
- "reason": "MinimumReplicasAvailable",
- "message": "Deployment has minimum availability.",
- "last_transition_time": "2021-01-01T00:00:00Z",
- "last_update_time": "2021-01-01T00:00:00Z"
}, - {
- "type": "Progressing",
- "status": "True",
- "reason": "NewReplicaSetAvailable",
- "message": "ReplicaSet \"opschain-api-7d4b9c\" has successfully progressed.",
- "last_transition_time": "2021-01-02T00:00:00Z",
- "last_update_time": "2021-01-02T00:00:00Z"
}
]
}, - "links": {
- "scale": "/api/admin/deployments/opschain-mintmodel-api/scale",
- "resources": "/api/admin/deployments/opschain-mintmodel-api/resources"
}, - "meta": {
- "max_replicas": 5,
- "concurrency": 2,
- "transformer_heap": "1536m",
- "transformer_spares": 1,
- "minimum_memory_limit": "6308Mi"
}
}
], - "meta": {
- "authorisations": {
- "resources": true,
- "restart": true,
- "scale": true
}
}
}Performs a rolling restart of a deployment in the OpsChain Kubernetes namespace, replacing each of its pods without changing the deployment configuration.
Notes:
updatable permission on the /admin/deployments/restart authorisation path. A rule on a parent path (e.g. /admin) grants it, and a rule on the restart path itself overrides that parent rule.| name required | string Example: opschain-api deployment name |
{- "data": {
- "id": "opschain-api",
- "type": "deployment",
- "attributes": {
- "namespace": "opschain",
- "uid": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "creation_timestamp": "2021-01-01T00:00:00Z",
- "generation": 3,
- "replicas": 2,
- "strategy": "RollingUpdate",
- "current_replicas": 2,
- "ready_replicas": 2,
- "available_replicas": 2,
- "updated_replicas": 2,
- "observed_generation": 3,
- "revision": "2",
- "restarted_at": "2021-01-02T00:00:00.000Z",
- "labels": {
- "app": "opschain-api"
}, - "selector": {
- "app": "opschain-api"
}, - "containers": [
- {
- "name": "opschain-api",
- "image": "opschain-api-image",
- "resources": {
- "requests": {
- "cpu": "500m",
- "memory": "1Gi"
}, - "limits": {
- "memory": "2Gi"
}
}
}
], - "conditions": [
- {
- "type": "Available",
- "status": "True",
- "reason": "MinimumReplicasAvailable",
- "message": "Deployment has minimum availability.",
- "last_transition_time": "2021-01-01T00:00:00Z",
- "last_update_time": "2021-01-01T00:00:00Z"
}, - {
- "type": "Progressing",
- "status": "True",
- "reason": "NewReplicaSetAvailable",
- "message": "ReplicaSet \"opschain-api-7d4b9c\" has successfully progressed.",
- "last_transition_time": "2021-01-02T00:00:00Z",
- "last_update_time": "2021-01-02T00:00:00Z"
}
]
}, - "links": { },
- "meta": {
- "max_replicas": 1
}
}
}Sets the number of replicas of a deployment in the OpsChain Kubernetes namespace.
Notes:
updatable permission on the /admin/deployments/scale authorisation path. A rule on a parent path (e.g. /admin) grants it, and a rule on the scale path itself overrides that parent rule.opschain-api-worker, opschain-mintmodel-api deployments can be scaled - every other deployment runs at a single replica and scaling it is rejected.replicas must be a whole number between 0 and the deployment's own maximum, which the list and scale responses report as meta.max_replicas.| name required | string Example: opschain-api-worker deployment name |
required | object |
{- "data": {
- "attributes": {
- "replicas": 3
}
}
}{- "data": {
- "id": "opschain-api-worker",
- "type": "deployment",
- "attributes": {
- "namespace": "opschain",
- "uid": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "creation_timestamp": "2021-01-01T00:00:00Z",
- "generation": 3,
- "replicas": 3,
- "strategy": "RollingUpdate",
- "current_replicas": 2,
- "ready_replicas": 2,
- "available_replicas": 2,
- "updated_replicas": 2,
- "observed_generation": 3,
- "revision": "2",
- "restarted_at": "2021-01-02T00:00:00.000Z",
- "labels": {
- "app": "opschain-api"
}, - "selector": {
- "app": "opschain-api"
}, - "containers": [
- {
- "name": "opschain-api",
- "image": "opschain-api-image",
- "resources": {
- "requests": {
- "cpu": "500m",
- "memory": "1Gi"
}, - "limits": {
- "memory": "2Gi"
}
}
}
], - "conditions": [
- {
- "type": "Available",
- "status": "True",
- "reason": "MinimumReplicasAvailable",
- "message": "Deployment has minimum availability.",
- "last_transition_time": "2021-01-01T00:00:00Z",
- "last_update_time": "2021-01-01T00:00:00Z"
}, - {
- "type": "Progressing",
- "status": "True",
- "reason": "NewReplicaSetAvailable",
- "message": "ReplicaSet \"opschain-api-7d4b9c\" has successfully progressed.",
- "last_transition_time": "2021-01-02T00:00:00Z",
- "last_update_time": "2021-01-02T00:00:00Z"
}
]
}, - "links": {
- "scale": "/api/admin/deployments/opschain-api-worker/scale"
}, - "meta": {
- "max_replicas": 10
}
}
}Changes the memory and CPU requests and limits of a deployment in the OpsChain Kubernetes namespace, and for the MintModel API the number of renders each replica runs at once and the heap of each transformer JVM. This changes at runtime what mintModelApi.resources, mintModelApi.concurrency and mintModelApi.transformer.heap set in values.yaml.
Notes:
updatable permission on the /admin/deployments/resources authorisation path. A rule on a parent path (e.g. /admin) grants it, and a rule on the resources path itself overrides that parent rule.opschain-mintmodel-api deployment can be resized.resources, concurrency and transformer_heap; what is left out keeps its current value. Within resources, only the quantities supplied change, and a quantity set to null is removed. The current values are reported by the deployments list.concurrency must be a whole number of at least 1, and no lower than the spare transformers the deployment keeps (meta.transformer_spares, set by mintModelApi.transformer.spares in values.yaml). transformer_heap is a JVM size such as 1536m or 2g.meta.minimum_memory_limit, and a smaller limit is rejected. The same rule is applied by the chart, so a change to it there must be made here too.mintModelApi.resources, mintModelApi.concurrency or mintModelApi.transformer.heap returns the deployment to its configured values. To change the number of spare transformers, set mintModelApi.transformer.spares in values.yaml and redeploy.previous.| name required | string Example: opschain-mintmodel-api deployment name |
required | object |
{- "data": {
- "attributes": {
- "resources": {
- "limits": {
- "cpu": "2",
- "memory": "9Gi"
}, - "requests": {
- "cpu": "500m",
- "memory": "1Gi"
}
}, - "concurrency": 2,
- "transformer_heap": "2g"
}
}
}{- "data": {
- "id": "opschain-mintmodel-api",
- "type": "deployment",
- "attributes": {
- "namespace": "opschain",
- "uid": "c3d4e5f6-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
- "creation_timestamp": "2021-01-01T00:00:00Z",
- "generation": 3,
- "replicas": 2,
- "strategy": "RollingUpdate",
- "current_replicas": 2,
- "ready_replicas": 2,
- "available_replicas": 2,
- "updated_replicas": 2,
- "observed_generation": 3,
- "revision": "2",
- "restarted_at": "2021-01-02T00:00:00.000Z",
- "labels": {
- "app": "opschain-mintmodel-api"
}, - "selector": {
- "app": "opschain-mintmodel-api"
}, - "containers": [
- {
- "name": "opschain-mintmodel-api",
- "image": "opschain-mintmodel-api-image",
- "resources": {
- "requests": {
- "memory": "512Mi"
}, - "limits": {
- "memory": "6400Mi"
}
}
}
], - "conditions": [
- {
- "type": "Available",
- "status": "True",
- "reason": "MinimumReplicasAvailable",
- "message": "Deployment has minimum availability.",
- "last_transition_time": "2021-01-01T00:00:00Z",
- "last_update_time": "2021-01-01T00:00:00Z"
}, - {
- "type": "Progressing",
- "status": "True",
- "reason": "NewReplicaSetAvailable",
- "message": "ReplicaSet \"opschain-api-7d4b9c\" has successfully progressed.",
- "last_transition_time": "2021-01-02T00:00:00Z",
- "last_update_time": "2021-01-02T00:00:00Z"
}
]
}, - "links": {
- "scale": "/api/admin/deployments/opschain-mintmodel-api/scale",
- "resources": "/api/admin/deployments/opschain-mintmodel-api/resources"
}, - "meta": {
- "max_replicas": 5,
- "concurrency": 2,
- "transformer_heap": "1536m",
- "transformer_spares": 1,
- "minimum_memory_limit": "6308Mi"
}
}
}Lists the external secret vaults, in code order. A setting assigns one to a project, environment, asset, template or template version through vault.code. The service credentials are never returned.
Notes:
{- "data": [
- {
- "id": "01a1e72f-06ae-74bb-8f1e-48f766484d62",
- "type": "external_vault",
- "attributes": {
- "code": "team_vault",
- "name": "Team vault",
- "auth_method": "token",
- "client_options": {
- "namespace": "team"
}, - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:46:21.228877Z",
- "updated_at": "2026-11-17T01:46:21.228877Z"
}
}
]
}Registers an external secret vault. OpsChain logs in to the vault with the service credentials before saving it, and saves nothing when the vault cannot be reached or does not accept them.
Notes:
bundled, which assigns the bundled secret vault, and cannot be changed later.secret-vault:// reference is rejected.required | object |
{- "data": {
- "attributes": {
- "code": "team_vault",
- "name": "Team vault",
- "auth_method": "token",
- "client_options": {
- "namespace": "team"
}, - "token": "hvs.service-token",
- "username": "opschain",
- "password": "service-password"
}
}
}{- "data": {
- "id": "01a1e72f-0763-7cea-a449-6c41c35a2b2a",
- "type": "external_vault",
- "attributes": {
- "code": "new_vault",
- "name": "New vault",
- "auth_method": "token",
- "client_options": { },
- "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:46:21.410388Z",
- "updated_at": "2026-11-17T01:46:21.410388Z"
}
}
}Shows an external secret vault. The service credentials are never returned.
Notes:
| id required | string external vault id |
{- "data": {
- "id": "01a1e72f-09c2-7aaa-9f30-26d5289cdaa9",
- "type": "external_vault",
- "attributes": {
- "code": "team_vault",
- "name": "Team vault",
- "auth_method": "token",
- "client_options": {
- "namespace": "team"
}, - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:46:22.017478Z",
- "updated_at": "2026-11-17T01:46:22.017478Z"
}
}
}Updates an external secret vault. A credential left blank keeps the stored value. OpsChain logs in to the vault with the resulting credentials before saving, and saves nothing when the vault cannot be reached or does not accept them.
Notes:
| id required | string external vault id |
required | object |
{- "data": {
- "attributes": {
- "name": "Team vault",
- "auth_method": "token",
- "client_options": {
- "namespace": "team"
}, - "token": "hvs.service-token",
- "username": "opschain",
- "password": "service-password"
}
}
}{- "data": {
- "id": "01a1e72f-0be0-7ba1-91b8-2196d2814a59",
- "type": "external_vault",
- "attributes": {
- "code": "team_vault",
- "name": "Renamed vault",
- "auth_method": "token",
- "client_options": {
- "namespace": "team"
}, - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:46:22.559501Z",
- "updated_at": "2026-11-17T01:46:22.575588Z"
}
}
}Deletes an external secret vault.
Notes:
| id required | string external vault id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find ExternalVault with 'id'=\"abc\""
}
}
]
}Returns every pod in the OpsChain Kubernetes namespace, including the runner, MintModel and OpsChain API worker pods.
Notes:
meta.authorisations.read_logs reports whether the user may fetch the pod logs, allowing a client to hide the logs links it cannot follow.meta.authorisations.delete reports whether the user may delete pods, allowing a client to hide the delete control it cannot use.controlled_by names the Kubernetes controller managing the pod (e.g. ReplicaSet/opschain-api) and is null for the pods OpsChain creates itself.delete link is only present on the pods that can be deleted - see the delete pod endpoint.{- "data": [
- {
- "id": "change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7",
- "type": "pod",
- "attributes": {
- "namespace": "opschain",
- "node": "node-1",
- "host_ip": "192.168.1.1",
- "pod_ip": "10.42.0.17",
- "start_time": "2021-01-01T00:00:00Z",
- "state": "Running",
- "image": "opschain-runner-image",
- "restart_count": 0,
- "uid": "a1b2c3d4-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
- "containers": [
- "opschain-runner",
- "opschain-log-forwarder"
], - "controlled_by": null,
- "labels": {
- "app": "opschain-runner"
}
}, - "links": {
- "logs": "/api/admin/pods/change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7/logs",
- "delete": "/api/admin/pods/change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7"
}
}, - {
- "id": "opschain-api-worker-1",
- "type": "pod",
- "attributes": {
- "namespace": "opschain",
- "node": "node-1",
- "host_ip": "192.168.1.1",
- "pod_ip": "192.168.1.2",
- "start_time": "2021-01-01T00:00:00Z",
- "state": "Running",
- "image": "opschain-api-worker-image",
- "restart_count": 0,
- "uid": "b2c3d4e5-6f70-4a8b-9c0d-1e2f3a4b5c6d",
- "containers": [
- "opschain-api-worker"
], - "controlled_by": "ReplicaSet/opschain-api-worker-7d9f8b6c5d",
- "labels": {
- "app": "opschain-api-worker"
}
}, - "links": {
- "logs": "/api/admin/pods/opschain-api-worker-1/logs"
}
}
], - "meta": {
- "authorisations": {
- "delete": true,
- "read_logs": true
}
}
}Returns the log for a pod in the OpsChain Kubernetes namespace.
Notes:
readable permission on the /admin/pods/logs authorisation path. A rule on a parent path (e.g. /admin) grants it, and a rule on the logs path itself overrides that parent rule.| name required | string Example: change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7 pod name |
| container | string Example: container=opschain-runner The container to fetch the log for. Defaults to the pod's first container. The valid values for a pod are listed in the |
| limit | integer [ 1 .. 10000 ] Default: 1000 Example: limit=1000 The maximum number of log lines to return. A 206 response and a |
| filter[logged_at_gt] | string Example: filter[logged_at_gt]=2021-01-01T00:00:01.123456Z-0 Only return log lines logged after this cursor. Supply the |
| download | string Example: download=pod.log Download the entire pod log with the specified file name. The |
{- "data": [
- {
- "id": "2021-01-01T00:00:01.123456Z-0",
- "type": "log_line",
- "attributes": {
- "message": "Starting the OpsChain step runner",
- "logged_at": "2021-01-01T00:00:01.123456Z"
}
}, - {
- "id": "2021-01-01T00:00:02.234567Z-0",
- "type": "log_line",
- "attributes": {
- "message": "Step completed successfully",
- "logged_at": "2021-01-01T00:00:02.234567Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Force deletes a pod in the OpsChain Kubernetes namespace, without waiting out its termination grace period.
Notes:
delete link on a pod in the list pods response identifies the pods this endpoint accepts, so a client does not need its own copy of that rule.| name required | string Example: change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7 pod name |
{- "data": {
- "id": "change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7",
- "type": "pod",
- "attributes": {
- "namespace": "opschain",
- "node": "node-1",
- "host_ip": "192.168.1.1",
- "pod_ip": "10.42.0.17",
- "start_time": "2021-01-01T00:00:00Z",
- "state": "Running",
- "image": "opschain-runner-image",
- "restart_count": 0,
- "uid": "a1b2c3d4-5e6f-4a8b-9c0d-1e2f3a4b5c6d",
- "containers": [
- "opschain-runner",
- "opschain-log-forwarder"
], - "controlled_by": null,
- "labels": {
- "app": "opschain-runner"
}
}, - "links": {
- "logs": "/api/admin/pods/change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7/logs",
- "delete": "/api/admin/pods/change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7"
}
}
}Lists the LDAP users that hold at least one vault policy in the bundled secret vault, with the policies assigned to each.
Notes:
opschain-) and the default and root policies are not listed.{- "data": [
- {
- "id": "alice",
- "type": "secret_vault_ldap_user",
- "attributes": {
- "name": "alice",
- "policies": [
- "team-a-readers"
]
}
}
]
}Shows the vault policies assigned to an LDAP user in the bundled secret vault.
Notes:
opschain-) and the default and root policies are not shown.| name required | string Example: alice LDAP user name |
{- "data": {
- "id": "alice",
- "type": "secret_vault_ldap_user",
- "attributes": {
- "name": "alice",
- "policies": [
- "team-a-readers"
]
}
}
}Sets the vault policies assigned to an LDAP user in the bundled secret vault. The policies supplied replace those currently assigned - send an empty list to remove them all.
Notes:
opschain-) and the default and root policies cannot be assigned. Any OpsChain policy the user already holds is kept.| name required | string Example: alice LDAP user name |
required | object |
{- "data": {
- "attributes": {
- "policies": [
- "team-a-readers"
]
}
}
}{- "data": {
- "id": "alice",
- "type": "secret_vault_ldap_user",
- "attributes": {
- "name": "alice",
- "policies": [
- "team-a-readers"
]
}
}
}Lists the LDAP groups that hold at least one vault policy in the bundled secret vault, with the policies assigned to each.
Notes:
opschain-) and the default and root policies are not listed.{- "data": [
- {
- "id": "alice",
- "type": "secret_vault_ldap_group",
- "attributes": {
- "name": "alice",
- "policies": [
- "team-a-readers"
]
}
}
]
}Shows the vault policies assigned to an LDAP group in the bundled secret vault.
Notes:
opschain-) and the default and root policies are not shown.| name required | string Example: alice LDAP group name |
{- "data": {
- "id": "alice",
- "type": "secret_vault_ldap_group",
- "attributes": {
- "name": "alice",
- "policies": [
- "team-a-readers"
]
}
}
}Sets the vault policies assigned to an LDAP group in the bundled secret vault. The policies supplied replace those currently assigned - send an empty list to remove them all.
Notes:
opschain-) and the default and root policies cannot be assigned. Any OpsChain policy the group already holds is kept.| name required | string Example: alice LDAP group name |
required | object |
{- "data": {
- "attributes": {
- "policies": [
- "team-a-readers"
]
}
}
}{- "data": {
- "id": "alice",
- "type": "secret_vault_ldap_group",
- "attributes": {
- "name": "alice",
- "policies": [
- "team-a-readers"
]
}
}
}Lists the key value mounts of the bundled secret vault, in path order. These are the mounts a secret vault policy rule may use - every rule path must be one of these paths, or a path below one.
Notes:
{- "data": [
- {
- "id": "secrets",
- "type": "secret_vault_mount",
- "attributes": {
- "path": "secrets",
- "kv_version": 2
}
}, - {
- "id": "team-a",
- "type": "secret_vault_mount",
- "attributes": {
- "path": "team-a",
- "kv_version": 1
}
}
]
}Lists the ACL policies in the bundled secret vault that OpsChain can manage, in name order. Each policy's document is the policy as the vault stores it, converted to JSON when it is written in HCL, and original_document then holds the HCL as the vault stores it; rules holds its rules when the document is in the format OpsChain writes, and is null for a policy with settings OpsChain does not manage.
Notes:
default and root policies, and the policies OpsChain owns (those starting with opschain-), are not listed.{- "data": [
- {
- "id": "team-a-readers",
- "type": "secret_vault_policy",
- "attributes": {
- "name": "team-a-readers",
- "rules": [
- {
- "path": "secrets/team-a/*",
- "capabilities": [
- "read",
- "list"
]
}
], - "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}",
- "format": "json",
- "original_document": null,
- "modified": "2026-10-26T10:36:19.734221565Z",
- "version": 1
}
}
]
}Creates an ACL policy in the bundled secret vault from the rules in the document. Assign it to LDAP users and groups through the secret_vault_ldap_users and secret_vault_ldap_groups admin endpoints.
Notes:
create, read, update, patch, delete, list, sudo, deny capabilities.allowed_parameters, denied_parameters, required_parameters, min_wrapping_ttl and max_wrapping_ttl, as in a vault policy.default and root policies, and the policies OpsChain owns (those starting with opschain-), cannot be created.required | object |
{- "data": {
- "attributes": {
- "name": "team-a-readers",
- "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}"
}
}
}{- "data": {
- "id": "team-a-readers",
- "type": "secret_vault_policy",
- "attributes": {
- "name": "team-a-readers",
- "rules": [
- {
- "capabilities": [
- "read",
- "list"
], - "path": "secrets/team-a/*"
}
], - "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}",
- "format": "json",
- "original_document": null,
- "modified": null,
- "version": null
}
}
}Shows an ACL policy in the bundled secret vault. The document is the policy as the vault stores it, converted to JSON when it is written in HCL, and original_document then holds the HCL as the vault stores it; rules holds its rules when the document is in the format OpsChain writes, and is null for a policy with settings OpsChain does not manage.
Notes:
default and root policies, and the policies OpsChain owns (those starting with opschain-), cannot be viewed.| name required | string Example: team-a-readers vault policy name |
{- "data": {
- "id": "team-a-readers",
- "type": "secret_vault_policy",
- "attributes": {
- "name": "team-a-readers",
- "rules": [
- {
- "path": "secrets/team-a/*",
- "capabilities": [
- "read",
- "list"
]
}
], - "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}",
- "format": "json",
- "original_document": null,
- "modified": "2026-10-26T10:36:19.734221565Z",
- "version": 1
}
}
}Replaces the rules of an existing ACL policy in the bundled secret vault with those in the document.
Notes:
create, read, update, patch, delete, list, sudo, deny capabilities.allowed_parameters, denied_parameters, required_parameters, min_wrapping_ttl and max_wrapping_ttl, as in a vault policy.default and root policies, and the policies OpsChain owns (those starting with opschain-), cannot be updated.| name required | string Example: team-a-readers vault policy name |
required | object |
{- "data": {
- "attributes": {
- "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}"
}
}
}{- "data": {
- "id": "team-a-readers",
- "type": "secret_vault_policy",
- "attributes": {
- "name": "team-a-readers",
- "rules": [
- {
- "capabilities": [
- "read",
- "list"
], - "path": "secrets/team-a/*"
}
], - "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}",
- "format": "json",
- "original_document": null,
- "modified": null,
- "version": null
}
}
}Deletes an ACL policy from the bundled secret vault.
Notes:
default and root policies, and the policies OpsChain owns (those starting with opschain-), cannot be deleted.| name required | string Example: team-a-readers vault policy name |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Record not found"
}
}
]
}Lists the documents OpsChain has saved for an ACL policy in the bundled secret vault, newest first, with who saved each one and when. The list goes back to when the policy was last created - the versions of a deleted policy that had the same name are not included.
Notes:
default and root policies, and the policies OpsChain owns (those starting with opschain-), cannot be viewed.| name required | string Example: team-a-readers vault policy name |
{- "data": [
- {
- "id": "01a1e731-1854-749d-aee5-aac603198a7d",
- "type": "secret_vault_policy_version",
- "attributes": {
- "username": "admin",
- "created_at": "2026-11-17T01:48:36.819Z",
- "document": "{\"path\":{\"secrets/team-a/*\":{\"capabilities\":[\"read\",\"list\"]}}}"
}
}
]
}Shows when the key that signs access tokens, refresh tokens and API keys was last rotated, and how many previous keys OpsChain still accepts tokens from. The keys themselves are never returned.
Notes:
{- "data": {
- "id": "0",
- "type": "token_signing_key",
- "attributes": {
- "agents_on_previous_secret": 0,
- "previous_key_count": 0,
- "rotated_at": null,
- "steps_on_previous_secret": 0
}, - "links": {
- "self": "/api/admin/token_signing_key"
}
}
}Replaces the key that signs access tokens, refresh tokens and API keys with a new random key. New tokens are signed with the new key straight away, on every site.
With compromised set to false, tokens signed with the previous key keep working until they expire, and OpsChain stops accepting the previous key once every token issued before the rotation has expired. Remote runner daemons are offered a new API key on their next poll.
With compromised set to true, OpsChain stops accepting every previous key at once. Every user is signed out, every API key stops working, running changes can no longer report their progress, and every remote runner target must be registered again.
Notes:
required | object |
{- "data": {
- "attributes": {
- "compromised": false
}
}
}{- "data": {
- "id": "0",
- "type": "token_signing_key",
- "attributes": {
- "agents_on_previous_secret": 0,
- "previous_key_count": 1,
- "rotated_at": "2026-11-17T01:49:47.956Z",
- "steps_on_previous_secret": 0
}, - "links": {
- "self": "/api/admin/token_signing_key"
}
}
}Lists the runner credentials, in code order. Filter by vault with filter[external_vault_code_eq]. The credentials themselves are never returned.
Notes:
| filter[external_vault_code_eq] | string Only the credentials for the external vault with this code |
{- "data": [
- {
- "id": "01a1e732-9f66-783e-bee0-159085e4d1fd",
- "type": "vault_runner_credential",
- "attributes": {
- "code": "team_runner",
- "name": "Team runner",
- "vault_code": "team_vault",
- "managed": false,
- "auth_method": "token",
- "mount_paths": [ ],
- "node_paths": [
- "/projects/xukrx"
], - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:50:16.932536Z",
- "updated_at": "2026-11-17T01:50:16.932536Z"
}, - "meta": {
- "uncovered_vaults": [
- {
- "vault_code": "bundled",
- "node_path": "/projects/xukrx"
}
]
}
}
]
}Creates a runner credential and tags it on nodes. A supplied credential holds a token, or a username and password, for the vault; OpsChain logs in to the vault with it before saving, and saves nothing when the vault cannot be reached or does not accept it. A managed credential (managed: true, bundled vault only) takes mount_paths instead: OpsChain writes a vault policy reaching those mounts and mints and renews the token itself.
Notes:
Managing runner credentials requires superuser access. No authorisation rule grants it.
A node can carry one runner credential per vault. A change under a tagged node uses the credential of the deepest tag for the vault its settings assign, and is rejected when no tag above it has a credential for that vault. Secret references the system configuration supplies keep using the default runner account.
The code, vault and managed cannot be changed later. Leave vault_code blank, or set it to bundled, for the bundled secret vault.
The credentials must be the values themselves. A secret-vault:// reference is rejected.
required | object |
{- "data": {
- "attributes": {
- "code": "team_runner",
- "vault_code": "team_vault",
- "managed": false,
- "name": "Team runner",
- "auth_method": "token",
- "token": "hvs.runner-token",
- "username": "runner",
- "password": "runner-password",
- "mount_paths": [
- "team/data"
], - "node_paths": [
- "/projects/team"
]
}
}
}{- "data": {
- "id": "01a1e732-a0f7-7e61-8cc8-f4d5405e9d09",
- "type": "vault_runner_credential",
- "attributes": {
- "code": "other_runner",
- "name": "Other runner",
- "vault_code": "team_vault",
- "managed": false,
- "auth_method": "token",
- "mount_paths": [ ],
- "node_paths": [
- "/projects/uppoi"
], - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:50:17.334642Z",
- "updated_at": "2026-11-17T01:50:17.334642Z"
}, - "meta": {
- "uncovered_vaults": [
- {
- "vault_code": "bundled",
- "node_path": "/projects/uppoi"
}
]
}
}
}Shows a runner credential. The credentials themselves are never returned.
Notes:
| id required | string runner credential id |
{- "data": {
- "id": "01a1e732-a7fe-756a-ad68-9993e099d5a6",
- "type": "vault_runner_credential",
- "attributes": {
- "code": "team_runner",
- "name": "Team runner",
- "vault_code": "team_vault",
- "managed": false,
- "auth_method": "token",
- "mount_paths": [ ],
- "node_paths": [
- "/projects/wncpr"
], - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:50:19.125150Z",
- "updated_at": "2026-11-17T01:50:19.125150Z"
}, - "meta": {
- "uncovered_vaults": [
- {
- "vault_code": "bundled",
- "node_path": "/projects/wncpr"
}
]
}
}
}Updates a runner credential. A credential left blank keeps the stored value, and node_paths, when given, replaces the tags. OpsChain logs in to the vault with the resulting credentials of a supplied credential before saving, and rewrites the vault policy of a managed one.
Notes:
Managing runner credentials requires superuser access. No authorisation rule grants it.
A node can carry one runner credential per vault. A change under a tagged node uses the credential of the deepest tag for the vault its settings assign, and is rejected when no tag above it has a credential for that vault. Secret references the system configuration supplies keep using the default runner account.
The code, vault and managed cannot be changed.
| id required | string runner credential id |
required | object |
{- "data": {
- "attributes": {
- "name": "Team runner",
- "auth_method": "token",
- "token": "hvs.runner-token",
- "username": "runner",
- "password": "runner-password",
- "mount_paths": [
- "team/data"
], - "node_paths": [
- "/projects/team"
]
}
}
}{- "data": {
- "id": "01a1e732-ad19-7e9b-b1ce-38b70e70b423",
- "type": "vault_runner_credential",
- "attributes": {
- "code": "team_runner",
- "name": "Renamed runner",
- "vault_code": "team_vault",
- "managed": false,
- "auth_method": "token",
- "mount_paths": [ ],
- "node_paths": [
- "/projects/wmucw"
], - "token_configured": true,
- "username_configured": false,
- "password_configured": false,
- "created_at": "2026-11-17T01:50:20.440460Z",
- "updated_at": "2026-11-17T01:50:20.460248Z"
}, - "meta": {
- "uncovered_vaults": [
- {
- "vault_code": "bundled",
- "node_path": "/projects/wmucw"
}
]
}
}
}Deletes a runner credential and its tags. OpsChain revokes the token of a managed credential.
Notes:
| id required | string runner credential id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find VaultRunnerCredential with 'id'=\"abc\""
}
}
]
}Lists all data cleanup definitions.
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[name_eq]=test API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e72e-15af-7c06-9aec-207c1caba168",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "card",
- "enabled": true,
- "created_by": "irwin-1664",
- "created_by_name": "irwin-1664",
- "cron_schedule": "0 0 7,14,21,28 * *",
- "repeat": true,
- "maximum_run_count": null,
- "purge_activities": false,
- "purge_events": true,
- "purge_jobs": false,
- "purge_agent_images": true,
- "purge_node_background_tasks": false,
- "purge_artifacts": false,
- "purge_system_data": false,
- "purge_audit_events": false,
- "archive_template_versions": false,
- "analyze_statistics": true,
- "filters": {
- "changes": {
- "created_at_lt": "2026-11-10T01:45:19.469Z"
}
}, - "node_paths": [
- "/projects/opc/environments/dev"
], - "run_count": 0,
- "created_at": "2026-11-17T01:45:19.534271Z",
- "updated_at": "2026-11-17T01:45:19.534271Z",
- "next_run_at": "2026-11-20T13:00:00.000000Z",
- "run_at": null,
- "end_at": "2027-02-15T01:45:19.470109Z"
}, - "links": {
- "self": "/api/data_cleanup_definitions/01a1e72e-15af-7c06-9aec-207c1caba168"
}
}
], - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}, - "has_any": true
}
}Notes:
cron_schedule or run_at fields must be provided.filters field are changes, events, audit_events, jobs, workflow_runs, node_background_tasks, template_versions, and artifacts. The agent image cleanup job accepts template_version_history and build_agent_image_tasks. Each of these can have ransack filters for the specific type they refer to, except artifacts, whose size_tiers shape is documented separately below.
IMPORTANT: If no filters are provided for a data type, the cleanup will remove all data that matches the node paths.node_paths field is an array of strings. Each string is a path to a node. The path must start with /projects and only contain forward slashes, lowercase letters, numbers and underscores, and optionally a single "%" at the end.
Use the % wildcard to include all nodes under a specific node or node-type, note that this will apply the cleanup to all nodes that are yet to be created, as long as they match the path.purge_node_background_tasks field removes finished node background tasks, along with their log lines and run API key tokens, once a newer task of the same type exists for the template version history.
The latest successful and latest non cancelled generate actions requests, a mintmodel concretise task referenced by any generate actions request, tasks referenced by a change or an agent status, and build agent image tasks whose image has not yet been purged are always retained.purge_artifacts field removes old artifact versions once they exceed a size-tiered retention policy, given via filters.artifacts.size_tiers: an array of { up_to, keep_versions, keep_days } objects, ordered by increasing size. up_to is a Kubernetes-style quantity string (e.g. "10Mi") giving the tier's inclusive upper size bound, or null for the catch-all tier covering anything larger. An artifact version is purged only once it both exceeds its own tier's keep_versions (ranked newest-first per node/code) and is older than its tier's keep_days. When purge_artifacts is true, filters.artifacts.size_tiers must contain at least one tier, otherwise the request is rejected with a 422 error on filters; it is optional when purge_artifacts is false.
purge_artefacts and filters.artefacts are still accepted as aliases of purge_artifacts and filters.artifacts; when both spellings are supplied, the artifact one is used.purge_system_data field removes the history of jobs that belong to no node, and the events that belong to no node or to the system configuration, using the jobs and events filters. Audit events are never removed. It ignores node_paths, and only a superuser can set it.purge_audit_events field removes the audit events of the matching nodes, using the audit_events filters. No other purge removes audit events, so this one can keep them for longer than the other events. Only a superuser can set it.archive_template_versions field archives the template versions of the matching nodes' templates that have been unused for filters.template_versions.unused_for_days days: not created, used by a change or assigned to an asset in that time. A version is never archived while an asset points at it (archived assets included), an unfinished change uses it, it is locked, or an unarchived version of an unarchived workflow names a template version with the same name. Archived versions keep their name reserved. filters.template_versions.unused_for_days is required and must be a whole number of days from 1 to 365, otherwise the request is rejected with a 422 error on filters. filters.template_versions.keep_latest keeps the newest N versions of each template by creation date, counting versions in use, and the other template_versions keys are ransack filters. Use the template_versions_preview endpoint to list the versions a definition would archive.analyze_statistics field refreshes the PostgreSQL planner statistics of any table whose statistics are stale, after the purges have run. It applies to the whole database, so the node_paths and filters fields are ignored for it.required | object |
{- "data": {
- "attributes": {
- "name": "feed",
- "enabled": true,
- "node_paths": [ ],
- "filters": { },
- "purge_activities": false,
- "purge_events": true,
- "purge_jobs": false,
- "cron_schedule": "0 0 * * *",
- "run_at": null,
- "end_at": null,
- "maximum_run_count": null,
- "repeat": true,
- "purge_agent_images": true,
- "purge_node_background_tasks": false,
- "analyze_statistics": true,
- "purge_system_data": false,
- "purge_audit_events": false,
- "archive_template_versions": false,
- "purge_artifacts": false
}
}
}{- "data": {
- "id": "01a1e72e-4bc7-7b98-b522-660264db9801",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "circuit",
- "enabled": true,
- "created_by": "logged_in_user",
- "created_by_name": "logged_in_user",
- "cron_schedule": "0 2 * * *",
- "repeat": true,
- "maximum_run_count": null,
- "purge_activities": true,
- "purge_events": true,
- "purge_jobs": true,
- "purge_agent_images": false,
- "purge_node_background_tasks": false,
- "purge_artifacts": false,
- "purge_system_data": false,
- "purge_audit_events": false,
- "archive_template_versions": false,
- "analyze_statistics": true,
- "filters": {
- "build_agent_image_tasks": {
- "created_at_days_ago_lteq": 30
}, - "jobs": {
- "run_at_days_ago_lteq": 30
}, - "events": {
- "created_at_days_ago_lteq": 365
}, - "audit_events": {
- "created_at_days_ago_lteq": 1095
}, - "node_background_tasks": {
- "created_at_days_ago_lteq": 90
}, - "artifacts": {
- "size_tiers": [
- {
- "up_to": "10Mi",
- "keep_versions": 20,
- "keep_days": 90
}, - {
- "up_to": "100Mi",
- "keep_versions": 5,
- "keep_days": 30
}, - {
- "up_to": null,
- "keep_versions": 1,
- "keep_days": 7
}
]
}, - "template_versions": {
- "unused_for_days": 180,
- "keep_latest": 3
}
}, - "node_paths": [ ],
- "run_count": 0,
- "created_at": "2026-11-17T01:45:33.382477Z",
- "updated_at": "2026-11-17T01:45:33.382477Z",
- "next_run_at": "2026-11-17T15:00:00.000000Z",
- "run_at": null,
- "end_at": null
}, - "links": {
- "self": "/api/data_cleanup_definitions/01a1e72e-4bc7-7b98-b522-660264db9801"
}
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Reports how many artefact versions, and how many bytes, a purge_artifacts retention policy would purge for the supplied node paths and size tiers, without purging anything.
Notes:
node_paths and filters.artifacts.size_tiers attributes have the same shape and validation as when creating a data cleanup definition with purge_artifacts set to true. filters.artefacts is still accepted as an alias of filters.artifacts.keep_versions newest versions per node and artefact code, and is older than its tier's keep_days.meta object. meta.tiers lists each tier, in order of increasing size, with the versions and bytes it would purge. meta.totals sums them across all tiers.required | object |
{- "data": {
- "attributes": {
- "node_paths": [
- "/projects%"
], - "filters": {
- "artifacts": {
- "size_tiers": [
- {
- "up_to": "10Mi",
- "keep_versions": 20,
- "keep_days": 90
}, - {
- "up_to": null,
- "keep_versions": 1,
- "keep_days": 7
}
]
}
}
}
}
}{- "data": null,
- "meta": {
- "tiers": [
- {
- "up_to": "10Mi",
- "keep_versions": 20,
- "keep_days": 90,
- "versions": 0,
- "bytes": 0
}, - {
- "up_to": null,
- "keep_versions": 1,
- "keep_days": 7,
- "versions": 0,
- "bytes": 0
}
], - "totals": {
- "versions": 0,
- "bytes": 0
}
}
}Lists the template versions an archive_template_versions data cleanup definition would archive for the supplied node paths and filters, without archiving anything.
Notes:
node_paths and filters.template_versions attributes have the same shape and validation as when creating a data cleanup definition with archive_template_versions set to true.meta object. meta.template_versions lists the path of each version that a run at the time of the request would archive, and meta.total counts them.required | object |
{- "data": {
- "attributes": {
- "node_paths": [
- "/projects%"
], - "filters": {
- "template_versions": {
- "unused_for_days": 180,
- "keep_latest": 3
}
}
}
}
}{- "data": null,
- "meta": {
- "template_versions": [ ],
- "total": 0
}
}Shows a data cleanup definition.
| data_cleanup_definition_id required | string Example: 01a1e72b-1057-7278-80db-bacc995147d8 data cleanup definition id |
{- "data": {
- "id": "01a1e72e-78c8-7c91-838b-0881e8fb6db9",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "capacitor",
- "enabled": true,
- "created_by": "jimmy_powlowski-1812",
- "created_by_name": "jimmy_powlowski-1812",
- "cron_schedule": "0 0 7,14,21,28 * *",
- "repeat": true,
- "maximum_run_count": null,
- "purge_activities": true,
- "purge_events": false,
- "purge_jobs": false,
- "purge_agent_images": false,
- "purge_node_background_tasks": true,
- "purge_artifacts": false,
- "purge_system_data": false,
- "purge_audit_events": false,
- "archive_template_versions": false,
- "analyze_statistics": false,
- "filters": {
- "changes": {
- "created_at_lt": "2026-11-10T01:45:44.818Z"
}
}, - "node_paths": [
- "/projects/opc/environments/dev"
], - "run_count": 0,
- "created_at": "2026-11-17T01:45:44.903241Z",
- "updated_at": "2026-11-17T01:45:44.903241Z",
- "next_run_at": "2026-11-20T13:00:00.000000Z",
- "run_at": null,
- "end_at": "2027-02-15T01:45:44.818337Z"
}, - "links": {
- "self": "/api/data_cleanup_definitions/01a1e72e-78c8-7c91-838b-0881e8fb6db9"
}
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Updates a data cleanup definition.
Notes:
cron_schedule or run_at switches the definition to that type of schedule and clears the other. Supplying run_at also clears end_at and maximum_run_count and resets repeat to false, unless they are supplied too. Switching from one type to the other also resets run_count to 0.| data_cleanup_definition_id required | string Example: 01a1e72b-1057-7278-80db-bacc995147d8 data cleanup definition id |
required | object |
{- "data": {
- "attributes": {
- "name": "new_name",
- "run_at": null,
- "end_at": null
}
}
}{- "data": {
- "id": "01a1e72e-80e6-783d-b5da-a1b4ee8f8024",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "new_name",
- "enabled": true,
- "created_by": "emeline.hilpert-1822",
- "created_by_name": "emeline.hilpert-1822",
- "cron_schedule": "0 0 7,14,21,28 * *",
- "repeat": true,
- "maximum_run_count": 5,
- "purge_activities": false,
- "purge_events": true,
- "purge_jobs": false,
- "purge_agent_images": false,
- "purge_node_background_tasks": true,
- "purge_artifacts": false,
- "purge_system_data": false,
- "purge_audit_events": false,
- "archive_template_versions": false,
- "analyze_statistics": false,
- "filters": {
- "changes": {
- "created_at_lt": "2026-11-10T01:45:46.835Z"
}
}, - "node_paths": [
- "/projects/opc/environments/dev"
], - "run_count": 0,
- "created_at": "2026-11-17T01:45:46.980664Z",
- "updated_at": "2026-11-17T01:45:47.238610Z",
- "next_run_at": "2026-11-20T13:00:00.000000Z",
- "run_at": null,
- "end_at": "2027-02-15T01:45:46.835463Z"
}, - "links": {
- "self": "/api/data_cleanup_definitions/01a1e72e-80e6-783d-b5da-a1b4ee8f8024"
}
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}Delete a data cleanup definition.
| data_cleanup_definition_id required | string Example: 01a1e72b-1057-7278-80db-bacc995147d8 data cleanup definition id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the data cleanup definition",
- "detail": "Your authorisation rules let you view the data cleanup definition but not delete it."
}
]
}Endpoints to manage the remote runner targets that run steps and change workers outside the OpsChain cluster.
Lists the remote runner targets the caller can read. Include remote_runner_target_scopes to return the node paths each target serves.
| include | string Example: include=remote_runner_target_scopes Related resources to include |
| filter[<query/sort filter>]= | string Example: filter[<query/sort filter>]==> filter[code_cont]=dc1 API filtering guide. Named filters: |
{- "data": [
- {
- "id": "01a1e730-ba05-718d-ad64-fb24bf3ed736",
- "type": "remote_runner_target",
- "attributes": {
- "code": "dc1_runner",
- "description": "Runner in the DC1 network",
- "maintenance_mode": false,
- "daemon_version": null,
- "daemon_protocols": null,
- "daemon_upgrade_allowed": null,
- "daemon_status": "unknown",
- "auto_upgrade": null,
- "daemon_upgrade_error": null,
- "effective_auto_upgrade": false,
- "drained": false,
- "live": true,
- "key_rotation_overdue": false,
- "bundled_daemon_version": "0.1.0.28",
- "created_at": "2026-11-17T01:48:12.676040Z",
- "updated_at": "2026-11-17T01:48:12.676040Z",
- "last_connected_at": "2026-11-17T01:48:12.597557Z",
- "key_expires_at": null,
- "daemon_reported_at": null,
- "upgrade_requested_at": null,
- "upgrade_offered_at": null
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e730-ba08-7581-a547-77d190a00fa9",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-ba08-7581-a547-77d190a00fa9"
}
}, - "node": {
- "data": {
- "id": "01a1e730-b99c-7100-a732-e63c4ae1fff0",
- "type": "node"
}
}, - "remote_runner_target_scopes": {
- "data": [
- {
- "id": "01a1e730-ba10-764c-bef2-9fd4640753c8",
- "type": "remote_runner_target_scope"
}
]
}
}, - "links": {
- "self": "/api/remote_runner_targets/01a1e730-ba05-718d-ad64-fb24bf3ed736"
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}
], - "included": [
- {
- "id": "01a1e730-ba10-764c-bef2-9fd4640753c8",
- "type": "remote_runner_target_scope",
- "attributes": {
- "path": "/projects/opc/environments/dev"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Creates a remote runner target. The response meta.bearer_token holds the token the remote runner daemon authenticates with; it is only returned by this request.
Notes:
node_id to create an instance-wide target (superuser only).scope_paths restricts the target to the listed node paths. Include remote_runner_target_scopes to return them in the response.| include | string Example: include=remote_runner_target_scopes Related resources to include |
required | object |
{- "data": {
- "attributes": {
- "code": "dc2_runner",
- "description": "Runner in the DC2 network",
- "public_key": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----\n",
- "client_certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
- "node_id": "01a1e72a-f049-77ab-992b-01351732a1a3",
- "scope_paths": [
- "/projects/opc/environments/dev"
]
}
}
}{- "data": {
- "id": "01a1e730-bc3f-7fbc-a8b2-f22d64137b89",
- "type": "remote_runner_target",
- "attributes": {
- "code": "dc2_runner",
- "description": "Runner in the DC2 network",
- "maintenance_mode": false,
- "daemon_version": null,
- "daemon_protocols": null,
- "daemon_upgrade_allowed": null,
- "daemon_status": "unknown",
- "auto_upgrade": null,
- "daemon_upgrade_error": null,
- "effective_auto_upgrade": false,
- "drained": false,
- "live": false,
- "key_rotation_overdue": false,
- "bundled_daemon_version": "0.1.0.28",
- "created_at": "2026-11-17T01:48:13.246734Z",
- "updated_at": "2026-11-17T01:48:13.246734Z",
- "last_connected_at": null,
- "key_expires_at": "2027-11-17T23:59:59.999999Z",
- "daemon_reported_at": null,
- "upgrade_requested_at": null,
- "upgrade_offered_at": null
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e730-bc42-7edc-89cc-7933ff5e4db5",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-bc42-7edc-89cc-7933ff5e4db5"
}
}, - "node": {
- "data": {
- "id": "01a1e730-bb43-7cf5-bb04-72481511f263",
- "type": "node"
}
}, - "remote_runner_target_scopes": {
- "data": [
- {
- "id": "01a1e730-bc4c-7156-b7cb-c34da1a5b87b",
- "type": "remote_runner_target_scope"
}
]
}
}, - "links": {
- "self": "/api/remote_runner_targets/01a1e730-bc3f-7fbc-a8b2-f22d64137b89"
}, - "meta": {
- "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWExZTczMC1iYzUxLTdkY2EtYTdmMi05ZTQ4ZjYzZjFlNWQiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTgyNjQ5NTk5OSwiaWF0IjoxNzk0ODgwMDkzfQ.DbjLK4UomIUgCwI_wcU8H-7RB9uaKE_ZOq1-cOEWw_8"
}
}, - "included": [
- {
- "id": "01a1e730-bc4c-7156-b7cb-c34da1a5b87b",
- "type": "remote_runner_target_scope",
- "attributes": {
- "path": "/projects/opc/environments/dev"
}
}
]
}Shows a remote runner target. Include remote_runner_target_scopes to return the node paths it serves.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
| include | string Example: include=remote_runner_target_scopes Related resources to include |
{- "data": {
- "id": "01a1e730-c67e-7a4e-9f8b-6199553172da",
- "type": "remote_runner_target",
- "attributes": {
- "code": "dc1_runner",
- "description": "Runner in the DC1 network",
- "maintenance_mode": false,
- "daemon_version": null,
- "daemon_protocols": null,
- "daemon_upgrade_allowed": null,
- "daemon_status": "unknown",
- "auto_upgrade": null,
- "daemon_upgrade_error": null,
- "effective_auto_upgrade": false,
- "drained": false,
- "live": true,
- "key_rotation_overdue": false,
- "bundled_daemon_version": "0.1.0.28",
- "created_at": "2026-11-17T01:48:15.869425Z",
- "updated_at": "2026-11-17T01:48:15.869425Z",
- "last_connected_at": "2026-11-17T01:48:15.665320Z",
- "key_expires_at": null,
- "daemon_reported_at": null,
- "upgrade_requested_at": null,
- "upgrade_offered_at": null
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e730-c681-785a-a765-f92b158bb99e",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-c681-785a-a765-f92b158bb99e"
}
}, - "node": {
- "data": {
- "id": "01a1e730-c590-7679-bb23-619707e5a66f",
- "type": "node"
}
}, - "remote_runner_target_scopes": {
- "data": [
- {
- "id": "01a1e730-c68a-75ef-8f52-94aa246fe69d",
- "type": "remote_runner_target_scope"
}
]
}
}, - "links": {
- "self": "/api/remote_runner_targets/01a1e730-c67e-7a4e-9f8b-6199553172da"
}, - "meta": {
- "authorisations": {
- "update": true,
- "delete": true
}
}
}, - "included": [
- {
- "id": "01a1e730-c68a-75ef-8f52-94aa246fe69d",
- "type": "remote_runner_target_scope",
- "attributes": {
- "path": "/projects/opc/environments/dev"
}
}
]
}Updates a remote runner target's description, maintenance mode or scopes.
Only the scope paths being added are checked for existence and authorisation; scopes that are kept or removed are not.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
| include | string Example: include=remote_runner_target_scopes Related resources to include |
required | object |
{- "data": {
- "attributes": {
- "description": "Runner in the DC1 network",
- "maintenance_mode": true,
- "auto_upgrade": true,
- "scope_paths": [
- "/projects/opc/environments/dev"
]
}
}
}{- "data": {
- "id": "01a1e730-caa0-738b-a32d-d51a539f045b",
- "type": "remote_runner_target",
- "attributes": {
- "code": "dc1_runner",
- "description": "Runner in the DC1 network",
- "maintenance_mode": true,
- "daemon_version": null,
- "daemon_protocols": null,
- "daemon_upgrade_allowed": null,
- "daemon_status": "unknown",
- "auto_upgrade": null,
- "daemon_upgrade_error": null,
- "effective_auto_upgrade": false,
- "drained": true,
- "live": true,
- "key_rotation_overdue": false,
- "bundled_daemon_version": "0.1.0.28",
- "created_at": "2026-11-17T01:48:16.927090Z",
- "updated_at": "2026-11-17T01:48:16.975751Z",
- "last_connected_at": "2026-11-17T01:48:16.757953Z",
- "key_expires_at": null,
- "daemon_reported_at": null,
- "upgrade_requested_at": null,
- "upgrade_offered_at": null
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e730-caa4-703a-8e37-d1ef2e336604",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-caa4-703a-8e37-d1ef2e336604"
}
}, - "node": {
- "data": {
- "id": "01a1e730-c9d8-7ee1-9f60-8c99a3e65ada",
- "type": "node"
}
}, - "remote_runner_target_scopes": {
- "data": [
- {
- "id": "01a1e730-caaf-7483-817a-aed5f9b8475e",
- "type": "remote_runner_target_scope"
}
]
}
}, - "links": {
- "self": "/api/remote_runner_targets/01a1e730-caa0-738b-a32d-d51a539f045b"
}, - "meta": null
}, - "included": [
- {
- "id": "01a1e730-caaf-7483-817a-aed5f9b8475e",
- "type": "remote_runner_target_scope",
- "attributes": {
- "path": "/projects/opc/environments/dev"
}
}
]
}Deletes a remote runner target. Work it has not yet claimed is left for another eligible target.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
{- "errors": [
- {
- "status": 403,
- "title": "You do not have permission to delete the remote runner target",
- "detail": "Your authorisation rules let you view the remote runner target but not delete it."
}
]
}Asks the target's daemon to upgrade itself to the build bundled in this OpsChain version; the daemon is offered the build on its next poll. Requires update access to the target.
Fails with upgrade_not_available unless the daemon is outdated or incompatible and its host allows upgrades.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
{- "data": {
- "id": "01a1e730-dd8a-7c2d-9ff6-819a5bb47174",
- "type": "remote_runner_target",
- "attributes": {
- "code": "dc1_runner",
- "description": "Runner in the DC1 network",
- "maintenance_mode": false,
- "daemon_version": "0.0.1",
- "daemon_protocols": null,
- "daemon_upgrade_allowed": true,
- "daemon_status": "outdated",
- "auto_upgrade": null,
- "daemon_upgrade_error": null,
- "effective_auto_upgrade": false,
- "drained": false,
- "live": true,
- "key_rotation_overdue": false,
- "bundled_daemon_version": "0.1.0.5",
- "created_at": "2026-11-17T01:48:21.769513Z",
- "updated_at": "2026-11-17T01:48:21.841799Z",
- "last_connected_at": "2026-11-17T01:48:21.533279Z",
- "key_expires_at": null,
- "daemon_reported_at": "2026-11-17T01:48:21.798107Z",
- "upgrade_requested_at": "2026-11-17T01:48:21.823234Z",
- "upgrade_offered_at": null
}, - "relationships": {
- "settings": {
- "data": {
- "id": "01a1e730-dd8d-7ead-abfd-afb860843bad",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/01a1e730-dd8d-7ead-abfd-afb860843bad"
}
}, - "node": {
- "data": {
- "id": "01a1e730-dc7b-7d53-8fe4-ad8d59b561fa",
- "type": "node"
}
}, - "remote_runner_target_scopes": {
- "data": [
- {
- "id": "01a1e730-dda4-72fa-a989-11af6bba1006",
- "type": "remote_runner_target_scope"
}
]
}
}, - "links": {
- "self": "/api/remote_runner_targets/01a1e730-dd8a-7c2d-9ff6-819a5bb47174"
}, - "meta": null
}
}Downloads the remote runner daemon archive bundled in this OpsChain build, used to install the daemon on the target's host.
Requires the same access as showing the target. The X-Checksum-Sha256 response header holds the archive's SHA-256 checksum.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
<binary data>
Downloads the simple-mode disk image (simple-mode.raw.zst) bundled in this OpsChain build, used to set up a simple-mode remote runner host.
Requires the same access as showing the target. The X-Checksum-Sha256 response header holds the file's SHA-256 checksum.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
<binary data>
Downloads the simple-mode systemd unit (opschain-remote-runner.service) bundled in this OpsChain build, used to set up a simple-mode remote runner host.
Requires the same access as showing the target. The X-Checksum-Sha256 response header holds the file's SHA-256 checksum.
| target_id required | string Example: 01a1e72b-1655-7e2f-8a63-156847f4afe0 remote runner target id |
<binary data>
Compares two changes to help explain why one failed and the other succeeded: their run options, commits, settings and properties snapshots, templates, step trees, failing steps and logs, artifacts, the changes that ran alongside each, and what was updated between the two runs. Secret values are never returned. Both changes must have been created under a release that records the snapshots the comparison needs.
required | object |
{- "data": {
- "attributes": {
- "change_id_a": "01c5c541-d408-42dc-b336-c280d71f0c76",
- "change_id_b": "225cd605-4de5-4518-baba-e6818795b949"
}
}
}{- "data": {
- "id": "01a1e72d-e97e-7d93-9881-8bbe26dcfbfd:01a1e72d-ea27-78dd-bf06-9510c8395b22",
- "type": "change_comparison",
- "attributes": {
- "changes": {
- "change_a": {
- "id": "01a1e72d-e97e-7d93-9881-8bbe26dcfbfd",
- "action": "compress",
- "action_path": "/projects/opc/environments/dev/actions/compress",
- "created_by": "nestor_boyle-1627",
- "api_key_id": null,
- "scheduled_activity_id": null,
- "workflow_run_id": null,
- "cluster_name": null,
- "executor_queue_name": "change-01a1e72d-e97e-7d93-9881-8bbe26dcfbfd",
- "state_timing_summary": { },
- "created_under_version": "",
- "node_path": "/projects/opc/environments/dev",
- "status": "success",
- "retry": false,
- "retry_of": null,
- "approval_steps": [ ],
- "created_at": "2026-11-17T01:45:08.220960Z",
- "started_at": "2026-11-17T01:39:01.761102Z",
- "finished_at": "2026-11-17T01:41:38.723493Z"
}, - "change_b": {
- "id": "01a1e72d-ea27-78dd-bf06-9510c8395b22",
- "action": "compress",
- "action_path": "/projects/opc/environments/dev/actions/compress",
- "created_by": "brian.rodriguez-1629",
- "api_key_id": null,
- "scheduled_activity_id": null,
- "workflow_run_id": null,
- "cluster_name": null,
- "executor_queue_name": "change-01a1e72d-ea27-78dd-bf06-9510c8395b22",
- "state_timing_summary": { },
- "created_under_version": "",
- "node_path": "/projects/opc/environments/dev",
- "status": "error",
- "retry": false,
- "retry_of": null,
- "approval_steps": [ ],
- "created_at": "2026-11-17T01:45:08.388664Z",
- "started_at": "2026-11-17T01:39:11.970662Z",
- "finished_at": "2026-11-17T01:42:27.613451Z"
}, - "related": false
}, - "run_options": {
- "change_a": {
- "skip_steps": [ ],
- "starting_step": null,
- "auto_continue_wait_steps": false,
- "build_without_cache": false,
- "pod_per_step": true
}, - "change_b": {
- "skip_steps": [ ],
- "starting_step": null,
- "auto_continue_wait_steps": false,
- "build_without_cache": false,
- "pod_per_step": true
}, - "diff": [ ]
}, - "commit": {
- "change_a": {
- "git_remote": "github",
- "git_rev": "main",
- "sha": "47cbd454e09acb955140c0a009e38634fd8e56ec",
- "mixed_sha": false
}, - "change_b": {
- "git_remote": "github",
- "git_rev": "main",
- "sha": "e5360dd1d7dc5a34410c2b3595a837f1aee84f42",
- "mixed_sha": false
}, - "diff": [
- "sha"
]
}, - "settings": {
- "diff": [ ]
}, - "override_settings": {
- "diff": [ ]
}, - "override_properties": {
- "diff": [
- {
- "path": [
- "feed"
], - "secret": false,
- "change_a": {
- "source": null,
- "value": "calculating"
}, - "change_b": null
}, - {
- "path": [
- "panel"
], - "secret": false,
- "change_a": null,
- "change_b": {
- "source": null,
- "value": "indexing"
}
}
]
}, - "properties": {
- "change_a": {
- "pre": {
- "status": "recorded",
- "step_id": "01a1e72d-e985-7451-8a1d-b6accd8ddd7a"
}, - "post": {
- "status": "recorded",
- "step_id": "01a1e72d-e985-7451-8a1d-b6accd8ddd7a"
}
}, - "change_b": {
- "pre": {
- "status": "recorded",
- "step_id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13"
}, - "post": {
- "status": "saved_before_failure",
- "step_id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13"
}
}, - "diff": {
- "pre": [
- {
- "path": [
- "example_property"
], - "secret": false,
- "change_a": {
- "source": "Change",
- "value": "pre_a",
- "version": 1
}, - "change_b": {
- "source": "Change",
- "value": "pre_b",
- "version": 1
}
}
], - "post": [
- {
- "path": [
- "example_property"
], - "secret": false,
- "change_a": {
- "source": "Change",
- "value": "post_a",
- "version": 1
}, - "change_b": {
- "source": "Change",
- "value": "post_b",
- "version": 1
}
}
]
}
}, - "template": {
- "change_a": {
- "template_version_id": null,
- "template_version": null,
- "template_commit_sha": null,
- "generate_actions_request_id": null,
- "mintmodel_history_id": null,
- "mintmodel_change": false
}, - "change_b": {
- "template_version_id": null,
- "template_version": null,
- "template_commit_sha": null,
- "generate_actions_request_id": null,
- "mintmodel_history_id": null,
- "mintmodel_change": false
}, - "mintmodel_diff": null
}, - "failure": {
- "change_a": null,
- "change_b": {
- "full_path": "compress",
- "step_id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13",
- "status": "error",
- "ignore_failure": false,
- "step_sequence": 1,
- "in_place_retried": false,
- "runner_image": {
- "key": null,
- "status": "unavailable"
}, - "started_at": "2026-11-17T01:39:11.970662Z",
- "finished_at": "2026-11-17T01:42:27.613451Z",
- "duration_seconds": 195.643,
- "state_timing": {
- "error": {
- "ended_at": "2026-11-17T01:45:08.395927Z",
- "started_at": "2026-11-17T01:45:08.395927Z"
}
}, - "retry_state": {
- "current_state": {
- "id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13",
- "started_at": "2026-11-17T01:39:11.970Z",
- "finished_at": "2026-11-17T01:42:27.613Z",
- "status_code": "error",
- "action_completed_at": null,
- "waiting_for_children": false
}
}
}
}, - "logs": {
- "change_a": {
- "step_id": "01a1e72d-e985-7451-8a1d-b6accd8ddd7a",
- "log_step_id": "01a1e72d-e985-7451-8a1d-b6accd8ddd7a",
- "from_original": false,
- "head": [ ],
- "tail": [ ]
}, - "change_b": {
- "step_id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13",
- "log_step_id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13",
- "from_original": false,
- "head": [ ],
- "tail": [ ]
}
}, - "artifacts": {
- "change_a": {
- "stored": [ ],
- "loaded": [ ]
}, - "change_b": {
- "stored": [ ],
- "loaded": [ ]
}, - "diff": [ ]
}, - "concurrency": {
- "change_a": {
- "changes": [ ],
- "truncated": false
}, - "change_b": {
- "changes": [ ],
- "truncated": false
}
}, - "between_runs": {
- "from": "2026-11-17T01:45:08.220960Z",
- "to": "2026-11-17T01:45:08.388664Z",
- "may_be_incomplete": true,
- "versions": [ ],
- "events": {
- "truncated": false,
- "items": [ ]
}
}, - "remote_runner": {
- "change_a": [ ],
- "change_b": [ ]
}, - "resource_usage": {
- "change_a": null,
- "change_b": null
}, - "step_tree": {
- "change_a": {
- "step_count": 1,
- "tree_discovered": false
}, - "change_b": {
- "step_count": 1,
- "tree_discovered": false
}, - "fan_out": [ ],
- "steps": [
- {
- "full_path": "compress",
- "differences": [
- "status",
- "properties"
], - "change_a": {
- "step_id": "01a1e72d-e985-7451-8a1d-b6accd8ddd7a",
- "status": "success",
- "ignore_failure": false,
- "step_sequence": 1,
- "in_place_retried": false,
- "runner_image": {
- "key": null,
- "status": "unavailable"
}, - "started_at": "2026-11-17T01:39:01.761102Z",
- "finished_at": "2026-11-17T01:41:38.723493Z",
- "duration_seconds": 156.962
}, - "change_b": {
- "step_id": "01a1e72d-ea2e-7749-98cf-bbdf2a92ae13",
- "status": "error",
- "ignore_failure": false,
- "step_sequence": 1,
- "in_place_retried": false,
- "runner_image": {
- "key": null,
- "status": "unavailable"
}, - "started_at": "2026-11-17T01:39:11.970662Z",
- "finished_at": "2026-11-17T01:42:27.613451Z",
- "duration_seconds": 195.643
}, - "properties": [
- {
- "path": [
- "example_property"
], - "secret": false,
- "change_a": {
- "source": "Change",
- "value": "pre_a",
- "version": 1
}, - "change_b": {
- "source": "Change",
- "value": "pre_b",
- "version": 1
}
}
]
}
], - "differing_count": 1,
- "truncated": false
}
}, - "meta": {
- "warnings": [ ]
}
}
}Extracts the converged properties, converged settings, and relevant asset MintModel for the two nodes supplied. Also includes environments and assets summaries, and most recent change for each node.
required | object |
{- "data": {
- "attributes": {
- "node_path_a": "/projects/opc/environments/dev/assets/env_soa",
- "node_path_b": "/projects/opc/assets/prj_soa"
}
}
}{- "data": {
- "id": "env_soa:prj_soa",
- "type": "node_comparison",
- "attributes": {
- "nodes": {
- "node_a": {
- "name": "Environment asset (env_soa)",
- "path": "/projects/opc/environments/dev/assets/env_soa",
- "created_at": "2026-11-17T01:45:15.138029Z",
- "updated_at": "2026-11-17T01:45:15.138029Z",
- "properties": {
- "updated_at": "2026-11-17T01:45:15.164241Z",
- "version": 1
}, - "settings": {
- "updated_at": "2026-11-17T01:45:15.205545Z",
- "version": 1
}, - "mintmodel": {
- "filename": "soa.json.erb",
- "valid?": true
}, - "latest_change": null,
- "parent": "Development (dev)"
}, - "node_b": {
- "name": "Project asset (prj_soa)",
- "path": "/projects/opc/assets/prj_soa",
- "created_at": "2026-11-17T01:45:15.611219Z",
- "updated_at": "2026-11-17T01:45:15.611219Z",
- "properties": {
- "updated_at": "2026-11-17T01:45:15.621725Z",
- "version": 1
}, - "settings": {
- "updated_at": "2026-11-17T01:45:15.651000Z",
- "version": 1
}, - "mintmodel": {
- "filename": "soa.json.erb",
- "valid?": true
}, - "latest_change": null,
- "parent": "OpsChain (opc)"
}
}, - "properties": {
- "node_a": {
- "data": {
- "example_property": "value_a"
}, - "sources": {
- "example_property": "Development (dev)"
}
}, - "node_b": {
- "data": {
- "example_property": "value_b",
- "another_property": "extra"
}, - "sources": {
- "example_property": "OpsChain (opc)",
- "another_property": "OpsChain (opc)"
}
}
}, - "mintmodel": {
- "node_a": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "node_b": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "diff": { }
}, - "environments": {
- "node_a": null,
- "node_b": null
}, - "assets": {
- "node_a": null,
- "node_b": null
}, - "agents": {
- "node_a": null,
- "node_b": null
}, - "settings": {
- "node_a": {
- "data": {
- "example_setting": "value_a"
}, - "sources": null
}, - "node_b": {
- "data": {
- "example_setting": "value_b"
}, - "sources": null
}
}
}
}
}