OpsChain logo
API docs by Redocly

OpsChain API (v1)

Download OpenAPI specification:

LimePoint Pty Ltd: opschain@limepoint.com URL: https://opschain.io

Introduction

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-09-10 (6c4268b7b)

Projects

Endpoints to interact with projects.

Notes:

  • The 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.
  • The list, create, show, update and archive asset endpoints are available via the /<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.

List projects

Lists all projects (including archived projects).

Each project in the response includes a link to:

  • the project's changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.
  • the project's scheduled_activities endpoint for managing scheduled activities belonging to this project. It acts like a scheduled activities endpoint.
  • the project's bookmarks endpoint for managing the bookmarks belonging to this project. It acts like a bookmarks endpoint.
  • the project's mintmodels endpoint for managing the MintModels belonging to this project. It acts like a MintModels endpoint.
  • the project's mintmodel_history endpoint for viewing this project's MintModel history. It acts like a MintModel history endpoint.
  • the project's workflows endpoint for viewing this project's workflows. It acts like a Workflows endpoint. .
query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[code_eq]=opc

API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].

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.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-ef71-70c7-a08c-b09e7e9f8bcd",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}

Create project

Creates a project.

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "opc",
      • "name": "OpsChain",
      • "description": "OpsChain project",
      • "project_type": "Enterprise"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-f04f-746a-a9c4-5ef6cdcefed6",
    • "type": "project",
    • "attributes": {
      • "code": "yjk7k",
      • "name": "temporibus602",
      • "description": "Quis culpa excepturi incidunt.",
      • "archived": false,
      • "created_by": "logged_in_user",
      • "project_type": "Standard"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/yjk7k",
      • "bookmarks": "/api/projects/yjk7k/bookmarks",
      • "git_remotes": "/api/projects/yjk7k/git_remotes",
      • "environments": "/api/projects/yjk7k/environments"
      },
    • "meta": {
      • "can_have_changes": false,
      • "can_have_children": true,
      • "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": {
        }
      }
    }
}

Show project

Shows a project, including any direct children.

The response includes a link to:

  • the project's changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.
  • the project's scheduled_activities endpoint for managing scheduled activities belonging to this project. It acts like a scheduled activities endpoint.
  • the project's bookmarks endpoint for managing the bookmarks belonging to this project. It acts like a bookmarks endpoint.
  • the project's mintmodels endpoint for managing the MintModels belonging to this project. It acts like a MintModels endpoint.
  • the project's mintmodel_history endpoint for viewing this project's MintModel history. It acts like a MintModel history endpoint.
  • the project's workflows endpoint for viewing this project's workflows. It acts like a Workflows endpoint. .
path Parameters
project_code
required
string
Example: opc

project code

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-f155-715e-b47c-8ed5b64554a5",
    • "type": "project",
    • "attributes": {
      • "code": "opc",
      • "name": "OpsChain",
      • "description": "OpsChain project",
      • "archived": false,
      • "created_by": "kaitlyn_yost-1960",
      • "project_type": "Enterprise"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc",
      • "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": [
        ],
      • "can_have_workflows": true,
      • "can_have_actions": false,
      • "authorisations": {
        }
      }
    },
  • "included": [ ]
}

Update project

Updates a project.

path Parameters
project_code
required
string
Example: opc

project code

Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "name": "Modified",
      • "description": "The updated project",
      • "archived": false
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-f24d-7d5a-ba66-e9cecda8df08",
    • "type": "project",
    • "attributes": {
      • "code": "opc",
      • "name": "quisquam611",
      • "description": "Vero sed vel quia.",
      • "archived": true,
      • "created_by": "jeniffer_larkin-1966",
      • "project_type": "Standard"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc",
      • "bookmarks": "/api/projects/opc/bookmarks",
      • "git_remotes": "/api/projects/opc/git_remotes",
      • "environments": "/api/projects/opc/environments"
      },
    • "meta": {
      • "can_have_changes": false,
      • "can_have_children": true,
      • "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": {
        }
      }
    }
}

Archive project

Archives a project.

path Parameters
project_code
required
string
Example: opc

project code

query Parameters
ignore_in_use
boolean

When true and the requesting user is a superuser, bypasses in use checks and force-destroys the project.

Responses

Response samples

Content type
text/plain
Environments
Endpoints to interact with environments.


Notes:


    

  • The 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.
    • 

  • The list, create, show, update and archive asset endpoints are available via the /<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.
    • 



List environments 
Lists all project environments (including archived environments).


Each environment in the response includes a link to:


    

  • the environment's changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.
    • 

  • the environment's scheduled_activities endpoint for managing scheduled activities belonging to this environment. It acts like a scheduled activities endpoint.
    • 

  • the environment's bookmarks endpoint for managing the bookmarks belonging to this environment. It acts like a bookmarks endpoint.
    • 

  • the environment's mintmodels endpoint for managing the MintModels belonging to this environment. It acts like a MintModels endpoint.
    • 

  • the environment's mintmodel_history endpoint for viewing this environment's MintModel history. It acts like a MintModel history endpoint.
    • 

  • the environment's workflows endpoint for viewing this environment's workflows. It acts like a Workflows endpoint.
.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=Test
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-beca-7ddc-b09b-fa1655727588",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create environment 
Creates an environment.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "dev",
      • "name": "Development",
      • "description": "OpsChain development environment"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-bfab-758c-bcce-a479bc2a418b",
    • "type": "environment",
    • "attributes": {
      • "code": "yipia",
      • "name": "est528",
      • "description": "Enim placeat ratione assumenda.",
      • "archived": false,
      • "created_by": "logged_in_user"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/yipia",
      • "bookmarks": "/api/projects/opc/environments/yipia/bookmarks",
      • "changes": "/api/projects/opc/environments/yipia/changes",
      • "scheduled_activities": "/api/projects/opc/environments/yipia/scheduled_activities",
      • "parent": "/api/projects/opc",
      • "assets": "/api/projects/opc/environments/yipia/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": [
        ],
      • "can_have_workflows": false,
      • "can_have_actions": false,
      • "authorisations": {
        }
      }
    }
}
Show environment 
Shows an environment.


The response includes a link to:


    

  • the environment's changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.
    • 

  • the environment's scheduled_activities endpoint for managing scheduled activities belonging to this environment. It acts like a scheduled activities endpoint.
    • 

  • the environment's bookmarks endpoint for managing the bookmarks belonging to this environment. It acts like a bookmarks endpoint.
    • 

  • the environment's mintmodels endpoint for managing the MintModels belonging to this environment. It acts like a MintModels endpoint.
    • 

  • the environment's mintmodel_history endpoint for viewing this environment's MintModel history. It acts like a MintModel history endpoint.
    • 

  • the environment's workflows endpoint for viewing this environment's workflows. It acts like a Workflows endpoint.
.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


environment_code
required
string
 
 Example:  dev
environment code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-c0e1-7b9c-bf20-9a516831199d",
    • "type": "environment",
    • "attributes": {
      • "code": "dev",
      • "name": "Development",
      • "description": "OpsChain development environment",
      • "archived": false,
      • "created_by": "ines-1665"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev",
      • "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": [
        ],
      • "can_have_workflows": false,
      • "can_have_actions": false,
      • "authorisations": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-c0bd-7d99-abbc-7470fc912b54",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}
Update environment 
Updates an environment.


path Parameters
project_code
required
string
 
 Example:  opc
project code


environment_code
required
string
 
 Example:  dev
environment code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "name": "Modified",
      • "description": "The updated environment",
      • "archived": false
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-c2c4-7f69-bbfd-7a1ed6fa541d",
    • "type": "environment",
    • "attributes": {
      • "code": "dev",
      • "name": "repudiandae538",
      • "description": "Ducimus dolore perferendis temporibus.",
      • "archived": true,
      • "created_by": "ramona_boehm-1673"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev",
      • "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": [
        ],
      • "can_have_workflows": false,
      • "can_have_actions": false,
      • "authorisations": {
        }
      }
    }
}
Archive environment 
Archives an environment.


path Parameters
project_code
required
string
 
 Example:  opc
project code


environment_code
required
string
 
 Example:  dev
environment code


query Parameters
ignore_in_use
boolean
 
When true and the requesting user is a superuser, bypasses in use checks and force-destroys the environment.


Responses
 Response samples 
Content type
text/plain
Show converged settings 
Show the converged settings for this environment, merged from all settings sources in the hierarchy (global, project, and environment settings).


The response includes a setting_sources meta object that attributes each setting value to its originating source.


path Parameters
project_code
required
string
 
 Example:  opc
project code


environment_code
required
string
 
 Example:  dev
environment code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "dev",
    • "type": "converged_settings",
    • "attributes": {
      • "data": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_settings"
      },
    • "meta": {
      • "setting_sources": {
        }
      }
    }
}
Show converged properties 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


environment_code
required
string
 
 Example:  dev
environment code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-09-10T11:27:30+00:00
Specify the date (and optionally time), to derive the active environment properties from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "dev",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-c6f3-7082-a699-0fe3fdfe0fd8",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-c714-7bc9-8d61-96edb5b90a34",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ]
}
Agents
Endpoints to interact with agents.


Notes:


    

  • The 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.
    • 

  • The list, create, show, update and archive asset endpoints are available via the /<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.
    • 



Build agent image 
Builds the container image for an agent. Note, this does not restart the agent.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-d105-7909-a614-6bce6d34e61d",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 2,
      • "status_code": "initializing",
      • "error_message": null,
      • "created_by": "logged_in_user",
      • "task_type": "BuildAgentImageTask",
      • "created_at": "2026-09-10T11:27:41.316877Z",
      • "updated_at": "2026-09-10T11:27:41.316877Z",
      • "image_sha": null,
      • "image_purged": false,
      • "image_in_use": false
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a08b12-d07d-7091-bac1-1da40cf68ac5/versions/2026_Q1_2",
      • "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a08b12-d105-7909-a614-6bce6d34e61d",
      • "agent": "/api/projects/opc/agents/agent1",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a08b12-d105-7909-a614-6bce6d34e61d"
      }
    }
}
List agent background tasks 
Lists the image build, start and stop tasks run for the agent's current template version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[request_number_eq]=1
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b12-d215-702c-a791-8c630ecac7a4",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      },
    • "partial_response": false
    }
}
Show agent background task 
Show a specific agent image build, start or stop task.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


node_background_task_id
required
string
 
 Example:  01a08b12-95f1-74d8-a882-ec79c8022842
agent background task id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-d37c-7caa-acb9-713766cd1a08",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 1,
      • "status_code": "success",
      • "error_message": null,
      • "created_by": "michael_romaguera-363",
      • "task_type": "BuildAgentImageTask",
      • "created_at": "2026-09-10T11:27:41.948349Z",
      • "updated_at": "2026-09-10T11:27:41.955984Z",
      • "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
      • "image_purged": false,
      • "image_in_use": true
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a08b12-d2e9-72d0-bb1f-c318d40e85d1/versions/2026_Q1_2",
      • "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a08b12-d37c-7caa-acb9-713766cd1a08",
      • "agent": "/api/projects/opc/agents/agent1",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a08b12-d37c-7caa-acb9-713766cd1a08"
      }
    }
}
Show agent status 
Shows the status for an agent.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-d4b7-7817-bfb4-5c9dab001f94",
    • "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"
      },
    • "relationships": {
      • "node": {
        },
      • "referenced_build_agent_image_task": {
        },
      • "available_build_agent_image_tasks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/agents/agent1/status",
      • "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
      }
    },
  • "included": [
    • {
      • "id": "01a08b12-d4b6-79a8-a5ff-7f18acf81169",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Update agent status 
Update an agent status.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "desired_status": "running",
      • "image_sha": "sha256:de10faf919fc71ba4eb1dd7bd6449566d012b0c9436b1c61bfee21d621b009aa"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-d649-7538-8965-2d5fe1440a24",
    • "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"
      },
    • "relationships": {
      • "node": {
        },
      • "referenced_build_agent_image_task": {
        },
      • "available_build_agent_image_tasks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/agents/agent1/status",
      • "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
      }
    },
  • "included": [
    • {
      • "id": "01a08b12-d648-7752-bd17-7d747571cfd1",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Show agent log lines 
Shows log lines for the agent.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b12-da4b-7bce-8cf9-42e9baedb7a1",
      • "type": "agent_log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Show agent Kubernetes events 
Shows Kubernetes events for the agent. This request will only succeed when the agent is running.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "0",
      • "type": "agent_event",
      • "attributes": {
        }
      }
    ]
}
List agents 
Lists all agents (including archived agents) that belong to the project.


Each agent in the response includes a link to:


    

  • the agent's changes endpoint for managing changes belonging to this agent. It acts like the changes endpoint.
    • 

  • the agent's scheduled_activities endpoint for managing scheduled activities belonging to this agent. It acts like a scheduled activities endpoint.
    • 

  • the agent's bookmarks endpoint for managing the bookmarks belonging to this agent. It acts like a bookmarks endpoint.
    • 

  • the agent's mintmodels endpoint for managing the MintModels belonging to this agent. It acts like a MintModels endpoint.
    • 

  • the agent's mintmodel_history endpoint for viewing this agent's MintModel history. It acts like a MintModel history endpoint.
    • 

  • the agent's workflows endpoint for viewing this agent's workflows. It acts like a Workflows endpoint.
.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=Test
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-98aa-7109-a702-f49ddd8990f8",
      • "type": "agent",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create agent 
Creates an agent.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "agent1",
      • "name": "Agent",
      • "description": "Asset description",
      • "template_code": "agn",
      • "template_version": "2026_Q1_2"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-9a10-7b25-bf73-33bd43ff3e6f",
    • "type": "agent",
    • "attributes": {
      • "code": "pl4m4",
      • "name": "a452",
      • "description": "Molestiae et quia autem.",
      • "archived": false,
      • "created_by": "logged_in_user",
      • "task_active": true
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "latest_node_background_tasks": {
        },
      • "agent_status": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/agents/pl4m4",
      • "bookmarks": "/api/projects/opc/agents/pl4m4/bookmarks",
      • "converged_properties": "/api/projects/opc/agents/pl4m4/converged_properties",
      • "parent": "/api/projects/opc",
      • "node_background_tasks": "/api/projects/opc/agents/pl4m4/node_background_tasks",
      • "version_history": "/api/projects/opc/agents/pl4m4/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": {
        }
      }
    }
}
Show agent 
Shows an agent belonging to a project.


The response includes a link to:


    

  • the agent's changes endpoint for managing changes belonging to this agent. It acts like the changes endpoint.
    • 

  • the agent's scheduled_activities endpoint for managing scheduled activities belonging to this agent. It acts like a scheduled activities endpoint.
    • 

  • the agent's bookmarks endpoint for managing the bookmarks belonging to this agent. It acts like a bookmarks endpoint.
    • 

  • the agent's mintmodels endpoint for managing the MintModels belonging to this agent. It acts like a MintModels endpoint.
    • 

  • the agent's mintmodel_history endpoint for viewing this agent's MintModel history. It acts like a MintModel history endpoint.
    • 

  • the agent's workflows endpoint for viewing this agent's workflows. It acts like a Workflows endpoint.
.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-9b62-7b4d-8542-1b701bbd27b1",
    • "type": "agent",
    • "attributes": {
      • "code": "agent1",
      • "name": "Agent",
      • "description": "Asset description",
      • "archived": false,
      • "created_by": "johnathan-1455",
      • "task_active": false
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "latest_node_background_tasks": {
        },
      • "agent_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": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-9b0b-71c8-879c-4bec5d208e52",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-9b24-71ae-acb3-3d5db92d8a61",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-9b3e-7e19-930a-469cffb20443",
      • "type": "template_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-9b76-721c-a9af-1a7e45fba40c",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-9b77-70dd-8329-fb69430b10fa",
      • "type": "agent_status",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Update agent 
Updates an agent belonging to a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "name": "Modified",
      • "description": "The updated agent",
      • "archived": false
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-9d23-7a4f-839e-0de19942c438",
    • "type": "agent",
    • "attributes": {
      • "code": "agent1",
      • "name": "voluptatem462",
      • "description": "Eos enim occaecati quasi.",
      • "archived": true,
      • "created_by": "darrel-1464",
      • "task_active": false
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "latest_node_background_tasks": {
        },
      • "agent_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": {
        }
      }
    }
}
Archive agent 
Archives an agent belonging to a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


query Parameters
ignore_in_use
boolean
 
When true and the requesting user is a superuser, bypasses in use checks and force-destroys the agent.


Responses
 Response samples 
Content type
text/plain
Show converged settings 
Show the converged settings for this agent, merged from all settings sources in the hierarchy (global and project settings).


The response includes a setting_sources meta object that attributes each setting value to its originating source.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-09-10T11:27:30+00:00
Specify the date (and optionally time), to derive the active template version and agent settings from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "agent1",
    • "type": "converged_settings",
    • "attributes": {
      • "data": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/agents/agent1/converged_settings"
      },
    • "meta": {
      • "setting_sources": {
        }
      }
    }
}
Show converged properties 
Show the converged properties as they will appear for this agent. i.e. the endpoint will


    

  1. merge any template (repository) properties from the agent's template (in the order described in the documentation)
    2. 

  2. merge any project properties
    3. 

  3. merge any properties assigned to the agent
    4. 



The API response will also include all the individual repository and database properties that were included in the result.


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-09-10T11:27:30+00:00
Specify the date (and optionally time), to derive the active template version and agent properties from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "agent1",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/agents/agent1/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-a39d-7362-93f9-d9ecab1196d8",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-a3cf-74db-850d-70d6225e916b",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-a400-72ce-8974-cf2cd4163e1a",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-a433-7cee-bd32-f89837f7d1b2",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "properties.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "projects/opc.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}
Assets
Endpoints to interact with assets.


Notes:


    

  • The 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.
    • 

  • The list, create, show, update and archive asset endpoints are available via the /<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.
    • 



List assets 
Lists all assets (including archived assets) that belong to the project.


Each asset in the response includes a link to:


    

  • the asset's changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.
    • 

  • the asset's scheduled_activities endpoint for managing scheduled activities belonging to this asset. It acts like a scheduled activities endpoint.
    • 

  • the asset's bookmarks endpoint for managing the bookmarks belonging to this asset. It acts like a bookmarks endpoint.
    • 

  • the asset's mintmodels endpoint for managing the MintModels belonging to this asset. It acts like a MintModels endpoint.
    • 

  • the asset's mintmodel_history endpoint for viewing this asset's MintModel history. It acts like a MintModel history endpoint.
    • 

  • the asset's workflows endpoint for viewing this asset's workflows. It acts like a Workflows endpoint.
