OpsChain logo
API docs by Redocly

OpsChain API (v1)

Download OpenAPI specification:Download

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.

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
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": [
    ],
  • "meta": {
    }
}

Create project

Creates a project.

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

Responses

Request samples

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

Response samples

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

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

Response samples

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

Archive project

Archives a project.

path Parameters
project_code
required
string
Example: opc

project code

Responses

Response samples

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


Notes:


    

  • The show and list response payloads include links to the environment's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively.
    • 

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



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


Each environment in the response includes a link to:


    

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

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

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

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

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

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



path Parameters
project_code
required
string
 
 Example:  opc
project code


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=Test
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": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    },
  • "included": [
    ]
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Archive environment 
Archives an environment.


path Parameters
project_code
required
string
 
 Example:  opc
project code


environment_code
required
string
 
 Example:  dev
environment code


Responses
 Response samples 
Content type
text/plain
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": {
    }
}
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": {
    },
  • "included": [
    ]
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": [
    ]
}
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
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": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    },
  • "included": [
    ]
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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


Responses
 Response samples 
Content type
text/plain
Show converged properties 
Show the converged properties as they will appear for this agent. i.e. the endpoint will


    

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

  2. merge any project properties
    3. 

  3. merge any properties assigned to the agent
    4. 



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


path Parameters
project_code
required
string
 
 Example:  opc
project code


agent_code
required
string
 
 Example:  agent1
agent code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-03-13T09:32:56+00:00
Specify the date (and optionally time), to derive the active template version and agent properties from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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
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": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    },
  • "included": [
    ]
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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


Responses
 Response samples 
Content type
text/plain
Show converged properties 
Show the converged properties as they will appear to actions run on this asset. i.e. the endpoint will


    

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

  2. merge any project properties
    3. 

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



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


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


query Parameters
converge_date
string
 
 Example:  converge_date=2026-03-13T09:32:56+00:00
Specify the date (and optionally time), to derive the active template version and asset properties from.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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:  6e396369-8813-44e1-88aa-2545ea880201
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.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create generate actions request 
Create a request to refresh the actions list for an asset.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  6e396369-8813-44e1-88aa-2545ea880201
generate actions request id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  6e396369-8813-44e1-88aa-2545ea880201
generate actions request id


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


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
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
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  85dcac9f-d00a-44cc-bc02-6c355c4c1d4d
version history id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Templates
Templates provide the available actions and a base set of
repository properties that
will be used to configure the asset.


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:  e4381d03-fee1-4294-a83e-91386bcb15ff
template id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  e4381d03-fee1-4294-a83e-91386bcb15ff
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": {
    },
  • "meta": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show template version 
Shows a specific template version.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  e4381d03-fee1-4294-a83e-91386bcb15ff
template id


version
required
string
 
 Example:  2023_Q4_2
template version


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}
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:  e4381d03-fee1-4294-a83e-91386bcb15ff
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
List templates 
Lists all templates for a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
Show template 
Shows a project template.


path Parameters
project_code
required
string
 
 Example:  opc
project code


template_id
required
string
 
 Example:  e4381d03-fee1-4294-a83e-91386bcb15ff
template id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}
Archive template 
Archives/unarchives a template.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_archive
required
string
 
 Example:  e4381d03-fee1-4294-a83e-91386bcb15ff
template id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update template 
Update a templates details.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_update
required
string
 
 Example:  e4381d03-fee1-4294-a83e-91386bcb15ff
template id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Git remotes
Endpoints to interact with git remotes.


Create Git remote 
Create a project Git remote.


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
{}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
List Git remotes 
Lists all Git remotes for a project.


path Parameters
project_code
required
string
 
 Example:  opc
project code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  50cc8bcf-77c0-43cd-8aed-eafa7d31083d
remote id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  50cc8bcf-77c0-43cd-8aed-eafa7d31083d
remote id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update Git remote credentials 
Update the credentials of a project Git remote.


path Parameters
project_code
required
string
 
 Example:  opc
project code


id_to_update
required
string
 
 Example:  50cc8bcf-77c0-43cd-8aed-eafa7d31083d
