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-10-08 (e74ea3547)

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": "01a11921-6e61-72e3-83ed-d8b75974b057",
      • "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": "01a11921-6f8b-7f5c-afd8-da2a9da21443",
    • "type": "project",
    • "attributes": {
      • "code": "0z0je",
      • "name": "facere685",
      • "description": "Adipisci hic maiores tempore.",
      • "archived": false,
      • "created_by": "logged_in_user",
      • "project_type": "Standard"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/0z0je",
      • "bookmarks": "/api/projects/0z0je/bookmarks",
      • "git_remotes": "/api/projects/0z0je/git_remotes",
      • "environments": "/api/projects/0z0je/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": "01a11921-712d-72f1-a6b3-9b551eadef84",
    • "type": "project",
    • "attributes": {
      • "code": "opc",
      • "name": "OpsChain",
      • "description": "OpsChain project",
      • "archived": false,
      • "created_by": "idell-2242",
      • "project_type": "Enterprise"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc",
      • "artefacts": "/api/projects/opc/artefacts",
      • "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": "01a11921-72a9-72dd-90be-126f53292dba",
    • "type": "project",
    • "attributes": {
      • "code": "opc",
      • "name": "tenetur694",
      • "description": "Voluptate ipsum sunt magnam.",
      • "archived": true,
      • "created_by": "spencer-2248",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11921-209f-726b-8e79-ce5a42d3ad31",
      • "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": "01a11921-2233-7579-854b-b1713a5dc22d",
    • "type": "environment",
    • "attributes": {
      • "code": "bbmnv",
      • "name": "reiciendis611",
      • "description": "Et cum beatae voluptates.",
      • "archived": false,
      • "created_by": "logged_in_user"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/bbmnv",
      • "artefacts": "/api/projects/opc/environments/bbmnv/artefacts",
      • "bookmarks": "/api/projects/opc/environments/bbmnv/bookmarks",
      • "changes": "/api/projects/opc/environments/bbmnv/changes",
      • "scheduled_activities": "/api/projects/opc/environments/bbmnv/scheduled_activities",
      • "parent": "/api/projects/opc",
      • "assets": "/api/projects/opc/environments/bbmnv/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": "01a11921-243f-762c-8f2b-da2ee27b93d5",
    • "type": "environment",
    • "attributes": {
      • "code": "dev",
      • "name": "Development",
      • "description": "OpsChain development environment",
      • "archived": false,
      • "created_by": "demetrice-1947"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev",
      • "artefacts": "/api/projects/opc/environments/dev/artefacts",
      • "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": "01a11921-240d-7844-85a6-0346050826e4",
      • "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": "01a11921-2650-781e-bff6-1ae540ee93a0",
    • "type": "environment",
    • "attributes": {
      • "code": "dev",
      • "name": "at621",
      • "description": "Autem et dolore tempore.",
      • "archived": true,
      • "created_by": "chase_glover-1955"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "parent": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev",
      • "artefacts": "/api/projects/opc/environments/dev/artefacts",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Show converged settings

Show the converged settings for this environment, merged from the project and environment settings. Only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.

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

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-10-08T01:27:11+00:00

Specify the date (and optionally time), to derive the active environment properties from.

exclude_layers[]
string
Example: exclude_layers[]=template

Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. > exclude_layers[]=template&exclude_layers[]=asset. Suffix a layer with _repository or _database to exclude only that half of it, e.g. > exclude_layers[]=asset_repository. The layers available for the node, and whether each one is currently included, are listed in the property_layers response meta. The template layer covers the properties files held under the <template code> folder of the template repository, as well as the template's database properties; the template_version layer covers the template version database properties only. Excluding a layer is a preview - the result is not cached and nothing is persisted.

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": {
        },
      • "property_layers": [
        ]
      }
    },
  • "included": [
    • {
      • "id": "01a11921-2d2b-7453-a4c3-cc204e635fb1",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-2d6c-79ee-aff5-69e05ad1ae60",
      • "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": "01a1191f-6266-7d69-a0b7-f7d40f5c7693",
    • "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-10-08T01:27:29.637225Z",
      • "updated_at": "2026-10-08T01:27:29.637225Z",
      • "image_sha": null,
      • "image_purged": false,
      • "image_in_use": false
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a1191f-616f-708d-90af-ff9aaf9279e7/versions/2026_Q1_2",
      • "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1191f-6266-7d69-a0b7-f7d40f5c7693",
      • "agent": "/api/projects/opc/agents/agent1",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1191f-6266-7d69-a0b7-f7d40f5c7693"
      }
    }
}

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": "01a1191f-6467-75aa-8f9e-c591fcc3d0c3",
      • "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: 01a1191f-03aa-757f-822d-1273008ae8e9

agent background task id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-6685-73ea-87d4-170dde48af6d",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 1,
      • "status_code": "success",
      • "error_message": null,
      • "created_by": "corie-364",
      • "task_type": "BuildAgentImageTask",
      • "created_at": "2026-10-08T01:27:30.692084Z",
      • "updated_at": "2026-10-08T01:27:30.709551Z",
      • "image_sha": "sha256:7655e0d4a9fe96130dc9e62dd8d85536e3ba743398d5e5ba5801a9fb0bbd2082",
      • "image_purged": false,
      • "image_in_use": true
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a1191f-65eb-79e8-8048-09bfe7c6751c/versions/2026_Q1_2",
      • "self": "/api/projects/opc/agents/agent1/node_background_tasks/01a1191f-6685-73ea-87d4-170dde48af6d",
      • "agent": "/api/projects/opc/agents/agent1",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a1191f-6685-73ea-87d4-170dde48af6d"
      }
    }
}

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": "01a1191f-6959-7f1c-bf04-2d6190d7af46",
    • "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": "01a1191f-6958-7269-a773-45d958b72ffe",
      • "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": "01a1191f-6c0e-76f8-b3a2-34b6920fa654",
    • "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": "01a1191f-6c0b-7b03-827a-8ead4eb11192",
      • "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": "01a1191f-70e2-712d-80ea-8c1c816849b3",
      • "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": "01a11920-e464-7ad9-88d2-7b200edbfe02",
      • "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": "01a11920-ea79-7e4d-b1a8-7354df08e26c",
    • "type": "agent",
    • "attributes": {
      • "code": "i9czm",
      • "name": "iusto535",
      • "description": "Impedit exercitationem aut rerum.",
      • "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/i9czm",
      • "bookmarks": "/api/projects/opc/agents/i9czm/bookmarks",
      • "converged_properties": "/api/projects/opc/agents/i9czm/converged_properties",
      • "parent": "/api/projects/opc",
      • "node_background_tasks": "/api/projects/opc/agents/i9czm/node_background_tasks",
      • "version_history": "/api/projects/opc/agents/i9czm/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": "01a11920-ede1-7611-a4d4-b7f6b0382f1e",
    • "type": "agent",
    • "attributes": {
      • "code": "agent1",
      • "name": "Agent",
      • "description": "Asset description",
      • "archived": false,
      • "created_by": "weston_kunze-1736",
      • "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": "01a11920-ed36-70db-9ace-4799fff2343d",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11920-ed65-71e8-8965-37a10b12653d",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11920-eda2-7dc3-8582-426920292136",
      • "type": "template_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11920-ee06-753d-b756-cb9ac7be82a2",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11920-ee08-708a-888d-bfcaf8f4fe37",
      • "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": "01a11920-f0d4-7006-a99c-74334c369b1b",
    • "type": "agent",
    • "attributes": {
      • "code": "agent1",
      • "name": "aliquam545",
      • "description": "Dolore perferendis error consequuntur.",
      • "archived": true,
      • "created_by": "florentino.marquardt-1745",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Show converged settings

Show the converged settings for this agent, merged from the project and agent settings. Only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.

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

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": "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. merge any project properties
  3. merge any properties assigned to the agent

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-10-08T01:27:11+00:00

Specify the date (and optionally time), to derive the active template version and agent properties from.

exclude_layers[]
string
Example: exclude_layers[]=template

Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. > exclude_layers[]=template&exclude_layers[]=asset. Suffix a layer with _repository or _database to exclude only that half of it, e.g. > exclude_layers[]=asset_repository. The layers available for the node, and whether each one is currently included, are listed in the property_layers response meta. The template layer covers the properties files held under the <template code> folder of the template repository, as well as the template's database properties; the template_version layer covers the template version database properties only. Excluding a layer is a preview - the result is not cached and nothing is persisted.

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": {
        },
      • "property_layers": [
        ]
      }
    },
  • "included": [
    • {
      • "id": "01a11920-fad0-7b5e-9f7c-d25045106db1",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11920-fb0e-70cc-8854-f3cb5f573085",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11920-fb42-7d9a-93bf-1c93eba00bd6",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11920-fb8a-73a8-80f0-36163eed167c",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "properties/properties.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "properties/projects/opc/properties.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": "01a11920-fd44-7a4a-894f-88765447e606",
      • "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": "01a11920-ffd5-7c74-ad77-9f78212535d7",
    • "type": "asset",
    • "attributes": {
      • "code": "y1eoj",
      • "name": "in565",
      • "description": "At commodi ipsum aspernatur.",
      • "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/y1eoj",
      • "actions": "/api/projects/opc/assets/y1eoj/actions",
      • "artefacts": "/api/projects/opc/assets/y1eoj/artefacts",
      • "bookmarks": "/api/projects/opc/assets/y1eoj/bookmarks",
      • "changes": "/api/projects/opc/assets/y1eoj/changes",
      • "scheduled_activities": "/api/projects/opc/assets/y1eoj/scheduled_activities",
      • "converged_properties": "/api/projects/opc/assets/y1eoj/converged_properties",
      • "mintmodels": "/api/projects/opc/assets/y1eoj/mintmodels",
      • "mintmodel_history": "/api/projects/opc/assets/y1eoj/mintmodel_history",
      • "parent": "/api/projects/opc",
      • "node_background_tasks": "/api/projects/opc/assets/y1eoj/node_background_tasks",
      • "version_history": "/api/projects/opc/assets/y1eoj/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": "01a11921-0265-74a0-aa48-182eeb5fbcd8",
    • "type": "asset",
    • "attributes": {
      • "code": "prj_soa",
      • "name": "Project asset",
      • "description": "Project asset description",
      • "archived": false,
      • "created_by": "irmgard-1808",
      • "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",
      • "artefacts": "/api/projects/opc/assets/prj_soa/artefacts",
      • "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": "01a11921-01a9-748e-887e-e79e67e44878",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11921-02b2-7bd8-b59f-a61978fc8d6a",
      • "type": "bookmark",
      • "attributes": {},
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11921-01dd-7d4c-8549-b51795967334",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11921-0220-7afa-b757-25ec742c8178",
      • "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": "01a11921-0550-77d7-b23f-6141ee0b2b9e",
    • "type": "asset",
    • "attributes": {
      • "code": "prj_soa",
      • "name": "voluptates575",
      • "description": "Necessitatibus rem unde vel.",
      • "archived": true,
      • "created_by": "manuela.baumbach-1818",
      • "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",
      • "artefacts": "/api/projects/opc/assets/prj_soa/artefacts",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Show converged settings

Show the converged settings for this asset, merged from the project, environment and asset settings. Only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.

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

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": "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. merge any project properties
  3. merge any properties assigned to the project asset

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-10-08T01:27:11+00:00

Specify the date (and optionally time), to derive the active template version and asset properties from.

exclude_layers[]
string
Example: exclude_layers[]=template

Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. > exclude_layers[]=template&exclude_layers[]=asset. Suffix a layer with _repository or _database to exclude only that half of it, e.g. > exclude_layers[]=asset_repository. The layers available for the node, and whether each one is currently included, are listed in the property_layers response meta. The template layer covers the properties files held under the <template code> folder of the template repository, as well as the template's database properties; the template_version layer covers the template version database properties only. Excluding a layer is a preview - the result is not cached and nothing is persisted.

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": {
        },
      • "property_layers": [
        ]
      }
    },
  • "included": [
    • {
      • "id": "01a11921-1081-75c3-ab9f-ef63d2afdecc",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-10fb-7f1c-95cb-dcaa3962ae85",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-112a-78f9-9713-d8224dcaf4d0",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11921-115f-7a45-9cd5-c41cb6962389",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "properties/properties.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "properties/projects/opc/properties.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: 01a1191e-fbd3-7a02-ae33-ad6c1efa445d
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": "01a11921-13cd-7abc-9b6e-f1bd2a795191",
      • "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

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "build_without_cache": false
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-17b2-7afc-80ca-e02e2c52b548",
    • "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-10-08T01:29:21.585780Z",
      • "updated_at": "2026-10-08T01:29:21.585780Z",
      • "build_without_cache": false
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a11921-16e5-7f0a-a2da-7110bbef34f8/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a11921-17b2-7afc-80ca-e02e2c52b548",
      • "asset": "/api/projects/opc/assets/prj_soa",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a11921-17b2-7afc-80ca-e02e2c52b548"
      }
    }
}

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": "01a11921-1930-70d5-8211-a5fef55de73a",
      • "type": "node_background_task",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11921-190d-7921-8f68-5affbd8c3d89",
      • "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: 01a1191e-fbd3-7a02-ae33-ad6c1efa445d

generate actions request id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-1ab0-7344-97aa-eb736b2c1d07",
    • "type": "node_background_task",
    • "attributes": {
      • "request_number": 1,
      • "status_code": "success",
      • "error_message": null,
      • "created_by": "melvin_harris-1901",
      • "actions": [
        ],
      • "actions_count": 1,
      • "task_type": "GenerateActionsRequest",
      • "created_at": "2026-10-08T01:29:22.351507Z",
      • "updated_at": "2026-10-08T01:29:22.358030Z",
      • "build_without_cache": false
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a11921-1a2c-7040-a40c-853d3ce8dfab/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a11921-1ab0-7344-97aa-eb736b2c1d07",
      • "asset": "/api/projects/opc/assets/prj_soa",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a11921-1ab0-7344-97aa-eb736b2c1d07"
      }
    }
}

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: 01a1191e-fbd3-7a02-ae33-ad6c1efa445d