.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=Test
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-a657-710e-ba78-705fc69f61ce",
      • "type": "asset",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create asset 
Creates an asset belonging to the project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "prj_soa",
      • "name": "Project asset",
      • "description": "Project asset description",
      • "template_code": "soa",
      • "template_version": "2023_Q4_2"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-a816-73d6-9ffb-303c7b875475",
    • "type": "asset",
    • "attributes": {
      • "code": "shpqp",
      • "name": "perferendis482",
      • "description": "Eos voluptas quod error.",
      • "archived": false,
      • "created_by": "logged_in_user",
      • "task_active": true
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "latest_node_background_tasks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/shpqp",
      • "actions": "/api/projects/opc/assets/shpqp/actions",
      • "bookmarks": "/api/projects/opc/assets/shpqp/bookmarks",
      • "changes": "/api/projects/opc/assets/shpqp/changes",
      • "scheduled_activities": "/api/projects/opc/assets/shpqp/scheduled_activities",
      • "converged_properties": "/api/projects/opc/assets/shpqp/converged_properties",
      • "mintmodels": "/api/projects/opc/assets/shpqp/mintmodels",
      • "mintmodel_history": "/api/projects/opc/assets/shpqp/mintmodel_history",
      • "parent": "/api/projects/opc",
      • "node_background_tasks": "/api/projects/opc/assets/shpqp/node_background_tasks",
      • "version_history": "/api/projects/opc/assets/shpqp/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": {
        }
      }
    }
}
Show asset 
Shows an asset belonging to a project.


The response includes a link to:


    

  • the asset's changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.
    • 

  • the asset's scheduled_activities endpoint for managing scheduled activities belonging to this asset. It acts like a scheduled activities endpoint.
    • 

  • the asset's bookmarks endpoint for managing the bookmarks belonging to this asset. It acts like a bookmarks endpoint.
    • 

  • the asset's mintmodels endpoint for managing the MintModels belonging to this asset. It acts like a MintModels endpoint.
    • 

  • the asset's mintmodel_history endpoint for viewing this asset's MintModel history. It acts like a MintModel history endpoint.
    • 

  • the asset's workflows endpoint for viewing this asset's workflows. It acts like a Workflows endpoint.
.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-a98b-783e-8132-84331b7277d5",
    • "type": "asset",
    • "attributes": {
      • "code": "prj_soa",
      • "name": "Project asset",
      • "description": "Project asset description",
      • "archived": false,
      • "created_by": "alease_sawayn-1527",
      • "mintmodel_valid": true,
      • "mintmodel_invalid_reason": null,
      • "erb_file_content": "<MintModel erb file contents>",
      • "task_active": false
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "latest_node_background_tasks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa",
      • "actions": "/api/projects/opc/assets/prj_soa/actions",
      • "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": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-a922-7063-ba96-5a45d26054eb",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-a9b1-7183-9e99-dab5c1f16bc5",
      • "type": "bookmark",
      • "attributes": {},
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-a940-73b0-92aa-59a7611bd648",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-a965-74fb-98af-cdbb9d7a3bf5",
      • "type": "template_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Update asset 
Updates an asset belonging to a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "name": "Modified",
      • "description": "The updated asset",
      • "archived": false
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-ab1c-7666-a880-b618992c74a3",
    • "type": "asset",
    • "attributes": {
      • "code": "prj_soa",
      • "name": "dolorem492",
      • "description": "Est sint aut quam.",
      • "archived": true,
      • "created_by": "ayako.volkman-1537",
      • "task_active": false
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "latest_node_background_tasks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa",
      • "actions": "/api/projects/opc/assets/prj_soa/actions",
      • "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": {
        }
      }
    }
}
Archive asset 
Archives an asset belonging to a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
ignore_in_use
boolean
 
When true and the requesting user is a superuser, bypasses in use checks and force-destroys the asset.


Responses
 Response samples 
Content type
text/plain
Show converged settings 
Show the converged settings for this asset, merged from all settings sources in the hierarchy (global, project, environment, and asset settings).


The response includes a setting_sources meta object that attributes each setting value to its originating source.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-09-10T11:27:30+00:00
Specify the date (and optionally time), to derive the active template version and asset settings from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "prj_soa",
    • "type": "converged_settings",
    • "attributes": {
      • "data": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/converged_settings"
      },
    • "meta": {
      • "setting_sources": {
        }
      }
    }
}
Show converged properties 
Show the converged properties as they will appear to actions run on this asset. i.e. the endpoint will


    

  1. merge any template (repository) properties from the asset's template (in the order described in the documentation)
    2. 

  2. merge any project properties
    3. 

  3. merge any properties assigned to the project asset
    4. 



The API response will also include all the individual repository and database properties that were included in the result.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-09-10T11:27:30+00:00
Specify the date (and optionally time), to derive the active template version and asset properties from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "prj_soa",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-b497-708b-b533-291b6326fa9f",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-b4cc-78e6-8634-225d6831fbcd",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-b4f6-7e89-b869-1d1502550acc",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-b52a-77d7-b9a1-93263343fe91",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "properties.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "projects/opc.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}
List generate actions request log lines 
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.


path Parameters
node_background_task_id
required
string
 
 Example:  01a08b12-9237-7008-a57f-7b2910abf05e
query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-b69f-776d-82de-cbd971c55039",
      • "type": "node_background_task_log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Create generate actions request 
Create a request to refresh the actions list for an asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-b8b1-7e2f-a0cd-7239aab6e68d",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 3,
      • "status_code": "initializing",
      • "error_message": null,
      • "created_by": "logged_in_user",
      • "actions_count": 0,
      • "task_type": "GenerateActionsRequest",
      • "created_at": "2026-09-10T11:28:40.625203Z",
      • "updated_at": "2026-09-10T11:28:40.625203Z"
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a08b13-b827-7c18-b005-509e93b6e4b0/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a08b13-b8b1-7e2f-a0cd-7239aab6e68d",
      • "asset": "/api/projects/opc/assets/prj_soa",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a08b13-b8b1-7e2f-a0cd-7239aab6e68d"
      }
    }
}
List generate actions requests 
Lists all generate actions requests made for the asset's current template version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[request_number_eq]=1
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-b9a4-72a1-a6a9-2413ece6a71f",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-b98f-7648-ae26-c2d0a6b88101",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      },
    • "partial_response": false
    }
}
Show generate actions request 
Show a specific actions generation request.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


node_background_task_id
required
string
 
 Example:  01a08b12-9237-7008-a57f-7b2910abf05e
generate actions request id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-bad6-7f2a-86d8-cc9dbbc8b519",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 1,
      • "status_code": "success",
      • "error_message": null,
      • "created_by": "roland.brown-1619",
      • "actions": [
        ],
      • "actions_count": 1,
      • "task_type": "GenerateActionsRequest",
      • "created_at": "2026-09-10T11:28:41.174328Z",
      • "updated_at": "2026-09-10T11:28:41.179927Z"
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a08b13-ba3b-767b-800e-737038c55b06/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a08b13-bad6-7f2a-86d8-cc9dbbc8b519",
      • "asset": "/api/projects/opc/assets/prj_soa",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a08b13-bad6-7f2a-86d8-cc9dbbc8b519"
      }
    }
}
Cancel generate actions request 
Cancels the generate actions request.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


node_background_task_id
required
string
 
 Example:  01a08b12-9237-7008-a57f-7b2910abf05e
generate actions request id


Responses
 Response samples 
Content type
text/plain
List properties history 
Lists all properties versions and template versions for the asset and its parents.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-f56e-746e-9d5f-3601a9a9e1e4",
      • "type": "project",
      • "attributes": {
        }
      },
    • {
      • "id": "01a08b13-f58c-7ba9-9ea1-e44c289556b5",
      • "type": "template",
      • "attributes": {
        }
      },
    • {
      • "id": "01a08b13-f5cf-746a-8cec-66e9f3004134",
      • "type": "asset",
      • "attributes": {
        }
      }
    ]
}
List template version history 
Lists the template versions that have been assigned to the asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=Test
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-382c-7541-b140-9022b1085c2d",
      • "type": "template_version_history",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Show template version history 
Shows a specific project asset's template version history record.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


id
required
string
 
 Example:  01a08b12-91ff-78e1-8226-e24eb3761b73
version history id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-3931-78a0-9459-9a1a46a94d45",
    • "type": "template_version_history",
    • "attributes": {
      • "created_by": "jared_herzog-2300",
      • "active_from": "2026-09-10T11:29:13.519593Z",
      • "active_to": null
      },
    • "relationships": {
      • "owner": {
        },
      • "template_version": {
        },
      • "node_background_tasks": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a08b14-38d1-79cb-8ef4-57c9cb9ca0e3/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/version_history/01a08b14-3931-78a0-9459-9a1a46a94d45",
      • "asset": "/api/projects/opc/assets/prj_soa"
      }
    },
  • "included": [
    • {
      • "id": "01a08b14-3919-7aaf-bfae-320ce77d15eb",
      • "type": "asset",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b14-38f3-77af-8029-88cc8f5206f8",
      • "type": "template_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Actions
Endpoints to query the action step trees available for a templated node.


Notes:


    

  • The list and show action endpoints are routed for any templated node, via the
/<path/to/node>/actions path, but only assets build an action catalog; an agent's action list is
always empty. The example endpoints in this section reflect the actions of a project asset.
    • 

  • Only the top level actions of the catalog are addressable, by their 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.
    • 



List actions 
Lists every action available for the asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
include_children
boolean
 
 Example:  include_children=true
By default each action is returned without its children. Set this to return the full step tree of every action.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "deploy",
      • "type": "action",
      • "links": {
        },
      • "attributes": {
        }
      },
    • {
      • "id": "provision",
      • "type": "action",
      • "links": {
        },
      • "attributes": {
        }
      }
    ]
}
Show action 
Shows the step tree of one of the asset's actions. The action can be identified by its action name or its step_name.


path Parameters
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "deploy",
    • "type": "action",
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/actions/deploy"
      },
    • "attributes": {
      • "action": "deploy",
      • "children": [
        ],
      • "pre_reqs": [ ],
      • "full_path": "deploy",
      • "step_name": "deploy",
      • "stage_step": false,
      • "description": "Deploy the asset",
      • "ignore_failure": false,
      • "child_execution_strategy": "sequential"
      }
    }
}
Templates
Templates provide the available actions and a base set of
repository properties that
will be used to configure the asset.


Create template 
Create a template.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "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"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-2b78-72f4-8d48-d4f422b8172b",
    • "type": "template",
    • "attributes": {
      • "code": "dhz9j",
      • "name": "hollis",
      • "description": "Maiores deserunt ut cumque.",
      • "archived": false,
      • "disabled": false,
      • "template_type": "asset",
      • "created_at": "2026-09-10T11:29:10.006753Z",
      • "updated_at": "2026-09-10T11:29:10.006753Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-2b78-72f4-8d48-d4f422b8172b",
      • "template_versions": "/api/projects/opc/templates/01a08b14-2b78-72f4-8d48-d4f422b8172b/versions",
      • "project": "/api/projects/opc"
      }
    }
}
List templates 
Lists all templates for a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_cont]=base
exclude_archived_nodes
boolean
 
 Example:  exclude_archived_nodes=true
when true, excludes archived nodes from each template's nodes relationship


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-2e9b-7995-9498-e7ba7ba0f760",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Show template 
Shows a project template.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


query Parameters
exclude_archived_nodes
boolean
 
 Example:  exclude_archived_nodes=true
when true, excludes archived nodes from each template's nodes relationship


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-2fde-737a-b393-bb0484c310e1",
    • "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-09-10T11:29:11.133575Z",
      • "updated_at": "2026-09-10T11:29:11.133575Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-2fde-737a-b393-bb0484c310e1",
      • "template_versions": "/api/projects/opc/templates/01a08b14-2fde-737a-b393-bb0484c310e1/versions",
      • "project": "/api/projects/opc"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Archive template 
Archives/unarchives a template.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_archive
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "archived": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-3135-755c-86eb-9cfff42050e3",
    • "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-09-10T11:29:11.476846Z",
      • "updated_at": "2026-09-10T11:29:11.515338Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-3135-755c-86eb-9cfff42050e3",
      • "template_versions": "/api/projects/opc/templates/01a08b14-3135-755c-86eb-9cfff42050e3/versions",
      • "project": "/api/projects/opc"
      }
    }
}
Update template 
Update a templates details.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_update
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "name": "Oracle SOA template",
      • "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
      • "git_remote_name": "github",
      • "disabled": false
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-3311-74c1-9b33-1de2ad56cb4c",
    • "type": "template",
    • "attributes": {
      • "code": "soa",
      • "name": "updated_name",
      • "description": "updated_description",
      • "archived": false,
      • "disabled": false,
      • "template_type": "asset",
      • "created_at": "2026-09-10T11:29:11.952862Z",
      • "updated_at": "2026-09-10T11:29:11.990177Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-3311-74c1-9b33-1de2ad56cb4c",
      • "template_versions": "/api/projects/opc/templates/01a08b14-3311-74c1-9b33-1de2ad56cb4c/versions",
      • "project": "/api/projects/opc"
      }
    }
}
Delete template 
Deletes a project template. A template cannot be deleted while it is assigned to a node or referenced by a change.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_delete
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


Responses
 Response samples 
Content type
text/plain
List template versions 
Lists all versions of a specific template.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[version_cont]=1.0
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-3a21-7155-bfcc-6382c8f61939",
      • "type": "template_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Create or update a template version 
Create or update a template version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


version
required
string
 
 Example:  2023_Q4_2
template version


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "description": "Added additional configuration options",
      • "git_rev": "auxiliary",
      • "archived": "false",
      • "locked": "false",
      • "float_git_rev": "false"
      }
    },
  • "meta": {
    • "ignore_in_use": false,
    • "fetch_revision": false
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-3c19-790b-ac40-68dc04c12b2f",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Id ullam occaecati eveniet ut cupiditate neque architecto aut repellat nostrum atque maxime dolores",
      • "state": "initializing",
      • "created_by": "logged_in_user",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-09-10T11:29:14.264973Z",
      • "updated_at": "2026-09-10T11:29:14.264973Z",
      • "has_mintmodel": false,
      • "git_rev": "1080p",
      • "commit_sha": null,
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-3b78-79db-a405-b26e3b1d7f7a/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a08b14-3b78-79db-a405-b26e3b1d7f7a"
      }
    }
}
Show template version 
Shows a specific template version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


version
required
string
 
 Example:  2023_Q4_2
template version


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-3f16-7e7c-9d85-b6a06793578a",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "delma-2334",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-09-10T11:29:15.030461Z",
      • "updated_at": "2026-09-10T11:29:15.030461Z",
      • "has_mintmodel": true,
      • "git_rev": "neural",
      • "commit_sha": "c9b19c6453373f4dc8b558ef3bab9b4a014bfc05",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-3efc-7251-88ae-1290139e1553/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a08b14-3efc-7251-88ae-1290139e1553"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Bulk assign assets to template versions 
Assign assets to the template version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


version
required
string
 
 Example:  2023_Q4_2
template version


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "asset_paths": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-40ea-7ed8-ac5f-465f7abd33d8",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "jamey_heaney-2342",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-09-10T11:29:15.498367Z",
      • "updated_at": "2026-09-10T11:29:15.498367Z",
      • "has_mintmodel": true,
      • "git_rev": "primary",
      • "commit_sha": "6872d3d075374667bfdf5be108525ceff662703d",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a08b14-40c3-7355-9fa5-8a3a4242b219/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a08b14-40c3-7355-9fa5-8a3a4242b219"
      }
    }
}
Cancel a template version Git SHA refresh 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  01a08b12-9058-79f9-9bc6-f25ab7b16e21
template id


version
required
string
 
 Example:  2023_Q4_2
template version


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-446d-73f3-acc5-af9d1e90d5a1",
    • "type": "template_version",
    • "attributes": {
      • "version": "dgi31",
      • "description": "Sit officia impedit similique asperiores officiis atque quam voluptates corrupti dolore vel",
      • "state": "ready",
      • "created_by": "elliott.rosenbaum-2361",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-09-10T11:29:16.396777Z",
      • "updated_at": "2026-09-10T11:29:16.435002Z",
      • "has_mintmodel": false,
      • "git_rev": "multi-byte",
      • "commit_sha": "1a15ba827864a3876cae30b1157c6fe69d76cc4f",
      • "git_remote_name": "cynthia"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/swwba/templates/01a08b14-4450-7b96-a791-f8ae41c52849/versions/dgi31",
      • "template": "/api/projects/swwba/templates/01a08b14-4450-7b96-a791-f8ae41c52849"
      }
    }
}
Git remotes
Endpoints to interact with git remotes.


Create Git remote 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-7fd4-7972-bae4-58a878fc7cec",
    • "type": "git_remote",
    • "attributes": {
      • "name": "github",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "public_url": null,
      • "archived": false,
      • "disabled": false,
      • "periodic_fetch_interval": null,
      • "created_at": "2026-09-10T11:28:26.067795Z",
      • "updated_at": "2026-09-10T11:28:26.067795Z",
      • "user": null,
      • "ssh_key_data": null,
      • "password": null,
      • "passphrase": null
      },
    • "relationships": {
      • "templates": {
        },
      • "project": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
      • "self": "/api/projects/opc/git_remotes/01a08b13-7fd4-7972-bae4-58a878fc7cec"
      },
    • "meta": null
    }
}
List Git remotes 
Lists all Git remotes for a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_cont]=origin
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-8283-7e21-83a4-e7918f64fc36",
      • "type": "git_remote",
      • "attributes": {},
      • "relationships": {
        },
      • "links": {
        },
      • "meta": null
      },
    • {
      • "id": "01a08b13-8287-7436-a8fe-f7cf3d8f39a2",
      • "type": "git_remote",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": null
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      },
    • "default_periodic_fetch_interval": 900
    }
}
Show Git remote 
Shows a project Git remote.


Note: Git remote credentials are obfuscated for security reasons.


path Parameters
project_code
required
string
 
 Example:  opc
project code


remote_id
required
string
 
 Example:  01a08b12-901b-76f5-844a-827f0ad5ca09