remote id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  50cc8bcf-77c0-43cd-8aed-eafa7d31083d
remote id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    }
}
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  93d86fb9-8704-4cdd-a87b-ed3ac7175d84
bookmark id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  93d86fb9-8704-4cdd-a87b-ed3ac7175d84
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": {
    }
}
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:  93d86fb9-8704-4cdd-a87b-ed3ac7175d84
bookmark id


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


Notes:


    

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

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



List MintModel history 
Lists the asset's MintModel history.


path Parameters
project_code
required
string
 
 Example:  opc
project code


asset_code
required
string
 
 Example:  prj_soa
asset code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  0236f491-518d-44b2-a5b1-6c7552f8a54d
MintModel history id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
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:  244d7972-15db-48d6-9787-501619cc9732
old MintModel id


new_mintmodel_id
required
string
 
 Example:  5161ca43-2498-4048-b84a-e9adbbdf1c2f
new MintModel id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  c2c44082-d922-4ba0-a761-f8ef2b92d34e
MintModel id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Generate MintModel 
Generate the MintModel for this asset, using the latest properties and template version.


Note: The endpoint does not store the MintModel, rather it provides a point in time reference for the
MintModel content that will be used by a change if one is executed for the 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": {
    }
}
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    }
}
Update workflow 
Update a 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
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete workflow 
Delete or archive a workflow.


    

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

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



path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


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


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
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": {
    }
}
Update workflow 
Update 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


Request Body schema: application/vnd.api+json
required
object
 
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete workflow version 
Delete or archive a workflow version.


    

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

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



path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


version
required
string
 
 Example:  2
version


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


Show properties 
Shows the current properties JSON and its version.


path Parameters
properties_id
required
string
 
 Example:  c4d3e36a-b32e-4ada-abca-45b66e90be49
properties id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update properties 
Updates a properties JSON if the included version matches the current properties version.


path Parameters
id_to_update
required
string
 
 Example:  c4d3e36a-b32e-4ada-abca-45b66e90be49
properties id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update properties (unsafe) 
Updates a properties JSON, without any version checking (always updates).


path Parameters
id_to_set
required
string
 
 Example:  c4d3e36a-b32e-4ada-abca-45b66e90be49
properties id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update file property 
Update a file property in the properties.


path Parameters
properties_id
required
string
 
 Example:  c4d3e36a-b32e-4ada-abca-45b66e90be49
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 (Valid values are 'raw' (default), 'json' or 'base64') 
 
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": {
    }
}
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:  c4d3e36a-b32e-4ada-abca-45b66e90be49
properties id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
Show properties version 
Shows the properties JSON for this properties version.


path Parameters
properties_id
required
string
 
 Example:  c4d3e36a-b32e-4ada-abca-45b66e90be49
properties id


version_number
required
integer
 
 Example:  1
version number


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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
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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create change 
Creates a change in a specific project, environment or asset.


Notes:


    

  1. When creating changes via a project, environment or asset changes path
(e.g. POST to /api/projects/{project_code}/changes) the parent_path request attributes must not be supplied
as the parent will be derived from the path.
    2. 

  2. When creating changes for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/changes)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.
    3. 



Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Show change 
Shows a change, including it's parent nodes.


path Parameters
change_id
required
string
 
 Example:  cacf1d55-667b-4c3d-8648-9440dfb828db
change id


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Cancel change 
Cancels a change.


path Parameters
change_id
required
string
 
 Example:  cacf1d55-667b-4c3d-8648-9440dfb828db
change id


Responses
 Response samples 
Content type
text/plain
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:  cacf1d55-667b-4c3d-8648-9440dfb828db
change id


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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
include
string
 
 Example:  include=parents
Include the scheduled change parents in the response


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Create activities 
Creates a scheduled activity in a specific project, environment or asset.


Notes:


    

  1. When creating scheduled activities via a project, environment or asset scheduled_activities path
(e.g. POST to /api/projects/{project_code}/scheduled_activities) the parent_path request attributes must not be supplied
as the parent will be derived from the path.
    

    2. 

  2. When creating scheduled activities for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/scheduled_activities)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.
    

    3. 

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

    4. 



Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show activity 
Shows a scheduled activity.