generate actions request id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11921-76ec-7813-b19c-67fee7dc1753",
      • "type": "project",
      • "attributes": {
        }
      },
    • {
      • "id": "01a11921-7732-736c-9caf-cfb2b6656a86",
      • "type": "template",
      • "attributes": {
        }
      },
    • {
      • "id": "01a11921-7791-7d19-946b-b7f6236217fd",
      • "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": "01a11922-0782-7090-bafc-79b9a8c92319",
      • "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: 01a1191e-fb83-7e27-8e4a-2a33665df03b

version history id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-08e2-711a-bfdf-4b67bce2a563",
    • "type": "template_version_history",
    • "attributes": {
      • "created_by": "berry.pollich-2654",
      • "active_from": "2026-10-08T01:30:23.328751Z",
      • "active_to": null
      },
    • "relationships": {
      • "owner": {
        },
      • "template_version": {
        },
      • "node_background_tasks": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a11922-086e-7217-8c13-cc806ea67bb0/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/version_history/01a11922-08e2-711a-bfdf-4b67bce2a563",
      • "asset": "/api/projects/opc/assets/prj_soa"
      }
    },
  • "included": [
    • {
      • "id": "01a11922-08c7-71b3-8f0c-fd61eb7a26ab",
      • "type": "asset",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11922-0899-7fd5-a512-e8ee7e491c38",
      • "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": "01a11921-f41b-7958-8acf-abd50d7df51d",
    • "type": "template",
    • "attributes": {
      • "code": "yx9la",
      • "name": "garrett.ortiz",
      • "description": "Dignissimos doloremque sit ea.",
      • "archived": false,
      • "disabled": false,
      • "template_type": "asset",
      • "created_at": "2026-10-08T01:30:18.010679Z",
      • "updated_at": "2026-10-08T01:30:18.010679Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11921-f41b-7958-8acf-abd50d7df51d",
      • "template_versions": "/api/projects/opc/templates/01a11921-f41b-7958-8acf-abd50d7df51d/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": "01a11921-f810-718e-a946-5885de22b4b5",
      • "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: 01a1191e-f93a-781b-9b39-58687b666b16

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": "01a11921-fa15-7a14-8796-aee9c9a27d1d",
    • "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-10-08T01:30:19.540818Z",
      • "updated_at": "2026-10-08T01:30:19.540818Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11921-fa15-7a14-8796-aee9c9a27d1d",
      • "template_versions": "/api/projects/opc/templates/01a11921-fa15-7a14-8796-aee9c9a27d1d/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: 01a1191e-f93a-781b-9b39-58687b666b16

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": "01a11921-fcaa-7600-9f95-0f15c2b0d4d4",
    • "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-10-08T01:30:20.201458Z",
      • "updated_at": "2026-10-08T01:30:20.278284Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11921-fcaa-7600-9f95-0f15c2b0d4d4",
      • "template_versions": "/api/projects/opc/templates/01a11921-fcaa-7600-9f95-0f15c2b0d4d4/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: 01a1191e-f93a-781b-9b39-58687b666b16

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": "01a11922-007e-7795-a835-6300a6eb68b5",
    • "type": "template",
    • "attributes": {
      • "code": "soa",
      • "name": "updated_name",
      • "description": "updated_description",
      • "archived": false,
      • "disabled": false,
      • "template_type": "asset",
      • "created_at": "2026-10-08T01:30:21.181732Z",
      • "updated_at": "2026-10-08T01:30:21.231071Z"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "git_remote": {
        },
      • "template_versions": {
        },
      • "nodes": {
        },
      • "project": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11922-007e-7795-a835-6300a6eb68b5",
      • "template_versions": "/api/projects/opc/templates/01a11922-007e-7795-a835-6300a6eb68b5/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: 01a1191e-f93a-781b-9b39-58687b666b16

template id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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: 01a1191e-f93a-781b-9b39-58687b666b16

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": "01a11922-0a1c-738a-a096-f42098ab4ad2",
      • "type": "template_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": 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: 01a1191e-f93a-781b-9b39-58687b666b16

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": "bluetooth",
      • "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": "01a11922-0e09-7035-8785-5c454d1a4647",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Delectus beatae quod ad enim facilis autem possimus atque magni maiores aperiam quas nesciunt non",
      • "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-10-08T01:30:24.647829Z",
      • "updated_at": "2026-10-08T01:30:24.647829Z",
      • "has_mintmodel": false,
      • "git_rev": "bluetooth",
      • "commit_sha": null,
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11922-0d08-761e-8101-14f29cc5a532/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a11922-0d08-761e-8101-14f29cc5a532"
      }
    }
}

Show template version

Shows a specific template version.

path Parameters
project_code
required
string
Example: opc

project code

template_id
required
string
Example: 01a1191e-f93a-781b-9b39-58687b666b16

template id

version
required
string
Example: 2023_Q4_2

template version

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-130d-7112-ba4b-9f441237cc12",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "londa-2688",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-10-08T01:30:25.932107Z",
      • "updated_at": "2026-10-08T01:30:25.932107Z",
      • "has_mintmodel": true,
      • "git_rev": "1080p",
      • "commit_sha": "34d8adfcf65677bf7e9eb008476cb9a9433a1955",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11922-12db-78be-b6c9-667c9207ee52/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a11922-12db-78be-b6c9-667c9207ee52"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}

Delete template version

Delete or archive a template version.

  • If the template version has never been assigned to an asset, it will be deleted.
  • If the template version has previously been assigned to an asset, it will be archived so the assignment history is preserved.
  • If the template version is currently assigned to an asset, it can be neither deleted nor archived.
path Parameters
project_code
required
string
Example: opc

project code

template_id
required
string
Example: 01a1191e-f93a-781b-9b39-58687b666b16

template id

version
required
string
Example: 2023_Q4_2

template version

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-16ad-72c9-9c4b-8e4bd418cdef",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "gonzalo.weissnat-2700",
      • "archived": true,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-10-08T01:30:26.860036Z",
      • "updated_at": "2026-10-08T01:30:27.096527Z",
      • "has_mintmodel": true,
      • "git_rev": "neural",
      • "commit_sha": "34674ee8bfad3f30d9cb30618781ddc802c0823a",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11922-1671-7909-8c4b-4ee505c94264/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a11922-1671-7909-8c4b-4ee505c94264"
      }
    }
}

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: 01a1191e-f93a-781b-9b39-58687b666b16

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": "01a11922-1cd0-7baf-b9de-a2b0119495a9",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "lewis-2719",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-10-08T01:30:28.431658Z",
      • "updated_at": "2026-10-08T01:30:28.431658Z",
      • "has_mintmodel": true,
      • "git_rev": "mobile",
      • "commit_sha": "e3c88c68ed62ea5d0d4ae9093b297c5e0b47f6fe",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/templates/01a11922-1c91-7e73-bd1e-6aece0cda618/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/01a11922-1c91-7e73-bd1e-6aece0cda618"
      }
    }
}

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: 01a1191e-f93a-781b-9b39-58687b666b16

template id

version
required
string
Example: 2023_Q4_2

template version

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-233e-7775-92e9-e1e0e8b1e860",
    • "type": "template_version",
    • "attributes": {
      • "version": "0fi23",
      • "description": "Est libero odio dolores fugiat laudantium magnam rerum",
      • "state": "ready",
      • "created_by": "clemencia-2738",
      • "archived": false,
      • "initialization_error": null,
      • "locked": false,
      • "float_git_rev": false,
      • "float_refresh_error": null,
      • "created_at": "2026-10-08T01:30:30.077346Z",
      • "updated_at": "2026-10-08T01:30:30.167368Z",
      • "has_mintmodel": false,
      • "git_rev": "back-end",
      • "commit_sha": "e810ea0948748653b52839c37798936810bfddd8",
      • "git_remote_name": "eliseo"
      },
    • "relationships": {
      • "properties": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "template": {
        },
      • "pending_commit": {
        }
      },
    • "links": {
      • "self": "/api/projects/mruzv/templates/01a11922-2302-7218-b315-056be0d06101/versions/0fi23",
      • "template": "/api/projects/mruzv/templates/01a11922-2302-7218-b315-056be0d06101"
      }
    }
}

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": "01a11920-bffa-7af8-ae25-8008a43d6049",
    • "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-10-08T01:28:59.129376Z",
      • "updated_at": "2026-10-08T01:28:59.129376Z",
      • "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/01a11920-bffa-7af8-ae25-8008a43d6049"
      },
    • "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": "01a11920-c3e7-7be5-a535-cff21528d1d8",
      • "type": "git_remote",
      • "attributes": {},
      • "relationships": {
        },
      • "links": {
        },
      • "meta": null
      },
    • {
      • "id": "01a11920-c3ed-73e2-b6f7-e16898af304f",
      • "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: 01a1191e-f8ef-79ce-8991-4e92a6c566e4

remote id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-c5b8-71f4-ab12-4ebfe4d3ed15",
    • "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/01a11920-c5b8-71f4-ab12-4ebfe4d3ed15"
      },
    • "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: 01a1191e-f8ef-79ce-8991-4e92a6c566e4

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": "01a11920-c763-7bb8-98bb-94df5cc556be",
    • "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/01a11920-c763-7bb8-98bb-94df5cc556be"
      },
    • "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: 01a1191e-f8ef-79ce-8991-4e92a6c566e4

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": "01a11920-c9be-756d-a7d8-715376f974b5",
    • "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/01a11920-c9be-756d-a7d8-715376f974b5"
      },
    • "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: 01a1191e-f8ef-79ce-8991-4e92a6c566e4

remote id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-cd61-7cf3-9b3e-2b8a29f1907a",
    • "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/01a11920-cd61-7cf3-9b3e-2b8a29f1907a"
      },
    • "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": "01a11920-2c41-7c4f-be04-3b73561f1113",
    • "type": "bookmark",
    • "attributes": {
      • "url": "https://waelchi.example/houston.rutherford",
      • "description": "Enim amet corrupti ut. 1",
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:28:21.312341Z",
      • "updated_at": "2026-10-08T01:28:21.312341Z"
      },
    • "relationships": {
      • "parent": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a11920-2c41-7c4f-be04-3b73561f1113",
      • "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": "01a11920-3230-78ec-95c3-8ef56afb1697",
      • "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: 01a1191e-fc3c-7660-b459-607059724a2e

bookmark id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-33f0-7821-a01e-dca924b54302",
    • "type": "bookmark",
    • "attributes": {},
    • "relationships": {
      • "parent": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a11920-33f0-7821-a01e-dca924b54302",
      • "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: 01a1191e-fc3c-7660-b459-607059724a2e

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": "01a11920-37a1-7a3d-92eb-3e9511af75da",
    • "type": "bookmark",
    • "attributes": {
      • "url": "https://updated.server.com:8080/new/path",
      • "description": "Updated server console path",
      • "created_by": "lonny-1137",
      • "created_at": "2026-10-08T01:28:24.224220Z",
      • "updated_at": "2026-10-08T01:28:24.261839Z"
      },
    • "relationships": {
      • "parent": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/01a11920-37a1-7a3d-92eb-3e9511af75da",
      • "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: 01a1191e-fc3c-7660-b459-607059724a2e

bookmark id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11920-d53c-7970-9e11-c25ebb8f9175",
      • "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: 01a1191f-1b64-7db9-a4fb-bf2f9d85e584

MintModel history id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-d761-7b6c-80df-23c31fb3c506",
    • "type": "mintmodel_history",
    • "attributes": {
      • "created_at": "2026-10-08T01:29:05.120676Z",
      • "updated_at": "2026-10-08T01:29:05.120676Z"
      },
    • "relationships": {
      • "parents": {
        },
      • "mintmodel": {
        },
      • "opschain_changes": {
        },
      • "template_version": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/01a11920-d761-7b6c-80df-23c31fb3c506"
      }
    },
  • "included": [
    • {
      • "id": "01a11920-d75b-7511-943e-432f71a5fd02",
      • "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
version
string
Example: version=2023_Q4_2

Return only the unique MintModels that have been generated for the asset while this version of its template was assigned. Returns an error if the version has never been assigned to the asset.

filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[created_at_gteq]=2026-01-01
limit
integer [ 1 .. 10000 ]
Default: 100
Example: limit=50

Limit the number of MintModels returned. When more records match than the limit a 206 response is returned and meta.partial_response is true.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a11920-d802-781b-a77b-4d27df6d63ea",
      • "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: 01a1191f-171f-7306-9ff8-d549fe53af69

old MintModel id

new_mintmodel_id
required
string
Example: 01a1191f-1733-7b1d-84d2-671866726c5d

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/01a11920-dc18-74c2-9a79-fd9585e37e3c",
      • "new_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/01a11920-dc29-7912-8f0b-2d59d89e2b46",
      • "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: 01a1191e-fc56-7a22-8143-69532937efe1

MintModel id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-de78-7132-90c8-7cb8fcc11b4e",
    • "type": "mintmodel",
    • "attributes": {
      • "data": {
        },
      • "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
      • "created_at": "2026-10-08T01:29:06.935280Z",
      • "updated_at": "2026-10-08T01:29:06.935280Z",
      • "render_logs": {
        },
      • "phase_output": { }
      },
    • "relationships": {
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodels/01a11920-de78-7132-90c8-7cb8fcc11b4e",
      • "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": "01a11920-e2f4-761b-a561-095e910591b7",
    • "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-10-08T01:29:08.082850Z",
      • "updated_at": "2026-10-08T01:29:08.082850Z"
      },
    • "relationships": {
      • "template_version_history": {
        },
      • "owner": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/01a11920-e22f-76dc-822e-57a43de5402a/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/01a11920-e2f4-761b-a561-095e910591b7",
      • "asset": "/api/projects/opc/assets/prj_soa",
      • "log_lines": "/api/node_background_task_log_lines?node_background_task_id=01a11920-e2f4-761b-a561-095e910591b7"
      }
    }
}

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": "01a11923-d443-7c0e-a18d-6ee6e0a7c9cd",
      • "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": "h2qp9",
      • "archived": false,
      • "name": "qapjwum1wx",
      • "description": "You can't program the array without copying the neural JBOD transmitter!",
      • "steps": [
        ],
      • "draft": true
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11923-d841-7c19-b0d8-116b7d8f124f",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets_new",
      • "name": "assets workflow_new",
      • "description": null,
      • "draft": false,
      • "archived": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:32:21.952714Z",
      • "updated_at": "2026-10-08T01:32:21.952714Z",
      • "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": "01a11923-df17-7e96-bf02-0e9a9849fbbc",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "created_by": "merideth-4667",
      • "created_at": "2026-10-08T01:32:23.703234Z",
      • "updated_at": "2026-10-08T01:32:23.703234Z",
      • "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": "cha4dvdbqw",
      • "description": "Generating the driver won't do anything, we need to transmit the cross-platform smtp interface!",
      • "steps": [
        ],
      • "draft": true
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11923-e557-738d-8101-4cfd8708f02a",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "new workflow name",
      • "description": "new description",
      • "draft": false,
      • "archived": false,
      • "created_by": "foster-4695",
      • "created_at": "2026-10-08T01:32:25.302449Z",
      • "updated_at": "2026-10-08T01:32:25.389095Z",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11923-ef49-720c-910d-4f70f23f276f",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-ef44-7e57-b31b-46ae5e9c8c3b",
      • "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": "01a11923-f72e-732b-9765-b47462b98802",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "created_by": "amanda-4786",
      • "created_at": "2026-10-08T01:32:29.869496Z",
      • "updated_at": "2026-10-08T01:32:29.869496Z",
      • "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": "01a11923-fc7b-76a9-a0be-29edcf8a7168",
    • "type": "workflow_version",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "created_by": "roscoe-4813",
      • "created_at": "2026-10-08T01:32:31.226573Z",
      • "updated_at": "2026-10-08T01:32:31.242826Z",
      • "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": "7ef2r",
      • "node_id": "01a1191f-3f9a-7559-852a-67ef2e50f654",
      • "archived": false,
      • "name": "alavtqjpy3",
      • "description": "Compressing the circuit won't do anything, we need to override the haptic xml microchip!",
      • "steps": [
        ],
      • "draft": true
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11924-054d-73d8-b18c-a7594f472698",
    • "type": "workflow_version",
    • "attributes": {
      • "code": "assets",
      • "name": "new workflow name",
      • "description": "new description",
      • "draft": true,
      • "archived": false,
      • "created_by": "elden-4859",
      • "created_at": "2026-10-08T01:32:33.483744Z",
      • "updated_at": "2026-10-08T01:32:33.529903Z",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Properties

Endpoints to interact with properties.

Show properties

Shows the current properties JSON and its version.

path Parameters
properties_id
required
string
Example: 01a1191e-f875-7b60-93bb-211c1782167d

properties id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-789e-72a9-b2f8-3a5bea5402a8",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-10-08T01:29:46.397544Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a11921-789e-72a9-b2f8-3a5bea5402a8",
      • "current_version": "/api/properties/01a11921-789e-72a9-b2f8-3a5bea5402a8/versions/1",
      • "versions": "/api/properties/01a11921-789e-72a9-b2f8-3a5bea5402a8/versions"
      }
    }
}