remote id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-8405-7f9a-a32e-e70a15c2a6a5",
    • "type": "git_remote",
    • "attributes": {},
    • "relationships": {
      • "templates": {
        },
      • "project": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
      • "self": "/api/projects/opc/git_remotes/01a08b13-8405-7f9a-a32e-e70a15c2a6a5"
      },
    • "meta": null
    }
}
Archive Git remote 
Archives/unarchives a project Git remote.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_archive
required
string
 
 Example:  01a08b12-901b-76f5-844a-827f0ad5ca09
remote id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "archived": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-8520-7ec6-858f-b4273070149d",
    • "type": "git_remote",
    • "attributes": {},
    • "relationships": {
      • "templates": {
        },
      • "project": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
      • "self": "/api/projects/opc/git_remotes/01a08b13-8520-7ec6-858f-b4273070149d"
      },
    • "meta": null
    }
}
Update Git remote 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_update
required
string
 
 Example:  01a08b12-901b-76f5-844a-827f0ad5ca09
remote id


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-8717-7017-a590-5b951956aead",
    • "type": "git_remote",
    • "attributes": {},
    • "relationships": {
      • "templates": {
        },
      • "project": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
      • "self": "/api/projects/opc/git_remotes/01a08b13-8717-7017-a590-5b951956aead"
      },
    • "meta": null
    }
}
Delete Git remote 
Deletes a project Git remote if it has no changes, otherwise it removes the credentials.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_delete
required
string
 
 Example:  01a08b12-901b-76f5-844a-827f0ad5ca09
remote id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-8919-77f0-8e68-f59bd330786c",
    • "type": "git_remote",
    • "attributes": {},
    • "relationships": {
      • "templates": {
        },
      • "project": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
      • "self": "/api/projects/opc/git_remotes/01a08b13-8919-77f0-8e68-f59bd330786c"
      },
    • "meta": {
      • "credentials_removed": true,
      • "messages": [
        ]
      }
    }
}
Bookmarks
Endpoints to interact with bookmarks.


Notes:


    

  • The list, create, show, update and delete bookmark endpoints are available via the
/<path/to/bookmark/owner>/bookmarks path. The example endpoints in this section reflect bookmarks owned
by a project asset.
    • 



Create bookmark 
Create a bookmark for a specific project, environment or asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-2077-7c85-b3ba-79e7846ce3d1",
    • "type": "bookmark",
    • "attributes": {
      • "url": "https://murphy.example/bernie",
      • "description": "Eius cupiditate fugiat repudiandae. 1",
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:28:01.655118Z",
      • "updated_at": "2026-09-10T11:28:01.655118Z"
      },
    • "relationships": {
      • "parent": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a08b13-2077-7c85-b3ba-79e7846ce3d1",
      • "parent": "/api/projects/opc/assets/prj_soa"
      }
    }
}
List bookmarks 
Lists all bookmarks for a specific project, environment or asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[description_cont]=server
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-246f-7511-89b7-357d104b9dd8",
      • "type": "bookmark",
      • "attributes": {},
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Show bookmark 
Show a bookmark for a specific project, environment or asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


bookmark_id
required
string
 
 Example:  01a08b12-9261-7e8b-9957-6b6be30b9daf
bookmark id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-259b-7dd8-8b01-6734ba745e58",
    • "type": "bookmark",
    • "attributes": {},
    • "relationships": {
      • "parent": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a08b13-259b-7dd8-8b01-6734ba745e58",
      • "parent": "/api/projects/opc/assets/prj_soa"
      }
    }
}
Update bookmark 
Update a bookmark for a specific project, environment or asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


bookmark_id
required
string
 
 Example:  01a08b12-9261-7e8b-9957-6b6be30b9daf
bookmark id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-282f-79ed-8a40-7a9e7bd1e958",
    • "type": "bookmark",
    • "attributes": {
      • "url": "https://updated.server.com:8080/new/path",
      • "description": "Updated server console path",
      • "created_by": "jetta_prosacco-909",
      • "created_at": "2026-09-10T11:28:03.630954Z",
      • "updated_at": "2026-09-10T11:28:03.674285Z"
      },
    • "relationships": {
      • "parent": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a08b13-282f-79ed-8a40-7a9e7bd1e958",
      • "parent": "/api/projects/opc/assets/prj_soa"
      }
    }
}
Delete bookmark 
Delete a bookmark for a specific project, environment or asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


bookmark_id
required
string
 
 Example:  01a08b12-9261-7e8b-9957-6b6be30b9daf
bookmark id


Responses
 Response samples 
Content type
text/plain
MintModels
Endpoints to query and generate MintModels for assets.


Notes:


    

  • The list, show and generate MintModel endpoints are available for all assets, via the
/<path/to/mintmodel/owner>/mintmodels path. The example endpoints in this section reflect MintModels owned
by a project asset.
    • 

  • The list and show endpoints will display all MintModels for the asset, regardless whether they were
applied successfully or not. Use the parent_mintmodel_history link in the API response to access the
asset's MintModel history.
    • 



List MintModel history 
Lists the asset's MintModel history.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-8e20-7bed-bc1f-201cd4bd2d0c",
      • "type": "mintmodel_history",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Show MintModel history 
Shows an asset's MintModel history record.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


id
required
string
 
 Example:  01a08b12-a52a-7660-a3b3-c1641b5a84e3
MintModel history id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-8f2a-7284-a642-f47802eeb4c7",
    • "type": "mintmodel_history",
    • "attributes": {
      • "created_at": "2026-09-10T11:28:29.993727Z",
      • "updated_at": "2026-09-10T11:28:29.993727Z"
      },
    • "relationships": {
      • "parents": {
        },
      • "mintmodel": {
        },
      • "opschain_changes": {
        },
      • "template_version": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/01a08b13-8f2a-7284-a642-f47802eeb4c7"
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-8f26-79bc-9516-30952d634466",
      • "type": "mintmodel",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
List MintModels 
List all MintModels for an asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-8f8d-79a5-9e25-2e67d7068290",
      • "type": "mintmodel",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Generate MintModel diff 
Generate a MintModel of the differences between two existing MintModels.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


old_mintmodel_id
required
string
 
 Example:  01a08b12-a232-7d31-b96b-358781beb2bf
old MintModel id


new_mintmodel_id
required
string
 
 Example:  01a08b12-a23f-7da1-86ab-2669a5865ec7
new MintModel id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "MintModelDiff",
    • "type": "diff_mintmodel",
    • "attributes": {
      • "diff_mintmodel": {
        },
      • "step_trees": [
        ]
      },
    • "links": {
      • "old_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/01a08b13-9122-7262-a204-1f39abce83f3",
      • "new_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/01a08b13-916b-79d9-aa11-2989420a1ba5",
      • "parent": "/projects/opc/assets/prj_soa"
      }
    }
}
Show MintModel 
Shows an asset MintModel.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


mintmodel_id
required
string
 
 Example:  01a08b12-9276-749a-a86e-86cda874f231
MintModel id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-92ec-7e65-8c38-c64d8dcd6220",
    • "type": "mintmodel",
    • "attributes": {
      • "data": {
        },
      • "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
      • "created_at": "2026-09-10T11:28:30.956371Z",
      • "updated_at": "2026-09-10T11:28:30.956371Z",
      • "render_logs": {
        },
      • "phase_output": { }
      },
    • "relationships": {
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodels/01a08b13-92ec-7e65-8c38-c64d8dcd6220",
      • "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
      }
    }
}
Concretise MintModel 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-97d7-7277-84c9-54abde49c540",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 2,
      • "status_code": "initializing",
      • "error_message": null,
      • "created_by": "logged_in_user",
      • "actions_count": 0,
      • "task_type": "MintModelConcretiseTask",
      • "created_at": "2026-09-10T11:28:32.214339Z",
      • "updated_at": "2026-09-10T11:28:32.214339Z"
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a08b13-96cc-7aad-bf67-982f55e5e573/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a08b13-97d7-7277-84c9-54abde49c540",
      • "asset": "/api/projects/opc/assets/prj_soa",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a08b13-97d7-7277-84c9-54abde49c540"
      }
    }
}
Workflows
Endpoints to interact with enterprise project workflows


List workflows 
Lists all workflows for a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_cont]=deploy
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b15-538a-7f38-827a-60eb2643e5d5",
      • "type": "workflow",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      },
    • "partial_response": false
    }
}
Create workflow 
Create a workflow


path Parameters
project_code
required
string
 
 Example:  opc
project code


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "code": "55gwr",
      • "archived": false,
      • "name": "m0yzzzmigv",
      • "description": "We need to transmit the haptic PCI panel!",
      • "steps": [
        ],
      • "draft": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-56b5-7988-9890-c58ecdba521e",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets_new",
      • "name": "assets workflow_new",
      • "description": null,
      • "draft": false,
      • "archived": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:30:26.612794Z",
      • "updated_at": "2026-09-10T11:30:26.612794Z",
      • "source_yaml": "---\nsteps:\n- type: change\n  name: run asset action\n  target: \"/projects/opc/assets/prj_soa\"\n  action: run\n",
      • "steps": [
        ],
      • "resolved_steps": [ ],
      • "sample_properties": { },
      • "latest_version": 1,
      • "latest_published_version": 1
      },
    • "relationships": {
      • "parent": {
        },
      • "versions": {
        }
      },
    • "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"
      }
    }
}
Show workflow 
Shows a workflow.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-5b94-7bf0-848e-38532789d4f1",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "created_by": "sean.strosin-4143",
      • "created_at": "2026-09-10T11:30:27.860166Z",
      • "updated_at": "2026-09-10T11:30:27.860166Z",
      • "source_yaml": "---\nsteps:\n- type: change\n  name: run asset action\n  target: \"/projects/opc/assets/prj_soa\"\n  action: run\n",
      • "steps": [
        ],
      • "resolved_steps": [ ],
      • "sample_properties": {
        },
      • "latest_version": 2,
      • "latest_published_version": 2
      },
    • "relationships": {
      • "parent": {
        },
      • "versions": {
        }
      },
    • "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 workflow 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "archived": false,
      • "name": "xvclnwgsxs",
      • "description": "If we override the feed, we can get to the IB hard drive through the 1080p SCSI feed!",
      • "steps": [
        ],
      • "draft": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-6015-7e35-8b4d-1f33b6b5c61e",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "new workflow name",
      • "description": "new description",
      • "draft": false,
      • "archived": false,
      • "created_by": "juan.jerde-4171",
      • "created_at": "2026-09-10T11:30:29.013338Z",
      • "updated_at": "2026-09-10T11:30:29.083816Z",
      • "source_yaml": "---\nsteps:\n- type: change\n  name: run asset action\n  target: \"/projects/opc/assets/prj_soa\"\n  action: run\n",
      • "steps": [
        ],
      • "resolved_steps": [
        ],
      • "sample_properties": {
        },
      • "latest_version": 2,
      • "latest_published_version": 2
      },
    • "relationships": {
      • "parent": {
        },
      • "versions": {
        }
      },
    • "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 workflow 
Delete or archive a workflow.


    

  • If the workflow has not been run before, it will be deleted.
    • 

  • If the workflow has been run before, it will be archived and all draft and unused versions will be deleted..
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Responses
 Response samples 
Content type
text/plain
Workflow versions
List workflow versions 
Lists all versions for a workflow.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b15-67e8-7ebe-b80e-b59032b345dc",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b15-67e5-7dc7-aac1-cbfc6f448e4b",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Delete draft workflow versions 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-6cbe-72e6-9ebc-81b6798163b5",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "created_by": "jolyn.lindgren-4262",
      • "created_at": "2026-09-10T11:30:32.253725Z",
      • "updated_at": "2026-09-10T11:30:32.253725Z",
      • "source_yaml": "---\nsteps:\n- type: change\n  name: run asset action\n  target: \"/projects/opc/assets/prj_soa\"\n  action: run\n",
      • "steps": [
        ],
      • "resolved_steps": [ ],
      • "sample_properties": {
        },
      • "latest_version": 2,
      • "latest_published_version": 2
      },
    • "relationships": {
      • "parent": {
        },
      • "versions": {
        }
      },
    • "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"
      }
    }
}
Show workflow version 
Shows a workflow version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


version
required
string
 
 Example:  2
version


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-7046-74a3-b621-2341e543cc4a",
    • "type": "workflow_version",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "created_by": "rosana_feeney-4289",
      • "created_at": "2026-09-10T11:30:33.157247Z",
      • "updated_at": "2026-09-10T11:30:33.172011Z",
      • "source_yaml": "---\nsteps:\n- type: change\n  name: run asset action\n  target: \"/projects/opc/assets/prj_soa\"\n  action: run\n",
      • "steps": [
        ],
      • "resolved_steps": [ ],
      • "sample_properties": {
        },
      • "version": 2
      },
    • "relationships": {
      • "parent": {
        }
      },
    • "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 workflow 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


version
required
string
 
 Example:  2
version


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "code": "oca7m",
      • "node_id": "01a08b12-bd01-70da-9a6f-17c25feb6f0f",
      • "archived": false,
      • "name": "oes8te4jkh",
      • "description": "Use the haptic GB interface, then you can hack the cross-platform driver!",
      • "steps": [
        ],
      • "draft": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-76cb-77f1-a341-ea2de8e11a59",
    • "type": "workflow_version",
    • "attributes": {
      • "code": "assets",
      • "name": "new workflow name",
      • "description": "new description",
      • "draft": true,
      • "archived": false,
      • "created_by": "joseph-4335",
      • "created_at": "2026-09-10T11:30:34.826949Z",
      • "updated_at": "2026-09-10T11:30:34.857281Z",
      • "source_yaml": "---\nsteps:\n- type: change\n  name: run asset action\n  target: \"/projects/opc/assets/prj_soa\"\n  action: run\n",
      • "steps": [
        ],
      • "resolved_steps": [ ],
      • "sample_properties": {
        },
      • "version": 2
      },
    • "relationships": {
      • "parent": {
        }
      },
    • "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 workflow version 
Delete or archive a workflow version.


    

  • If the workflow version has not been run before, it will be deleted.
    • 

  • If the workflow version has been run before, it will be archived.
    • 



path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


version
required
string
 
 Example:  2
version


Responses
 Response samples 
Content type
text/plain
Properties
Endpoints to interact with properties.


Show properties 
Shows the current properties JSON and its version.


path Parameters
properties_id
required
string
 
 Example:  01a08b12-8fcb-7279-b02e-1e47726acfc7
properties id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-f684-7e14-ad2c-1f9243ade91d",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-09-10T11:28:56.452386Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a08b13-f684-7e14-ad2c-1f9243ade91d",
      • "current_version": "/api/properties/01a08b13-f684-7e14-ad2c-1f9243ade91d/versions/1",
      • "versions": "/api/properties/01a08b13-f684-7e14-ad2c-1f9243ade91d/versions"
      }
    }
}
Update properties 
Updates a properties JSON if the included version matches the current properties version.


path Parameters
id_to_update
required
string
 
 Example:  01a08b12-8fcb-7279-b02e-1e47726acfc7
properties id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "data": {
        },
      • "version": 1
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-f780-7088-b3da-5a312b7a7088",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2026-09-10T11:28:56.703198Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a08b13-f780-7088-b3da-5a312b7a7088",
      • "current_version": "/api/properties/01a08b13-f780-7088-b3da-5a312b7a7088/versions/2",
      • "versions": "/api/properties/01a08b13-f780-7088-b3da-5a312b7a7088/versions"
      }
    }
}
Update properties (unsafe) 
Updates a properties JSON, without any version checking (always updates).


path Parameters
id_to_set
required
string
 
 Example:  01a08b12-8fcb-7279-b02e-1e47726acfc7
properties id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "data": {
        }
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-f971-7e1a-8f31-f273ac536e9e",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2026-09-10T11:28:57.201359Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a08b13-f971-7e1a-8f31-f273ac536e9e",
      • "current_version": "/api/properties/01a08b13-f971-7e1a-8f31-f273ac536e9e/versions/2",
      • "versions": "/api/properties/01a08b13-f971-7e1a-8f31-f273ac536e9e/versions"
      }
    }
}
Create or update a file property 
Create or update a file property in the properties.


path Parameters
properties_id
required
string
 
 Example:  01a08b12-8fcb-7279-b02e-1e47726acfc7
properties id


Request Body schema: multipart/form-data
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.


Responses
 Request samples 
Content type
multipart/form-data
------------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--

 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-fae4-7b59-9dd1-dae6993421c4",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2026-09-10T11:28:57.572234Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a08b13-fae4-7b59-9dd1-dae6993421c4",
      • "current_version": "/api/properties/01a08b13-fae4-7b59-9dd1-dae6993421c4/versions/2",
      • "versions": "/api/properties/01a08b13-fae4-7b59-9dd1-dae6993421c4/versions"
      }
    }
}
Properties versions
Endpoints to interact with the version history for
properties.


List properties versions 
Lists all versions of an OpsChain properties.


path Parameters
properties_id
required
string
 
 Example:  01a08b12-8fcb-7279-b02e-1e47726acfc7
properties id


query Parameters
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-fbdf-7c8b-b3d6-58005927aa86",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Show properties version 
Shows the properties JSON for this properties version.


path Parameters
properties_id
required
string
 
 Example:  01a08b12-8fcb-7279-b02e-1e47726acfc7
properties id


version_number
required
integer
 
 Example:  1
version number


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-fcf6-7050-96e3-5c16e91f1e87",
    • "type": "properties_version",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-09-10T11:28:58.101590Z",
      • "owner_type": "Project"
      },
    • "relationships": {
      • "properties": {
        }
      },
    • "links": {
      • "versions": "/api/properties/01a08b13-fcf1-7aca-8b1f-1bf64e56717a/versions",
      • "owner": "/api/projects/opc",
      • "self": "/api/properties/01a08b13-fcf1-7aca-8b1f-1bf64e56717a/versions/1"
      },
    • "meta": { }
    }
}
Activities
Endpoints to interact with activities (changes and workflow runs combined).


List activities 
Lists all activities (changes and workflow runs) accessible to the user.


query Parameters
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 meta.partial_response is true.


exact_count
boolean
 
 Example:  exact_count=true
By default meta.total_matching_filter stops counting at 1000 and meta.total_matching_filter_exact reports false. Set this to count every matching activity instead - this is significantly slower on instances with a large activity history.


filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[created_by_cont]=opschain
API filtering guide. Named filters: filter[active_over].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b12-c8f1-7d04-81cf-9599695d6b94",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-c85b-7e12-83de-c850abc806c8",
      • "type": "change",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-c733-70c6-bd4f-5c73cd75ba9b",
      • "type": "change",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-c651-7116-afbf-153c31ca1a29",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-c520-7440-8049-088f7fb1c1c3",
      • "type": "change",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false,
    • "has_any": true,
    • "total_matching_filter": 5,
    • "total_matching_filter_exact": true
    }
}
Changes
Endpoints to interact with changes.


List changes 
Lists all changes.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[environment_code_eq]=dev
API filtering guide. Named filters: filter[active], filter[active_over], filter[created_by_eq], filter[created_by_in], filter[finished], filter[waiting_for_approval_by], filter[waiting_to_run].


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>]
string
 
 Example:  fields[<resource_type>]=code,status,action
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-2fae-71e7-bdf3-10212ca5f509",
      • "type": "change",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "01a08b13-2fb1-7c6c-972b-a8e1ff00da1b",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-2f58-7cb2-9413-619e2d439700",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-2f7d-75da-8f36-08aeb6f14b12",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true,
      • "execute": true
      },
    • "partial_response": false,
    • "has_any": true
    }
}
Create change 
Creates a change in a specific project, environment or asset.


Notes:


    

  1. When creating changes via a project, environment or asset 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.
    2. 

  2. When creating changes for assets (e.g. POST to /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.
    3. 

  3. Supplying the 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.
    4. 



Request Body schema: application/vnd.api+json
 One of 
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "metadata": {
        },
      • "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,
      • "action": "transmit",
      • "parent_path": "/projects/opc/environments/dev/assets/env_soa",
      • "template_version": "2023_Q4_2"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-3276-7f8d-9917-643572ed6300",
    • "type": "change",
    • "attributes": {
      • "created_by": "logged_in_user",
      • "step_name": "navigate",
      • "action": "navigate",
      • "build_without_cache": false,
      • "auto_continue_wait_steps": false,
      • "initial_step_tree": { },
      • "metadata": {
        },
      • "scheduled": false,
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "cancelled_by": null,
      • "state_timing": {
        },
      • "state_timing_summary": { },
      • "notify": { },
      • "skip_steps": [ ],
      • "starting_step": null,
      • "cluster_name": null,
      • "status_code": "initializing",
      • "created_at": "2026-09-10T11:28:06.262165Z",
      • "started_at": "2026-09-10T11:28:06.258224Z",
      • "finished_at": null,
      • "updated_at": "2026-09-10T11:28:06.269028Z",
      • "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": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "workflow_run": {
        },
      • "workflow": {
        },
      • "override_properties": {
        },
      • "override_settings": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/01a08b13-315c-7598-85ad-f71dbd1a91f7",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/01a08b13-3276-7f8d-9917-643572ed6300",
      • "log_lines": "/api/changes/01a08b13-3276-7f8d-9917-643572ed6300/log_lines"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "01a08b13-3279-7e75-ae9c-ff07d05a7865",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ]
}
Show change 
Shows a change, including it's parent nodes.


path Parameters
change_id
required
string
 
 Example:  01a08b12-a187-7e26-8113-9164b262ebd1
change id


query Parameters
include
string
 
 Example:  include=steps,parents
Include the change steps and parents in the response


fields[<resource_type>]
string
 
 Example:  fields[<resource_type>]=code,status,action
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-348f-7ffb-9815-a9f05f2f3c4a",
    • "type": "change",
    • "attributes": {
      • "created_by": "aretha.dach-965",
      • "step_name": "navigate",
      • "action": "navigate",
      • "build_without_cache": false,
      • "auto_continue_wait_steps": false,
      • "initial_step_tree": { },
      • "metadata": {
        },
      • "scheduled": false,
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "cancelled_by": null,
      • "state_timing": {
        },
      • "state_timing_summary": { },
      • "notify": { },
      • "skip_steps": [ ],
      • "starting_step": null,
      • "cluster_name": null,
      • "status_code": "success",
      • "created_at": "2026-09-10T11:28:06.799005Z",
      • "started_at": "2026-09-10T11:21:48.316048Z",
      • "finished_at": "2026-09-10T11:24:26.915346Z",
      • "updated_at": "2026-09-10T11:28:06.805075Z",
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": "adf6d2a2989fca7003f8bc7533105e72543710d1",
      • "requires_approval_from": null
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "workflow_run": {
        },
      • "workflow": {
        },
      • "override_properties": {
        },
      • "override_settings": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/01a08b13-3477-7190-886e-8fcfe6c178d0",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/01a08b13-348f-7ffb-9815-a9f05f2f3c4a",
      • "log_lines": "/api/changes/01a08b13-348f-7ffb-9815-a9f05f2f3c4a/log_lines"
      },
    • "meta": {
      • "wait_queue": [ ],
      • "blocking_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-3492-767c-958e-6e431232de6d",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-3440-7a58-9999-7eb581540c3a",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-3462-707b-a242-d8c586f36501",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}
Cancel change 
Cancels a change.


path Parameters
change_id
required
string
 
 Example:  01a08b12-a187-7e26-8113-9164b262ebd1
change id


Responses
 Response samples 
Content type
text/plain
Show change settings 
Show the converged settings for a change, including any change-specific setting overrides merged on top of the asset's settings hierarchy.


The response includes a setting_sources meta object that attributes each setting value to its originating source.


path Parameters
change_id
required
string
 
 Example:  01a08b12-a187-7e26-8113-9164b262ebd1
change id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-3970-74e5-8cc5-3d6dfb3ce8ed",
    • "type": "converged_settings",
    • "attributes": {
      • "data": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_settings"
      },
    • "meta": {
      • "setting_sources": {
        }
      }
    }
}
Show change properties 
Converge the root step properties for a change.


The optional action_stage argument can be:


    

  • "pre" - to converge the properties as they were supplied to the root step action before it executed
    • 

  • "post" - to converge the properties as they were at the end of the latest completed step in the change
    • 



path Parameters
change_id
required
string
 
 Example:  01a08b12-a187-7e26-8113-9164b262ebd1
change id


query Parameters
action_stage
string
 
 Example:  action_stage=pre
Converge the pre or post action properties


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "reboot (post)",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-3bcd-723a-afc2-d54bfa9c2aed",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-3bf7-7476-a542-654074d65c73",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b13-3c2c-7b5b-a642-30e535e9dae0",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ]
}
Scheduled activities
List activities 
Lists all scheduled activities.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[project_code_eq]=opc
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


include
string
 
 Example:  include=parents
Include the scheduled change parents in the response


fields[<resource_type>]
string
 
 Example:  fields[<resource_type>]=code,status
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-0491-74cb-bac1-56ac8a2456a8",
      • "type": "scheduled_change",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-0627-7aff-95d1-803eb737ec37",
      • "type": "scheduled_workflow",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "included": [
    • {
      • "id": "01a08b13-0451-7bd4-9726-2bc990cb81b4",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-046f-7ef8-9522-635fc02e3046",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      },
    • "has_any": true
    }
}
Create activities 
Creates a scheduled activity in a specific project, environment or asset.


Notes:


    

  1. 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.
    

    2. 

  2. 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.
    

    3. 

  3. See the various payload examples to understand the required fields for each possible request to this endpoint.
    

    4. 



Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "git_rev": "master",
      • "action": "install_os",
      • "cron_schedule": "58 21 6 3 3",
      • "new_commits_only": true,
      • "repeat": true,
      • "metadata": {
        },
      • "run_at": null,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "end_at": null,
      • "allow_parallel_execution": false,
      • "property_overrides": {
        },
      • "settings_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "auto_continue_wait_steps": false,
      • "commit_file_patterns": [ ],
      • "commit_file_pattern_match": "any",
      • "parent_path": "/projects/opc/environments/dev",
      • "git_remote_name": "github"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-097b-7dd4-be0c-db66390b5e62",
    • "type": "scheduled_change",
    • "attributes": {
      • "created_by": "logged_in_user",
      • "cron_schedule": "12 0 6 10 3",
      • "repeat": true,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "enabled": true,
      • "allow_parallel_execution": false,
      • "metadata": {
        },
      • "property_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "created_at": "2026-09-10T11:27:55.770741Z",
      • "updated_at": "2026-09-10T11:27:55.770741Z",
      • "next_run_at": "2026-10-05T13:12:00.000000Z",
      • "run_at": null,
      • "end_at": null,
      • "action": "different_action",
      • "new_commits_only": true,
      • "git_rev": "1080p",
      • "auto_continue_wait_steps": false,
      • "commit_file_patterns": [ ],
      • "commit_file_pattern_match": "any",
      • "project_name": "OpsChain",
      • "project_code": "opc",
      • "settings_overrides": {
        },
      • "asset_code": null,
      • "asset_name": null,
      • "environment_code": "dev",
      • "environment_name": "Development",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "parents": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/01a08b13-0778-7019-a932-b8ae6d9154dc",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/scheduled_activities/01a08b13-097b-7dd4-be0c-db66390b5e62"
      }
    }
}
Show activity 
Shows a scheduled activity.


path Parameters
scheduled_change_id
required
string
 
 Example:  01a08b12-9786-792a-bef5-18ba8117b731
scheduled change id


query Parameters
include
string
 
 Example:  include=parents
Include the scheduled change parents in the response


fields[<resource_type>]
string
 
 Example:  fields[<resource_type>]=code,status
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-0d70-73c7-8337-8bc8680dd531",
    • "type": "scheduled_change",
    • "attributes": {
      • "created_by": "ora_klocko-742",
      • "cron_schedule": "4 8 20 7 3",
      • "repeat": true,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "enabled": true,
      • "allow_parallel_execution": false,
      • "metadata": {
        },
      • "property_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "created_at": "2026-09-10T11:27:56.782816Z",
      • "updated_at": "2026-09-10T11:27:56.782816Z",
      • "next_run_at": "2027-07-06T22:04:00.000000Z",
      • "run_at": null,
      • "end_at": null,
      • "action": "generate",
      • "new_commits_only": true,
      • "git_rev": "digital",
      • "auto_continue_wait_steps": false,
      • "commit_file_patterns": [
        ],
      • "commit_file_pattern_match": "any",
      • "project_name": "OpsChain",
      • "project_code": "opc",
      • "settings_overrides": {
        },
      • "asset_code": null,
      • "asset_name": null,
      • "environment_code": "dev",
      • "environment_name": "Development",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "parents": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/01a08b13-0d55-76dc-8f08-1e4440682bad",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/scheduled_activities/01a08b13-0d70-73c7-8337-8bc8680dd531"
      }
    },
  • "included": [
    • {
      • "id": "01a08b13-0ca4-7c67-8277-cad2e5e99723",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a08b13-0d1d-79ae-8182-032410f30fc6",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}
Update activity 
Updates a scheduled activity in a specific project, environment or asset.


Notes:


    

  1. The project, environment or asset the activity runs against cannot be changed. The parent_path, project_code,
environment_code and asset_code attributes must not be supplied - create a new scheduled activity against the
required parent instead.
    2. 

  2. When updating activities for assets (e.g. PATCH to /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.
    3. 

  3. See the various payload examples to understand the attributes you can supply to this endpoint.
    4. 

  4. The payload need only consist of the attributes you wish to modify. There is no need to supply the entire scheduled activity.
    5. 



path Parameters
scheduled_change_id
required
string
 
 Example:  01a08b12-9786-792a-bef5-18ba8117b731
scheduled change id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "git_rev": "master",
      • "action": "install_os",
      • "cron_schedule": "36 3 9 1 4",
      • "new_commits_only": true,
      • "repeat": true,
      • "metadata": {
        },
      • "run_at": null,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "end_at": null,
      • "allow_parallel_execution": false,
      • "property_overrides": {
        },
      • "settings_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "auto_continue_wait_steps": false,
      • "commit_file_patterns": [ ],
      • "commit_file_pattern_match": "any",
      • "git_remote_name": "github"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-1333-7263-a1f1-857138963eb0",
    • "type": "scheduled_change",
    • "attributes": {
      • "created_by": "alonso-776",
      • "cron_schedule": "1 18 14 10 2",
      • "repeat": true,
      • "run_count": 0,
      • "maximum_run_count": 5,
      • "enabled": true,
      • "allow_parallel_execution": false,
      • "metadata": {
        },
      • "property_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "created_at": "2026-09-10T11:27:58.258119Z",
      • "updated_at": "2026-09-10T11:27:58.729729Z",
      • "next_run_at": "2026-10-06T07:01:00.000000Z",
      • "run_at": null,
      • "end_at": null,
      • "action": "new_action",
      • "new_commits_only": true,
      • "git_rev": "mobile",
      • "auto_continue_wait_steps": false,
      • "commit_file_patterns": [
        ],
      • "commit_file_pattern_match": "any",
      • "project_name": "OpsChain",
      • "project_code": "opc",
      • "settings_overrides": {
        },
      • "asset_code": null,
      • "asset_name": null,
      • "environment_code": "dev",
      • "environment_name": "Development",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "parents": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/01a08b13-1323-7f1f-8487-e7da78c49823",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/scheduled_activities/01a08b13-1333-7263-a1f1-857138963eb0"
      }
    }
}
Delete activity 
Delete a scheduled activity.


path Parameters
scheduled_change_id
required
string
 
 Example:  01a08b12-9786-792a-bef5-18ba8117b731
scheduled change id


Responses
 Response samples 
Content type
text/plain
Steps
Endpoints to interact with change steps.


List steps 
Lists all steps.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[action_eq]=provision
API filtering guide. Named filters: filter[active_over], filter[finished], filter[waiting_for_user], filter[waiting_to_run], filter[with_input_arguments], filter[without_input_arguments].


limit
integer  [ 1 .. 1000 ] 
 Default:  1000
 
 Example:  limit=50
Limit the number of steps returned


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-11f2-7840-a06c-73e9b798f097",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}
Show step 
Shows a change step.


path Parameters
step_id
required
string
 
 Example:  01a08b12-a1a6-7469-aac1-2ceb1621be37
step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-12df-7cc6-b923-c22f8e0ff547",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": null,
      • "action": "synthesize",
      • "change_id": "01a08b14-12dd-7bb1-a5f6-ce70eec46e38",
      • "child_execution_strategy": "sequential",
      • "full_path": "synthesize",
      • "ignore_failure": false,
      • "input_arguments": [ ],
      • "state_timing": {
        },
      • "step_sequence": 1,
      • "step_type": "standard",
      • "description": "Deploy the release to the environment",
      • "step_name": "synthesize",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:21:41.841643Z",
      • "started_at": "2026-09-10T11:22:41.841643Z",
      • "finished_at": "2026-09-10T11:26:21.619078Z",
      • "updated_at": "2026-09-10T11:29:03.748012Z",
      • "status_code": "success"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a08b14-12dd-7bb1-a5f6-ce70eec46e38",
      • "change": "/api/projects/opc/environments/dev/changes/01a08b14-12dd-7bb1-a5f6-ce70eec46e38",
      • "log_lines": "/api/steps/01a08b14-12df-7cc6-b923-c22f8e0ff547/log_lines",
      • "self": "/api/steps/01a08b14-12df-7cc6-b923-c22f8e0ff547"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b14-12a0-738c-aed4-b00bbeeb074b",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b14-12c1-7c76-aa8d-012bcba4f8b0",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b14-12e7-73cc-a9d3-77325601e0f6",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b14-12ff-7c0e-9f5d-4ae43a2c7b3c",
      • "type": "properties",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Continue step 
Continues a "waiting" change step.


path Parameters
step_id
required
string
 
 Example:  01a08b12-a7f2-7a3f-8c17-8009ce99ae96
step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Manually removed from load balancer.",
      • "input_arguments": {
        }
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-14de-7ed4-8f1f-2dec57e61b93",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": null,
      • "action": "opschain_wait_step_2",
      • "change_id": "01a08b14-14dc-7b91-8c26-a717cb70e2fc",
      • "child_execution_strategy": "sequential",
      • "full_path": "opschain_wait_step_2",
      • "ignore_failure": false,
      • "input_arguments": [ ],
      • "state_timing": {
        },
      • "step_sequence": 1,
      • "step_type": "wait_step",
      • "description": "Deploy the release to the environment",
      • "step_name": "opschain_wait_step_2",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:20:03.719195Z",
      • "started_at": "2026-09-10T11:21:03.719195Z",
      • "finished_at": "2026-09-10T11:29:05.349103Z",
      • "updated_at": "2026-09-10T11:29:05.379718Z",
      • "status_code": "success"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a08b14-14dc-7b91-8c26-a717cb70e2fc",
      • "change": "/api/projects/opc/environments/dev/changes/01a08b14-14dc-7b91-8c26-a717cb70e2fc",
      • "log_lines": "/api/steps/01a08b14-14de-7ed4-8f1f-2dec57e61b93/log_lines",
      • "self": "/api/steps/01a08b14-14de-7ed4-8f1f-2dec57e61b93"
      },
    • "meta": { }
    }
}
Approve step 
Approves a change step that needs approval.


path Parameters
step_id
required
string
 
 Example:  01a08b12-a7f2-7a3f-8c17-8009ce99ae96
step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "As per CR 7 👍"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-1c5f-7e2d-8a46-6cddc084166c",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": [
        ],
      • "action": "opschain_wait_step_4",
      • "change_id": "01a08b14-1c5d-7a9e-84c0-cbd109f91cdc",
      • "child_execution_strategy": "sequential",
      • "full_path": "opschain_wait_step_4",
      • "ignore_failure": false,
      • "input_arguments": [ ],
      • "state_timing": {
        },
      • "step_sequence": 1,
      • "step_type": "wait_step",
      • "description": "Deploy the release to the environment",
      • "step_name": "opschain_wait_step_4",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:19:12.266086Z",
      • "started_at": "2026-09-10T11:20:12.266086Z",
      • "finished_at": null,
      • "updated_at": "2026-09-10T11:29:06.213711Z",
      • "status_code": "queued"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a08b14-1c5d-7a9e-84c0-cbd109f91cdc",
      • "change": "/api/projects/opc/environments/dev/changes/01a08b14-1c5d-7a9e-84c0-cbd109f91cdc",
      • "log_lines": "/api/steps/01a08b14-1c5f-7e2d-8a46-6cddc084166c/log_lines",
      • "self": "/api/steps/01a08b14-1c5f-7e2d-8a46-6cddc084166c"
      },
    • "meta": { }
    }
}
Reject step 
Rejects a change step that needs approval.