path Parameters
scheduled_change_id
required
string
 
 Example:  406ef8db-647b-4a25-be88-241c04722438
scheduled change id


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Update activity 
Updates a scheduled activity in a specific project, environment or asset.


Notes:


    

  1. When updating activities via a project, environment or asset scheduled_activities path
(e.g. POST to /api/projects/{project_code}/scheduled_activities) the parent_path request attributes must not be supplied
as the parent will be derived from the path.
    2. 

  2. When updating activities for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/scheduled_activities)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.
    3. 

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

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



path Parameters
scheduled_change_id
required
string
 
 Example:  406ef8db-647b-4a25-be88-241c04722438
scheduled change id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete activity 
Delete a scheduled activity.


path Parameters
scheduled_change_id
required
string
 
 Example:  406ef8db-647b-4a25-be88-241c04722438
scheduled change id


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


List steps 
Lists all steps.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[action_eq]=provision
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
Show step 
Shows a change step.


path Parameters
step_id
required
string
 
 Example:  144350b9-94e9-4256-92d8-eeeb4923b11f
step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Update step 
Update a step to flag it to be skipped on retry.


path Parameters
step_id
required
string
 
 Example:  144350b9-94e9-4256-92d8-eeeb4923b11f
step id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Continue step 
Continues a "waiting" change step.


path Parameters
step_id
required
string
 
 Example:  ad8c4eb4-767f-410a-bab6-a5014e479b82
step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Approve step 
Approves a change step that needs approval.


path Parameters
step_id
required
string
 
 Example:  ad8c4eb4-767f-410a-bab6-a5014e479b82
step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Reject step 
Rejects a change step that needs approval.


path Parameters
step_id
required
string
 
 Example:  ad8c4eb4-767f-410a-bab6-a5014e479b82
step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  144350b9-94e9-4256-92d8-eeeb4923b11f
step id


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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:  cacf1d55-667b-4c3d-8648-9440dfb828db
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": [
    ],
  • "meta": {
    }
}
List step log lines 
List the log lines for a change step.


path Parameters
step_id
required
string
 
 Example:  144350b9-94e9-4256-92d8-eeeb4923b11f
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": [
    ],
  • "meta": {
    }
}
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 .. null ] 
 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": [
    ],
  • "meta": {
    }
}
List workflow run log lines 
List the workflow run log lines for a workflow run.


path Parameters
workflow_run_id
required
string
 
 Example:  825be1a6-ded7-4093-9831-e75cb6a1af75
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": [
    ],
  • "meta": {
    }
}
List workflow step log lines 
List the log lines for a workflow step.


path Parameters
workflow_step_id
required
string
 
 Example:  7b17a030-1718-4f9d-91ea-742ad597e438
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": [
    ],
  • "meta": {
    }
}
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 .. null ] 
 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": [
    ],
  • "meta": {
    }
}
Workflow runs
Endpoints to interact with workflow runs


Notes:


    

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

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

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

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

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

    

    • 



List all workflow runs 
Lists all workflow runs.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
Run a workflow 
Runs a pre-defined workflow


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Show workflow run 
Shows a workflow run.


path Parameters
run_id
required
string
 
 Example:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Cancel workflow run 
Cancels a workflow run.


path Parameters
run_id
required
string
 
 Example:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


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


path Parameters
project_code
required
string
 
 Example:  opc
project code


workflow_code
required
string
 
 Example:  assets
workflow code


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


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


List all workflow steps 
Lists all workflow steps.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
Show a workflow step 
Shows a workflow step.


path Parameters
step_id
required
string
 
 Example:  e6a80e70-a82e-49da-a4d3-336992c2d029
workflow step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update a workflow step 
Update a workflow step to flag it to be skipped on retry.


path Parameters
step_id
required
string
 
 Example:  e6a80e70-a82e-49da-a4d3-336992c2d029
workflow step id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  1b653332-707d-4ca0-8d29-7bef6786793d
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  97132fce-cb3f-4cf2-979c-fb4743b9eec1
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Reject workflow step 
Reject a workflow step that requires approval.