Update properties

Updates a properties JSON if the included version matches the current properties version.

path Parameters
id_to_update
required
string
Example: 01a1191e-f875-7b60-93bb-211c1782167d

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": "01a11921-79f3-7a47-b0b0-c5bc77eca9d6",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2026-10-08T01:29:46.738093Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a11921-79f3-7a47-b0b0-c5bc77eca9d6",
      • "current_version": "/api/properties/01a11921-79f3-7a47-b0b0-c5bc77eca9d6/versions/2",
      • "versions": "/api/properties/01a11921-79f3-7a47-b0b0-c5bc77eca9d6/versions"
      }
    }
}

Update properties (unsafe)

Updates a properties JSON, without any version checking (always updates).

path Parameters
id_to_set
required
string
Example: 01a1191e-f875-7b60-93bb-211c1782167d

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": "01a11921-7cd2-71d4-8b4f-002db1c65f0d",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2026-10-08T01:29:47.473452Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a11921-7cd2-71d4-8b4f-002db1c65f0d",
      • "current_version": "/api/properties/01a11921-7cd2-71d4-8b4f-002db1c65f0d/versions/2",
      • "versions": "/api/properties/01a11921-7cd2-71d4-8b4f-002db1c65f0d/versions"
      }
    }
}

Create or update a file property

Create or update a file property in the properties.

path Parameters
properties_id
required
string
Example: 01a1191e-f875-7b60-93bb-211c1782167d

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": "01a11921-7ee1-760a-b995-0c639c1b6433",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2026-10-08T01:29:48.000392Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/01a11921-7ee1-760a-b995-0c639c1b6433",
      • "current_version": "/api/properties/01a11921-7ee1-760a-b995-0c639c1b6433/versions/2",
      • "versions": "/api/properties/01a11921-7ee1-760a-b995-0c639c1b6433/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: 01a1191e-f875-7b60-93bb-211c1782167d

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.

exclude_data
boolean
Default: false
Example: exclude_data=true

Exclude the data attribute from each of the properties versions returned. Use the show endpoint to fetch the data for an individual version.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a11921-8047-7d1c-8bed-51d16856090c",
      • "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: 01a1191e-f875-7b60-93bb-211c1782167d

properties id

version_number
required
integer
Example: 1

version number

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-81d9-77ac-b458-ecc04b542f3c",
    • "type": "properties_version",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-10-08T01:29:48.760330Z",
      • "owner_type": "Project"
      },
    • "relationships": {
      • "properties": {
        }
      },
    • "links": {
      • "versions": "/api/properties/01a11921-81ce-7c2a-9b8d-1fab26f54908/versions",
      • "owner": "/api/projects/opc",
      • "self": "/api/properties/01a11921-81ce-7c2a-9b8d-1fab26f54908/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].

download
string
Example: download=activities.csv

Download activities in CSV format with the specified file name. The activities will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order or limit requested.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a1191f-5266-7724-9749-b0b1875be487",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-514b-72a7-b806-f080eaa49c60",
      • "type": "change",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-5000-77db-8a1d-82b42e4707eb",
      • "type": "change",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-4e86-70f1-aaa2-e1ba8e1c0ee2",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-4c90-7206-b41d-4d20a69cbb82",
      • "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[step_action_or_name_eq], filter[step_action_or_name_in], filter[waiting_to_run]. filter[step_action_or_name_eq]=<action or step name> returns every change with a step whose action or step name matches, at any depth in the step tree, e.g. > filter[step_action_or_name_eq]=provision. The comparison ignores case. filter[step_action_or_name_in][]=<action or step name> does the same for several values, e.g. > filter[step_action_or_name_in][]=provision&filter[step_action_or_name_in][]=destroy. The /api/ui_support/step_actions?prefix=<prefix> endpoint lists the actions and step names available to these filters.

download
string
Example: download=changes.csv

Download changes in CSV format with the specified file name. The changes will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested.

include
string
Example: include=steps,parents

Include the change steps and parents in the response

fields[<resource_type>]
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.

include_children
boolean
Example: include_children=true

Only applies when the changes are being listed for a node - via a node path or parent_path. Include the changes of the node's descendants as well as its own.

total_count
boolean
Example: total_count=true

Report the number of changes matching the filter in meta.total_matching_filter, stopping at 1000 - meta.total_matching_filter_exact reports whether the count is exact. No count is computed unless this or exact_count is supplied.

exact_count
boolean
Example: exact_count=true

Report meta.total_matching_filter without a cap - this is significantly slower on instances with a large change history.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a11920-43de-7e09-b183-19c384007318",
      • "type": "change",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "01a11920-43e4-7c31-af0c-bc8fdbd6e9da",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11920-4356-7a75-a749-45e2226f2b85",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11920-4388-7415-9777-594efc11b196",
      • "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. 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. 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.
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,
      • "paused_at": null,
      • "executor_queue_name": null,
      • "action": "input",
      • "parent_path": "/projects/opc/environments/dev/assets/env_soa",
      • "template_version": "2023_Q4_2"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-481a-7e44-9c7d-babc9fa117ce",
    • "type": "change",
    • "attributes": {
      • "created_by": "logged_in_user",
      • "step_name": "connect",
      • "action": "connect",
      • "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,
      • "pause_state": "none",
      • "status_code": "initializing",
      • "paused": false,
      • "paused_by": [ ],
      • "created_at": "2026-10-08T01:28:28.441021Z",
      • "started_at": "2026-10-08T01:28:28.433318Z",
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:28:28.455585Z",
      • "paused_at": null,
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": null,
      • "requires_approval_from": null
      },
    • "relationships": {
      • "parents": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "workflow_run": {
        },
      • "workflow": {
        },
      • "override_properties": {
        },
      • "override_settings": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/01a11920-462e-7652-b863-578a4ba81a62",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/01a11920-481a-7e44-9c7d-babc9fa117ce",
      • "log_lines": "/api/changes/01a11920-481a-7e44-9c7d-babc9fa117ce/log_lines",
      • "pause": "/api/changes/01a11920-481a-7e44-9c7d-babc9fa117ce/pause"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "01a11920-4821-7458-a5f8-6831bb49aea7",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ]
}

Show change

Shows a change, including it's parent nodes.

path Parameters
change_id
required
string
Example: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

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": "01a11920-4bac-7b9b-91d3-72dea7ca4bb7",
    • "type": "change",
    • "attributes": {
      • "created_by": "sherrell_veum-1193",
      • "step_name": "input",
      • "action": "input",
      • "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,
      • "pause_state": "none",
      • "status_code": "success",
      • "paused": false,
      • "paused_by": [ ],
      • "created_at": "2026-10-08T01:28:29.354441Z",
      • "started_at": "2026-10-08T01:19:15.086705Z",
      • "finished_at": "2026-10-08T01:22:15.906514Z",
      • "updated_at": "2026-10-08T01:28:29.367353Z",
      • "paused_at": null,
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": "4d786dfa6ff13fbad0801da05bf05ec513d0831a",
      • "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/01a11920-4b80-7559-afef-882ac413c34a",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/01a11920-4bac-7b9b-91d3-72dea7ca4bb7",
      • "log_lines": "/api/changes/01a11920-4bac-7b9b-91d3-72dea7ca4bb7/log_lines"
      },
    • "meta": {
      • "wait_queue": [ ],
      • "blocking_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "01a11920-4bb1-7dab-98f8-fe7e2f5576aa",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11920-4b17-7e70-8855-6781f81a73e4",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11920-4b58-7928-b958-cf126664990b",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}

Cancel change

Cancels a change.

path Parameters
change_id
required
string
Example: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

change id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Pause change

Pauses a running change. Steps already running finish, but no further steps are dispatched until the change is resumed.

path Parameters
change_id
required
string
Example: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

change id

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "reason": "Holding this change until the database maintenance window closes"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-537c-78ec-9281-3f1d492dbdfa",
    • "type": "change",
    • "attributes": {
      • "created_by": "bianca-1217",
      • "step_name": "index",
      • "action": "index",
      • "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,
      • "pause_state": "pausing",
      • "status_code": "running",
      • "paused": true,
      • "paused_by": [
        ],
      • "created_at": "2026-10-08T01:28:31.352981Z",
      • "started_at": "2026-10-08T01:20:42.541316Z",
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:28:31.369373Z",
      • "paused_at": "2026-10-08T01:28:31.451016Z",
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": "fe7e12cce591be4ae69a58fb4a9f8f5501399170",
      • "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/01a11920-534f-7363-ac83-e6d0b1cf2a01",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/01a11920-537c-78ec-9281-3f1d492dbdfa",
      • "log_lines": "/api/changes/01a11920-537c-78ec-9281-3f1d492dbdfa/log_lines",
      • "resume": "/api/changes/01a11920-537c-78ec-9281-3f1d492dbdfa/resume"
      },
    • "meta": { }
    }
}

Resume change

Resumes a paused change, dispatching the steps that were held while it was paused.

path Parameters
change_id
required
string
Example: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

change id

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "reason": "Maintenance window closed"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-59c4-7900-a57f-cc37d7d66bf6",
    • "type": "change",
    • "attributes": {
      • "created_by": "carley-1235",
      • "step_name": "copy",
      • "action": "copy",
      • "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,
      • "pause_state": "none",
      • "status_code": "running",
      • "paused": false,
      • "paused_by": [
        ],
      • "created_at": "2026-10-08T01:28:32.962866Z",
      • "started_at": "2026-10-08T01:23:12.585966Z",
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:28:32.973348Z",
      • "paused_at": null,
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": "0d7344469121362f6da53d6de8db46a4d6defcd5",
      • "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/01a11920-599d-7b53-bfee-726181e17abd",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/01a11920-59c4-7900-a57f-cc37d7d66bf6",
      • "log_lines": "/api/changes/01a11920-59c4-7900-a57f-cc37d7d66bf6/log_lines",
      • "pause": "/api/changes/01a11920-59c4-7900-a57f-cc37d7d66bf6/pause"
      },
    • "meta": { }
    }
}

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. Only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.

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

path Parameters
change_id
required
string
Example: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

change id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-5f6c-748f-a21b-1d9538e13131",
    • "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: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

change id

query Parameters
action_stage
string
Example: action_stage=pre

Converge the pre or post action properties

exclude_layers[]
string
Example: exclude_layers[]=template

Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. > exclude_layers[]=template&exclude_layers[]=asset. Suffix a layer with _repository or _database to exclude only that half of it, e.g. > exclude_layers[]=asset_repository. The layers available for the node, and whether each one is currently included, are listed in the property_layers response meta. The template layer covers the properties files held under the <template code> folder of the template repository, as well as the template's database properties; the template_version layer covers the template version database properties only. Excluding a layer is a preview - the result is not cached and nothing is persisted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "program (post)",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        },
      • "property_layers": [
        ]
      }
    },
  • "included": [
    • {
      • "id": "01a11920-6324-7a5e-920a-f52967696b14",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11920-635e-72b2-b293-9ef75b9d96bf",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11920-63b4-7a3d-8b0b-9e24fb04ed5a",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ]
}