path Parameters
step_id
required
string
 
 Example:  01a08b12-a7f2-7a3f-8c17-8009ce99ae96
step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Failed user acceptance testing"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-200f-784b-be00-c3466df2675c",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": [
        ],
      • "action": "opschain_wait_step_7",
      • "change_id": "01a08b14-200d-76f4-9dee-544be68b273a",
      • "child_execution_strategy": "sequential",
      • "full_path": "opschain_wait_step_7",
      • "ignore_failure": false,
      • "input_arguments": [ ],
      • "state_timing": {
        },
      • "step_sequence": 1,
      • "step_type": "wait_step",
      • "description": "Deploy the release to the environment",
      • "step_name": "opschain_wait_step_7",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:22:34.721989Z",
      • "started_at": "2026-09-10T11:23:34.721989Z",
      • "finished_at": "2026-09-10T11:29:07.150709Z",
      • "updated_at": "2026-09-10T11:29:07.159267Z",
      • "status_code": "aborted"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a08b14-200d-76f4-9dee-544be68b273a",
      • "change": "/api/projects/opc/environments/dev/changes/01a08b14-200d-76f4-9dee-544be68b273a",
      • "log_lines": "/api/steps/01a08b14-200f-784b-be00-c3466df2675c/log_lines",
      • "self": "/api/steps/01a08b14-200f-784b-be00-c3466df2675c"
      },
    • "meta": { }
    }
}
Show step settings 
Show the converged settings for the change containing this step, including any change-specific setting overrides.


The response includes a setting_sources meta object that attributes each setting value to its originating source.


path Parameters
step_id
required
string
 
 Example:  01a08b12-a1a6-7469-aac1-2ceb1621be37
step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-245e-79e7-b0de-9040f30cea8f",
    • "type": "converged_settings",
    • "attributes": {
      • "data": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_settings"
      },
    • "meta": {
      • "setting_sources": {
        }
      }
    }
}
Show step properties 
Converge the properties for a step.


The optional action_stage argument can be:


    

  • "pre" - to converge the properties as they were supplied to the step action before it executed
    • 

  • "post" - to converge the properties as they were after the step action was complete (does not take into account any changes made by the step's children)
    • 



path Parameters
step_id
required
string
 
 Example:  01a08b12-a1a6-7469-aac1-2ceb1621be37
step id


query Parameters
action_stage
string
 
 Example:  action_stage=pre
Converge the pre or post action properties


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "synthesize (post)",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b14-2639-7d50-b07c-867e27a84400",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b14-2669-73ea-8639-1528127d7a6d",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b14-2699-7a23-b8e5-131b34892249",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ]
}
Log lines
Endpoints to query log lines for changes and individual change steps.


List change log lines 
List the log lines for a change.


path Parameters
change_id
required
string
 
 Example:  01a08b12-a187-7e26-8113-9164b262ebd1
query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-0db4-7a01-b9cd-20889670c7b5",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
List step log lines 
List the log lines for a change step.


path Parameters
step_id
required
string
 
 Example:  01a08b12-a1a6-7469-aac1-2ceb1621be37
query Parameters
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>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-0f79-7c98-8da9-b0b66ab6b271",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
List filtered log lines 
List filtered log lines.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-113f-7053-b074-034344882c31",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
List workflow run log lines 
List the workflow run log lines for a workflow run.


path Parameters
workflow_run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-4f25-7866-8ff7-0f79e758e70d",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
List workflow step log lines 
List the log lines for a workflow step.


path Parameters
workflow_step_id
required
string
 
 Example:  01a08b12-a9f1-7c19-ab23-ed8b39750a9f
query Parameters
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>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-56c7-78f2-a912-26feadc61e22",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
List filtered workflow run log lines 
List filtered workflow run log lines.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[message_cont]=dolorem
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-618b-7afc-a4ff-28f86c57f4d5",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Workflow runs
Endpoints to interact with workflow runs


Notes:


    

  • The list and show endpoints are available via the following paths:
      

    1. /workflow_runs - will return all workflow runs accessible to the user.
      2. 

    2. /project/{project_code}/workflow_runs - will return all workflow runs for all this project's workflows.
      3. 

    3. /project/{project_code}/workflows/{workflow_code}/workflow_runs - will return all workflow runs this workflow.
      4. 

    4. /<path/to/asset>/workflow_runs - will return all workflow runs that include a change for this asset.
      5. 

    

    • 



List all workflow runs 
Lists all workflow runs.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[created_by_cont]=opschain
API filtering guide. Named filters: filter[active_over], filter[created_by_eq], filter[created_by_in].


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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-62e3-71b9-8790-a1185c71b07d",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a08b14-655f-7027-9ceb-067e828eebe4",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "01a08b14-62a8-7cf5-a503-347de1fdabb8",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-6547-7555-8b3e-58365e4fcd66",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true,
      • "execute": true
      },
    • "partial_response": false
    }
}
Run a workflow 
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.


Request Body schema: application/vnd.api+json
 One of 
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "project_code": "opc",
      • "workflow_code": "assets"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-696b-7567-8476-131c75239612",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": { },
      • "created_by": "logged_in_user",
      • "cancelled_by": null,
      • "skip_steps": [ ],
      • "status_code": "pending",
      • "created_at": "2026-09-10T11:29:25.866623Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2026-09-10T11:29:25.877765Z",
      • "project_name": "OpsChain",
      • "workflow_code": "assets"
      },
    • "relationships": {
      • "workflow_version": {
        },
      • "workflow": {
        },
      • "parent_workflow_step": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "override_properties": {
        }
      },
    • "links": {
      • "parent": "/api/projects/opc",
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-696b-7567-8476-131c75239612",
      • "log_lines": "/api/workflow_runs/01a08b14-696b-7567-8476-131c75239612/log_lines"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "01a08b14-66ca-7dca-8300-6fa79f37ff4f",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-6973-72aa-95c0-f728e2aec0d6",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-697b-74fc-82ce-f3f612d385b5",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Show workflow run 
Shows a workflow run.


path Parameters
run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-761e-7e24-b7fb-11c81fd43898",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": {
        },
      • "created_by": "zenia_zboncak-2665",
      • "cancelled_by": null,
      • "skip_steps": [ ],
      • "status_code": "success",
      • "created_at": "2026-09-10T11:29:29.118374Z",
      • "started_at": "2026-09-10T11:23:13.557677Z",
      • "finished_at": "2026-09-10T11:27:44.944022Z",
      • "updated_at": "2026-09-10T11:29:29.125376Z",
      • "project_name": "OpsChain",
      • "workflow_code": "assets"
      },
    • "relationships": {
      • "workflow_version": {
        },
      • "workflow": {
        },
      • "parent_workflow_step": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "override_properties": {
        }
      },
    • "links": {
      • "parent": "/api/projects/opc",
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-761e-7e24-b7fb-11c81fd43898",
      • "log_lines": "/api/workflow_runs/01a08b14-761e-7e24-b7fb-11c81fd43898/log_lines"
      },
    • "meta": {
      • "wait_queue": [ ],
      • "blocking_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "01a08b14-75ed-713f-ae1b-a09a5045e2ee",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-7623-7563-9c36-7c2bc98904f7",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-7629-79e2-b9aa-eb8867dd47bf",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-784e-7660-9ca9-11e16b1ff88a",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-7858-76ba-9ed4-ed84bd9db14e",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-78ca-700f-8413-4fde3a1e4dd6",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-7764-7c9d-b979-de8ed7a16ed4",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Cancel workflow run 
Cancels a workflow run.


path Parameters
run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


Responses
 Response samples 
Content type
text/plain
List workflow runs (workflow specific) 
Lists all runs for a workflow.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[created_by_cont]=opschain
API filtering guide. Named filters: filter[active_over], filter[created_by_eq], filter[created_by_in].


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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-8552-73a5-bc9a-0c104478278c",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "01a08b14-850d-7964-a628-742f7561f1dd",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true,
      • "execute": true
      },
    • "partial_response": false
    }
}
Run a workflow (workflow specific) 
Runs a pre-defined workflow


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "version": 2,
      • "property_overrides": {
        },
      • "metadata": {
        },
      • "notify": {
        },
      • "skip_steps": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-8fc5-749c-b331-d535ad9b2d75",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": { },
      • "created_by": "logged_in_user",
      • "cancelled_by": null,
      • "skip_steps": [ ],
      • "status_code": "pending",
      • "created_at": "2026-09-10T11:29:35.684702Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2026-09-10T11:29:35.697667Z",
      • "project_name": "OpsChain",
      • "workflow_code": "assets"
      },
    • "relationships": {
      • "workflow_version": {
        },
      • "workflow": {
        },
      • "parent_workflow_step": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "override_properties": {
        }
      },
    • "links": {
      • "parent": "/api/projects/opc",
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-8fc5-749c-b331-d535ad9b2d75",
      • "log_lines": "/api/workflow_runs/01a08b14-8fc5-749c-b331-d535ad9b2d75/log_lines"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "01a08b14-8cd3-79ac-b18e-da80809f24ea",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-8fcf-7273-8a7e-37a2158db2a2",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-8fd5-7070-9bae-b3d96375f96c",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Show workflow run (workflow specific) 
Shows a workflow run.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-9cbf-7af9-8548-b12f5ffa5db1",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": {
        },
      • "created_by": "julian.kreiger-2939",
      • "cancelled_by": null,
      • "skip_steps": [ ],
      • "status_code": "success",
      • "created_at": "2026-09-10T11:29:39.007020Z",
      • "started_at": "2026-09-10T11:21:11.350566Z",
      • "finished_at": "2026-09-10T11:24:51.558904Z",
      • "updated_at": "2026-09-10T11:29:39.015649Z",
      • "project_name": "OpsChain",
      • "workflow_code": "assets"
      },
    • "relationships": {
      • "workflow_version": {
        },
      • "workflow": {
        },
      • "parent_workflow_step": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "override_properties": {
        }
      },
    • "links": {
      • "parent": "/api/projects/opc",
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-9cbf-7af9-8548-b12f5ffa5db1",
      • "log_lines": "/api/workflow_runs/01a08b14-9cbf-7af9-8548-b12f5ffa5db1/log_lines"
      },
    • "meta": {
      • "wait_queue": [ ],
      • "blocking_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "01a08b14-9c7f-7dff-bd5c-04a85472c0a0",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-9cc5-73c6-9ff7-bdf801725284",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-9ccd-7374-a4e7-2ff15c18c0bf",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-9e98-7ba4-a629-c6c44ab83a03",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-9ea2-79d7-a482-1f106333b25d",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-9f04-7e04-a291-177b5dc0942b",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-9db3-7b06-a6d8-b2ae6ea2048f",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Cancel workflow run (workflow specific) 
Cancels a workflow run.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


Responses
 Response samples 
Content type
text/plain
Workflow steps
Endpoints to interact with the steps in a workflow run


List all workflow steps 
Lists all workflow steps.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[status_code_eq]=running
API filtering guide. Named filters: filter[active_over], filter[finished], filter[waiting_for_user], filter[waiting_to_run].


limit
integer  [ 1 .. 1000 ] 
 Default:  1000
 
 Example:  limit=50
Limit the number of workflow steps returned


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-b4d9-76df-866e-e6b68dfbc2a5",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b4e0-7c4e-9bd1-69e68a7793a3",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b6bd-7827-bd77-7583616d111e",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b6c7-7acd-a288-73cc0d481315",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b737-7186-99e6-1fd723236bdc",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b815-7773-991e-3e29e4ef181e",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b81f-7c23-a9ea-e869ec898957",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b82c-7735-aaeb-97e3ad5a8f6b",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b5d1-7913-a3c9-ee74a5da88f0",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-b732-7cf3-96c3-15f8de1c0ffd",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "execute": true
      },
    • "partial_response": false
    }
}
Show a workflow step 
Shows a workflow step.


path Parameters
step_id
required
string
 
 Example:  01a08b12-af19-72d0-95d2-a3a969c72eb0
workflow step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-b9ee-76fc-a175-f2cb9641c802",
    • "type": "workflow_noop_step",
    • "attributes": {
      • "lock_version": 1,
      • "created_by": "lettie-3130",
      • "name": "esse",
      • "step_sequence": 1,
      • "status_code": "success",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:29:46.477502Z",
      • "started_at": "2026-09-10T11:19:50.746652Z",
      • "finished_at": "2026-09-10T11:27:58.409605Z",
      • "updated_at": "2026-09-10T11:29:46.481361Z",
      • "child_execution_strategy": "sequential"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-b9e8-7c90-8c46-2bc99f293a2c/steps/01a08b14-b9ee-76fc-a175-f2cb9641c802",
      • "log_lines": "/api/workflow_steps/01a08b14-b9ee-76fc-a175-f2cb9641c802/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b14-b9e8-7c90-8c46-2bc99f293a2c",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b14-b9e8-7c90-8c46-2bc99f293a2c"
      }
    }
}
Continue workflow step 
Continues a "waiting" workflow step. To approve/reject a workflow step that needs approval see the
approve workflow step API endpoint.


path Parameters
step_id
required
string
 
 Example:  01a08b12-af4e-7eb4-b3cf-6aeb5a12993f
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Done sanity checks. Ok to continue."
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-c6cf-7837-8729-ce30c8f56c94",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [
        ],
      • "requires_approval_from": null,
      • "lock_version": 3,
      • "created_by": "nathanial.dibbert-3196",
      • "name": "Wait",
      • "step_sequence": 8,
      • "status_code": "continued",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:21:59.017164Z",
      • "started_at": "2026-09-10T11:22:59.017164Z",
      • "finished_at": "2026-09-10T11:29:49.795063Z",
      • "updated_at": "2026-09-10T11:29:49.811357Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-c384-73e4-932d-c963899a95d3/steps/01a08b14-c6cf-7837-8729-ce30c8f56c94",
      • "log_lines": "/api/workflow_steps/01a08b14-c6cf-7837-8729-ce30c8f56c94/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b14-c384-73e4-932d-c963899a95d3/steps/01a08b14-c389-7037-a85e-535b8dc282d6",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b14-c384-73e4-932d-c963899a95d3"
      }
    }
}
Approve workflow step 
Approve a workflow step that requires approval. To continue a workflow step that does need approval see the
continue workflow step API endpoint


path Parameters
step_id
required
string
 
 Example:  01a08b12-af5f-77b5-9fbd-d78bb5bd2b2c
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Ok to proceed."
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-d550-7ee7-a69a-a0dde305f1fc",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [
        ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "ngan_gibson-3295",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "approved",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:19:00.331247Z",
      • "started_at": "2026-09-10T11:20:00.331247Z",
      • "finished_at": "2026-09-10T11:29:53.508117Z",
      • "updated_at": "2026-09-10T11:29:53.524040Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-d1db-7c97-9c4d-a7676d4def2c/steps/01a08b14-d550-7ee7-a69a-a0dde305f1fc",
      • "log_lines": "/api/workflow_steps/01a08b14-d550-7ee7-a69a-a0dde305f1fc/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b14-d1db-7c97-9c4d-a7676d4def2c/steps/01a08b14-d1e0-7657-9cf9-d8e9ef5d0cc9",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b14-d1db-7c97-9c4d-a7676d4def2c"
      }
    }
}
Reject workflow step 
Reject a workflow step that requires approval.


path Parameters
step_id
required
string
 
 Example:  01a08b12-af2f-7235-a725-230323a71824
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Ok to proceed."
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-e822-75f8-b7ee-28f23fd9701f",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [
        ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "walker_dibbert-3427",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "rejected",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:20:32.913838Z",
      • "started_at": "2026-09-10T11:21:32.913838Z",
      • "finished_at": "2026-09-10T11:29:58.329755Z",
      • "updated_at": "2026-09-10T11:29:58.336292Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b14-e4e5-752b-95d1-9d082e6a3066/steps/01a08b14-e822-75f8-b7ee-28f23fd9701f",
      • "log_lines": "/api/workflow_steps/01a08b14-e822-75f8-b7ee-28f23fd9701f/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b14-e4e5-752b-95d1-9d082e6a3066/steps/01a08b14-e4ea-7c79-9c86-c438ef4c4887",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b14-e4e5-752b-95d1-9d082e6a3066"
      }
    }
}
List workflow steps (run specific) 
Lists all steps in a workflow run.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


query Parameters
limit
integer  [ 1 .. 1000 ] 
 Default:  1000
 
 Example:  limit=50
Limit the number of workflow steps returned


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-fa8f-7335-82e3-edc180d8ddce",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fa97-7d68-8bc5-a702a5900d23",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fcc5-7b3d-9152-3023a506f44e",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fcda-7b74-b7a9-55095d116269",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fd66-7beb-b707-ec3fa714c264",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fe8d-7ffe-b32b-5e428317c416",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fe9a-70d2-a764-870681ea2620",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fea4-7a75-b161-90a198eaddf5",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b14-fbb3-7f7b-bd4f-d561493072c8",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "execute": true
      },
    • "partial_response": false
    }
}
Show workflow step (run specific) 
Shows a step of a workflow run.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


step_id
required
string
 
 Example:  01a08b12-af19-72d0-95d2-a3a969c72eb0
workflow step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-05fb-7029-a754-95d5eab0068f",
    • "type": "workflow_noop_step",
    • "attributes": {
      • "lock_version": 1,
      • "created_by": "zita_ferry-3626",
      • "name": "suscipit",
      • "step_sequence": 1,
      • "status_code": "success",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:30:05.945911Z",
      • "started_at": "2026-09-10T11:20:26.914450Z",
      • "finished_at": "2026-09-10T11:25:07.663860Z",
      • "updated_at": "2026-09-10T11:30:05.950485Z",
      • "child_execution_strategy": "sequential"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b15-05f4-7885-8047-03c2d844dc58/steps/01a08b15-05fb-7029-a754-95d5eab0068f",
      • "log_lines": "/api/workflow_steps/01a08b15-05fb-7029-a754-95d5eab0068f/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b15-05f4-7885-8047-03c2d844dc58",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b15-05f4-7885-8047-03c2d844dc58"
      }
    }
}
Continue workflow step (run specific) 
Continues a "waiting" workflow step. To approve/reject a workflow step that needs approval see the
approve workflow step API endpoint.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