path Parameters
step_id
required
string
 
 Example:  294e1765-5ff4-407a-95c9-63a6a8884d07
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


step_id
required
string
 
 Example:  e6a80e70-a82e-49da-a4d3-336992c2d029
workflow step id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


step_id
required
string
 
 Example:  1b653332-707d-4ca0-8d29-7bef6786793d
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


step_id
required
string
 
 Example:  97132fce-cb3f-4cf2-979c-fb4743b9eec1
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  825be1a6-ded7-4093-9831-e75cb6a1af75
workflow run id


step_id
required
string
 
 Example:  294e1765-5ff4-407a-95c9-63a6a8884d07
workflow step id


Request Body schema: application/vnd.api+json
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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
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": [
    ],
  • "meta": {
    }
}
Create event 
Creates an event.


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show event 
Shows an event.


path Parameters
event_id
required
string
 
 Example:  6a1000b6-cf7e-4f5d-b24b-b469f88357ca
event id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Event filters
List event filters 
Lists all event filters.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete event filter 
Delete an event filter.


path Parameters
event_filter_code
required
string
 
 Example:  change_success
event filter code


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
List event node subscribers 
List event subscribers for a specific project, environment or asset.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show event subscriber 
Show an event subscriber.


path Parameters
event_subscriber_id
required
string
 
 Example:  d5def5c0-23c4-4767-9f31-5e95af4fa8fb
event subscriber id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update event subscriber 
Update an event subscriber.


path Parameters
event_subscriber_id
required
string
 
 Example:  d5def5c0-23c4-4767-9f31-5e95af4fa8fb
event subscriber id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete event subscriber 
Delete an event subscriber.


path Parameters
event_subscriber_id
required
string
 
 Example:  d5def5c0-23c4-4767-9f31-5e95af4fa8fb
event subscriber id


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete notification channel 
Delete a global notification channel.


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete notification channel 
Delete a notification channel for a specific project, environment or asset..


path Parameters
notification_channel_code
required
string
 
 Example:  system_email
notification channel code


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
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": [
    ],
  • "meta": {
    }
}
Settings
Endpoints to interact with settings.


Show settings 
Shows the current settings.


path Parameters
settings_id
required
string
 
 Example:  efeadf30-2c37-4218-903f-ad4779e28bc0
settings id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update settings 
Updates a settings JSON if the included version matches the current settings version.


path Parameters
id_to_update
required
string
 
 Example:  efeadf30-2c37-4218-903f-ad4779e28bc0
settings id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update settings (unsafe) 
Updates a settings JSON, without any version checking (always updates).


path Parameters
id_to_set
required
string
 
 Example:  efeadf30-2c37-4218-903f-ad4779e28bc0
settings id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  efeadf30-2c37-4218-903f-ad4779e28bc0
settings id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
Show settings version 
Shows the settings values for this settings version.


path Parameters
settings_id
required
string
 
 Example:  efeadf30-2c37-4218-903f-ad4779e28bc0
settings id


version_number
required
integer
 
 Example:  1
version number


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show rule 
Shows an authorisation rule.


path Parameters
authorisation_rule_id
required
string
 
 Example:  6da558d8-6e92-4188-b983-5d59e8b1875d
authorisation rule id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update authorisation rule 
Update an authorisation rule.


path Parameters
authorisation_rule_id
required
string
 
 Example:  6da558d8-6e92-4188-b983-5d59e8b1875d
authorisation rule id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete rule 
Delete an authorisation rule.


path Parameters
authorisation_rule_id
required
string
 
 Example:  6da558d8-6e92-4188-b983-5d59e8b1875d
authorisation rule id


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


List policies 
Lists all authorisation policies.


query Parameters
filter[<query/sort filter>]=
string
 
 Example:  filter[<query/sort filter>]==> filter[name_eq]=secure
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show policy 
Shows an authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Delete policy 
Delete an authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


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


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