Download a support bundle for a change

Builds a zip archive of the information LimePoint support needs to diagnose a change: the change and its steps, its logs, the properties and settings in effect, its template and MintModel, server version information, recent runs of the same action and recent events. Each item is collected using the requesting user's permissions, so anything they cannot read is omitted or redacted. Items that could not be collected are listed in the archive's manifest.json and SUMMARY.md rather than failing the request.

path Parameters
change_id
required
string
Example: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90

change id

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "log_limit": 2000,
      • "step_logs": "failed",
      • "time_zone": "Australia/Melbourne",
      • "client": {
        }
      }
    }
}

Response samples

Content type
application/zip
<binary data>

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": "01a11920-01cc-766a-bfaf-bc2a62cc121d",
      • "type": "scheduled_change",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11920-03f3-7829-a016-c4aad766239b",
      • "type": "scheduled_workflow",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "included": [
    • {
      • "id": "01a11920-0167-7037-bb39-ebe4cda38e02",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "01a11920-0195-718c-a2da-fd7fafb5ed31",
      • "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. 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. See the various payload examples to understand the required fields for each possible request to this endpoint.

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": "0 21 12 8 4",
      • "new_commits_only": false,
      • "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
Example
{
  • "data": {
    • "id": "01a1191f-07ed-7875-af8e-030ebab17ee2",
    • "type": "scheduled_change",
    • "attributes": {
      • "created_by": "pablo-22",
      • "cron_schedule": "14 1 11 4 0",
      • "repeat": true,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "enabled": true,
      • "allow_parallel_execution": false,
      • "metadata": {
        },
      • "property_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "created_at": "2026-10-08T01:27:06.474033Z",
      • "updated_at": "2026-10-08T01:27:06.474033Z",
      • "next_run_at": "2027-04-03T14:14:00.000000Z",
      • "run_at": null,
      • "end_at": null,
      • "action": "override",
      • "new_commits_only": true,
      • "git_rev": "redundant",
      • "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/01a1191e-f8ef-79ce-8991-4e92a6c566e4",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/scheduled_activities/01a1191f-07ed-7875-af8e-030ebab17ee2"
      }
    }
}

Show activity

Shows a scheduled activity.

path Parameters
scheduled_change_id
required
string
Example: 01a1191f-07ed-7875-af8e-030ebab17ee2

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
Example
{
  • "data": {
    • "id": "01a1191f-07ed-7875-af8e-030ebab17ee2",
    • "type": "scheduled_change",
    • "attributes": {
      • "created_by": "pablo-22",
      • "cron_schedule": "14 1 11 4 0",
      • "repeat": true,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "enabled": true,
      • "allow_parallel_execution": false,
      • "metadata": {
        },
      • "property_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "created_at": "2026-10-08T01:27:06.474033Z",
      • "updated_at": "2026-10-08T01:27:06.474033Z",
      • "next_run_at": "2027-04-03T14:14:00.000000Z",
      • "run_at": null,
      • "end_at": null,
      • "action": "override",
      • "new_commits_only": true,
      • "git_rev": "redundant",
      • "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/01a1191e-f8ef-79ce-8991-4e92a6c566e4",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/scheduled_activities/01a1191f-07ed-7875-af8e-030ebab17ee2"
      }
    }
}

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. 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. See the various payload examples to understand the attributes you can supply to this endpoint.
  4. The payload need only consist of the attributes you wish to modify. There is no need to supply the entire scheduled activity.
path Parameters
scheduled_change_id
required
string
Example: 01a1191f-07ed-7875-af8e-030ebab17ee2

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": "52 20 13 9 *",
      • "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
Example
{
  • "data": {
    • "id": "01a1191f-07ed-7875-af8e-030ebab17ee2",
    • "type": "scheduled_change",
    • "attributes": {
      • "created_by": "pablo-22",
      • "cron_schedule": "14 1 11 4 0",
      • "repeat": true,
      • "run_count": 0,
      • "maximum_run_count": null,
      • "enabled": true,
      • "allow_parallel_execution": false,
      • "metadata": {
        },
      • "property_overrides": {
        },
      • "notify": {
        },
      • "skip_steps": [ ],
      • "created_at": "2026-10-08T01:27:06.474033Z",
      • "updated_at": "2026-10-08T01:27:06.474033Z",
      • "next_run_at": "2027-04-03T14:14:00.000000Z",
      • "run_at": null,
      • "end_at": null,
      • "action": "override",
      • "new_commits_only": true,
      • "git_rev": "redundant",
      • "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/01a1191e-f8ef-79ce-8991-4e92a6c566e4",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/scheduled_activities/01a1191f-07ed-7875-af8e-030ebab17ee2"
      }
    }
}

Delete activity

Delete a scheduled activity.

path Parameters
scheduled_change_id
required
string
Example: 01a1191f-07ed-7875-af8e-030ebab17ee2

scheduled change id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11921-b68f-7e15-baf2-78a23811cb57",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

Show step

Shows a change step.

path Parameters
step_id
required
string
Example: 01a1191f-0573-7e44-bc25-508ac1514f4a

step id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-b8d3-7e1b-8398-04a8a6f7a4e6",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": null,
      • "action": "reboot",
      • "change_id": "01a11921-b8ce-710e-9487-3695b21d2075",
      • "child_execution_strategy": "sequential",
      • "full_path": "reboot",
      • "ignore_failure": false,
      • "input_arguments": [ ],
      • "state_timing": {
        },
      • "step_sequence": 1,
      • "step_type": "standard",
      • "description": "Deploy the release to the environment",
      • "step_name": "reboot",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:19:16.569361Z",
      • "started_at": "2026-10-08T01:20:16.569361Z",
      • "finished_at": "2026-10-08T01:25:07.922742Z",
      • "updated_at": "2026-10-08T01:30:02.922021Z",
      • "status_code": "success"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a11921-b8ce-710e-9487-3695b21d2075",
      • "change": "/api/projects/opc/environments/dev/changes/01a11921-b8ce-710e-9487-3695b21d2075",
      • "log_lines": "/api/steps/01a11921-b8d3-7e1b-8398-04a8a6f7a4e6/log_lines",
      • "self": "/api/steps/01a11921-b8d3-7e1b-8398-04a8a6f7a4e6"
      },
    • "meta": {
      • "property_sources": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a11921-b82f-7d5a-bde0-501b871e25cd",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-b880-7c48-8eb9-793876814176",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-b8e6-7a08-b60f-2a600a5be70e",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-b91a-7def-9867-34735c3bb67c",
      • "type": "properties",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Continue step

Continues a "waiting" change step.

path Parameters
step_id
required
string
Example: 01a1191f-1f58-74ce-bf7b-63d1f4b84e7c

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": "01a11921-be8d-795d-aa08-88b7ab528fdc",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": null,
      • "action": "opschain_wait_step_2",
      • "change_id": "01a11921-be86-73a1-bf01-2b51926cdeb6",
      • "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-10-08T01:22:41.237371Z",
      • "started_at": "2026-10-08T01:23:41.237371Z",
      • "finished_at": "2026-10-08T01:30:05.466808Z",
      • "updated_at": "2026-10-08T01:30:05.510413Z",
      • "status_code": "success"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a11921-be86-73a1-bf01-2b51926cdeb6",
      • "change": "/api/projects/opc/environments/dev/changes/01a11921-be86-73a1-bf01-2b51926cdeb6",
      • "log_lines": "/api/steps/01a11921-be8d-795d-aa08-88b7ab528fdc/log_lines",
      • "self": "/api/steps/01a11921-be8d-795d-aa08-88b7ab528fdc"
      },
    • "meta": { }
    }
}

Approve step

Approves a change step that needs approval.

path Parameters
step_id
required
string
Example: 01a1191f-1f58-74ce-bf7b-63d1f4b84e7c

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": "01a11921-c82d-7d91-82ae-283291faf8e4",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": [
        ],
      • "action": "opschain_wait_step_4",
      • "change_id": "01a11921-c828-753b-9060-5457ec1a2a1d",
      • "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-10-08T01:19:33.351848Z",
      • "started_at": "2026-10-08T01:20:33.351848Z",
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:30:06.963183Z",
      • "status_code": "queued"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a11921-c828-753b-9060-5457ec1a2a1d",
      • "change": "/api/projects/opc/environments/dev/changes/01a11921-c828-753b-9060-5457ec1a2a1d",
      • "log_lines": "/api/steps/01a11921-c82d-7d91-82ae-283291faf8e4/log_lines",
      • "self": "/api/steps/01a11921-c82d-7d91-82ae-283291faf8e4"
      },
    • "meta": { }
    }
}

Reject step

Rejects a change step that needs approval.

path Parameters
step_id
required
string
Example: 01a1191f-1f58-74ce-bf7b-63d1f4b84e7c

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": "01a11921-cfe1-766b-b1b5-608f139de307",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": [
        ],
      • "action": "opschain_wait_step_7",
      • "change_id": "01a11921-cfdb-7e34-b2a6-843e4063e0b7",
      • "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-10-08T01:19:31.104632Z",
      • "started_at": "2026-10-08T01:20:31.104632Z",
      • "finished_at": "2026-10-08T01:30:08.862167Z",
      • "updated_at": "2026-10-08T01:30:08.882703Z",
      • "status_code": "aborted"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "pre_properties_versions": {
        },
      • "post_properties_versions": {
        },
      • "change": {
        }
      },
    • "links": {
      • "parent": "/api/changes/01a11921-cfdb-7e34-b2a6-843e4063e0b7",
      • "change": "/api/projects/opc/environments/dev/changes/01a11921-cfdb-7e34-b2a6-843e4063e0b7",
      • "log_lines": "/api/steps/01a11921-cfe1-766b-b1b5-608f139de307/log_lines",
      • "self": "/api/steps/01a11921-cfe1-766b-b1b5-608f139de307"
      },
    • "meta": { }
    }
}

Show step settings

Show the converged settings for the change containing this step, including any change-specific setting overrides. Only the values that differ from the global settings are returned: a setting whose converged value matches the global value is omitted, even when it is set directly on a node, so the response is empty when nothing differs from the global settings.

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

path Parameters
step_id
required
string
Example: 01a1191f-0573-7e44-bc25-508ac1514f4a

step id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-d6c8-771b-b11e-86137e6ae641",
    • "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: 01a1191f-0573-7e44-bc25-508ac1514f4a

step id

query Parameters
action_stage
string
Example: action_stage=pre

Converge the pre or post action properties

exclude_layers[]
string
Example: exclude_layers[]=template

Exclude a property layer from the converged result. Repeat the parameter to exclude several layers, e.g. > exclude_layers[]=template&exclude_layers[]=asset. Suffix a layer with _repository or _database to exclude only that half of it, e.g. > exclude_layers[]=asset_repository. The layers available for the node, and whether each one is currently included, are listed in the property_layers response meta. The template layer covers the properties files held under the <template code> folder of the template repository, as well as the template's database properties; the template_version layer covers the template version database properties only. Excluding a layer is a preview - the result is not cached and nothing is persisted.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "bypass (post)",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev/converged_properties"
      },
    • "meta": {
      • "property_sources": {
        },
      • "property_layers": [
        ]
      }
    },
  • "included": [
    • {
      • "id": "01a11921-da80-7987-97dc-c7f9d4b80609",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-dac6-75c7-ab08-e11b2bd9523e",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11921-db1f-7dd6-b279-e3cecd408319",
      • "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: 01a1191f-04e7-7e96-8ab6-54dc3b64fc90
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": "01a11921-acb7-7687-8d42-7d6ce502d458",
      • "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: 01a1191f-0573-7e44-bc25-508ac1514f4a
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": "01a11921-afcf-7e9c-86b6-570d2761a40b",
      • "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": "01a11921-b497-7891-a60c-cdd29168b867",
      • "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: 01a1191f-21a3-775e-ab9b-282712b0d799
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": "01a11922-3614-767a-aad9-8515afc862bb",
      • "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: 01a1191f-21c1-7924-af03-2ee1a1f32420
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": "01a11922-4642-7be0-8070-623cec14cb8f",
      • "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": "01a11922-51b9-7f9b-92cf-124ccc4e883d",
      • "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. /project/{project_code}/workflow_runs - will return all workflow runs for all this project's workflows.
    3. /project/{project_code}/workflows/{workflow_code}/workflow_runs - will return all workflow runs this workflow.
    4. /<path/to/asset>/workflow_runs - will return all workflow runs that include a change for this asset.

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": "01a11922-5862-7731-bf43-78eac0196957",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      },
    • {
      • "id": "01a11922-53d7-7db5-bcdf-44c309ff1a88",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "01a11922-5840-7de1-917d-4e9d6e9c3c26",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-5352-7633-bc72-28fab3e5f07c",
      • "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": "01a11922-5ebb-7418-8a0b-188bf819e3eb",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": { },
      • "created_by": "logged_in_user",
      • "cancelled_by": null,
      • "notify": { },
      • "skip_steps": [ ],
      • "pause_state": "none",
      • "status_code": "pending",
      • "paused": false,
      • "paused_by": [ ],
      • "created_at": "2026-10-08T01:30:45.306271Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:30:45.323206Z",
      • "paused_at": null,
      • "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/01a11922-5ebb-7418-8a0b-188bf819e3eb",
      • "log_lines": "/api/workflow_runs/01a11922-5ebb-7418-8a0b-188bf819e3eb/log_lines",
      • "pause": "/api/workflow_runs/01a11922-5ebb-7418-8a0b-188bf819e3eb/pause"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "01a11922-5aaf-7704-b5c9-c44d67bc8786",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-5ec7-7df7-aa64-432a5c4c339b",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-5ece-7c86-9504-8850aa868c0d",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show workflow run

Shows a workflow run.

path Parameters
run_id
required
string
Example: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-73ca-717c-870f-0a900f2c3c47",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": {
        },
      • "created_by": "josiah-3041",
      • "cancelled_by": null,
      • "notify": { },
      • "skip_steps": [ ],
      • "pause_state": "none",
      • "status_code": "success",
      • "paused": false,
      • "paused_by": [ ],
      • "created_at": "2026-10-08T01:30:50.697116Z",
      • "started_at": "2026-10-08T01:21:27.930040Z",
      • "finished_at": "2026-10-08T01:25:40.793318Z",
      • "updated_at": "2026-10-08T01:30:50.709283Z",
      • "paused_at": null,
      • "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/01a11922-73ca-717c-870f-0a900f2c3c47",
      • "log_lines": "/api/workflow_runs/01a11922-73ca-717c-870f-0a900f2c3c47/log_lines"
      },
    • "meta": {
      • "wait_queue": [ ],
      • "blocking_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "01a11922-7374-7bde-a7f4-cb21d3479d8d",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-73d1-7da9-9f12-ebbcca30f332",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-73dc-7078-b88b-70ad3a13dfc3",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-7688-73f9-b765-3658098aaa1e",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-7698-76ee-95a0-95091c9ccfc4",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-7744-7b45-a779-e510ac86e972",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-753c-7786-9c2e-194842358592",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Cancel workflow run

Cancels a workflow run.

path Parameters
run_id
required
string
Example: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Pause workflow run

Pauses a running workflow run. Steps already running finish, but no further steps are dispatched until the run is resumed.

path Parameters
run_id
required
string
Example: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "reason": "Holding this run until the database maintenance window closes"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-8bca-74ae-a0b9-434f18f5d58d",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": {
        },
      • "created_by": "easter_mitchell-3145",
      • "cancelled_by": null,
      • "notify": { },
      • "skip_steps": [ ],
      • "pause_state": "paused",
      • "status_code": "running",
      • "paused": true,
      • "paused_by": [
        ],
      • "created_at": "2026-10-08T01:30:56.841094Z",
      • "started_at": "2026-10-08T01:23:25.244694Z",
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:30:56.860250Z",
      • "paused_at": "2026-10-08T01:30:57.716259Z",
      • "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/01a11922-8bca-74ae-a0b9-434f18f5d58d",
      • "log_lines": "/api/workflow_runs/01a11922-8bca-74ae-a0b9-434f18f5d58d/log_lines",
      • "resume": "/api/workflow_runs/01a11922-8bca-74ae-a0b9-434f18f5d58d/resume"
      },
    • "meta": { }
    }
}

