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, automated change rules, bookmarks and MintModels endpoints. These endpoints act like the assets, changes, automated changes, 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 automated_change_rules endpoint for managing automated change rules belonging to this project. It acts like the automated change 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. .
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": [
    ]
}

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 automated_change_rules endpoint for managing automated change rules belonging to this project. It acts like the automated change 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. .
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
application/vnd.api+json
{ }

Environments

Endpoints to interact with environments.

Notes:

  • The show and list response payloads include links to the environment's assets, changes, automated change rules, bookmarks and MintModels endpoints. These endpoints act like the assets, changes, automated changes, 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 automated_change_rules endpoint for managing automated change rules belonging to this environment. It acts like the automated change 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. .
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": [
    ]
}

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 automated_change_rules endpoint for managing automated change rules belonging to this environment. It acts like the automated change 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. .
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
application/vnd.api+json
{ }

Assets

Endpoints to interact with assets.

Notes:

  • The show and list response payloads include links to the asset's changes, automated change rules, bookmarks and MintModels endpoints. These endpoints act like the changes, automated changes, 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 automated_change_rules endpoint for managing automated change rules belonging to this asset. It acts like the automated change 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. .
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": [
    ]
}

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 automated_change_rules endpoint for managing automated change rules belonging to this asset. It acts like the automated change 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. .
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
application/vnd.api+json
{ }

Show converged properties

Show the converged properties as they will appear to actions run on this asset. i.e. the endpoint will

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

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

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[action_eq]=Test

Responses

Response samples

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

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": [
    ]
}

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: 42b107ff-eacb-4b7e-bfcb-875a655b36e5

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_code
required
string
Example: soa

template code

Responses

Response samples

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

Create or update a template version

Create or update a template version.

path Parameters
project_code
required
string
Example: opc

project code

template_code
required
string
Example: soa

template code

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

Show template version

Shows a specific template version.

path Parameters
project_code
required
string
Example: opc

project code

template_code
required
string
Example: soa

template code

version
required
string
Example: 2023_Q4_2

template version

Responses

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": [
    ]
}

Show template

Shows a project template.

path Parameters
project_code
required
string
Example: opc

project code

template_code
required
string
Example: soa

template code

Responses

Response samples

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

Archive template

Archives/unarchives a template.

path Parameters
project_code
required
string
Example: opc

project code

code_to_archive
required
string
Example: soa

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

Update template credentials

Update the credentials of a template.

path Parameters
project_code
required
string
Example: opc

project code

code_to_update
required
string
Example: soa

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

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": [
    ]
}

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: 0e282d9f-50be-4b5e-b1e1-58c5bb4d3705

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: 0e282d9f-50be-4b5e-b1e1-58c5bb4d3705

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: 0e282d9f-50be-4b5e-b1e1-58c5bb4d3705

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: 0e282d9f-50be-4b5e-b1e1-58c5bb4d3705

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 an asset bookmark.

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 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": [
    ]
}

Show bookmark

Shows an asset bookmark.

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

bookmark_id
required
string
Example: 3e3cc9d7-e025-4836-85cf-5c9e7c5deba1

bookmark id

Responses

Response samples

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

Update bookmark

Update an asset bookmark.

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

bookmark_id
required
string
Example: 3e3cc9d7-e025-4836-85cf-5c9e7c5deba1

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 an asset bookmark.

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

bookmark_id
required
string
Example: 3e3cc9d7-e025-4836-85cf-5c9e7c5deba1

bookmark id

Responses

Response samples

Content type
application/vnd.api+json
{ }

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": [
    ]
}

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: 50a3726b-4d3f-412e-b753-c6e6d8c89ab8

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": [
    ]
}

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: 0ec367c6-fd95-43bb-850a-12f44fc750d4

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": [
    ]
}

Create workflows