step_id
required
string
 
 Example:  01a08b12-af4e-7eb4-b3cf-6aeb5a12993f
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Done sanity checks. Ok to continue."
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-1adc-7bfe-8204-876fbe494859",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [
        ],
      • "requires_approval_from": null,
      • "lock_version": 3,
      • "created_by": "kurtis-3726",
      • "name": "Wait",
      • "step_sequence": 8,
      • "status_code": "continued",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:21:40.946987Z",
      • "started_at": "2026-09-10T11:22:40.946987Z",
      • "finished_at": "2026-09-10T11:30:11.317710Z",
      • "updated_at": "2026-09-10T11:30:11.331452Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b15-16c7-7094-b008-822ae33a0b5f/steps/01a08b15-1adc-7bfe-8204-876fbe494859",
      • "log_lines": "/api/workflow_steps/01a08b15-1adc-7bfe-8204-876fbe494859/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b15-16c7-7094-b008-822ae33a0b5f/steps/01a08b15-16cd-7819-a8eb-2b78b2d2b3af",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b15-16c7-7094-b008-822ae33a0b5f"
      }
    }
}
Approve workflow step (run specific) 
Approve a workflow step that requires approval. To continue a workflow step that does need approval see the
continue workflow step API endpoint


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


step_id
required
string
 
 Example:  01a08b12-af5f-77b5-9fbd-d78bb5bd2b2c
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Ok to proceed."
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-2b64-7496-b4a3-864221fe628c",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [
        ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "christian.bruen-3825",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "approved",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:21:00.187536Z",
      • "started_at": "2026-09-10T11:22:00.187536Z",
      • "finished_at": "2026-09-10T11:30:15.561548Z",
      • "updated_at": "2026-09-10T11:30:15.579910Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b15-27e3-72d8-86a0-3785a05294dc/steps/01a08b15-2b64-7496-b4a3-864221fe628c",
      • "log_lines": "/api/workflow_steps/01a08b15-2b64-7496-b4a3-864221fe628c/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b15-27e3-72d8-86a0-3785a05294dc/steps/01a08b15-27e9-774b-86fb-efdee3d8e002",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b15-27e3-72d8-86a0-3785a05294dc"
      }
    }
}
Reject workflow step (run specific) 
Reject a workflow step that requires approval.


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


run_id
required
string
 
 Example:  01a08b12-a9df-72bf-80df-65b22578da8a
workflow run id


step_id
required
string
 
 Example:  01a08b12-af2f-7235-a725-230323a71824
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Ok to proceed."
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b15-43d4-707a-ab2b-6ff92dc289c9",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [
        ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "lucius-3957",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "rejected",
      • "skip_requested": false,
      • "created_at": "2026-09-10T11:23:41.415206Z",
      • "started_at": "2026-09-10T11:24:41.415206Z",
      • "finished_at": "2026-09-10T11:30:21.812009Z",
      • "updated_at": "2026-09-10T11:30:21.818122Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a08b15-4090-7858-8226-c4f94344e619/steps/01a08b15-43d4-707a-ab2b-6ff92dc289c9",
      • "log_lines": "/api/workflow_steps/01a08b15-43d4-707a-ab2b-6ff92dc289c9/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a08b15-4090-7858-8226-c4f94344e619/steps/01a08b15-4096-7480-8835-99851ca6a32a",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a08b15-4090-7858-8226-c4f94344e619"
      }
    }
}
Events
Endpoints to interact with events.


List events 
Lists all events.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[query_param_code_eq]=opc
API filtering guide. Named filters: filter[change_action_eq], filter[change_created_by_eq], filter[change_or_step_action_eq], filter[change_or_step_created_by_eq], filter[for_change], filter[for_workflow_run], filter[for_workflow_run_nested], filter[run_or_step_workflow_eq], filter[run_workflow_eq], filter[step_action_eq], filter[step_created_by_eq], filter[step_workflow_eq]. filter[for_change]=<change id> returns every event for a change, including events on its steps regardless of tree depth, e.g. > filter[for_change]=79f7f4e2-3b1d-4b2a-9e2c-1d9c2f6a4b3e. filter[for_workflow_run]=<workflow run id> returns every event for a workflow run and its own workflow steps, e.g. > filter[for_workflow_run]=2f8b6a1c-5e4d-4a3b-8c1f-6d9e2a7b5c4d. filter[for_workflow_run_nested]=<workflow run id> does the same as for_workflow_run but additionally includes events from any changes the run spawned (e.g. via a change step) and their steps, e.g. > filter[for_workflow_run_nested]=2f8b6a1c-5e4d-4a3b-8c1f-6d9e2a7b5c4d.


limit
integer  [ 1 .. 1000 ] 
 Default:  10
 
 Example:  limit=50
Limit the number of events returned


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-6627-755e-8c58-492b2e97fd04",
      • "type": "event",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Create event 
Creates an event.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "type": "custom event",
      • "any_key": "with a value",
      • "another_key": "with a different value",
      • "nested": {
        }
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-674e-7b20-aa17-6ea77fce7f9f",
    • "type": "event",
    • "attributes": {
      • "some": "event data",
      • "username": "logged_in_user",
      • "system": false,
      • "type": "my event",
      • "event_node_path": null,
      • "created_at": "2026-09-10T11:28:19.789804Z"
      },
    • "relationships": {
      • "source": {
        }
      },
    • "links": {
      • "self": "/api/events/01a08b13-674e-7b20-aa17-6ea77fce7f9f"
      }
    }
}
Show event 
Shows an event.


path Parameters
event_id
required
string
 
 Example:  01a08b12-a474-7131-92d0-1f0d59f6f1f4
event id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-699d-78a8-a2bf-1ce10756f81d",
    • "type": "event",
    • "attributes": {
      • "nested": {
        },
      • "any_key": "with a value",
      • "another_key": "with a different value",
      • "username": "jared",
      • "system": false,
      • "type": "my custom event",
      • "event_node_path": "/projects/opc",
      • "created_at": "2026-09-10T11:28:20.380823Z"
      },
    • "relationships": {
      • "source": {
        }
      },
    • "links": {
      • "self": "/api/events/01a08b13-699d-78a8-a2bf-1ce10756f81d"
      }
    }
}
Event filters
List event filters 
Lists all event filters.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[code_eq]=changes_success
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-5cd5-7791-a403-3df293cef298",
      • "type": "event_filter",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create event filter 
Create an event filter.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "change_success",
      • "description": "Filter for successful changes in dev",
      • "rules": {
        }
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-5dc1-75ff-8103-d4aee33ccfac",
    • "type": "event_filter",
    • "attributes": {
      • "rules": {
        },
      • "code": "qnlcz",
      • "description": "Delectus quia ipsum dignissimos.",
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:28:17.344663Z",
      • "updated_at": "2026-09-10T11:28:17.344663Z"
      },
    • "links": {
      • "self": "/api/event_filters/qnlcz",
      • "subscribers": "/api/event_filters/qnlcz/event_subscribers"
      }
    }
}
Show event filter 
Show an event filter.


path Parameters
event_filter_code
required
string
 
 Example:  change_success
event filter code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-6023-7c52-a6ab-2e7f8f81139b",
    • "type": "event_filter",
    • "attributes": {
      • "rules": {
        },
      • "code": "change_success",
      • "description": "Filter for successful changes in dev",
      • "created_by": "opschain",
      • "created_at": "2026-09-10T11:28:17.955151Z",
      • "updated_at": "2026-09-10T11:28:17.955151Z"
      },
    • "links": {
      • "self": "/api/event_filters/change_success",
      • "subscribers": "/api/event_filters/change_success/event_subscribers"
      }
    }
}
Update event filter 
Update an event filter.


path Parameters
event_filter_code
required
string
 
 Example:  change_success
event filter code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "rules": {
        },
      • "description": "hello world errors filter"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-61c0-7369-b1c5-45d3f1ce72e6",
    • "type": "event_filter",
    • "attributes": {
      • "rules": {
        },
      • "code": "change_success",
      • "description": "hello world errors filter",
      • "created_by": "opschain",
      • "created_at": "2026-09-10T11:28:18.367657Z",
      • "updated_at": "2026-09-10T11:28:18.381584Z"
      },
    • "links": {
      • "self": "/api/event_filters/change_success",
      • "subscribers": "/api/event_filters/change_success/event_subscribers"
      }
    }
}
Delete event filter 
Delete an event filter.


path Parameters
event_filter_code
required
string
 
 Example:  change_success
event filter code


Responses
 Response samples 
Content type
text/plain
Event subscribers
List event subscribers 
Lists all event subscribers.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[enabled_eq]=true
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-6b66-798a-a53d-b683fa6013db",
      • "type": "event_subscriber",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create event subscriber 
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.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "event_filter_code": "change_success",
      • "channel_parent_path": "/system_configuration",
      • "channel_code": "system_email",
      • "channel_kwargs": {
        },
      • "enabled": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-6d28-78b2-8a1a-2ef4025f96a6",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": {
        },
      • "enabled": true,
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:28:21.287767Z",
      • "updated_at": "2026-09-10T11:28:21.287767Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a08b13-6d28-78b2-8a1a-2ef4025f96a6"
      }
    }
}
List event node subscribers 
List event subscribers for a specific project, environment or asset.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[enabled_eq]=true
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-707c-7232-ad33-bb9ec88b48e1",
      • "type": "event_subscriber",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create event subscriber 
Create an event subscriber.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "event_filter_code": "change_success",
      • "channel_parent_path": "/system_configuration",
      • "channel_code": "system_email",
      • "channel_kwargs": {
        },
      • "enabled": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-7257-743c-9577-cd3eea8e9000",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": {
        },
      • "enabled": true,
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:28:22.614431Z",
      • "updated_at": "2026-09-10T11:28:22.614431Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a08b13-7257-743c-9577-cd3eea8e9000"
      }
    }
}
Show event subscriber 
Show an event subscriber.


path Parameters
event_subscriber_id
required
string
 
 Example:  01a08b12-a4bc-7c44-ad25-46de4452c197
event subscriber id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-771b-7798-8dc9-440618c73d88",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": { },
      • "enabled": true,
      • "created_by": "palmer.parker-1273",
      • "created_at": "2026-09-10T11:28:23.834347Z",
      • "updated_at": "2026-09-10T11:28:23.834347Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a08b13-771b-7798-8dc9-440618c73d88"
      }
    }
}
Update event subscriber 
Update an event subscriber.


path Parameters
event_subscriber_id
required
string
 
 Example:  01a08b12-a4bc-7c44-ad25-46de4452c197
event subscriber id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "event_filter_code": "change_success",
      • "channel_parent_path": "/projects/opc",
      • "channel_code": "project_direct",
      • "channel_kwargs": {
        },
      • "enabled": false
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-7a1d-763b-abf7-34aaa44885e4",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": {
        },
      • "enabled": false,
      • "created_by": "molly.mertz-1285",
      • "created_at": "2026-09-10T11:28:24.604676Z",
      • "updated_at": "2026-09-10T11:28:24.640397Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a08b13-7a1d-763b-abf7-34aaa44885e4"
      }
    }
}
Delete event subscriber 
Delete an event subscriber.


path Parameters
event_subscriber_id
required
string
 
 Example:  01a08b12-a4bc-7c44-ad25-46de4452c197
event subscriber id


Responses
 Response samples 
Content type
text/plain
Global notification channels
List notification channels 
Lists all global notification channels.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[code_eq]=slack
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-c7a8-7fb5-84cc-e1db9551f228",
      • "type": "notification_channel",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create notification channel 
Create a global notification channel, available to every node in the instance.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "ops_team_slack",
      • "notification_job_code": "direct_job",
      • "format": "slack",
      • "default_channel": false,
      • "enabled": true,
      • "kwargs": {},
      • "description": "Slack channel for the operations team"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-c841-77bf-87c3-13fb45ae65f4",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "slack",
      • "code": "ops_team_slack",
      • "description": "Slack channel for the operations team",
      • "default_channel": false,
      • "internal": false,
      • "enabled": true,
      • "kwargs": {},
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:28:44.608688Z",
      • "updated_at": "2026-09-10T11:28:44.608688Z",
      • "job_code": "direct_job"
      },
    • "relationships": {
      • "notification_job": {
        }
      },
    • "links": {
      • "self": "/api/system_configuration/notification_channels/ops_team_slack",
      • "parent": "/api/system_configuration"
      }
    }
}
Test notification channel 
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. Only email and direct message channels can be tested, and a disabled channel is rejected.


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "to": "ops-team@example.com"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-c9b5-7f9c-84ce-189bea5f898f",
    • "type": "notification_channel_test",
    • "attributes": {
      • "result": [
        ]
      }
    }
}
Show notification channel 
Show a global notification channel.


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-cad0-781c-96db-05aa45f97079",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "html",
      • "code": "system_email",
      • "description": "System channel for email notifications",
      • "default_channel": true,
      • "internal": false,
      • "enabled": true,
      • "kwargs": {
        },
      • "created_by": "mora-1707",
      • "created_at": "2026-09-10T11:28:45.264049Z",
      • "updated_at": "2026-09-10T11:28:45.264049Z",
      • "job_code": "email_job"
      },
    • "relationships": {
      • "notification_job": {
        }
      },
    • "links": {
      • "self": "/api/system_configuration/notification_channels/system_email",
      • "parent": "/api/system_configuration"
      }
    }
}
Update notification channel 
Update a global notification channel.


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "notification_job_code": "direct_job",
      • "format": "slack",
      • "default_channel": false,
      • "enabled": false,
      • "kwargs": {},
      • "description": "New channel description"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-cbe0-7c02-a748-2891de1266e8",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "slack",
      • "code": "system_email",
      • "description": "New channel description",
      • "default_channel": false,
      • "internal": false,
      • "enabled": false,
      • "kwargs": {},
      • "created_by": "lakita-1709",
      • "created_at": "2026-09-10T11:28:45.536232Z",
      • "updated_at": "2026-09-10T11:28:45.548569Z",
      • "job_code": "direct_job"
      },
    • "relationships": {
      • "notification_job": {
        }
      },
    • "links": {
      • "self": "/api/system_configuration/notification_channels/system_email",
      • "parent": "/api/system_configuration"
      }
    }
}
Delete notification channel 
Delete a global notification channel.


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Responses
 Response samples 
Content type
text/plain
Notification channels
List notification channels 
List notification channels for a specific project, environment or asset.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[code_eq]=slack
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-cfee-727d-a514-955514b02667",
      • "type": "notification_channel",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Show a notification channel 
Show a notification channel for a specific project, environment or asset..


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-d0dd-7053-8e79-f3b0b3a8c918",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "slack",
      • "code": "project_direct",
      • "description": "Project specific channel for slack notifications",
      • "default_channel": true,
      • "internal": false,
      • "enabled": true,
      • "kwargs": {
        },
      • "created_by": "lora-1721",
      • "created_at": "2026-09-10T11:28:46.812087Z",
      • "updated_at": "2026-09-10T11:28:46.812087Z",
      • "job_code": "direct_job"
      },
    • "relationships": {
      • "notification_job": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/notification_channels/project_direct",
      • "parent": "/api/projects/opc"
      }
    }
}
Update notification channel 
Update a notification channel for a specific project, environment or asset.


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "notification_job_code": "direct_job",
      • "format": "slack",
      • "default_channel": false,
      • "enabled": false,
      • "kwargs": {},
      • "description": "New channel description"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-d282-7f01-acd7-b2fc0afcf852",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "slack",
      • "code": "project_direct",
      • "description": "New channel description",
      • "default_channel": false,
      • "internal": false,
      • "enabled": false,
      • "kwargs": {},
      • "created_by": "desmond-1729",
      • "created_at": "2026-09-10T11:28:47.234458Z",
      • "updated_at": "2026-09-10T11:28:47.249747Z",
      • "job_code": "direct_job"
      },
    • "relationships": {
      • "notification_job": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/notification_channels/project_direct",
      • "parent": "/api/projects/opc"
      }
    }
}
Delete notification channel 
Delete a notification channel for a specific project, environment or asset..


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


Responses
 Response samples 
Content type
text/plain
Notification jobs
List notification jobs 
Lists all notification jobs.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[code_eq]=notify_targets
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-d4db-7ede-8abf-8ba9e969faf4",
      • "type": "notification_job",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Show notification job 
Show a notification job.


path Parameters
notification_job_code
required
string
 
 Example:  email_job
notification job code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-d52e-7648-bf28-36dca0b3616d",
    • "type": "notification_job",
    • "attributes": {
      • "job_class": "Notifications::SendEmailJob",
      • "target_type": "smtp",
      • "valid_formats": [
        ],
      • "code": "email_job",
      • "description": "Send an email to the target user(s)",
      • "created_at": "2026-09-10T11:28:47.917729Z",
      • "updated_at": "2026-09-10T11:28:47.917729Z",
      • "all_kwargs": [
        ]
      },
    • "relationships": {
      • "notification_channels": {
        }
      },
    • "links": {
      • "self": "/api/notification_jobs/email_job"
      }
    }
}
Email
Endpoint to send an ad-hoc email from a running change or agent.


Send an email 
Sends an email via the global default email channel's SMTP configuration.


Notes:


    

  • This endpoint can only be used with the API key OpsChain issues to a running change or agent - the key
supplied to the runner in its step context. Any other token results in a 404.
    • 

  • At least one of to, cc or bcc must be supplied. Each accepts either a single address or an array of addresses.
    • 

  • Attachment content must be base64 encoded. The combined decoded size of all attachments must not exceed 5MB.
    • 

  • A global default email channel must be configured for this endpoint to be able to send email.
    • 

  • The from address is not restricted - a running change or agent may send email as any address its SMTP server accepts.
The address the email was sent from is recorded in the api:email:create event raised for each request.
    • 



Authorizations:
bearerAuth
header Parameters
Authorization
required
string
 
the API key OpsChain supplied to the running change or agent


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "subject": "OpsChain change 4d9d2f2c completed",
      • "body": "The deploy action completed successfully.",
      • "to": [
        ],
      • "cc": [
        ],
      • "bcc": [
        ],
      • "from": "changes@limepoint.com",
      • "content_type": "text/plain",
      • "attachments": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "6aa2944f2bde3_110e1110478e7@1b82327b0eb1.mail",
    • "type": "email",
    • "attributes": {
      • "from": "no-reply@limepoint.com",
      • "to": [
        ],
      • "cc": [ ],
      • "bcc": [ ],
      • "subject": "OpsChain change 4d9d2f2c completed",
      • "attachment_filenames": [ ],
      • "sent_at": "2026-09-10T11:28:15Z"
      }
    }
}
Jobs
Endpoint to fetch information about the jobs processed by the OpsChain.