Resume workflow run

Resumes a paused workflow run, dispatching the steps that were held while it was paused.

path Parameters
run_id
required
string
Example: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "reason": "Maintenance window closed"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-9d73-72ec-9b6c-dd3b0b64c809",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": {
        },
      • "created_by": "floyd_kuhic-3221",
      • "cancelled_by": null,
      • "notify": { },
      • "skip_steps": [ ],
      • "pause_state": "none",
      • "status_code": "running",
      • "paused": false,
      • "paused_by": [
        ],
      • "created_at": "2026-10-08T01:31:01.362171Z",
      • "started_at": "2026-10-08T01:25:52.729336Z",
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:31:01.374273Z",
      • "paused_at": null,
      • "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/01a11922-9d73-72ec-9b6c-dd3b0b64c809",
      • "log_lines": "/api/workflow_runs/01a11922-9d73-72ec-9b6c-dd3b0b64c809/log_lines",
      • "pause": "/api/workflow_runs/01a11922-9d73-72ec-9b6c-dd3b0b64c809/pause"
      },
    • "meta": { }
    }
}

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": "01a11922-ae64-7320-9a53-987afaeb0f97",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "01a11922-adfd-77ac-ae05-595cf53ee83e",
      • "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": "01a11922-be30-78dc-8523-b5492bc83c26",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": { },
      • "created_by": "logged_in_user",
      • "cancelled_by": null,
      • "notify": { },
      • "skip_steps": [ ],
      • "pause_state": "none",
      • "status_code": "pending",
      • "paused": false,
      • "paused_by": [ ],
      • "created_at": "2026-10-08T01:31:09.743427Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:31:09.762606Z",
      • "paused_at": null,
      • "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/01a11922-be30-78dc-8523-b5492bc83c26",
      • "log_lines": "/api/workflow_runs/01a11922-be30-78dc-8523-b5492bc83c26/log_lines",
      • "pause": "/api/workflow_runs/01a11922-be30-78dc-8523-b5492bc83c26/pause"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "01a11922-b9da-7539-9e43-392744872330",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-be3e-7db3-a04a-a755256bc7fe",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-be47-7d88-9f51-77f1a21d3f5b",
      • "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: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-d1a3-74ee-abfa-e6cb6cf84ad3",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "scheduled": false,
      • "metadata": {
        },
      • "created_by": "dudley_price-3463",
      • "cancelled_by": null,
      • "notify": { },
      • "skip_steps": [ ],
      • "pause_state": "none",
      • "status_code": "success",
      • "paused": false,
      • "paused_by": [ ],
      • "created_at": "2026-10-08T01:31:14.722148Z",
      • "started_at": "2026-10-08T01:25:59.148403Z",
      • "finished_at": "2026-10-08T01:29:16.909654Z",
      • "updated_at": "2026-10-08T01:31:14.735843Z",
      • "paused_at": null,
      • "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/01a11922-d1a3-74ee-abfa-e6cb6cf84ad3",
      • "log_lines": "/api/workflow_runs/01a11922-d1a3-74ee-abfa-e6cb6cf84ad3/log_lines"
      },
    • "meta": {
      • "wait_queue": [ ],
      • "blocking_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "01a11922-d14c-7068-b693-aa1de76517ed",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-d1ab-78b0-b03a-2c860ca7d140",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-d1b8-7450-b6f6-6ab14faea120",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-d48a-7b7a-94c2-5764354d4295",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-d499-7d6a-93c3-06cf136724cd",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-d522-7269-acaf-8bd8c4bfd140",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-d340-7a85-960b-3955b52bc2b6",
      • "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: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11922-f330-7c8e-adec-6e2c06ed6ab8",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f33c-7e63-bdc4-cbbd459fabba",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f68e-7e34-b1cc-bafb6e12a78a",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f69d-7a09-b3a4-c71c01e446a3",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f734-7e12-9c31-730d9a103abb",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f869-757e-b10e-c48e694e5b08",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f876-76dc-a0f7-c257be7f6c2a",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f883-7fb7-8c31-2c125ac2b55b",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f517-7dbf-baad-2c82d17c00c6",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11922-f72d-7865-b603-09daab699d10",
      • "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: 01a1191f-2973-736c-b31a-20457f415adf

workflow step id

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    • "id": "01a1191f-2973-736c-b31a-20457f415adf",
    • "type": "workflow_change_step",
    • "attributes": {
      • "lock_version": 1,
      • "created_by": "lavone.stehr-130",
      • "name": "program",
      • "step_sequence": 5,
      • "status_code": "pending",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:27:15.056033Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:27:15.063165Z",
      • "action": "program",
      • "property_overrides": {
        }
      },
    • "relationships": {
      • "change": {
        },
      • "change_parent": {
        },
      • "action_template_version": {
        },
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a1191f-21a3-775e-ab9b-282712b0d799/steps/01a1191f-2973-736c-b31a-20457f415adf",
      • "log_lines": "/api/workflow_steps/01a1191f-2973-736c-b31a-20457f415adf/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a1191f-21a3-775e-ab9b-282712b0d799/steps/01a1191f-21c1-7924-af03-2ee1a1f32420",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1191f-21a3-775e-ab9b-282712b0d799"
      }
    }
}

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: 01a1191f-29c4-7757-b4dc-b823aedd0990

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": "01a11923-0eb5-778f-95ce-81bbff6aa9b5",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [
        ],
      • "requires_approval_from": null,
      • "lock_version": 3,
      • "created_by": "corrinne.zemlak-3720",
      • "name": "Wait",
      • "step_sequence": 8,
      • "status_code": "continued",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:21:56.953731Z",
      • "started_at": "2026-10-08T01:22:56.953731Z",
      • "finished_at": "2026-10-08T01:31:30.391331Z",
      • "updated_at": "2026-10-08T01:31:30.422442Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a11923-0990-766a-9995-44cf99b94725/steps/01a11923-0eb5-778f-95ce-81bbff6aa9b5",
      • "log_lines": "/api/workflow_steps/01a11923-0eb5-778f-95ce-81bbff6aa9b5/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a11923-0990-766a-9995-44cf99b94725/steps/01a11923-0999-751e-bdb9-cb457f9c5a3c",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a11923-0990-766a-9995-44cf99b94725"
      }
    }
}

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: 01a1191f-29de-796c-82aa-db835526be1b

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": "01a11923-247e-7235-8cb5-5981da56128e",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [
        ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "felicidad_huel-3819",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "approved",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:25:07.457238Z",
      • "started_at": "2026-10-08T01:26:07.457238Z",
      • "finished_at": "2026-10-08T01:31:35.964862Z",
      • "updated_at": "2026-10-08T01:31:35.989975Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a11923-1f83-7ddb-ab58-758cc1385cdb/steps/01a11923-247e-7235-8cb5-5981da56128e",
      • "log_lines": "/api/workflow_steps/01a11923-247e-7235-8cb5-5981da56128e/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a11923-1f83-7ddb-ab58-758cc1385cdb/steps/01a11923-1f8b-781d-83dc-6724fbbde663",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a11923-1f83-7ddb-ab58-758cc1385cdb"
      }
    }
}

Reject workflow step

Reject a workflow step that requires approval.

path Parameters
step_id
required
string
Example: 01a1191f-298c-7567-b248-78ef30df95d0

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": "01a11923-4191-75be-9b0c-5d2306383cd6",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [
        ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "rudy-3951",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "rejected",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:25:05.417470Z",
      • "started_at": "2026-10-08T01:26:05.417470Z",
      • "finished_at": "2026-10-08T01:31:43.405116Z",
      • "updated_at": "2026-10-08T01:31:43.413871Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a11923-3ca6-7d5e-a506-dbf4c64022fd/steps/01a11923-4191-75be-9b0c-5d2306383cd6",
      • "log_lines": "/api/workflow_steps/01a11923-4191-75be-9b0c-5d2306383cd6/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a11923-3ca6-7d5e-a506-dbf4c64022fd/steps/01a11923-3caf-766a-b24a-9da86ad3f0bc",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a11923-3ca6-7d5e-a506-dbf4c64022fd"
      }
    }
}

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: 01a1191f-21a3-775e-ab9b-282712b0d799

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": "01a11923-59a2-7359-a1c6-2114f60c7763",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-59b0-72db-b243-d1800d48f958",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5cad-79b4-9b4b-e724e153a1fc",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5cbf-7d85-a7e7-1a01e4a3a060",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5d68-7245-b658-0ad2e0040fbb",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5e91-7075-bbb5-72345b12d041",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5e9d-7d8f-9824-d58176e61844",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5eaa-7c12-a049-c2f5e3a06e93",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11923-5b47-72b3-a78c-8c9eec9a98fa",
      • "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: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

step_id
required
string
Example: 01a1191f-2973-736c-b31a-20457f415adf

workflow step id

Responses

Response samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    • "id": "01a1191f-2973-736c-b31a-20457f415adf",
    • "type": "workflow_change_step",
    • "attributes": {
      • "lock_version": 1,
      • "created_by": "lavone.stehr-130",
      • "name": "program",
      • "step_sequence": 5,
      • "status_code": "pending",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:27:15.056033Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2026-10-08T01:27:15.063165Z",
      • "action": "program",
      • "property_overrides": {
        }
      },
    • "relationships": {
      • "change": {
        },
      • "change_parent": {
        },
      • "action_template_version": {
        },
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a1191f-21a3-775e-ab9b-282712b0d799/steps/01a1191f-2973-736c-b31a-20457f415adf",
      • "log_lines": "/api/workflow_steps/01a1191f-2973-736c-b31a-20457f415adf/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a1191f-21a3-775e-ab9b-282712b0d799/steps/01a1191f-21c1-7924-af03-2ee1a1f32420",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a1191f-21a3-775e-ab9b-282712b0d799"
      }
    }
}

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: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

step_id
required
string
Example: 01a1191f-29c4-7757-b4dc-b823aedd0990

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": "01a11923-81df-7be0-9a69-9484204b3195",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [
        ],
      • "requires_approval_from": null,
      • "lock_version": 3,
      • "created_by": "jermaine.zemlak-4250",
      • "name": "Wait",
      • "step_sequence": 8,
      • "status_code": "continued",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:25:59.294563Z",
      • "started_at": "2026-10-08T01:26:59.294563Z",
      • "finished_at": "2026-10-08T01:31:59.874089Z",
      • "updated_at": "2026-10-08T01:31:59.892499Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a11923-7cfe-7424-98c6-fa0b163c1d0a/steps/01a11923-81df-7be0-9a69-9484204b3195",
      • "log_lines": "/api/workflow_steps/01a11923-81df-7be0-9a69-9484204b3195/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a11923-7cfe-7424-98c6-fa0b163c1d0a/steps/01a11923-7d06-7f4d-9634-102dffe45d8a",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a11923-7cfe-7424-98c6-fa0b163c1d0a"
      }
    }
}

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: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

step_id
required
string
Example: 01a1191f-29de-796c-82aa-db835526be1b

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": "01a11923-97f5-703a-a011-fcd1adc81527",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [
        ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "melba.schuster-4349",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "approved",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:23:47.105272Z",
      • "started_at": "2026-10-08T01:24:47.105272Z",
      • "finished_at": "2026-10-08T01:32:05.537615Z",
      • "updated_at": "2026-10-08T01:32:05.559856Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a11923-9269-773c-a97e-a5c49454c61a/steps/01a11923-97f5-703a-a011-fcd1adc81527",
      • "log_lines": "/api/workflow_steps/01a11923-97f5-703a-a011-fcd1adc81527/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a11923-9269-773c-a97e-a5c49454c61a/steps/01a11923-9270-7d49-9e20-069dfeb27933",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a11923-9269-773c-a97e-a5c49454c61a"
      }
    }
}

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: 01a1191f-21a3-775e-ab9b-282712b0d799