Create a workflow and push to the workflows 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
{
  • "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: 535d1f1d-7d7c-42bd-b016-0b0d87f4c1b5

workflow code

Responses

Response samples

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

Properties

Endpoints to interact with properties.

Show properties

Shows the current properties JSON and its version.

path Parameters
properties_id
required
string
Example: 5335d4bf-c9fb-4532-8813-c102a1bb2df9

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: 5335d4bf-c9fb-4532-8813-c102a1bb2df9

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: 5335d4bf-c9fb-4532-8813-c102a1bb2df9

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

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: 5335d4bf-c9fb-4532-8813-c102a1bb2df9

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: 5335d4bf-c9fb-4532-8813-c102a1bb2df9

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

Shows a change, including it's parent nodes.

path Parameters
change_id
required
string
Example: de851ee2-c2f7-4f55-81ee-ccd6ca9b49b9

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: de851ee2-c2f7-4f55-81ee-ccd6ca9b49b9

change id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Automated changes

List rules

Lists all automated change rules.

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[project_code_eq]=opc
include
string
Example: include=parents

Include the automated change parents in the response

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "included": [
    ],
  • "meta": {
    }
}

Create rule

Creates an automated change rule in a specific project, environment or asset.

Notes:

  1. When creating automated change rules via a project, environment or asset automated_change_rules path (e.g. POST to /api/projects/{project_code}/automated_change_rules) the parent_path request attributes must not be supplied as the parent will be derived from the path.
  2. When creating automated change rules for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/automated_change_rules) 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.
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 automated change rule.

path Parameters
automated_change_id
required
string
Example: 8c59bf92-cda2-4adb-91fb-5d45de1164cc

automated change id

query Parameters
include
string
Example: include=parents

Include the automated change parents in the response

Responses

Response samples

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

Delete rule

Deletes an automated change rule.

path Parameters
automated_change_id
required
string
Example: 8c59bf92-cda2-4adb-91fb-5d45de1164cc

automated change id

Responses

Response samples

Content type
application/vnd.api+json
{ }

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: 1adf62c3-c11e-499d-abaf-59cf7678442c

step id

Responses

Response samples

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

Continue step

Continues a "waiting" change step.

path Parameters
step_id
required
string
Example: 30d2ffae-feb7-4476-b169-3a9df5686d31

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: 30d2ffae-feb7-4476-b169-3a9df5686d31

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: 30d2ffae-feb7-4476-b169-3a9df5686d31

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

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: de851ee2-c2f7-4f55-81ee-ccd6ca9b49b9
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": [
    ]
}

List step log lines

List the log lines for a change step.

path Parameters
step_id
required
string
Example: 1adf62c3-c11e-499d-abaf-59cf7678442c
query Parameters
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": [
    ]
}

List filtered log lines

List filtered log lines.

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[message_cont]=dolorem
limit
integer [ 1 .. 10000 ]
Default: 1000
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": [
    ]
}

Workflow runs

Endpoints to interact with workflow runs

List workflow runs

Lists all runs for a workflow.

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

Responses

Response samples

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

Run a workflow

Runs a pre-defined workflow

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

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

Shows a workflow run.

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

Responses

Response samples

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

Cancel workflow run

Cancels a workflow run.

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Workflow steps

Endpoints to interact with the steps in a workflow run

List workflow steps in a workflow run

Lists all steps in a workflow run.

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

Responses

Response samples

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

Show workflow step

Shows a step in a workflow run.

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

step_id
required
string
Example: 58d1730b-c76f-4157-b56b-4f2f4faeb7f1

workflow step id

Responses

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
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

step_id
required
string
Example: cb4f24e9-9f26-47d2-8850-63448f9b8853

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
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

step_id
required
string
Example: cb4f24e9-9f26-47d2-8850-63448f9b8853

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
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: fn5ae

workflow code

run_id
required
string
Example: d4e814ef-c950-4070-ac4a-40d0cf3366a3

workflow run id

step_id
required
string
Example: cb4f24e9-9f26-47d2-8850-63448f9b8853

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": [
    ]
}

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: 043c07fa-b939-4654-9d1f-f195d2606864

event id

Responses

Response samples

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

Settings

Endpoints to interact with settings.

Show settings

Shows the current settings.

path Parameters
settings_id
required
string
Example: 37ba6efc-1488-4c84-b23e-1c20992a3594

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: 37ba6efc-1488-4c84-b23e-1c20992a3594

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: 37ba6efc-1488-4c84-b23e-1c20992a3594

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: 37ba6efc-1488-4c84-b23e-1c20992a3594

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: 37ba6efc-1488-4c84-b23e-1c20992a3594

settings id

version_number
required
integer
Example: 1

version number

Responses

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