Get information about the jobs that are being processed by the OpsChain 
Returns information about the jobs that are being processed by the OpsChain.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[status_eq]=finished
limit
integer  [ 1 .. 1000 ] 
 Default:  100
 
 Example:  limit=50
Limit the number of jobs returned


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "217880",
      • "type": "job",
      • "attributes": {
        }
      },
    • {
      • "id": "841171",
      • "type": "job",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false,
    • "has_any": true,
    • "total_matching_filter": 2,
    • "total_matching_filter_exact": true
    }
}
Settings
Endpoints to interact with settings.


Show settings 
Shows the current settings.


path Parameters
settings_id
required
string
 
 Example:  01a08b12-8fe6-79b0-bbcf-5b7de3ed5d7f
settings id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-0613-7019-8fbe-b8ac87cbabe9",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-09-10T11:29:00.434567Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/01a08b14-0613-7019-8fbe-b8ac87cbabe9",
      • "current_version": "/api/settings/01a08b14-0613-7019-8fbe-b8ac87cbabe9/versions/1",
      • "versions": "/api/settings/01a08b14-0613-7019-8fbe-b8ac87cbabe9/versions"
      }
    }
}
Update settings 
Updates a settings JSON if the included version matches the current settings version.


path Parameters
id_to_update
required
string
 
 Example:  01a08b12-8fe6-79b0-bbcf-5b7de3ed5d7f
settings id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "data": {
        },
      • "version": 1
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-071e-7cf5-9570-71229e1f17d3",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-09-10T11:29:00.702299Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/01a08b14-071e-7cf5-9570-71229e1f17d3",
      • "current_version": "/api/settings/01a08b14-071e-7cf5-9570-71229e1f17d3/versions/1",
      • "versions": "/api/settings/01a08b14-071e-7cf5-9570-71229e1f17d3/versions"
      }
    }
}
Update settings (unsafe) 
Updates a settings JSON, without any version checking (always updates).


path Parameters
id_to_set
required
string
 
 Example:  01a08b12-8fe6-79b0-bbcf-5b7de3ed5d7f
settings id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "data": {
        }
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-093d-73f3-99d6-a99caed119ee",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-09-10T11:29:01.244594Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/01a08b14-093d-73f3-99d6-a99caed119ee",
      • "current_version": "/api/settings/01a08b14-093d-73f3-99d6-a99caed119ee/versions/1",
      • "versions": "/api/settings/01a08b14-093d-73f3-99d6-a99caed119ee/versions"
      }
    }
}
Settings versions
Endpoints to interact with the version history for
settings.


List settings versions 
Lists all versions of an OpsChain settings.


path Parameters
settings_id
required
string
 
 Example:  01a08b12-8fe6-79b0-bbcf-5b7de3ed5d7f
settings id


query Parameters
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 meta.partial_response is true.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-0ada-7088-ab5c-e3fbeb1510fc",
      • "type": "settings_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Show settings version 
Shows the settings values for this settings version.


path Parameters
settings_id
required
string
 
 Example:  01a08b12-8fe6-79b0-bbcf-5b7de3ed5d7f
settings id


version_number
required
integer
 
 Example:  1
version number


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-0bdf-792c-b696-91f82b16b4a7",
    • "type": "settings_version",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-09-10T11:29:01.919159Z"
      },
    • "relationships": {
      • "settings": {
        }
      },
    • "links": {
      • "versions": "/api/settings/01a08b14-0bdd-7b5c-bdc6-5aff49054e36/versions",
      • "owner": "/api/projects/opc",
      • "self": "/api/settings/01a08b14-0bdd-7b5c-bdc6-5aff49054e36/versions/1"
      }
    }
}
Authorisation rules
Endpoints to interact with authorisation rules.


List rules 
Lists all authorisation rules.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name]=rule_name
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b12-f246-7d9b-a18c-ab53e13bc15e",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-f33e-74c9-98be-862506c714e6",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-f346-7ef2-b24d-a8228bb5ba27",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-f387-7224-a2b6-8eebe8160849",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Create rule 
Create an authorisation rule.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "path": "^/projects/opc/assets/prj_soa",
      • "readable": false,
      • "updatable": false,
      • "deletable": false,
      • "executable": false,
      • "name": "Deny access to Project asset"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-f562-703d-ac1b-379d03bcefb6",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "override",
      • "path": "^/projects/budaz/environments/lklet",
      • "readable": false,
      • "updatable": false,
      • "deletable": false,
      • "executable": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:27:50.625249Z",
      • "updated_at": "2026-09-10T11:27:50.625249Z"
      },
    • "relationships": {
      • "authorisation_policies": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/01a08b12-f562-703d-ac1b-379d03bcefb6"
      }
    }
}
Show rule 
Shows an authorisation rule.


path Parameters
authorisation_rule_id
required
string
 
 Example:  01a08b12-9692-7cec-bacb-85c38d28c8a0
authorisation rule id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-f9d8-75fc-b0fd-4456da6435d9",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "Deny access to Project asset",
      • "path": "^/projects/opc/assets/prj_soa",
      • "readable": false,
      • "updatable": false,
      • "deletable": false,
      • "executable": false,
      • "created_by": "opschain",
      • "created_at": "2026-09-10T11:27:51.767802Z",
      • "updated_at": "2026-09-10T11:27:51.767802Z"
      },
    • "relationships": {
      • "authorisation_policies": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/01a08b12-f9d8-75fc-b0fd-4456da6435d9"
      }
    }
}
Update authorisation rule 
Update an authorisation rule.


path Parameters
authorisation_rule_id
required
string
 
 Example:  01a08b12-9692-7cec-bacb-85c38d28c8a0
authorisation rule id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "path": "/projects/demo/environments/dev",
      • "readable": false,
      • "updatable": false,
      • "deletable": false,
      • "executable": false,
      • "name": "Deny all on dev environment"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-fcf9-7033-855d-025fc7e187c6",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "Deny all on dev environment",
      • "path": "^/projects/demo/environments/dev",
      • "readable": false,
      • "updatable": false,
      • "deletable": false,
      • "executable": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:27:52.568513Z",
      • "updated_at": "2026-09-10T11:27:52.656106Z"
      },
    • "relationships": {
      • "authorisation_policies": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/01a08b12-fcf9-7033-855d-025fc7e187c6"
      }
    }
}
Delete rule 
Delete an authorisation rule.


path Parameters
authorisation_rule_id
required
string
 
 Example:  01a08b12-9692-7cec-bacb-85c38d28c8a0
authorisation rule id


Responses
 Response samples 
Content type
text/plain
Authorisation policies
Endpoints to interact with authorisation policies.


List policies 
Lists all authorisation policies.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=secure
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b12-e190-7c2d-b634-d4e11d6470f8",
      • "type": "authorisation_policy",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-e2ac-7cc3-8f13-747562adcb09",
      • "type": "authorisation_policy",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Create policy 
Create an authorisation policy with a list of authorisation rules.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "name": "herman",
      • "description": "Saepe et pariatur eum.",
      • "authorisation_rules": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-e489-7e0f-a673-62d3d6594e3c",
    • "type": "authorisation_policy",
    • "attributes": {
      • "name": "royce",
      • "description": "Assumenda minima temporibus nostrum.",
      • "system": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-09-10T11:27:46.313330Z",
      • "updated_at": "2026-09-10T11:27:46.313330Z"
      },
    • "relationships": {
      • "policy_rules": {
        },
      • "policy_assignments": {
        },
      • "authorisation_rules": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a08b12-e489-7e0f-a673-62d3d6594e3c",
      • "policy_rules": "/api/authorisation_policies/01a08b12-e489-7e0f-a673-62d3d6594e3c/rules",
      • "policy_assignments": "/api/authorisation_policies/01a08b12-e489-7e0f-a673-62d3d6594e3c/assignments"
      }
    }
}
Show policy 
Shows an authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-e7ca-791a-ab19-4414140f6244",
    • "type": "authorisation_policy",
    • "attributes": {
      • "name": "New users policy",
      • "description": "Access for all incoming users",
      • "system": false,
      • "created_by": "tracy-452",
      • "created_at": "2026-09-10T11:27:47.146035Z",
      • "updated_at": "2026-09-10T11:27:47.146035Z"
      },
    • "relationships": {
      • "policy_rules": {
        },
      • "policy_assignments": {
        },
      • "authorisation_rules": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a08b12-e7ca-791a-ab19-4414140f6244",
      • "policy_rules": "/api/authorisation_policies/01a08b12-e7ca-791a-ab19-4414140f6244/rules",
      • "policy_assignments": "/api/authorisation_policies/01a08b12-e7ca-791a-ab19-4414140f6244/assignments"
      }
    }
}
Update authorisation policy and its rules 
Update an authorisation policy and its authorisation rules. If no authorisation rules are provided, all associated rules will be removed from the policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "name": "cleo.koelpin",
      • "description": "Eos sint quia doloribus.",
      • "authorisation_rules": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-eb44-7490-8086-785aa892c0db",
    • "type": "authorisation_policy",
    • "attributes": {
      • "name": "Updated policy name",
      • "description": "Access for all incoming users",
      • "system": false,
      • "created_by": "candace-480",
      • "created_at": "2026-09-10T11:27:48.035814Z",
      • "updated_at": "2026-09-10T11:27:48.092926Z"
      },
    • "relationships": {
      • "policy_rules": {
        },
      • "policy_assignments": {
        },
      • "authorisation_rules": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a08b12-eb44-7490-8086-785aa892c0db",
      • "policy_rules": "/api/authorisation_policies/01a08b12-eb44-7490-8086-785aa892c0db/rules",
      • "policy_assignments": "/api/authorisation_policies/01a08b12-eb44-7490-8086-785aa892c0db/assignments"
      }
    }
}
Delete policy 
Delete an authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


Responses
 Response samples 
Content type
text/plain
Authorisation policy assignments
Endpoints to interact with authorisation policy assignments.


List policy assignments 
Lists all policy assignments for a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[username_eq]=opschain
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-e1d6-7dd0-8891-66ecdcb7a8b1",
      • "type": "policy_assignment",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Assign a policy to users or groups 
Assign an authorisation policy to one or more users and/or groups.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "user_id": null,
      • "assignments": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-e366-757c-85e7-a0fa0f0f0301",
      • "type": "policy_assignment",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}
Show assignment 
Show a policy assignment for a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


policy_assignment_id
required
string
 
 Example:  01a08b12-96d8-777e-9560-221b5b2fcc36
policy assignment id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-e635-7ab9-87e1-4af54c9db1e6",
    • "type": "policy_assignment",
    • "attributes": {
      • "username": "opschain",
      • "auth_provider": "local",
      • "groupname": "ldap-group",
      • "created_by": "calandra-1861",
      • "created_at": "2026-09-10T11:28:52.277285Z",
      • "updated_at": "2026-09-10T11:28:52.277285Z"
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a08b13-e629-7e86-a6d9-23ec454a5586/assignments/01a08b13-e635-7ab9-87e1-4af54c9db1e6"
      }
    }
}
Authorisation policy rules
Endpoints to interact with authorisation policy rules.


List policy rules 
Lists all policy rules for a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[username_eq]=opschain
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-e8c0-7390-8b89-677229718ce0",
      • "type": "policy_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b13-e8c4-75df-880d-e506ff1e84ef",
      • "type": "policy_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Create policy rule(s) 
Add one or more authorisation rules to a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "authorisation_rule_id": "01a08b12-9692-7cec-bacb-85c38d28c8a0"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-ea5c-7227-befb-c01e0bb104ef",
      • "type": "policy_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Delete a policy rule 
Remove an authorisation rule from a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  01a08b12-96b2-75e2-9657-cceaf590314e
authorisation policy id


policy_rule_id
required
string
 
 Example:  01a08b12-96c0-764a-9d02-be76c12fac37
policy rule id


Responses
 Response samples 
Content type
text/plain
Tokens
List tokens 
List all authorisation tokens.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[description_cont]=automation
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b12-dd6f-7118-8025-d7fb55aa5504",
      • "type": "authentication_token",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a08b12-dd38-7b67-9bd9-e8a5abfb5daa",
      • "type": "authentication_token",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}
Create access token 
Creates an access token for the current user.


Notes:


    

  • When the 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.
    • 

  • When the 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.
    • 



Authorizations:
cookieAuthbearerAuthbasicAuthNone
Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "username": "username",
      • "password": "password"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-de1e-7789-9a9b-0ee112167985",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "AccessToken",
      • "expires_at": "2026-09-10T15:27:44.000000Z",
      • "created_at": "2026-09-10T11:27:44.627212Z",
      • "updated_at": "2026-09-10T11:27:44.627212Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a08b12-de1e-7789-9a9b-0ee112167985"
      },
    • "meta": {
      • "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWEwOGIxMi1kZTFlLTc3ODktOWE5Yi0wZWUxMTIxNjc5ODUiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTc4OTA1NDA2NCwiaWF0IjoxNzg5MDM5NjY0fQ.3tQ2LqFFzMCCTexXezf36Y6Sc-76yrCmClYBtpEtn48"
      }
    }
}
Create API key token 
Creates an API key token for the current user.


Note: LDAP or local login credentials, or an access token are required to use this endpoint.


Authorizations:
bearerAuthbasicAuth
Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "username": "username",
      • "password": "password",
      • "description": "CI token for API access",
      • "expiry_date": "2027-03-10T11:27:26.330651Z"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-dea8-7996-9365-ce736b741543",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "ApiKeyToken",
      • "description": "Omnis fuga molestiae debitis.",
      • "expires_at": "2026-09-24T23:59:59.999999Z",
      • "created_at": "2026-09-10T11:27:44.807958Z",
      • "updated_at": "2026-09-10T11:27:44.807958Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a08b12-dea8-7996-9365-ce736b741543"
      },
    • "meta": {
      • "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWEwOGIxMi1kZWE4LTc5OTYtOTM2NS1jZTczNmI3NDE1NDMiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTc5MDI5NDM5OSwiaWF0IjoxNzg5MDM5NjY0fQ.3AegubmbrMaBTX9t28Bd9c7GQcNa5KJ2vUPNgd7JUqw"
      }
    }
}
Show token 
Show an authorisation token.


path Parameters
token_id
required
string
 
 Example:  01a08b12-9661-7e78-a266-320c7984d7af
authorisation token id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-df34-788a-bc6b-ba4763ea4ef0",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "ApiKeyToken",
      • "description": "CI token for API access",
      • "expires_at": "2027-03-10T23:59:59.999999Z",
      • "created_at": "2026-09-10T11:27:44.947559Z",
      • "updated_at": "2026-09-10T11:27:44.947559Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a08b12-df34-788a-bc6b-ba4763ea4ef0"
      }
    }
}
Delete token 
Delete an authorisation token if it exists.


path Parameters
token_id
required
string
 
 Example:  01a08b12-9661-7e78-a266-320c7984d7af
authorisation token id


Responses
 Response samples 
Content type
text/plain
Show access token 
Shows the active access token(s) in use by the current user.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b12-e0c0-73fa-b27d-b29d6bc235ce",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "AccessToken",
      • "expires_at": "2026-09-10T15:27:45.000000Z",
      • "created_at": "2026-09-10T11:27:45.297920Z",
      • "updated_at": "2026-09-10T11:27:45.297920Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a08b12-e0c0-73fa-b27d-b29d6bc235ce"
      }
    }
}
Delete access token 
Deletes the active access token(s) in use by the current user.


Responses
 Response samples 
Content type
text/plain
Users
Endpoints to interact with the users in the system.


List users 
Lists users in the system


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[username_eq]=opschain
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b14-4953-7879-904b-2bcd71f05105",
      • "type": "user",
      • "attributes": {
        },
      • "meta": { },
      • "links": {
        }
      }
    ]
}
Show user 
Show a user.


path Parameters
user_id
required
string
 
 Example:  01a08b12-8dad-7a78-9cd7-fbdd8c8fe084
user id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-49b2-7122-9557-208684d4a539",
    • "type": "user",
    • "attributes": {
      • "username": "logged_in_user",
      • "groupnames": [
        ],
      • "auth_provider": "ldap",
      • "email_address": "logged_in_user@limepoint.com",
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        },
      • "created_at": "2026-09-10T11:29:17.745491Z",
      • "updated_at": "2026-09-10T11:29:17.745491Z"
      },
    • "meta": {
      • "superuser": true
      },
    • "links": {
      • "self": "/api/users/01a08b14-49b2-7122-9557-208684d4a539"
      }
    }
}
Update user 
Update a user's notification preferences.


path Parameters
user_id
required
string
 
 Example:  01a08b12-8dad-7a78-9cd7-fbdd8c8fe084
user id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "email_address": "user@limepoint.com",
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        }
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-4a50-7a2b-b931-357b76a7e809",
    • "type": "user",
    • "attributes": {
      • "username": "logged_in_user",
      • "groupnames": [
        ],
      • "auth_provider": "ldap",
      • "email_address": "logged_in_user@limepoint.com",
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        },
      • "created_at": "2026-09-10T11:29:17.903971Z",
      • "updated_at": "2026-09-10T11:29:17.949281Z"
      },
    • "meta": { },
    • "links": {
      • "self": "/api/users/01a08b14-4a50-7a2b-b931-357b76a7e809"
      }
    }
}
Show current user 
Show the currently logged in user.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-4b44-735c-992a-0886e4efd64e",
    • "type": "user",
    • "attributes": {
      • "username": "logged_in_user",
      • "groupnames": [
        ],
      • "auth_provider": "ldap",
      • "email_address": "logged_in_user@limepoint.com",
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        },
      • "created_at": "2026-09-10T11:29:18.147620Z",
      • "updated_at": "2026-09-10T11:29:18.147620Z"
      },
    • "meta": {
      • "superuser": true
      },
    • "links": {
      • "self": "/api/users/01a08b14-4b44-735c-992a-0886e4efd64e"
      }
    }
}
User notifications
Endpoints to interact with a users notification settings.