workflow run id

step_id
required
string
Example: 01a1191f-298c-7567-b248-78ef30df95d0

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": "01a11923-bc1a-70be-9865-a911015a4069",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [
        ],
      • "continued_by": [ ],
      • "requires_approval_from": {
        },
      • "lock_version": 3,
      • "created_by": "fritz_stracke-4481",
      • "name": "Approval",
      • "step_sequence": 8,
      • "status_code": "rejected",
      • "skip_requested": false,
      • "created_at": "2026-10-08T01:23:53.222912Z",
      • "started_at": "2026-10-08T01:24:53.222912Z",
      • "finished_at": "2026-10-08T01:32:14.804724Z",
      • "updated_at": "2026-10-08T01:32:14.814170Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/01a11923-b661-7ba8-a56c-0b05809cec18/steps/01a11923-bc1a-70be-9865-a911015a4069",
      • "log_lines": "/api/workflow_steps/01a11923-bc1a-70be-9865-a911015a4069/log_lines",
      • "parent": "/api/projects/opc/workflows/assets/runs/01a11923-b661-7ba8-a56c-0b05809cec18/steps/01a11923-b66b-752f-9f84-be1b1b2f2bcc",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/01a11923-b661-7ba8-a56c-0b05809cec18"
      }
    }
}

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": "01a11920-a15d-744b-a3fd-9ce51ba415c0",
      • "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": "01a11920-a23b-7f84-a0b0-7e121e2d3063",
    • "type": "event",
    • "attributes": {
      • "some": "event data",
      • "username": "logged_in_user",
      • "system": false,
      • "type": "my event",
      • "event_node_path": null,
      • "created_at": "2026-10-08T01:28:51.515040Z"
      },
    • "relationships": {
      • "source": {
        }
      },
    • "links": {
      • "self": "/api/events/01a11920-a23b-7f84-a0b0-7e121e2d3063"
      }
    }
}

Show event

Shows an event.

path Parameters
event_id
required
string
Example: 01a1191f-1a9d-774e-bcf2-b14320a2e03e

event id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-a4ce-7727-8392-48c80834ccde",
    • "type": "event",
    • "attributes": {
      • "nested": {
        },
      • "any_key": "with a value",
      • "another_key": "with a different value",
      • "username": "megan",
      • "system": false,
      • "type": "my custom event",
      • "event_node_path": "/projects/opc",
      • "created_at": "2026-10-08T01:28:52.173275Z"
      },
    • "relationships": {
      • "source": {
        }
      },
    • "links": {
      • "self": "/api/events/01a11920-a4ce-7727-8392-48c80834ccde"
      }
    }
}

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": "01a11920-93c3-783f-b0a4-2585c4600380",
      • "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": "01a11920-96fb-7f8f-b679-b8ddf51025d9",
    • "type": "event_filter",
    • "attributes": {
      • "rules": {
        },
      • "code": "852it",
      • "description": "Omnis consequatur ut perferendis.",
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:28:48.634954Z",
      • "updated_at": "2026-10-08T01:28:48.634954Z"
      },
    • "links": {
      • "self": "/api/event_filters/852it",
      • "subscribers": "/api/event_filters/852it/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": "01a11920-9b55-74ff-bee0-6c2e7b4982c9",
    • "type": "event_filter",
    • "attributes": {
      • "rules": {
        },
      • "code": "change_success",
      • "description": "Filter for successful changes in dev",
      • "created_by": "opschain",
      • "created_at": "2026-10-08T01:28:49.748638Z",
      • "updated_at": "2026-10-08T01:28:49.748638Z"
      },
    • "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": "01a11920-9d44-755d-996e-f882fe03cb76",
    • "type": "event_filter",
    • "attributes": {
      • "rules": {
        },
      • "code": "change_success",
      • "description": "hello world errors filter",
      • "created_by": "opschain",
      • "created_at": "2026-10-08T01:28:50.243444Z",
      • "updated_at": "2026-10-08T01:28:50.259419Z"
      },
    • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11920-a6d0-7659-8bc8-c10687336cff",
      • "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": "01a11920-a8e9-7f59-9c5e-e7d29d055d5a",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": {
        },
      • "enabled": true,
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:28:53.224565Z",
      • "updated_at": "2026-10-08T01:28:53.224565Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a11920-a8e9-7f59-9c5e-e7d29d055d5a"
      }
    }
}

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": "01a11920-ad95-72f1-9b3d-ea719ec94753",
      • "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": "01a11920-b00a-709b-a031-7d34b75be386",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": {
        },
      • "enabled": true,
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:28:55.048879Z",
      • "updated_at": "2026-10-08T01:28:55.048879Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a11920-b00a-709b-a031-7d34b75be386"
      }
    }
}

Show event subscriber

Show an event subscriber.

path Parameters
event_subscriber_id
required
string
Example: 01a1191f-1b08-7156-b22d-a589943a4170

event subscriber id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-b3c7-79ab-a2f4-4ea0193760f9",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": { },
      • "enabled": true,
      • "created_by": "darwin-1547",
      • "created_at": "2026-10-08T01:28:56.006866Z",
      • "updated_at": "2026-10-08T01:28:56.006866Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a11920-b3c7-79ab-a2f4-4ea0193760f9"
      }
    }
}

Update event subscriber

Update an event subscriber.

path Parameters
event_subscriber_id
required
string
Example: 01a1191f-1b08-7156-b22d-a589943a4170

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": "01a11920-b75a-73bc-a35f-b6354840fe85",
    • "type": "event_subscriber",
    • "attributes": {
      • "channel_kwargs": {
        },
      • "enabled": false,
      • "created_by": "steven.ebert-1559",
      • "created_at": "2026-10-08T01:28:56.921248Z",
      • "updated_at": "2026-10-08T01:28:56.959658Z"
      },
    • "relationships": {
      • "event_filter": {
        },
      • "notification_channel": {
        }
      },
    • "links": {
      • "self": "/api/event_subscribers/01a11920-b75a-73bc-a35f-b6354840fe85"
      }
    }
}

Delete event subscriber

Delete an event subscriber.

path Parameters
event_subscriber_id
required
string
Example: 01a1191f-1b08-7156-b22d-a589943a4170

event subscriber id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11921-2e70-7663-aa53-1e71b19e74e4",
      • "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": "01a11921-2f64-78d9-8e87-85b2ff3dd305",
    • "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-10-08T01:29:27.651201Z",
      • "updated_at": "2026-10-08T01:29:27.651201Z",
      • "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": "01a11921-311e-7401-a42a-33db30f6abab",
    • "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": "01a11921-331e-7a01-b73a-021d6987eec6",
    • "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": "stanley-1989",
      • "created_at": "2026-10-08T01:29:28.599367Z",
      • "updated_at": "2026-10-08T01:29:28.599367Z",
      • "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": "01a11921-34d1-74be-bf7b-83535c558cd0",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "slack",
      • "code": "system_email",
      • "description": "New channel description",
      • "default_channel": false,
      • "internal": false,
      • "enabled": false,
      • "kwargs": {},
      • "created_by": "rosetta_hermann-1991",
      • "created_at": "2026-10-08T01:29:29.040196Z",
      • "updated_at": "2026-10-08T01:29:29.070050Z",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11921-39a8-7d9a-bcda-9e478702f1b4",
      • "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": "01a11921-3a5c-7f6b-97e7-d441b334f5d0",
    • "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": "janette-2003",
      • "created_at": "2026-10-08T01:29:30.460273Z",
      • "updated_at": "2026-10-08T01:29:30.460273Z",
      • "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": "01a11921-3bdf-7f27-b730-30226c3c7eea",
    • "type": "notification_channel",
    • "attributes": {
      • "format": "slack",
      • "code": "project_direct",
      • "description": "New channel description",
      • "default_channel": false,
      • "internal": false,
      • "enabled": false,
      • "kwargs": {},
      • "created_by": "vena_cruickshank-2011",
      • "created_at": "2026-10-08T01:29:30.846694Z",
      • "updated_at": "2026-10-08T01:29:30.871198Z",
      • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a11921-4281-7bac-8ca5-2b6b107dc372",
      • "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": "01a11921-4364-72bf-9a5a-a0f3fc625f02",
    • "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-10-08T01:29:32.770722Z",
      • "updated_at": "2026-10-08T01:29:32.770722Z",
      • "all_kwargs": [
        ]
      },
    • "relationships": {
      • "notification_channels": {
        }
      },
    • "links": {
      • "self": "/api/notification_jobs/email_job"
      }
    }
}

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": "807756",
      • "type": "job",
      • "attributes": {
        }
      },
    • {
      • "id": "902786",
      • "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: 01a1191e-f8aa-71f6-bf6f-0b6fd818916a

settings id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-a23f-7849-8309-f216659661c6",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-10-08T01:29:57.054786Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/01a11921-a23f-7849-8309-f216659661c6",
      • "current_version": "/api/settings/01a11921-a23f-7849-8309-f216659661c6/versions/1",
      • "versions": "/api/settings/01a11921-a23f-7849-8309-f216659661c6/versions"
      }
    }
}

Update settings

Updates a settings JSON if the included version matches the current settings version.

path Parameters
id_to_update
required
string
Example: 01a1191e-f8aa-71f6-bf6f-0b6fd818916a

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": "01a11921-a39f-7264-b800-752389d53f4c",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-10-08T01:29:57.405612Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/01a11921-a39f-7264-b800-752389d53f4c",
      • "current_version": "/api/settings/01a11921-a39f-7264-b800-752389d53f4c/versions/1",
      • "versions": "/api/settings/01a11921-a39f-7264-b800-752389d53f4c/versions"
      }
    }
}

Update settings (unsafe)

Updates a settings JSON, without any version checking (always updates).

path Parameters
id_to_set
required
string
Example: 01a1191e-f8aa-71f6-bf6f-0b6fd818916a

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": "01a11921-a64d-7dc8-b3bb-3bc8e77b46cb",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-10-08T01:29:58.092962Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/01a11921-a64d-7dc8-b3bb-3bc8e77b46cb",
      • "current_version": "/api/settings/01a11921-a64d-7dc8-b3bb-3bc8e77b46cb/versions/1",
      • "versions": "/api/settings/01a11921-a64d-7dc8-b3bb-3bc8e77b46cb/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: 01a1191e-f8aa-71f6-bf6f-0b6fd818916a

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.

exclude_data
boolean
Default: false
Example: exclude_data=true

Exclude the data attribute from each of the settings versions returned. Use the show endpoint to fetch the data for an individual version.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a11921-a879-7d09-ae36-fd129e31cdef",
      • "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: 01a1191e-f8aa-71f6-bf6f-0b6fd818916a

settings id

version_number
required
integer
Example: 1

version number

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-aa88-70ab-a1aa-ed2a5f45c989",
    • "type": "settings_version",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2026-10-08T01:29:59.175231Z"
      },
    • "relationships": {
      • "settings": {
        }
      },
    • "links": {
      • "versions": "/api/settings/01a11921-aa84-70dd-9b4f-78897fd184ed/versions",
      • "owner": "/api/projects/opc",
      • "self": "/api/settings/01a11921-aa84-70dd-9b4f-78897fd184ed/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": "01a1191f-e521-7c81-9b22-e5f5be48b38f",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-e746-7639-a1df-0758f814455f",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-e756-70e5-9a1a-6ab2808e729e",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-e7a9-74ce-add4-677d6750c49e",
      • "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": "01a1191f-ea60-7fd4-addf-87dbddacfab5",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "transmit",
      • "path": "^/projects/pvcup/environments/dwpow",
      • "readable": false,
      • "updatable": false,
      • "deletable": false,
      • "executable": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:28:04.448088Z",
      • "updated_at": "2026-10-08T01:28:04.448088Z"
      },
    • "relationships": {
      • "authorisation_policies": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/01a1191f-ea60-7fd4-addf-87dbddacfab5"
      }
    }
}

Show rule

Shows an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 01a1191f-06a9-76f3-8a21-2644de6c65aa

authorisation rule id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-eed9-7545-b5fb-be61edd99a60",
    • "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-10-08T01:28:05.592620Z",
      • "updated_at": "2026-10-08T01:28:05.592620Z"
      },
    • "relationships": {
      • "authorisation_policies": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/01a1191f-eed9-7545-b5fb-be61edd99a60"
      }
    }
}

Update authorisation rule

Update an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 01a1191f-06a9-76f3-8a21-2644de6c65aa

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": "01a1191f-f53d-7b00-8c72-7016870ed664",
    • "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-10-08T01:28:07.228813Z",
      • "updated_at": "2026-10-08T01:28:07.405359Z"
      },
    • "relationships": {
      • "authorisation_policies": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/01a1191f-f53d-7b00-8c72-7016870ed664"
      }
    }
}

Delete rule

Delete an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 01a1191f-06a9-76f3-8a21-2644de6c65aa

authorisation rule id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a1191f-c7a6-777f-a43a-1cd26b724d5e",
      • "type": "authorisation_policy",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-caf2-7520-8aea-81d93bee4aab",
      • "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": "cletus_damore",
      • "description": "Nesciunt dolorem assumenda rerum.",
      • "authorisation_rules": [
        ]
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-cf68-7504-b605-2f08b04f1969",
    • "type": "authorisation_policy",
    • "attributes": {
      • "name": "albert.schroeder",
      • "description": "Et odio qui saepe.",
      • "system": false,
      • "created_by": "logged_in_user",
      • "created_at": "2026-10-08T01:27:57.543456Z",
      • "updated_at": "2026-10-08T01:27:57.543456Z"
      },
    • "relationships": {
      • "policy_rules": {
        },
      • "policy_assignments": {
        },
      • "authorisation_rules": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a1191f-cf68-7504-b605-2f08b04f1969",
      • "policy_rules": "/api/authorisation_policies/01a1191f-cf68-7504-b605-2f08b04f1969/rules",
      • "policy_assignments": "/api/authorisation_policies/01a1191f-cf68-7504-b605-2f08b04f1969/assignments"
      }
    }
}