path Parameters
authorisation_policy_id
required
string
 
 Example:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


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": [
    ],
  • "meta": {
    }
}
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:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
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:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


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": [
    ],
  • "meta": {
    }
}
Create policy rule(s) 
Add one or more authorisation rules to a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
Delete a policy rule 
Remove an authorisation rule from a specific authorisation policy.


path Parameters
authorisation_policy_id
required
string
 
 Example:  0cc2b8c9-1351-4674-8998-6620f360551f
authorisation policy id


policy_rule_id
required
string
 
 Example:  831a1126-d421-46b3-92cc-6f26709ff3b6
policy rule id


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


List users 
Lists users in the system


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
Show user 
Show a user.


path Parameters
user_id
required
string
 
 Example:  f418e68d-7936-40e4-91d5-83863b4c9800
user id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Update user 
Update a user's notification preferences.


path Parameters
user_id
required
string
 
 Example:  f418e68d-7936-40e4-91d5-83863b4c9800
user id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
Show current user 
Show the currently logged in user.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": [
    ]
}
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": {
    }
}
List workflow notifications 
Lists all workflow 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": {
    }
}
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": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    }
}
Trust store
Endpoint to manage the trust store and certificates.


List certificates 
Lists certificates in the trust store.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
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": {
    }
}
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": {
    }
}
Delete certificate 
Delete certificate from the trust store.


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


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


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


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


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

Updated certificate description
------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="file"; filename="remote_system.crt"
content-type: application/x-x509-ca-cert
content-length: 1887

-----BEGIN CERTIFICATE-----
MIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL
BQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l
ZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD
DAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ
KoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16
SOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE
gdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5
RqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt
dxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS
GbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v
iNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28
X8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH
E+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf
0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI
djd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW
YlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV
LjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD
AQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk
pjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX
QKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0
R8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW
xerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk
NDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15
ZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW
hcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR
tMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd
esPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5
AuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B
WbrO/ELdag==
-----END CERTIFICATE-----

------------XnJLe9ZIbbGUYtzPQJ16u1--

 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    }
}
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": {
    }
}
Get OpsChain system configuration 
Shows the current system configuration node.


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


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "included": [
    ]
}
Admin operations
Endpoints to monitor the status of your OpsChain instance.


Get status information about the OpsChain database 
Returns status information about the OpsChain database.


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": [
    ]
}
Get the status of the OpsChain queues 
Returns the status of the OpsChain queues and details about their jobs.


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ]
}
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": [
    ]
}
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
Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}
Create data cleanup definition 
Notes:


    

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

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

  3. The keys accepted for the filters field are changes, events, jobs, and workflow_runs. The agent image cleanup job accepts template_version_history and the build_agent_image_task. Each of these can have ransack filters for the specific type they refer to.
IMPORTANT: If no filters are provided for a data type, the cleanup will remove all data that matches the node paths.
    4. 

  4. The node_paths field is an array of strings. Each string is a path to a node. The path must start with /projects and only contain forward slashes, lowercase letters, numbers and underscores, and optionally a single "%" at the end.
Use the % wildcard to include all nodes under a specific node or node-type, note that this will apply the cleanup to all nodes that are yet to be created, as long as they match the path.
    5. 



Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}
Show a data cleanup definition 
Shows a data cleanup definition.


path Parameters
data_cleanup_definition_id
required
string
 
 Example:  f51d6902-6907-4b85-a8e2-cdb0a4092cd9
data cleanup definition id


Responses
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}
Update the data cleanup definition 
Updates a data cleanup definition.


Notes:


    

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

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



path Parameters
data_cleanup_definition_id
required
string
 
 Example:  f51d6902-6907-4b85-a8e2-cdb0a4092cd9
data cleanup definition id


Request Body schema: application/vnd.api+json
required
object
 
Responses
 Request samples 
Content type
application/vnd.api+json
Example
{
  • "data": {
    }
}
 Response samples 
Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}
Delete the data cleanup definition 
Delete a data cleanup definition.


path Parameters
data_cleanup_definition_id
required
string
 
 Example:  f51d6902-6907-4b85-a8e2-cdb0a4092cd9
data cleanup definition id


Responses
 Response samples 
Content type
text/plain