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.

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

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

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.

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

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

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

List changes

Lists all changes performed in this environment.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

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

Create change

Creates a change in this 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": {
    },
  • "included": [
    ]
}

Show change

Shows a change performed in this environment.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

change_id
required
string
Example: cab37311-d338-4125-8307-12658e9c029e

change id

Responses

Response samples

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

Cancel change

Cancels a change running in this environment.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

change_id
required
string
Example: cab37311-d338-4125-8307-12658e9c029e

change id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Assets

Assets are available in the enterprise edition of OpsChain and allow you to represent an instance of an asset template. The template provides the available actions and a base set of properties to configure the asset. These properties can be overridden by the asset's properties as required.

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

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

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

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

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

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

Project - 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
{ }

Environment - list assets

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

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

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

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

Environment - create asset

Creates an asset belonging to the 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": {
    }
}

Environment - show asset

Shows an asset belonging to an environment.

The response includes a link to the asset's changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint. .

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

asset_code
required
string
Example: env_soa

asset code

Responses

Response samples

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

Environment - update asset

Updates an asset belonging to an environment.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

asset_code
required
string
Example: env_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": {
    }
}

Environment - archive asset

Archives an asset belonging to an environment.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

asset_code
required
string
Example: env_soa

asset code

Responses

Response samples

Content type
application/vnd.api+json
{ }

Asset templates

Asset templates provide the available actions and a base set of repository properties that will be used to configure the asset.

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

Project - show template version history

Shows the project asset's current 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: 6d1fa401-f34f-42fc-9a7c-073347a6eafc

version history id

Responses

Response samples

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

Environment - list template version history

Lists the template versions that have been assigned to an environment asset.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

asset_code
required
string
Example: env_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": [
    ]
}

Environment - show template version history

Shows the environment asset's current template version history record.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

asset_code
required
string
Example: prj_soa

asset code

id
required
string
Example: 9d10e20f-5ad2-4e2e-8ba0-9e08efcc3fb0

version history id

Responses

Response samples

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

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.

path Parameters
project_code
required
string
Example: opc

project code

remote_id
required
string
Example: f6e111d6-34a8-4482-becd-02e166dc311d

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: f6e111d6-34a8-4482-becd-02e166dc311d

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: f6e111d6-34a8-4482-becd-02e166dc311d

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: f6e111d6-34a8-4482-becd-02e166dc311d

remote id

Responses

Response samples

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

Properties

Endpoints to interact with properties.

Show properties

Shows a properties JSON.

path Parameters
properties_id
required
string
Example: ab058642-b544-4092-9a0d-a35f92487cbf

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: ab058642-b544-4092-9a0d-a35f92487cbf

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: ab058642-b544-4092-9a0d-a35f92487cbf

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: ab058642-b544-4092-9a0d-a35f92487cbf

properties id

Responses

Response samples

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

Show properties version

Shows an OpsChain properties version.

path Parameters
properties_id
required
string
Example: ab058642-b544-4092-9a0d-a35f92487cbf

properties id

version_number
required
integer
Example: 1

version number

Responses

Response samples

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

Show settings version

Shows an OpsChain settings version.

path Parameters
settings_id
required
string
Example: 88dec4ed-a05a-4cce-8c25-66152b83f65c

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

Responses

Response samples

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

Create change

Creates a change.

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.

path Parameters
change_id
required
string
Example: cab37311-d338-4125-8307-12658e9c029e

change id

Responses

Response samples

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

Cancel change

Cancels a change.

path Parameters
change_id
required
string
Example: cab37311-d338-4125-8307-12658e9c029e

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

Responses

Response samples

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

Create rule

Creates an automated change 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 automated change rule.

path Parameters
automated_change_id
required
string
Example: b7fd8d5e-49be-4b29-a8c0-a2468beb7683

automated change id

Responses

Response samples

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

Delete rule

Deletes an automated change rule.

path Parameters
automated_change_id
required
string
Example: b7fd8d5e-49be-4b29-a8c0-a2468beb7683

automated change id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Steps

Endpoints to interact with change steps.

Show step

Shows a change step.

path Parameters
step_id
required
string
Example: 7db86fdf-ad71-45ba-8d65-693cc6622f59

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: e5b800d4-af87-46b7-9943-04eeaf5dc0e8

step id

Responses

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: 8ce7e4f6-bfdb-4ca0-a27b-79df4b7da0b3

step id

Responses

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: cab37311-d338-4125-8307-12658e9c029e
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: 7db86fdf-ad71-45ba-8d65-693cc6622f59
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": [
    ]
}

List unfiltered log lines

List unfiltered log lines.

Responses

Response samples

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

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: f4172be0-60a6-452b-a0b4-53ae11643ce3

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: 88dec4ed-a05a-4cce-8c25-66152b83f65c

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: 88dec4ed-a05a-4cce-8c25-66152b83f65c

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: 88dec4ed-a05a-4cce-8c25-66152b83f65c

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: 88dec4ed-a05a-4cce-8c25-66152b83f65c

settings id

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