Show policy

Shows an authorisation policy.

path Parameters
authorisation_policy_id
required
string
Example: 01a1191f-06e3-7267-aa26-41aae3c56293

authorisation policy id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-d422-7564-bd31-6b729a9b53e8",
    • "type": "authorisation_policy",
    • "attributes": {
      • "name": "New users policy",
      • "description": "Access for all incoming users",
      • "system": false,
      • "created_by": "maragret.muller-680",
      • "created_at": "2026-10-08T01:27:58.753469Z",
      • "updated_at": "2026-10-08T01:27:58.753469Z"
      },
    • "relationships": {
      • "policy_rules": {
        },
      • "policy_assignments": {
        },
      • "authorisation_rules": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a1191f-d422-7564-bd31-6b729a9b53e8",
      • "policy_rules": "/api/authorisation_policies/01a1191f-d422-7564-bd31-6b729a9b53e8/rules",
      • "policy_assignments": "/api/authorisation_policies/01a1191f-d422-7564-bd31-6b729a9b53e8/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: 01a1191f-06e3-7267-aa26-41aae3c56293

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": "keith",
      • "description": "Quos aspernatur quia earum.",
      • "authorisation_rules": [
        ]
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-da15-71ed-858e-663080a18b62",
    • "type": "authorisation_policy",
    • "attributes": {
      • "name": "Updated policy name",
      • "description": "Access for all incoming users",
      • "system": false,
      • "created_by": "carroll_hayes-708",
      • "created_at": "2026-10-08T01:28:00.276230Z",
      • "updated_at": "2026-10-08T01:28:00.377933Z"
      },
    • "relationships": {
      • "policy_rules": {
        },
      • "policy_assignments": {
        },
      • "authorisation_rules": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a1191f-da15-71ed-858e-663080a18b62",
      • "policy_rules": "/api/authorisation_policies/01a1191f-da15-71ed-858e-663080a18b62/rules",
      • "policy_assignments": "/api/authorisation_policies/01a1191f-da15-71ed-858e-663080a18b62/assignments"
      }
    }
}

Delete policy

Delete an authorisation policy.

path Parameters
authorisation_policy_id
required
string
Example: 01a1191f-06e3-7267-aa26-41aae3c56293

authorisation policy id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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: 01a1191f-06e3-7267-aa26-41aae3c56293

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": "01a11921-573c-78e5-8814-59cf798be5fc",
      • "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: 01a1191f-06e3-7267-aa26-41aae3c56293

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": "01a11921-5a5c-753b-84aa-53546b080da0",
      • "type": "policy_assignment",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}

Show assignment

Show a policy assignment for a specific authorisation policy.

path Parameters
authorisation_policy_id
required
string
Example: 01a1191f-06e3-7267-aa26-41aae3c56293

authorisation policy id

policy_assignment_id
required
string
Example: 01a1191f-072c-77e1-a640-fef44fe1a892

policy assignment id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-5f89-7894-8ffd-8732d8370d17",
    • "type": "policy_assignment",
    • "attributes": {
      • "username": "opschain",
      • "auth_provider": "local",
      • "groupname": "ldap-group",
      • "created_by": "salome-2143",
      • "created_at": "2026-10-08T01:29:39.976488Z",
      • "updated_at": "2026-10-08T01:29:39.976488Z"
      },
    • "links": {
      • "self": "/api/authorisation_policies/01a11921-5f67-76d1-aa51-10b4e6e250f3/assignments/01a11921-5f89-7894-8ffd-8732d8370d17"
      }
    }
}

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: 01a1191f-06e3-7267-aa26-41aae3c56293

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": "01a11921-650d-7ada-b8b9-7afa64edbdb8",
      • "type": "policy_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a11921-6513-7fcc-8e51-3851dde65ddf",
      • "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: 01a1191f-06e3-7267-aa26-41aae3c56293

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": "01a1191f-06a9-76f3-8a21-2644de6c65aa"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a11921-6760-78c6-a869-aa640f091d71",
      • "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: 01a1191f-06e3-7267-aa26-41aae3c56293

authorisation policy id

policy_rule_id
required
string
Example: 01a1191f-06fe-7c37-99f2-63c03d9a8f9a

policy rule id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": "01a1191f-c030-717c-bbe8-61f8890a06a8",
      • "type": "authentication_token",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "01a1191f-bfdc-7f39-988e-1c64eebf4f47",
      • "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": "01a1191f-c147-7bd3-b2d2-f035726b2a60",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "AccessToken",
      • "expires_at": "2026-10-08T05:27:53.000000Z",
      • "created_at": "2026-10-08T01:27:53.845448Z",
      • "updated_at": "2026-10-08T01:27:53.845448Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a1191f-c147-7bd3-b2d2-f035726b2a60"
      },
    • "meta": {
      • "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWExMTkxZi1jMTQ3LTdiZDMtYjJkMi1mMDM1NzI2YjJhNjAiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTc5MTQzNzI3MywiaWF0IjoxNzkxNDIyODczfQ.9bIVQoAn9x7JsZjpXNXl0-w60PpcwkDDSTliNlyhqwI"
      }
    }
}

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-04-08T01:27:06.119616Z"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-c215-72be-9f15-75d4d2d64e71",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "ApiKeyToken",
      • "description": "Ipsum ut cum eos.",
      • "expires_at": "2026-10-22T23:59:59.999999Z",
      • "created_at": "2026-10-08T01:27:54.132157Z",
      • "updated_at": "2026-10-08T01:27:54.132157Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a1191f-c215-72be-9f15-75d4d2d64e71"
      },
    • "meta": {
      • "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWExMTkxZi1jMjE1LTcyYmUtOWYxNS03NWQ0ZDJkNjRlNzEiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTc5MjcxMzU5OSwiaWF0IjoxNzkxNDIyODc0fQ.C9_5UVlYS8d9B_G3GY6V_VOMVtxq9b_iq0hR7WXt67c"
      }
    }
}

Create download token

Returns a URL that downloads the supplied API URL without an Authorization header, for use as a browser link.

Notes:

  • The url must be a relative API URL that includes the download query parameter.
  • The returned URL appends a download_token query parameter that is valid for 60 seconds, for that exact URL and only for as long as the access token used to create it remains valid.
  • Only a request authenticated with an access token can create a download token.
Authorizations:
bearerAuth
header Parameters
Authorization
required
string

access token bearer authorisation

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "url": "/api/activities?download=activities.csv"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "meta": {
    • "download_url": "/api/activities?download=activities.csv&download_token=eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW5faWQiOiIwMWExMTkxZi1jMzEzLTczMzEtYjVlMi04MGRjMjFlYmZkNzUiLCJhdWQiOiJvcHNjaGFpbl9kb3dubG9hZCIsImV4cCI6MTc5MTQyMjkzNCwiaWF0IjoxNzkxNDIyODc0LCJyZXEiOiI0NDkxY2EwZjFiMjZkMzBmZjIxZWIzYmYzYzQ0ZGFhNzE0N2NmNWFhYmJjYzg1MzJhNDE3YWU1N2Q5MjU0YzNiIn0.2xZ7vcv59XB8RwHDUu9d92N0Ue9_MGRqviMFDyaBkjg"
    }
}

Show token

Show an authorisation token.

path Parameters
token_id
required
string
Example: 01a1191f-0686-70f1-8b8e-4944b5d08e78

authorisation token id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a1191f-c3ca-76c4-8151-f8cadf3a99a6",
    • "type": "authentication_token",
    • "attributes": {
      • "type": "ApiKeyToken",
      • "description": "CI token for API access",
      • "expires_at": "2027-04-08T01:27:54.564501Z",
      • "created_at": "2026-10-08T01:27:54.568991Z",
      • "updated_at": "2026-10-08T01:27:54.568991Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/tokens/01a1191f-c3ca-76c4-8151-f8cadf3a99a6"
      }
    }
}

Delete token

Delete an authorisation token if it exists.

path Parameters
token_id
required
string
Example: 01a1191f-0686-70f1-8b8e-4944b5d08e78

authorisation token id

Responses

Show access token

Shows the access token used to authenticate the request. When the request authenticates with a username and password instead of a token, returns an array of all the current user's access tokens.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a1191f-c635-72a2-a705-74668038f94c",
      • "type": "authentication_token",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Delete access token

Deletes the access token used to authenticate the request. When the request authenticates with a username and password instead of a token, deletes all the current user's access tokens.

Responses

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": "01a11922-2ac8-792c-a99c-93ed350f7411",
      • "type": "user",
      • "attributes": {
        },
      • "meta": { },
      • "links": {
        }
      }
    ]
}

Show user

Show a user.

path Parameters
user_id
required
string
Example: 01a1191e-f5a7-7997-8966-5e03d0adf605

user id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-2b62-79d9-8b0f-71a77b5a2f33",
    • "type": "user",
    • "attributes": {
      • "username": "logged_in_user",
      • "groupnames": [
        ],
      • "auth_provider": "ldap",
      • "email_address": "logged_in_user@limepoint.com",
      • "display_name": null,
      • "first_name": null,
      • "last_name": null,
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        },
      • "created_at": "2026-10-08T01:30:32.161635Z",
      • "updated_at": "2026-10-08T01:30:32.161635Z"
      },
    • "meta": {
      • "superuser": true
      },
    • "links": {
      • "self": "/api/users/01a11922-2b62-79d9-8b0f-71a77b5a2f33"
      }
    }
}

Update user

Update a user's notification preferences, and a local user's names.

path Parameters
user_id
required
string
Example: 01a1191e-f5a7-7997-8966-5e03d0adf605

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",
      • "display_name": "Jane Citizen",
      • "first_name": "Jane",
      • "last_name": "Citizen",
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        }
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-2c72-73f3-a3d4-9382c259f713",
    • "type": "user",
    • "attributes": {
      • "username": "logged_in_user",
      • "groupnames": [
        ],
      • "auth_provider": "ldap",
      • "email_address": "logged_in_user@limepoint.com",
      • "display_name": null,
      • "first_name": null,
      • "last_name": null,
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        },
      • "created_at": "2026-10-08T01:30:32.433289Z",
      • "updated_at": "2026-10-08T01:30:32.497391Z"
      },
    • "meta": { },
    • "links": {
      • "self": "/api/users/01a11922-2c72-73f3-a3d4-9382c259f713"
      }
    }
}

Show current user

Show the currently logged in user.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11922-2df5-7ae3-bfe3-b69ef0750371",
    • "type": "user",
    • "attributes": {
      • "username": "logged_in_user",
      • "groupnames": [
        ],
      • "auth_provider": "ldap",
      • "email_address": "logged_in_user@limepoint.com",
      • "display_name": null,
      • "first_name": null,
      • "last_name": null,
      • "default_notification_methods": [
        ],
      • "direct_message_ids": {
        },
      • "created_at": "2026-10-08T01:30:32.820616Z",
      • "updated_at": "2026-10-08T01:30:32.820616Z"
      },
    • "meta": {
      • "superuser": true
      },
    • "links": {
      • "self": "/api/users/01a11922-2df5-7ae3-bfe3-b69ef0750371"
      }
    }
}

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": "01a11921-44a4-7b85-bb0a-8daa5ee83244",
      • "type": "change_notifications",
      • "attributes": {
        }
      },
    • {
      • "id": "01a11921-44a4-7b85-bb0a-8daa5ee83244",
      • "type": "settings_notifications",
      • "attributes": {
        }
      },
    • {
      • "id": "01a11921-44a4-7b85-bb0a-8daa5ee83244",
      • "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": "01a11921-47d4-761d-9510-d3ea509e047b",
    • "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": "01a11921-4b10-70a8-98d9-2cbed6ec0ebf",
    • "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: 01a1191e-f5a7-7997-8966-5e03d0adf605

user id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-4dd4-754e-88b7-327d26f35129",
    • "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": "01a1191f-043b-7f8b-afd4-62e9a81e73f6",
      • "source": "settings",
      • "mintmodel_owner_path": "/projects/opc/assets/prj_soa",
      • "converge_date": "2026-10-08T01:27:12.331708Z",
      • "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": "01a1191f-0421-7e06-b3bc-a62e8988f39d",
      • "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": "01a1191f-0421-7e06-b3bc-a62e8988f39d",
      • "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"

01a11921-a17e-7e16-a86a-e9189f9fbd91
------------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": {
        },
      • "maintenance_mode": false,
      • "maintenance_mode_exempts_superusers": false
      },
    • "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-10-08T01:30:31.094256Z",
      • "updated_at": "2026-10-08T01:30:31.094256Z"
      },
    • "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-10-08T01:30:31.223976Z",
      • "updated_at": "2026-10-08T01:30:31.223976Z"
      },
    • "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
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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-10-08T01:30:31.810367Z",
      • "updated_at": "2026-10-08T01:30:31.810367Z"
      },
    • "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": "01a11921-f2b4-7013-be7a-cf26852f2156",
    • "type": "system_configuration",
    • "attributes": {
      • "code": "system",
      • "name": "System Configuration",
      • "description": "System configuration node"
      },
    • "relationships": {
      • "settings": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/system_configuration",
      • "settings": "/api/settings/01a11921-f2c6-7dc7-8a02-deda0fe3449c",
      • "properties": "/api/properties/01a11921-f2bb-76d3-8f1b-fdabdeb6d86f"
      },
    • "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": "01a11921-f2c6-7dc7-8a02-deda0fe3449c",
      • "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": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "cordon": true
      }
    }
}

Cordon or uncordon a site

Cordons a site so it takes no new work, or uncordons it so it takes work again. Work already running in a cordoned site carries on there until it finishes, including its running agents, and is reported in each site's work_in_progress. A site cannot be cordoned while no other site is taking work.