List notifications 
Lists notifications the user has configured for a specific project, environment or asset (that do not
reference a specific action or workflow).


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-d5ae-7143-b423-c0a3a43f179c",
      • "type": "change_notifications",
      • "attributes": {
        }
      },
    • {
      • "id": "01a08b13-d5ae-7143-b423-c0a3a43f179c",
      • "type": "settings_notifications",
      • "attributes": {
        }
      },
    • {
      • "id": "01a08b13-d5ae-7143-b423-c0a3a43f179c",
      • "type": "properties_notifications",
      • "attributes": {
        }
      }
    ]
}
List change notifications 
Lists all change specific notifications the user has configured for a specific project, environment or asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-d814-7768-a2e4-fddcd1738e01",
    • "type": "action_notifications",
    • "attributes": {
      • "custom_proj_action": {
        },
      • "proj_action_1": {
        },
      • "proj_action_2": {
        },
      • "provision": {
        }
      }
    }
}
List workflow notifications 
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.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-da31-747d-92de-7fb243ec3fd2",
    • "type": "workflow_run_notifications",
    • "attributes": {
      • "assets": [ ],
      • "custom_workflow": [
        ],
      • "workflow_2": [
        ]
      }
    }
}
List all user notifications 
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.


path Parameters
user_id
required
string
 
 Example:  01a08b12-8dad-7a78-9cd7-fbdd8c8fe084
user id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-dc14-766b-9039-7461435b9839",
    • "type": "all_user_notifications",
    • "attributes": {
      • "/projects/opc/assets/prj_soa": {
        },
      • "/projects/opc/environments/dev/assets/env_soa": {
        },
      • "/projects/opc": {
        }
      }
    }
}
Groups
Endpoints to interact with the user LDAP groups.


Secrets
Endpoints to interact with secrets from the vault or decrypting AES encrypted strings.


Resolve secrets 
Returns the decrypted values of the supplied secrets


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "owner_type": "settings",
      • "owner_id": "01a08b12-9475-7081-af72-0e16235d4ad5",
      • "source": "settings",
      • "mintmodel_owner_path": "/projects/opc/assets/prj_soa",
      • "converge_date": "2026-09-10T11:27:30.674321Z",
      • "values_to_decrypt": [
        ]
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "secrets",
    • "type": "secrets",
    • "attributes": {
      • "results": [
        ]
      }
    }
}
Resolve a global secret 
Returns the decrypted value of a secret resolved directly from the secret vault


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "vault_owner_id": "01a08b12-9450-7f65-ad2a-ca249d51e8d1",
      • "vault_path": "secret-vault://path/to/vault/vault_key",
      • "expected_vault_value": "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A=="
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "secrets",
    • "type": "secrets",
    • "attributes": {
      • "results": [
        ]
      }
    }
}
Encrypt a value 
Returns the OpsChain-encrypted form of the supplied value


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "value_to_encrypt": "the value to encrypt"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "secrets",
    • "type": "secrets",
    • "attributes": {
      • "results": [
        ]
      }
    }
}
Store a secret 
Creates a secret value in the secret vault at the supplied path


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "vault_owner_id": "01a08b12-9450-7f65-ad2a-ca249d51e8d1",
      • "vault_path": "secret-vault://path/to/vault/vault_key",
      • "vault_value": "the value to store"
      }
    },
  • "meta": {
    • "replace_secret": false
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "secrets",
    • "type": "secrets",
    • "attributes": {
      • "results": [
        ]
      }
    }
}
Store a secret file 
Uploads a file and stores its contents in the secret vault at the supplied path


Request Body schema: multipart/form-data
vault_owner_id
string (Node whose vault configuration is used to store the secret) 
 
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.


Responses
 Request samples 
Content type
multipart/form-data
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="vault_owner_id"

01a08b14-0588-7a76-8b10-be44e10369bf
------------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--

 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "secrets",
    • "type": "secrets",
    • "attributes": {
      • "results": [
        ]
      }
    }
}
Info
Get version and other information about the running OpsChain instance.


Get OpsChain server info 
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "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": {
        }
      },
    • "links": {
      • "self": "/api/info"
      },
    • "meta": {
      • "authorisations": {
        }
      }
    }
}
Trust store
Endpoint to manage the trust store and certificates.


List certificates 
Lists certificates in the trust store.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[filename_cont]=root
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "ca_self.pem",
      • "type": "certificate",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Create certificate 
Creates a certificate in the trust store.


Request Body schema: multipart/form-data
description
string or null
 
file
string <binary> 
 
certificate file, the uploaded file's filename is used to name the new certificate


Responses
 Request samples 
Content type
multipart/form-data
------------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--

 Response samples 
Content type
application/vnd.api+json
{
  • "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-09-10T11:29:17.043005Z",
      • "updated_at": "2026-09-10T11:29:17.043005Z"
      },
    • "links": {
      • "self": "/api/trust_store/remote_system.crt"
      }
    }
}
Show certificate 
Shows a certificate from the trust store.


path Parameters
certificate_filename
required
string
 
 Example:  ca_self.pem
certificate filename


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "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-09-10T11:29:17.121656Z",
      • "updated_at": "2026-09-10T11:29:17.121656Z"
      },
    • "links": {
      • "self": "/api/trust_store/ca_self.pem"
      }
    }
}
Delete certificate 
Delete certificate from the trust store.


path Parameters
certificate_filename
required
string
 
 Example:  ca_self.pem
certificate filename


Responses
 Response samples 
Content type
text/plain
Update certificate 
Updates a certificate in the trust store.


path Parameters
certificate_filename
required
string
 
 Example:  ca_self.pem
certificate filename


Request Body schema: multipart/form-data
description
string or null
 
file
string <binary> 
 
certificate file (the filename is ignored)


Responses
 Request samples 
Content type
multipart/form-data
------------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--

 Response samples 
Content type
application/vnd.api+json
{
  • "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-09-10T11:29:17.534670Z",
      • "updated_at": "2026-09-10T11:29:17.534670Z"
      },
    • "links": {
      • "self": "/api/trust_store/remote_system.crt"
      }
    }
}
System configuration
Endpoint to fetch the current system configuration.


Update licence 
Updates the system licence.


Request Body schema: multipart/form-data
licence
string
 
Responses
 Request samples 
Content type
multipart/form-data
------------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--

 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "expired_opschain.licence",
    • "type": "licence",
    • "attributes": {
      • "licence": "licence data"
      }
    }
}
Get OpsChain system configuration 
Shows the current system configuration node.


query Parameters
include
string
 
 Example:  include=settings
Include the settings in the response


fields[<resource_type>]
string
 
 Example:  fields[<resource_type>]=code,name
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b14-2a14-79d9-af5d-17d64c66b9cf",
    • "type": "system_configuration",
    • "attributes": {
      • "code": "system",
      • "name": "System Configuration",
      • "description": "System configuration node"
      },
    • "relationships": {
      • "settings": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/system_configuration",
      • "settings": "/api/settings/01a08b14-2a22-73b7-8401-ec453ea5d2b7",
      • "properties": "/api/properties/01a08b14-2a1a-7ff5-aa6a-fd908581af9d"
      },
    • "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": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a08b14-2a22-73b7-8401-ec453ea5d2b7",
      • "type": "settings",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}
Admin operations
Endpoints to monitor the status of your OpsChain instance.


Get the clusters in the OpsChain topology 
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "opschain-db",
      • "type": "cluster",
      • "attributes": {
        }
      }
    ]
}
Get status information about the OpsChain database 
Returns status information about the OpsChain database.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "0",
      • "type": "database_status",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}
Get currently active OpsChain background tasks 
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [ ]
}
Get the status of the OpsChain nodes 
Returns the status of all the OpsChain nodes.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "opschain.limepoint.engineering",
      • "type": "node_status",
      • "attributes": {
        }
      }
    ]
}
Get the status of the OpsChain queues 
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "default",
      • "type": "queue_status",
      • "attributes": {
        }
      }
    ]
}
Get the status of the OpsChain resource slot pools 
Returns the status of the actions_refresh, runner, mintmodel_concretise, and image_build slot pools, including per-slot occupancy.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "runner",
      • "type": "resource_slot_pool",
      • "attributes": {
        }
      }
    ]
}
Get the status of the OpsChain API workers 
Returns the status of all the OpsChain API workers in the configured namespace.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "opschain-api-worker-1",
      • "type": "worker",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}
List the deployments in the OpsChain namespace 
Returns every deployment in the OpsChain Kubernetes namespace, including its replica counts, rollout status and the time it was last restarted.


Notes:


    

  • Each deployment reports the highest number of replicas OpsChain will run it at as meta.max_replicas.
    • 

  • A deployment that can be scaled - one whose 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.
    • 

  • 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.
    • 



Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "opschain-api",
      • "type": "deployment",
      • "attributes": {
        },
      • "links": { },
      • "meta": {
        }
      },
    • {
      • "id": "opschain-api-worker",
      • "type": "deployment",
      • "attributes": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "restart": true,
      • "scale": true
      }
    }
}
Restart a deployment 
Performs a rolling restart of a deployment in the OpsChain Kubernetes namespace, replacing each of its pods without changing the deployment configuration.


Notes:


    

  • Restarting a deployment requires the 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.
    • 

  • The restart is performed asynchronously by Kubernetes - the response reports the deployment as it was accepted for restart, not the completed rollout.
    • 

  • Restarting the OpsChain API deployment terminates the pod serving the request.
    • 



path Parameters
name
required
string
 
 Example:  opschain-api
deployment name


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "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": {
        },
      • "selector": {
        },
      • "containers": [
        ],
      • "conditions": [
        ]
      },
    • "links": { },
    • "meta": {
      • "max_replicas": 1
      }
    }
}
Scale a deployment 
Sets the number of replicas of a deployment in the OpsChain Kubernetes namespace.


Notes:


    

  • Scaling a deployment requires the 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.
    • 

  • Only the opschain-api-worker, opschain-mintmodel-steps-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.
    • 

  • The scaling is performed asynchronously by Kubernetes - the response reports the deployment as it was accepted for scaling, not the completed rollout.
    • 

  • Scaling down does not stop the surplus workers immediately - they keep running until they have finished their in-progress jobs, for up to the deployment's termination grace period (1 hour by default).
    • 

  • The replica count is not written back to the OpsChain Helm values, so the next Helm upgrade returns the deployment to its configured replica count.
    • 



path Parameters
name
required
string
 
 Example:  opschain-api-worker
deployment name


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "replicas": 3
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "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": {
        },
      • "selector": {
        },
      • "containers": [
        ],
      • "conditions": [
        ]
      },
    • "links": {
      • "scale": "/api/admin/deployments/opschain-api-worker/scale"
      },
    • "meta": {
      • "max_replicas": 10
      }
    }
}
List the pods in the OpsChain namespace 
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.
    • 

  • A delete link is only present on the pods that can be deleted - see the delete pod endpoint.
    • 



Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7",
      • "type": "pod",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "opschain-api-worker-1",
      • "type": "pod",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "delete": true,
      • "read_logs": true
      }
    }
}
Get a pod's log 
Returns the log for a pod in the OpsChain Kubernetes namespace.


Notes:


    

  • Fetching a pod log requires the 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.
    • 

  • Pod logs are only retained by Kubernetes while the pod exists - use the OpsChain change / workflow run log lines to review the output of a completed change.
    • 

  • At most 100MB of the pod log is read from the Kubernetes API per request. Log output beyond that limit is not returned.
    • 



path Parameters
name
required
string
 
 Example:  change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7
pod name


query Parameters
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 containers attribute of the list pods response.


limit
integer  [ 1 .. 10000 ] 
 Default:  1000
 
 Example:  limit=1000
The maximum number of log lines to return. A 206 response and a more link are returned when the pod log has more lines than the limit.


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 id of the last log line received to fetch the next page of log lines - supplying a bare timestamp instead excludes every log line sharing that timestamp.


download
string
 
 Example:  download=pod.log
Download the entire pod log with the specified file name. The limit and filter[logged_at_gt] parameters are ignored when downloading.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "2021-01-01T00:00:01.123456Z-0",
      • "type": "log_line",
      • "attributes": {
        }
      },
    • {
      • "id": "2021-01-01T00:00:02.234567Z-0",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}
Force delete a pod 
Force deletes a pod in the OpsChain Kubernetes namespace, without waiting out its termination grace period.


Notes:


    

  • Deleting a pod requires superuser access. No authorisation rule grants it.
    • 

  • Only the pods OpsChain creates to do its own processing can be deleted - the change worker, step runner, agent, generate actions and MintModel generation pods. The pods belonging to the OpsChain deployments and stateful sets are refused, as are any other pods sharing the namespace.
    • 

  • The 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.
    • 

  • Kubernetes removes the pod asynchronously - the response reports the pod as it was accepted for deletion.
    • 

  • Deleting a pod that OpsChain is still waiting on fails the step or task it was running. Use it to recover from a pod that is stuck, not to stop work in progress - cancel the change or workflow run instead.
    • 



path Parameters
name
required
string
 
 Example:  change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7
pod name


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "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": [
        ],
      • "controlled_by": null,
      • "labels": {
        }
      },
    • "links": {
      • "logs": "/api/admin/pods/change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7/logs",
      • "delete": "/api/admin/pods/change-3ecf1a2b-4d5e-4f60-8a71-92b3c4d5e6f7"
      }
    }
}
Data cleanup definitions
Endpoints to interact with data cleanup definitions.


List data cleanup definitions 
Lists all data cleanup definitions.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=test
API filtering guide. Named filters: filter[created_by_eq], filter[created_by_in].


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a08b13-442c-7044-9027-9b55ce6ad004",
      • "type": "data_cleanup_definition",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      },
    • "has_any": true
    }
}
Create data cleanup definition 
Notes:


    

  1. See the various payload examples to understand the required fields for each possible request to this endpoint.
    2. 

  2. Either the cron_schedule or run_at fields must be provided.
    3. 

  3. The keys accepted for the filters field are changes, events, jobs, workflow_runs, and node_background_tasks. 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.
IMPORTANT: If no filters are provided for a data type, the cleanup will remove all data that matches the node paths.
    4. 

  4. The 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.
    5. 

  5. The 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.
    6. 



Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "name": "feed",
      • "enabled": true,
      • "node_paths": [ ],
      • "filters": { },
      • "purge_activities": true,
      • "purge_events": false,
      • "purge_jobs": true,
      • "cron_schedule": "0 0 * * *",
      • "run_at": null,
      • "end_at": null,
      • "maximum_run_count": null,
      • "repeat": true,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": true
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-4a68-7d94-a644-b8e1a0e3e863",
    • "type": "data_cleanup_definition",
    • "attributes": {
      • "name": "matrix",
      • "enabled": true,
      • "created_by": "logged_in_user",
      • "cron_schedule": "50 23 12 12 1",
      • "repeat": true,
      • "maximum_run_count": null,
      • "purge_activities": true,
      • "purge_events": false,
      • "purge_jobs": false,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": true,
      • "filters": {
        },
      • "node_paths": [
        ],
      • "run_count": 0,
      • "created_at": "2026-09-10T11:28:12.391873Z",
      • "updated_at": "2026-09-10T11:28:12.391873Z",
      • "next_run_at": "2026-12-07T12:50:00.000000Z",
      • "run_at": null,
      • "end_at": null
      },
    • "links": {
      • "self": "/api/data_cleanup_definitions/01a08b13-4a68-7d94-a644-b8e1a0e3e863"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Show a data cleanup definition 
Shows a data cleanup definition.


path Parameters
data_cleanup_definition_id
required
string
 
 Example:  01a08b12-a3f6-7bb5-a5bc-a93158a309ca
data cleanup definition id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-4c60-78af-b4bb-3f943e94e5d5",
    • "type": "data_cleanup_definition",
    • "attributes": {
      • "name": "interface",
      • "enabled": false,
      • "created_by": "rayford_mclaughlin-1079",
      • "cron_schedule": "0 0 7,14,21,28 * *",
      • "repeat": true,
      • "maximum_run_count": null,
      • "purge_activities": true,
      • "purge_events": false,
      • "purge_jobs": true,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": false,
      • "filters": {
        },
      • "node_paths": [
        ],
      • "run_count": 0,
      • "created_at": "2026-09-10T11:28:12.895387Z",
      • "updated_at": "2026-09-10T11:28:12.897850Z",
      • "next_run_at": null,
      • "run_at": "2026-09-03T11:28:12.890870Z",
      • "end_at": "2026-12-09T11:28:12.890886Z"
      },
    • "links": {
      • "self": "/api/data_cleanup_definitions/01a08b13-4c60-78af-b4bb-3f943e94e5d5"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Update the data cleanup definition 
Updates a data cleanup definition.


Notes:


    

  1. See the various payload examples in the create endpoint to understand the attributes you can supply to this endpoint.
    2. 

  2. The payload need only consist of the attributes you wish to modify. There is no need to supply the entire data cleanup definition.
    3. 



path Parameters
data_cleanup_definition_id
required
string
 
 Example:  01a08b12-a3f6-7bb5-a5bc-a93158a309ca
data cleanup definition id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "name": "new_name",
      • "run_at": null,
      • "end_at": null
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a08b13-4e00-7aac-ac8b-c807d56ea45e",
    • "type": "data_cleanup_definition",
    • "attributes": {
      • "name": "new_name",
      • "enabled": false,
      • "created_by": "reginald-1089",
      • "cron_schedule": "0 0 7,14,21,28 * *",
      • "repeat": true,
      • "maximum_run_count": 5,
      • "purge_activities": true,
      • "purge_events": true,
      • "purge_jobs": false,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": false,
      • "filters": {
        },
      • "node_paths": [
        ],
      • "run_count": 0,
      • "created_at": "2026-09-10T11:28:13.311555Z",
      • "updated_at": "2026-09-10T11:28:13.332756Z",
      • "next_run_at": null,
      • "run_at": "2026-09-03T11:28:13.306847Z",
      • "end_at": "2026-12-09T11:28:13.306863Z"
      },
    • "links": {
      • "self": "/api/data_cleanup_definitions/01a08b13-4e00-7aac-ac8b-c807d56ea45e"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}
Delete the data cleanup definition 
Delete a data cleanup definition.


path Parameters
data_cleanup_definition_id
required
string
 
 Example:  01a08b12-a3f6-7bb5-a5bc-a93158a309ca
data cleanup definition id


Responses
 Response samples 
Content type
text/plain
Compare nodes
Compare two nodes 
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.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "node_path_a": "/projects/opc/environments/dev/assets/env_soa",
      • "node_path_b": "/projects/opc/assets/prj_soa"
      }
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    • "id": "env_soa:prj_soa",
    • "type": "node_comparison",
    • "attributes": {
      • "nodes": {
        },
      • "properties": {
        },
      • "settings": {
        },
      • "mintmodel": {
        },
      • "environments": {
        },
      • "assets": {
        },
      • "agents": {
        }
      }
    }
}