path Parameters
name
required
string

The name of the site (its database cluster)

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "cordoned": true,
      • "cordon_reason": "Disaster recovery test"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "opschain-db",
    • "type": "cluster",
    • "attributes": {
      • "name": "opschain-db",
      • "role": "primary",
      • "cordon_reason": "Disaster recovery test",
      • "consuming_work": true,
      • "cordoned": true,
      • "cordoned_by": "logged_in_user",
      • "replication_status": "primary",
      • "replication_lag_seconds": null,
      • "work_in_progress": {
        },
      • "last_worker_seen_at": "2026-10-08T01:27:26.045989Z",
      • "api_started_at": "2026-10-08T01:27:26.045087Z",
      • "cordoned_at": "2026-10-08T01:27:26.068009Z"
      }
    }
}

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 whether OpsChain is currently drained of in-flight work

Returns whether the OpsChain instance is currently drained (no active changes, workflow runs, or node background tasks), along with the active count for each. Intended to be checked before proceeding with a maintenance-mode upgrade window, to confirm nothing is still in-flight.

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "0",
      • "type": "drain_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": "01a11920-71e1-7fd8-b62d-5b8d6490071b",
      • "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. Either the cron_schedule or run_at fields must be provided.
  3. The keys accepted for the filters field are changes, events, jobs, workflow_runs, node_background_tasks, and artefacts. The agent image cleanup job accepts template_version_history and build_agent_image_tasks. Each of these can have ransack filters for the specific type they refer to, except artefacts, whose size_tiers shape is documented separately below. IMPORTANT: If no filters are provided for a data type, the cleanup will remove all data that matches the node paths.
  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. 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. The purge_artefacts field removes old artefact versions once they exceed a size-tiered retention policy, given via filters.artefacts.size_tiers: an array of { up_to, keep_versions, keep_days } objects, ordered by increasing size. up_to is a Kubernetes-style quantity string (e.g. "10Mi") giving the tier's inclusive upper size bound, or null for the catch-all tier covering anything larger. An artefact version is purged only once it both exceeds its own tier's keep_versions (ranked newest-first per node/code) and is older than its tier's keep_days. When purge_artefacts is true, filters.artefacts.size_tiers must contain at least one tier, otherwise the request is rejected with a 422 error on filters; it is optional when purge_artefacts is false.
  7. The analyze_statistics field refreshes the PostgreSQL planner statistics of any table whose statistics are stale, after the purges have run. It applies to the whole database, so the node_paths and filters fields are ignored for it.
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "name": "matrix",
      • "enabled": true,
      • "node_paths": [ ],
      • "filters": { },
      • "purge_activities": false,
      • "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": true,
      • "purge_node_background_tasks": false,
      • "analyze_statistics": false,
      • "purge_artefacts": false
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-7f78-7751-b48c-db26979b9f3d",
    • "type": "data_cleanup_definition",
    • "attributes": {
      • "name": "capacitor",
      • "enabled": true,
      • "created_by": "logged_in_user",
      • "cron_schedule": "0 2 * * *",
      • "repeat": true,
      • "maximum_run_count": null,
      • "purge_activities": true,
      • "purge_events": false,
      • "purge_jobs": true,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": false,
      • "purge_artefacts": false,
      • "analyze_statistics": true,
      • "filters": {
        },
      • "node_paths": [ ],
      • "run_count": 0,
      • "created_at": "2026-10-08T01:28:42.615171Z",
      • "updated_at": "2026-10-08T01:28:42.615171Z",
      • "next_run_at": "2026-10-08T15:00:00.000000Z",
      • "run_at": null,
      • "end_at": null
      },
    • "links": {
      • "self": "/api/data_cleanup_definitions/01a11920-7f78-7751-b48c-db26979b9f3d"
      }
    },
  • "meta": {
    • "authorisations": {
      • "update": true,
      • "delete": true
      }
    }
}

Preview an artefact retention policy

Reports how many artefact versions, and how many bytes, a purge_artefacts retention policy would purge for the supplied node paths and size tiers, without purging anything.

Notes:

  1. The node_paths and filters.artefacts.size_tiers attributes have the same shape and validation as when creating a data cleanup definition with purge_artefacts set to true.
  2. At least one size tier is required.
  3. The counts are those that a purge run at the time of the request would remove: a version is counted only if it is beyond its tier's keep_versions newest versions per node and artefact code, and is older than its tier's keep_days.
  4. The result is returned in the top level meta object. meta.tiers lists each tier, in order of increasing size, with the versions and bytes it would purge. meta.totals sums them across all tiers.
  5. This endpoint requires the same authorisation as creating a data cleanup definition.
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "node_paths": [
        ],
      • "filters": {
        }
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": null,
  • "meta": {
    • "tiers": [
      • {
        },
      • {
        }
      ],
    • "totals": {
      • "versions": 0,
      • "bytes": 0
      }
    }
}

Show a data cleanup definition

Shows a data cleanup definition.

path Parameters
data_cleanup_definition_id
required
string
Example: 01a1191f-19ac-7924-bc71-ea6f2584725a

data cleanup definition id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11920-887b-7a83-863b-e4dbc7f39a77",
    • "type": "data_cleanup_definition",
    • "attributes": {
      • "name": "protocol",
      • "enabled": true,
      • "created_by": "santos_nienow-1380",
      • "cron_schedule": "0 0 7,14,21,28 * *",
      • "repeat": true,
      • "maximum_run_count": null,
      • "purge_activities": true,
      • "purge_events": false,
      • "purge_jobs": false,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": false,
      • "purge_artefacts": false,
      • "analyze_statistics": false,
      • "filters": {
        },
      • "node_paths": [
        ],
      • "run_count": 0,
      • "created_at": "2026-10-08T01:28:44.922720Z",
      • "updated_at": "2026-10-08T01:28:44.922720Z",
      • "next_run_at": "2026-10-15T01:28:44.916561Z",
      • "run_at": "2026-10-15T01:28:44.916561Z",
      • "end_at": "2027-01-06T01:28:44.916590Z"
      },
    • "links": {
      • "self": "/api/data_cleanup_definitions/01a11920-887b-7a83-863b-e4dbc7f39a77"
      }
    },
  • "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. The payload need only consist of the attributes you wish to modify. There is no need to supply the entire data cleanup definition.
path Parameters
data_cleanup_definition_id
required
string
Example: 01a1191f-19ac-7924-bc71-ea6f2584725a

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": "01a11920-8ac2-7647-82f1-b7af6387e252",
    • "type": "data_cleanup_definition",
    • "attributes": {
      • "name": "new_name",
      • "enabled": true,
      • "created_by": "marylin_hegmann-1390",
      • "cron_schedule": "0 0 7,14,21,28 * *",
      • "repeat": true,
      • "maximum_run_count": 5,
      • "purge_activities": true,
      • "purge_events": false,
      • "purge_jobs": true,
      • "purge_agent_images": false,
      • "purge_node_background_tasks": true,
      • "purge_artefacts": false,
      • "analyze_statistics": false,
      • "filters": {
        },
      • "node_paths": [
        ],
      • "run_count": 0,
      • "created_at": "2026-10-08T01:28:45.505107Z",
      • "updated_at": "2026-10-08T01:28:45.525415Z",
      • "next_run_at": "2026-10-15T01:28:45.494024Z",
      • "run_at": "2026-10-15T01:28:45.494024Z",
      • "end_at": "2027-01-06T01:28:45.494044Z"
      },
    • "links": {
      • "self": "/api/data_cleanup_definitions/01a11920-8ac2-7647-82f1-b7af6387e252"
      }
    },
  • "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: 01a1191f-19ac-7924-bc71-ea6f2584725a

data cleanup definition id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

Remote runner targets

Endpoints to manage the remote runner targets that run steps and change workers outside the OpsChain cluster.

List remote runner targets

Lists the remote runner targets the caller can read. Include remote_runner_target_scopes to return the node paths each target serves.

query Parameters
include
string
Example: include=remote_runner_target_scopes

Related resources to include

filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[code_cont]=dc1

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

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "01a11921-83b9-7ccc-9f17-e4ec9e7342f8",
      • "type": "remote_runner_target",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "included": [
    • {
      • "id": "01a11921-83c1-7ea2-a757-a309309de072",
      • "type": "remote_runner_target_scope",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      },
    • "partial_response": false
    }
}

Create remote runner target

Creates a remote runner target. The response meta.bearer_token holds the token the remote runner daemon authenticates with; it is only returned by this request.

Notes:

  1. Omit node_id to create an instance-wide target (superuser only).
  2. scope_paths restricts the target to the listed node paths. Include remote_runner_target_scopes to return them in the response.
query Parameters
include
string
Example: include=remote_runner_target_scopes

Related resources to include

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "dc2_runner",
      • "description": "Runner in the DC2 network",
      • "public_key": "-----BEGIN PUBLIC KEY-----\n...\n-----END PUBLIC KEY-----\n",
      • "client_certificate": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----\n",
      • "node_id": "01a1191e-f86a-7f6f-b90f-08e0684677fa",
      • "scope_paths": [
        ]
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-861e-747b-a132-a1e323d56af8",
    • "type": "remote_runner_target",
    • "attributes": {
      • "code": "dc2_runner",
      • "description": "Runner in the DC2 network",
      • "maintenance_mode": false,
      • "drained": false,
      • "live": false,
      • "key_rotation_overdue": false,
      • "created_at": "2026-10-08T01:29:49.853385Z",
      • "updated_at": "2026-10-08T01:29:49.853385Z",
      • "last_connected_at": null,
      • "key_expires_at": "2027-10-08T23:59:59.999999Z"
      },
    • "relationships": {
      • "settings": {
        },
      • "node": {
        },
      • "remote_runner_target_scopes": {
        }
      },
    • "links": {
      • "self": "/api/remote_runner_targets/01a11921-861e-747b-a132-a1e323d56af8"
      },
    • "meta": {
      • "bearer_token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIwMWExMTkyMS04NjJhLTc0ZTgtYjU4Zi02OWI5OGUxNzQyOTAiLCJpc3MiOiJPcHNDaGFpbiIsImF1ZCI6Im9wc2NoYWluX2FwaSIsImV4cCI6MTgyMzAzOTk5OSwiaWF0IjoxNzkxNDIyOTg5fQ.JaciA4eEK86xGya3QJFTnHqM5oymLRRWxp4gfhRT3_g"
      }
    },
  • "included": [
    • {
      • "id": "01a11921-8626-7521-b0ee-c2c2bfa7de3f",
      • "type": "remote_runner_target_scope",
      • "attributes": {
        }
      }
    ]
}

Show remote runner target

Shows a remote runner target. Include remote_runner_target_scopes to return the node paths it serves.

path Parameters
target_id
required
string
Example: 01a1191f-1ead-7fa5-af34-d6ac71f4b1f4

remote runner target id

query Parameters
include
string
Example: include=remote_runner_target_scopes

Related resources to include

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-8a98-7143-a347-05f6c465273b",
    • "type": "remote_runner_target",
    • "attributes": {
      • "code": "dc1_runner",
      • "description": "Runner in the DC1 network",
      • "maintenance_mode": false,
      • "drained": false,
      • "live": true,
      • "key_rotation_overdue": false,
      • "created_at": "2026-10-08T01:29:50.999259Z",
      • "updated_at": "2026-10-08T01:29:50.999259Z",
      • "last_connected_at": "2026-10-08T01:29:50.785445Z",
      • "key_expires_at": null
      },
    • "relationships": {
      • "settings": {
        },
      • "node": {
        },
      • "remote_runner_target_scopes": {
        }
      },
    • "links": {
      • "self": "/api/remote_runner_targets/01a11921-8a98-7143-a347-05f6c465273b"
      },
    • "meta": {
      • "authorisations": {
        }
      }
    },
  • "included": [
    • {
      • "id": "01a11921-8aa1-7708-ad0a-3bcd15002ccb",
      • "type": "remote_runner_target_scope",
      • "attributes": {
        }
      }
    ]
}

Update remote runner target

Updates a remote runner target's description, maintenance mode or scopes.

Only the scope paths being added are checked for existence and authorisation; scopes that are kept or removed are not.

path Parameters
target_id
required
string
Example: 01a1191f-1ead-7fa5-af34-d6ac71f4b1f4

remote runner target id

query Parameters
include
string
Example: include=remote_runner_target_scopes

Related resources to include

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "description": "Runner in the DC1 network",
      • "maintenance_mode": true,
      • "scope_paths": [
        ]
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "01a11921-8d92-71f3-8e9c-f6b600a94495",
    • "type": "remote_runner_target",
    • "attributes": {
      • "code": "dc1_runner",
      • "description": "Runner in the DC1 network",
      • "maintenance_mode": true,
      • "drained": true,
      • "live": true,
      • "key_rotation_overdue": false,
      • "created_at": "2026-10-08T01:29:51.761220Z",
      • "updated_at": "2026-10-08T01:29:51.796725Z",
      • "last_connected_at": "2026-10-08T01:29:51.612639Z",
      • "key_expires_at": null
      },
    • "relationships": {
      • "settings": {
        },
      • "node": {
        },
      • "remote_runner_target_scopes": {
        }
      },
    • "links": {
      • "self": "/api/remote_runner_targets/01a11921-8d92-71f3-8e9c-f6b600a94495"
      },
    • "meta": null
    },
  • "included": [
    • {
      • "id": "01a11921-8da0-72e2-922c-95fe7e63df8d",
      • "type": "remote_runner_target_scope",
      • "attributes": {
        }
      }
    ]
}

Delete remote runner target

Deletes a remote runner target. Work it has not yet claimed is left for another eligible target.

path Parameters
target_id
required
string
Example: 01a1191f-1ead-7fa5-af34-d6ac71f4b1f4

remote runner target id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    • {
      • "status": 404,
      • "title": "Record not found",
      • "meta": {
        }
      }
    ]
}

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": {
        }
      }
    }
}