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 automation_rules endpoint for managing automation rules belonging to this project. It acts like an automation rules 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 Schema: application/vnd.api+json
required
Array of objects
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "fa34ac0a-5bf6-4036-a6bb-e6c3e18638e7",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "authorisations": {
      • "update": true
      }
    }
}

Create project

Creates a project.

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "0b13381f-70fe-42c1-83c3-66f55f82b438",
    • "type": "project",
    • "attributes": {
      • "code": "mc0i8",
      • "name": "consequatur302",
      • "description": "In iusto nam odio.",
      • "archived": false,
      • "project_type": "Standard"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/mc0i8",
      • "bookmarks": "/api/projects/mc0i8/bookmarks",
      • "git_remotes": "/api/projects/mc0i8/git_remotes",
      • "environments": "/api/projects/mc0i8/environments"
      },
    • "meta": {
      • "can_have_changes": false,
      • "can_have_children": true,
      • "can_have_properties": true,
      • "can_have_settings": true,
      • "can_have_templates": false,
      • "requires_template": false,
      • "child_node_types": [
        ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    }
}

Show project

Shows a project, including any direct children.

The response includes a link to:

  • the project's changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.
  • the project's automation_rules endpoint for managing automation rules belonging to this project. It acts like an automation rules 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 Schema: application/vnd.api+json
required
object
Array of objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "f841e1b0-15d3-4734-8cbc-171b40e1332a",
    • "type": "project",
    • "attributes": {
      • "code": "opc",
      • "name": "OpsChain",
      • "description": "OpsChain project",
      • "archived": false,
      • "project_type": "Enterprise"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc",
      • "bookmarks": "/api/projects/opc/bookmarks",
      • "changes": "/api/projects/opc/changes",
      • "automation_rules": "/api/projects/opc/automation_rules",
      • "git_remotes": "/api/projects/opc/git_remotes",
      • "workflows": "/api/projects/opc/workflows",
      • "workflow_runs": "/api/projects/opc/workflow_runs",
      • "templates": "/api/projects/opc/templates",
      • "environments": "/api/projects/opc/environments",
      • "assets": "/api/projects/opc/assets"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": true,
      • "can_have_properties": true,
      • "can_have_settings": true,
      • "can_have_templates": true,
      • "requires_template": false,
      • "child_node_types": [
        ],
      • "can_have_workflows": true,
      • "authorisations": {
        }
      }
    },
  • "included": [ ]
}

Update project

Updates a project.

path Parameters
project_code
required
string
Example: opc

project code

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

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects or objects

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "416c76b8-3e66-471e-81ee-536ac7f14e18",
    • "type": "project",
    • "attributes": {
      • "code": "opc",
      • "name": "eum311",
      • "description": "Aut perspiciatis ullam ut.",
      • "archived": true,
      • "project_type": "Standard"
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc",
      • "bookmarks": "/api/projects/opc/bookmarks",
      • "git_remotes": "/api/projects/opc/git_remotes",
      • "environments": "/api/projects/opc/environments"
      },
    • "meta": {
      • "can_have_changes": false,
      • "can_have_children": true,
      • "can_have_properties": true,
      • "can_have_settings": true,
      • "can_have_templates": false,
      • "requires_template": false,
      • "child_node_types": [
        ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    }
}

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 automation_rules endpoint for managing automation rules belonging to this environment. It acts like an automation rules 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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "6cd99c5b-f5bf-4137-a56e-71607d9171b7",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "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": {
    • "attributes": {
      • "code": "dev",
      • "name": "Development",
      • "description": "OpsChain development environment"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "2139d8a6-4d8f-4f73-878e-b39d12dee374",
    • "type": "environment",
    • "attributes": {
      • "code": "tiwkj",
      • "name": "quae276",
      • "description": "Natus quo est sed.",
      • "archived": false
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/tiwkj",
      • "bookmarks": "/api/projects/opc/environments/tiwkj/bookmarks",
      • "changes": "/api/projects/opc/environments/tiwkj/changes",
      • "automation_rules": "/api/projects/opc/environments/tiwkj/automation_rules",
      • "parent": "/api/projects/opc",
      • "assets": "/api/projects/opc/environments/tiwkj/assets"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": true,
      • "can_have_properties": true,
      • "can_have_settings": true,
      • "can_have_templates": false,
      • "requires_template": false,
      • "child_node_types": [
        ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    }
}

Show environment

Shows an environment.

The response includes a link to:

  • the environment's changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.
  • the environment's automation_rules endpoint for managing automation rules belonging to this environment. It acts like an automation rules 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 Schema: application/vnd.api+json
required
object
Array of objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "a99947c0-7e6f-46a7-b0d7-19c2b0b37452",
    • "type": "environment",
    • "attributes": {
      • "code": "dev",
      • "name": "Development",
      • "description": "OpsChain development environment",
      • "archived": false
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev",
      • "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
      • "changes": "/api/projects/opc/environments/dev/changes",
      • "automation_rules": "/api/projects/opc/environments/dev/automation_rules",
      • "parent": "/api/projects/opc",
      • "assets": "/api/projects/opc/environments/dev/assets"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": true,
      • "can_have_properties": true,
      • "can_have_settings": true,
      • "can_have_templates": false,
      • "requires_template": false,
      • "child_node_types": [
        ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    },
  • "included": [
    • {
      • "id": "239c32cf-a948-4ae8-95c9-5ef9fd3281bb",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}

Update environment

Updates an environment.

path Parameters
project_code
required
string
Example: opc

project code

environment_code
required
string
Example: dev

environment code

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

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects or objects

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "92bbc530-5188-4a88-a3c9-10b9d25390b9",
    • "type": "environment",
    • "attributes": {
      • "code": "dev",
      • "name": "quaerat286",
      • "description": "Sit eaque eligendi nam.",
      • "archived": true
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "settings": {
        },
      • "project": {
        },
      • "children": {
        },
      • "bookmarks": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/environments/dev",
      • "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
      • "changes": "/api/projects/opc/environments/dev/changes",
      • "automation_rules": "/api/projects/opc/environments/dev/automation_rules",
      • "parent": "/api/projects/opc",
      • "assets": "/api/projects/opc/environments/dev/assets"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": true,
      • "can_have_properties": true,
      • "can_have_settings": true,
      • "can_have_templates": false,
      • "requires_template": false,
      • "child_node_types": [
        ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    }
}

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 automation_rules endpoint for managing automation rules belonging to this asset. It acts like an automation rules 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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "dbe7ecae-408d-4485-af62-1de313b666aa",
      • "type": "asset",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "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": {
    • "attributes": {
      • "code": "prj_soa",
      • "name": "Project asset",
      • "description": "Project asset description",
      • "template_name": "Oracle SOA template",
      • "template_version": "2023_Q4_2"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "ac6ab3ab-22a0-4e0e-b1f0-51613be7f060",
    • "type": "asset",
    • "attributes": {
      • "code": "pzj9w",
      • "name": "placeat248",
      • "description": "Eos optio maiores tempore.",
      • "archived": false,
      • "actions": [
        ],
      • "mintmodel_valid": true
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/pzj9w",
      • "bookmarks": "/api/projects/opc/assets/pzj9w/bookmarks",
      • "changes": "/api/projects/opc/assets/pzj9w/changes",
      • "automation_rules": "/api/projects/opc/assets/pzj9w/automation_rules",
      • "converged_properties": "/api/projects/opc/assets/pzj9w/converged_properties",
      • "mintmodels": "/api/projects/opc/assets/pzj9w/mintmodels",
      • "mintmodel_history": "/api/projects/opc/assets/pzj9w/mintmodel_history",
      • "parent": "/api/projects/opc",
      • "version_history": "/api/projects/opc/assets/pzj9w/version_history"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": false,
      • "can_have_properties": true,
      • "can_have_settings": false,
      • "can_have_templates": false,
      • "requires_template": true,
      • "child_node_types": [ ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    }
}

Show asset

Shows an asset belonging to a project.

The response includes a link to:

  • the asset's changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.
  • the asset's automation_rules endpoint for managing automation rules belonging to this asset. It acts like an automation rules 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 Schema: application/vnd.api+json
required
object
Array of objects or objects or objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "1c6b71fd-662a-4a36-8f74-42709d23f274",
    • "type": "asset",
    • "attributes": {
      • "code": "prj_soa",
      • "name": "Project asset",
      • "description": "Project asset description",
      • "archived": false,
      • "actions": [
        ],
      • "mintmodel_valid": true
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa",
      • "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
      • "changes": "/api/projects/opc/assets/prj_soa/changes",
      • "automation_rules": "/api/projects/opc/assets/prj_soa/automation_rules",
      • "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
      • "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
      • "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
      • "parent": "/api/projects/opc",
      • "version_history": "/api/projects/opc/assets/prj_soa/version_history"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": false,
      • "can_have_properties": true,
      • "can_have_settings": false,
      • "can_have_templates": false,
      • "requires_template": true,
      • "child_node_types": [ ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    },
  • "included": [
    • {
      • "id": "b65e8baf-1b74-49b3-adfb-935e920f4e92",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "e2a8ad51-5ffe-457c-b9b4-4e9621ed320c",
      • "type": "mintmodel_history",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "b188686f-342f-4755-ae85-87510ada6968",
      • "type": "bookmark",
      • "attributes": {},
      • "links": {
        }
      },
    • {
      • "id": "e7c3d235-2499-4ed4-be7b-959cd30f545a",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": null
      },
    • {
      • "id": "1d85c1cc-4e2a-4ca6-a33f-b9be494dcee6",
      • "type": "template_version",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}

Update asset

Updates an asset belonging to a project.

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

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

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects or objects or objects or objects

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "6edcbde9-af06-4f35-b60d-ca303b90cc99",
    • "type": "asset",
    • "attributes": {
      • "code": "prj_soa",
      • "name": "doloribus258",
      • "description": "Ullam voluptas ut quas.",
      • "archived": true,
      • "actions": [
        ],
      • "mintmodel_valid": true
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "project": {
        },
      • "template_version": {
        },
      • "bookmarks": {
        },
      • "template": {
        },
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa",
      • "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
      • "changes": "/api/projects/opc/assets/prj_soa/changes",
      • "automation_rules": "/api/projects/opc/assets/prj_soa/automation_rules",
      • "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
      • "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
      • "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
      • "parent": "/api/projects/opc",
      • "version_history": "/api/projects/opc/assets/prj_soa/version_history"
      },
    • "meta": {
      • "can_have_changes": true,
      • "can_have_children": false,
      • "can_have_properties": true,
      • "can_have_settings": false,
      • "can_have_templates": false,
      • "requires_template": true,
      • "child_node_types": [ ],
      • "can_have_workflows": false,
      • "authorisations": {
        }
      }
    }
}

Archive asset

Archives an asset belonging to a project.

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

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 Schema: application/vnd.api+json
required
object
Array of objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "prj_soa",
    • "type": "converged_properties",
    • "attributes": {
      • "data": {
        }
      },
    • "relationships": {
      • "repository_properties": {
        },
      • "properties": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/converged_properties"
      }
    },
  • "included": [
    • {
      • "id": "3072eb43-0275-4390-b338-4be3243f426c",
      • "type": "properties",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "791d4278-f084-4709-afae-0b39d5032608",
      • "type": "properties",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "properties.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "projects/opc.yaml",
      • "type": "repository_properties",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}

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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "45fde666-7ea9-4e12-9387-a2f8c2bee6c2",
      • "type": "template_version_history",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

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: 1fb2fdd0-c184-47d9-b5cf-e3e548bfbd45

version history id

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "7a4619c1-33cd-4026-be95-b3c2ed9d0d3c",
    • "type": "template_version_history",
    • "attributes": {
      • "active_from": "2025-02-13T04:19:10.260907Z",
      • "active_to": null
      },
    • "relationships": {
      • "owner": {
        },
      • "template_version": {
        }
      },
    • "links": {
      • "template_version": "/api/projects/opc/templates/soa/versions/2023_Q4_2",
      • "self": "/api/projects/opc/assets/prj_soa/version_history/7a4619c1-33cd-4026-be95-b3c2ed9d0d3c",
      • "asset": "/api/projects/opc/assets/prj_soa"
      }
    },
  • "included": [
    • {
      • "id": "00760629-43ed-4c4d-b190-4e21bb8dbd88",
      • "type": "asset",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "d266af59-9955-43d8-80ca-1c9a6bdf2fd6",
      • "type": "template_version",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}

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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "8d780159-5907-4319-86bb-4d45cd910245",
      • "type": "template_version",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}

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

Response Schema: application/vnd.api+json
required
object
Array of objects

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "description": "Added additional configuration options",
      • "git_rev": "auxiliary",
      • "archived": false
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "18864c56-b525-4f84-9a27-e580fc6d16e3",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Atque porro iure nesciunt quod soluta sunt rerum nobis natus",
      • "state": "initializing",
      • "created_by": "ismael",
      • "archived": false,
      • "has_mintmodel": false,
      • "created_at": "2025-02-13T04:19:10.835039Z",
      • "updated_at": "2025-02-13T04:19:10.835039Z",
      • "git_rev": "optical",
      • "commit_sha": null
      },
    • "links": {
      • "self": "/api/projects/opc/templates/soa/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/soa"
      }
    }
}

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 Schema: application/vnd.api+json
required
object
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "ec440c2f-5864-4b51-a674-fab318da2ddc",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "arlie.stamm",
      • "archived": false,
      • "has_mintmodel": true,
      • "created_at": "2025-02-13T04:19:11.546020Z",
      • "updated_at": "2025-02-13T04:19:11.546020Z",
      • "git_rev": "auxiliary",
      • "commit_sha": "8a2f233f0c73b6e01f50172793c711e0c3824465",
      • "actions": [
        ]
      },
    • "links": {
      • "self": "/api/projects/opc/templates/soa/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/soa"
      }
    }
}

Bulk assign assets to template versions

Assign assets to the 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

Response Schema: application/vnd.api+json
required
object
Array of objects

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "e8691a42-f5c2-46bd-ab15-fd799fb50b29",
    • "type": "template_version",
    • "attributes": {
      • "version": "2023_Q4_2",
      • "description": "Added additional configuration options",
      • "state": "ready",
      • "created_by": "marguerita_schimmel",
      • "archived": false,
      • "has_mintmodel": true,
      • "created_at": "2025-02-13T04:19:11.870922Z",
      • "updated_at": "2025-02-13T04:19:11.870922Z",
      • "git_rev": "bluetooth",
      • "commit_sha": "1a5de932ced046a627e3e89fb353090cefc47989",
      • "actions": [
        ]
      },
    • "links": {
      • "self": "/api/projects/opc/templates/soa/versions/2023_Q4_2",
      • "template": "/api/projects/opc/templates/soa"
      }
    }
}

Create template

Create a template.

path Parameters
project_code
required
string
Example: opc

project code

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "soa",
      • "name": "Oracle SOA template",
      • "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "user": "limepoint",
      • "password": "password",
      • "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "e419d5d6-7b57-413b-a2ad-b9e73655e643",
    • "type": "template",
    • "attributes": {
      • "name": "kraig_koss",
      • "url": "https://davis.example/repo.git",
      • "archived": false,
      • "disabled": false,
      • "created_at": "2025-02-13T04:19:12.567116Z",
      • "updated_at": "2025-02-13T04:19:12.567116Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}",
      • "code": "pstig",
      • "description": "Sit ut ea voluptates."
      },
    • "relationships": {
      • "template_versions": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/templates/pstig",
      • "template_versions": "/api/projects/opc/templates/pstig/versions"
      },
    • "meta": null
    }
}

List templates

Lists all templates for a project.

path Parameters
project_code
required
string
Example: opc

project code

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "91ac77d0-d3e4-4bae-b623-23dd17315171",
      • "type": "template",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": null
      }
    ]
}

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 Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "62a86588-e637-4c9f-a921-0f608db8dd1e",
    • "type": "template",
    • "attributes": {
      • "name": "Oracle SOA template",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "archived": false,
      • "disabled": false,
      • "created_at": "2025-02-13T04:19:13.264353Z",
      • "updated_at": "2025-02-13T04:19:13.264353Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}",
      • "code": "soa",
      • "description": "Oracle SOA Suite 12c (12.2.1.4.0)"
      },
    • "relationships": {
      • "template_versions": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/templates/soa",
      • "template_versions": "/api/projects/opc/templates/soa/versions"
      },
    • "meta": null
    }
}

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

Response Schema: application/vnd.api+json
required
object

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "35e7c506-b6b7-41c2-88dc-6c78f6e20331",
    • "type": "template",
    • "attributes": {
      • "name": "Oracle SOA template",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "archived": true,
      • "disabled": false,
      • "created_at": "2025-02-13T04:19:13.520963Z",
      • "updated_at": "2025-02-13T04:19:13.555229Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}",
      • "code": "soa",
      • "description": "Oracle SOA Suite 12c (12.2.1.4.0)"
      },
    • "relationships": {
      • "template_versions": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/templates/soa",
      • "template_versions": "/api/projects/opc/templates/soa/versions"
      },
    • "meta": null
    }
}

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

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "user": "limepoint",
      • "password": "password",
      • "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "68814ff6-15a3-4649-94da-7527fa2a7501",
    • "type": "template",
    • "attributes": {
      • "name": "Oracle SOA template",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "archived": false,
      • "disabled": false,
      • "created_at": "2025-02-13T04:19:13.916322Z",
      • "updated_at": "2025-02-13T04:19:13.948173Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}",
      • "code": "soa",
      • "description": "Oracle SOA Suite 12c (12.2.1.4.0)"
      },
    • "relationships": {
      • "template_versions": {
        }
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/templates/soa",
      • "template_versions": "/api/projects/opc/templates/soa/versions"
      },
    • "meta": null
    }
}

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": {
    • "id": "69d818e5-b485-4d63-9c2a-3b9650b837c9",
    • "type": "git_remote",
    • "attributes": {},
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/git_remotes/69d818e5-b485-4d63-9c2a-3b9650b837c9"
      },
    • "meta": null
    }
}

List Git remotes

Lists all Git remotes for a project.

path Parameters
project_code
required
string
Example: opc

project code

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "94d22fa3-7955-4f2f-a80d-cbf16b3a922f",
      • "type": "git_remote",
      • "attributes": {
        },
      • "links": {
        },
      • "meta": null
      }
    ]
}

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: 298e0cbc-8857-487a-b902-27c6fc702e54

remote id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "23464f98-a0f6-416d-abe6-5838cd8269a4",
    • "type": "git_remote",
    • "attributes": {
      • "name": "github",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "archived": false,
      • "disabled": false,
      • "created_at": "2025-02-13T04:18:50.250443Z",
      • "updated_at": "2025-02-13T04:18:50.250443Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}"
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/git_remotes/23464f98-a0f6-416d-abe6-5838cd8269a4"
      },
    • "meta": null
    }
}

Archive Git remote

Archives/unarchives a project Git remote.

path Parameters
project_code
required
string
Example: opc

project code

id_to_archive
required
string
Example: 298e0cbc-8857-487a-b902-27c6fc702e54

remote id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "65615923-a987-40a3-ab51-12d824274d44",
    • "type": "git_remote",
    • "attributes": {
      • "name": "github",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "archived": true,
      • "disabled": false,
      • "created_at": "2025-02-13T04:18:50.564038Z",
      • "updated_at": "2025-02-13T04:18:50.608584Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}"
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/git_remotes/65615923-a987-40a3-ab51-12d824274d44"
      },
    • "meta": null
    }
}

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: 298e0cbc-8857-487a-b902-27c6fc702e54

remote id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "user": "limepoint",
      • "password": "password",
      • "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "a613ff15-0aa8-48e9-868e-7b53afb3ebcc",
    • "type": "git_remote",
    • "attributes": {
      • "name": "github",
      • "url": "https://github.com/LimePoint/opschain-getting-started",
      • "archived": false,
      • "disabled": false,
      • "created_at": "2025-02-13T04:18:51.059732Z",
      • "updated_at": "2025-02-13T04:18:51.095213Z",
      • "user": "{{hidden}}",
      • "password": "{{hidden}}",
      • "ssh_key_data": "{{hidden}}"
      },
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/git_remotes/a613ff15-0aa8-48e9-868e-7b53afb3ebcc"
      },
    • "meta": null
    }
}

Delete Git remote

Deletes a project Git remote if it has no changes, otherwise it removes the credentials.

path Parameters
project_code
required
string
Example: opc

project code

id_to_delete
required
string
Example: 298e0cbc-8857-487a-b902-27c6fc702e54

remote id

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "26ccafe5-fa11-48df-b78a-dc0b50587a14",
    • "type": "git_remote",
    • "attributes": {},
    • "links": {
      • "project": "/api/projects/opc",
      • "self": "/api/projects/opc/git_remotes/26ccafe5-fa11-48df-b78a-dc0b50587a14"
      },
    • "meta": {
      • "credentials_removed": true,
      • "messages": [
        ]
      }
    }
}

Bookmarks

Endpoints to interact with bookmarks.

Notes:

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

Create bookmark

Create 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": {
    • "id": "92abad99-6a75-4ca7-bdda-d84fd210ed6c",
    • "type": "bookmark",
    • "attributes": {},
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/92abad99-6a75-4ca7-bdda-d84fd210ed6c",
      • "parent": "/api/projects/opc/assets/prj_soa"
      }
    }
}

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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "3ef96855-dc1b-48bc-957d-1e59232fa6c8",
      • "type": "bookmark",
      • "attributes": {},
      • "links": {
        }
      }
    ]
}

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: 481edb5f-f5ec-41a3-a506-d53c6833c3af

bookmark id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "b08988e4-2d69-44a3-8dd4-d75e488729b0",
    • "type": "bookmark",
    • "attributes": {},
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/b08988e4-2d69-44a3-8dd4-d75e488729b0",
      • "parent": "/api/projects/opc/assets/prj_soa"
      }
    }
}

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: 481edb5f-f5ec-41a3-a506-d53c6833c3af

bookmark id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "4af7ff37-05a1-4619-b6bd-33ad3e84e3d7",
    • "type": "bookmark",
    • "attributes": {
      • "url": "https://updated.server.com:8080/new/path",
      • "description": "Updated server console path",
      • "created_by": "margherita_gislason",
      • "created_at": "2025-02-13T04:18:45.141812Z",
      • "updated_at": "2025-02-13T04:18:45.181372Z"
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/bookmarks/4af7ff37-05a1-4619-b6bd-33ad3e84e3d7",
      • "parent": "/api/projects/opc/assets/prj_soa"
      }
    }
}

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: 481edb5f-f5ec-41a3-a506-d53c6833c3af

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 Schema: application/vnd.api+json
required
Array of objects
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "1e69e166-7cd3-4e89-8081-c6b8ed089c88",
      • "type": "mintmodel_history",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

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: 832f388b-db82-46b0-aec4-ffbebd7445b6

MintModel history id

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "6c5465fd-362f-42ac-a557-09e018126ea0",
    • "type": "mintmodel_history",
    • "attributes": {
      • "created_at": "2025-02-13T04:18:54.160327Z",
      • "updated_at": "2025-02-13T04:18:54.160327Z"
      },
    • "relationships": {
      • "parents": {
        },
      • "mintmodel": {
        },
      • "opschain_changes": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/6c5465fd-362f-42ac-a557-09e018126ea0"
      }
    },
  • "included": [
    • {
      • "id": "1b3e56b1-2cf1-4c8b-ba2e-415b9a811846",
      • "type": "mintmodel",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

List MintModels

List all MintModels for an asset.

path Parameters
project_code
required
string
Example: opc

project code

asset_code
required
string
Example: prj_soa

asset code

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "8b59a4ef-9be0-48e2-9f41-f974c2043e53",
      • "type": "mintmodel",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

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: e7e6ef31-02e5-4b26-8fba-6248b15f6c7d

MintModel id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "95d40e2c-0a84-4fe5-911e-3b39243196da",
    • "type": "mintmodel",
    • "attributes": {
      • "data": {
        },
      • "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
      • "created_at": "2025-02-13T04:18:54.919400Z",
      • "updated_at": "2025-02-13T04:18:54.919400Z"
      },
    • "relationships": {
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodels/95d40e2c-0a84-4fe5-911e-3b39243196da",
      • "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
      }
    }
}

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 Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "3a1de378-4764-4d39-b66c-b85f77226a71",
    • "type": "mintmodel",
    • "attributes": {
      • "data": {
        },
      • "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
      • "created_at": "2025-02-13T04:18:55.371052Z",
      • "updated_at": "2025-02-13T04:18:55.371052Z"
      },
    • "relationships": {
      • "mintmodel_history": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/assets/prj_soa/mintmodels/3a1de378-4764-4d39-b66c-b85f77226a71",
      • "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
      }
    }
}

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 Schema: application/vnd.api+json
required
Array of objects
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "370ccf60-be2c-4e6f-8208-de45c147c98f",
      • "type": "workflow",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

Create workflow

Create a workflow

path Parameters
project_code
required
string
Example: opc

project code

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "code": "srmap",
      • "name": "connect",
      • "description": "Calculating the application won't do anything, we need to copy the optical gb bus!",
      • "steps": [
        ],
      • "archived": false,
      • "draft": false,
      • "source_yaml": "---\ncode: srmap\nname: connect\ndescription: Calculating the application won't do anything, we need to copy the optical\n gb bus!\ncreated_by: sylvie\nsteps:\n- action: compress\n target: \"/projects/zlaws/assets/qulx9\"\n type: change\n"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "779fd64c-e7ed-42af-92ef-cc7f3802fa4b",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets_new",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "archived": false,
      • "version": 1,
      • "draft": false,
      • "created_by": "jillian",
      • "created_at": "2025-02-13T04:19:44.673339Z",
      • "updated_at": "2025-02-13T04:19:44.673339Z",
      • "source_yaml": "---\ncode: assets\nname: assets workflow\ndescription: workflow for assets\ncreated_by: wilfredo_brekke\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
      • "steps": [
        ]
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets_new",
      • "versions": "/api/projects/opc/workflows/assets_new/versions",
      • "latest_version": "/api/projects/opc/workflows/assets_new/versions/1",
      • "current_published_version": "/api/projects/opc/workflows/assets_new/versions/1",
      • "project": "/api/projects/opc",
      • "runs": "/api/projects/opc/workflows/assets_new/runs"
      }
    }
}

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 Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "b863be20-2757-4b83-825b-24b472227510",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "archived": false,
      • "version": 1,
      • "draft": false,
      • "created_by": "jannet.reynolds",
      • "created_at": "2025-02-13T04:19:45.819645Z",
      • "updated_at": "2025-02-13T04:19:45.819674Z",
      • "source_yaml": "---\ncode: assets\nname: assets workflow\ndescription: workflow for assets\ncreated_by: jannet.reynolds\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
      • "steps": [
        ]
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets",
      • "versions": "/api/projects/opc/workflows/assets/versions",
      • "latest_version": "/api/projects/opc/workflows/assets/versions/1",
      • "current_published_version": "/api/projects/opc/workflows/assets/versions/1",
      • "project": "/api/projects/opc",
      • "runs": "/api/projects/opc/workflows/assets/runs"
      }
    }
}

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
object

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "name": "new workflow name",
      • "steps": [
        ],
      • "draft": true,
      • "description": "new description",
      • "archived": false,
      • "source_yaml": "string"
      }
    },
  • "meta": {
    • "validate": true
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "f7217f2b-c067-45e1-b7ca-a8d3b3784a90",
    • "type": "workflow",
    • "attributes": {
      • "code": "assets",
      • "name": "new workflow name",
      • "description": "new description",
      • "archived": false,
      • "version": 2,
      • "draft": true,
      • "created_by": "eden.koss",
      • "created_at": "2025-02-13T04:19:46.631922Z",
      • "updated_at": "2025-02-13T04:19:46.706768Z",
      • "source_yaml": "---\ncode: assets\nname: assets workflow\ndescription: workflow for assets\ncreated_by: eden.koss\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
      • "steps": [
        ]
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets",
      • "versions": "/api/projects/opc/workflows/assets/versions",
      • "latest_version": "/api/projects/opc/workflows/assets/versions/2",
      • "current_published_version": "/api/projects/opc/workflows/assets/versions/1",
      • "project": "/api/projects/opc",
      • "runs": "/api/projects/opc/workflows/assets/runs"
      }
    }
}

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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "32fac2a8-3e09-4a02-9056-adad685d9783",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "links": {
        }
      }
    ]
}

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

version

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "287a52f7-7f7e-4c62-a5c3-9a1d4c9c9050",
    • "type": "workflow_version",
    • "attributes": {
      • "code": "assets",
      • "name": "assets workflow",
      • "description": "workflow for assets",
      • "draft": false,
      • "archived": false,
      • "version": 1,
      • "created_by": "young_konopelski",
      • "created_at": "2025-02-13T04:19:42.699305Z",
      • "updated_at": "2025-02-13T04:19:42.699305Z",
      • "source_yaml": "---\ncode: assets\nname: assets workflow\ndescription: workflow for assets\ncreated_by: young_konopelski\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
      • "steps": [
        ]
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/versions/1",
      • "runs": "/api/projects/opc/workflows/assets/versions/1/runs",
      • "workflow": "/api/projects/opc/workflows/assets",
      • "project": "/api/projects/opc"
      }
    }
}

Properties

Endpoints to interact with properties.

Show properties

Shows the current properties JSON and its version.

path Parameters
properties_id
required
string
Example: 2db05b2b-52cd-4190-9132-6ac93c0517e0

properties id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "b024e758-22d5-404e-b58e-4734a2d03fed",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2025-02-13T04:19:01.655992Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/b024e758-22d5-404e-b58e-4734a2d03fed",
      • "current_version": "/api/properties/b024e758-22d5-404e-b58e-4734a2d03fed/versions/1",
      • "versions": "/api/properties/b024e758-22d5-404e-b58e-4734a2d03fed/versions"
      }
    }
}

Update properties

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

path Parameters
id_to_update
required
string
Example: 2db05b2b-52cd-4190-9132-6ac93c0517e0

properties id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "data": {
        },
      • "version": 1
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "69adf701-2727-4975-8e55-26b3d6c64d38",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2025-02-13T04:19:01.918390Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/69adf701-2727-4975-8e55-26b3d6c64d38",
      • "current_version": "/api/properties/69adf701-2727-4975-8e55-26b3d6c64d38/versions/2",
      • "versions": "/api/properties/69adf701-2727-4975-8e55-26b3d6c64d38/versions"
      }
    }
}

Update properties (unsafe)

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

path Parameters
id_to_set
required
string
Example: 2db05b2b-52cd-4190-9132-6ac93c0517e0

properties id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "4b4e5b09-98b5-42aa-ad90-4812b63ffa4c",
    • "type": "properties",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2025-02-13T04:19:02.443649Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/properties/4b4e5b09-98b5-42aa-ad90-4812b63ffa4c",
      • "current_version": "/api/properties/4b4e5b09-98b5-42aa-ad90-4812b63ffa4c/versions/2",
      • "versions": "/api/properties/4b4e5b09-98b5-42aa-ad90-4812b63ffa4c/versions"
      }
    }
}

Properties versions

Endpoints to interact with the version history for properties.

List properties versions

Lists all versions of an OpsChain properties.

path Parameters
properties_id
required
string
Example: 2db05b2b-52cd-4190-9132-6ac93c0517e0

properties id

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "78b92a11-b7ed-4fcd-b0d3-731080edb2fd",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show properties version

Shows the properties JSON for this properties version.

path Parameters
properties_id
required
string
Example: 2db05b2b-52cd-4190-9132-6ac93c0517e0

properties id

version_number
required
integer
Example: 1

version number

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "350b5f1f-ab70-44f9-9845-d2f578fb6290",
    • "type": "properties_version",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2025-02-13T04:19:03.118836Z",
      • "owner_type": "project"
      },
    • "relationships": {
      • "properties": {
        }
      },
    • "links": {
      • "versions": "/api/properties/98f9edf4-5d86-4c4b-a738-8f9b8472cad6/versions",
      • "owner": "/api/projects/opc",
      • "self": "/api/properties/98f9edf4-5d86-4c4b-a738-8f9b8472cad6/versions/1"
      }
    }
}

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 Schema: application/vnd.api+json
required
Array of objects
object
Array of objects or objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "36d5f208-5337-4db5-90de-4231c76a5146",
      • "type": "change",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "e005a388-5a54-4a6f-9062-b1c9c3214faf",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "1c5cf677-d2ea-4413-bca1-3a1d2ff3325d",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "5e209c70-be70-4018-8cdd-689bbe185da4",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false,
    • "has_any": true
    }
}

Create change

Creates a change in a specific project, environment or asset.

Notes:

  1. When creating changes via a project, environment or asset changes path (e.g. POST to /api/projects/{project_code}/changes) the parent_path request attributes must not be supplied as the parent will be derived from the path.
  2. When creating changes for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/changes) the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be derived from the asset's template.
Request Body schema: application/vnd.api+json
required
object

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "action": "parse",
      • "parent_path": "/projects/opc/environments/dev",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "metadata": {
        }
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "0296dd30-44bf-4bd4-9da6-165a1af7aa0e",
    • "type": "change",
    • "attributes": {
      • "created_by": "darell",
      • "name": null,
      • "action": "parse",
      • "initial_step_tree": null,
      • "metadata": {
        },
      • "automated": false,
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "status_code": "initializing",
      • "created_at": "2025-02-13T04:18:46.883285Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2025-02-13T04:18:46.886237Z",
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": null,
      • "requires_approval_from": null
      },
    • "relationships": {
      • "parents": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "workflow_run": {
        },
      • "workflow": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/5054721e-6413-4dd5-948c-301b336ea6d7",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/0296dd30-44bf-4bd4-9da6-165a1af7aa0e",
      • "log_lines": "/api/changes/0296dd30-44bf-4bd4-9da6-165a1af7aa0e/log_lines"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "2dca2da7-cf7a-4b67-b698-c37347d54870",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show change

Shows a change, including it's parent nodes.

path Parameters
change_id
required
string
Example: 4da6cb56-64d1-4cf3-bad1-e0c103183f2a

change id

query Parameters
include
string
Example: include=steps,parents

Include the change steps and parents in the response

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "869f6943-4fd2-4ce9-a7e1-df32a6a47737",
    • "type": "change",
    • "attributes": {
      • "created_by": "cleo",
      • "name": "back_up",
      • "action": "back_up",
      • "initial_step_tree": null,
      • "metadata": {
        },
      • "automated": true,
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "status_code": "success",
      • "created_at": "2025-02-13T04:18:47.340479Z",
      • "started_at": "2025-02-13T04:10:07.013374Z",
      • "finished_at": "2025-02-13T04:13:32.724833Z",
      • "updated_at": "2025-02-13T04:18:47.342774Z",
      • "asset_name": null,
      • "environment_name": "Development",
      • "project_name": "OpsChain",
      • "git_remote_name": "github",
      • "git_rev": "main",
      • "commit_sha": "d33bb3b20b7c6f1e54535cb876b1f33a329c07be",
      • "requires_approval_from": null
      },
    • "relationships": {
      • "properties": {
        },
      • "parents": {
        },
      • "root_step": {
        },
      • "steps": {
        },
      • "workflow_run": {
        },
      • "workflow": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/d5ae6e49-a9a4-4ded-87f2-cf7850ed4397",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/projects/opc/environments/dev/changes/869f6943-4fd2-4ce9-a7e1-df32a6a47737",
      • "log_lines": "/api/changes/869f6943-4fd2-4ce9-a7e1-df32a6a47737/log_lines"
      },
    • "meta": {
      • "parallel_changes_allowed": false,
      • "blocked_by_change_in_same_parent": false,
      • "blocked_by_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "dacbf483-f6b5-4893-be11-ff0282ae5c7c",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "e8ed8301-a3a0-4efe-94cf-35ea473fe9f2",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "7c89d2bd-daf0-424f-908e-8cd2eb16d264",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}

Cancel change

Cancels a change.

path Parameters
change_id
required
string
Example: 4da6cb56-64d1-4cf3-bad1-e0c103183f2a

change id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Automation rules

List rules

Lists all automation 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 Schema: application/vnd.api+json
required
Array of automated_change_rule_element (object) or automated_workflow_rule_element (object)
Array of project_element (object) or environment_element (object) or asset_element (object)
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "e9d4e541-3192-4d13-8542-5ab42cc9c39b",
      • "type": "automated_change_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "888963ef-ca33-43d6-ad8b-0d7dccc8a3d2",
      • "type": "automated_workflow_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "included": [
    • {
      • "id": "8f6e7312-5ba2-477e-8070-3bb772a37381",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "5edae168-9990-4fdc-91b0-529aebef2f78",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ],
  • "meta": {
    • "has_any": true
    }
}

Create rule

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

Notes:

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

  2. When creating automation rules for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/automation_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.

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

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

Responses

Request samples

Content type
application/vnd.api+json
Example
{
  • "data": {
    • "attributes": {
      • "git_rev": "master",
      • "action": "install_os",
      • "cron_schedule": "1 22 23 3 *",
      • "new_commits_only": true,
      • "repeat": false,
      • "metadata": {
        },
      • "parent_path": "/projects/opc/environments/dev",
      • "git_remote_name": "github"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "47bf9f6a-66e4-43ed-b80c-c5ddd766f66c",
    • "type": "automated_change_rule",
    • "attributes": {
      • "created_by": "bryon.mills",
      • "cron_schedule": "11 23 21 7 *",
      • "repeat": false,
      • "metadata": {
        },
      • "enabled": true,
      • "created_at": "2025-02-13T04:18:41.349132Z",
      • "next_run_at": "2025-07-21T13:11:00.000000Z",
      • "action": "different_action",
      • "new_commits_only": false,
      • "git_rev": "primary",
      • "project_name": "OpsChain",
      • "project_code": "opc",
      • "asset_code": null,
      • "asset_name": null,
      • "environment_code": "dev",
      • "environment_name": "Development",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "parents": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/ab235f9b-33dc-4fb4-b807-abc95a1c2333",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/automation_rules/47bf9f6a-66e4-43ed-b80c-c5ddd766f66c"
      }
    }
}

Show rule

Shows an automation rule.

path Parameters
automated_change_id
required
string
Example: 42a2e6e5-80c6-4591-abcd-e6fd0ba0059d

automated change id

query Parameters
include
string
Example: include=parents

Include the automated change parents in the response

Responses

Response Schema: application/vnd.api+json
required
automated_change_rule_element (object) or automated_workflow_rule_element (object)
Array of project_element (object) or environment_element (object) or asset_element (object)

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "80dd34af-3f9b-4284-9534-0244fcd6a3cd",
    • "type": "automated_change_rule",
    • "attributes": {
      • "created_by": "stephanie",
      • "cron_schedule": "3 11 8 12 *",
      • "repeat": true,
      • "metadata": {
        },
      • "enabled": true,
      • "created_at": "2025-02-13T04:18:41.962156Z",
      • "next_run_at": "2025-12-08T00:03:00.000000Z",
      • "action": "copy",
      • "new_commits_only": true,
      • "git_rev": "redundant",
      • "project_name": "OpsChain",
      • "project_code": "opc",
      • "asset_code": null,
      • "asset_name": null,
      • "environment_code": "dev",
      • "environment_name": "Development",
      • "git_remote_name": "github"
      },
    • "relationships": {
      • "parents": {
        }
      },
    • "links": {
      • "git_remote": "/api/projects/opc/git_remotes/ca329efc-d37a-4e67-ba56-eeaeee7f49d7",
      • "project": "/api/projects/opc",
      • "parent": "/api/projects/opc/environments/dev",
      • "self": "/api/automation_rules/80dd34af-3f9b-4284-9534-0244fcd6a3cd"
      }
    },
  • "included": [
    • {
      • "id": "b40d1a55-a33e-4041-ae8e-e3e1df112f4d",
      • "type": "project",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      },
    • {
      • "id": "5e94fdc3-44ee-4243-aaa7-601b702e3789",
      • "type": "environment",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": {
        }
      }
    ]
}

Delete rule

Deletes an automation rule.

path Parameters
automated_change_id
required
string
Example: 42a2e6e5-80c6-4591-abcd-e6fd0ba0059d

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 Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "867d7677-e19c-4738-80e9-dd6d8ea0fdd0",
      • "type": "step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show step

Shows a change step.

path Parameters
step_id
required
string
Example: 793fc072-e40e-4327-b001-40c13e8896d0

step id

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "945eb6f1-2807-438d-a76c-9a292c145cfa",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": null,
      • "action": "hack",
      • "name": "hack",
      • "step_type": "standard",
      • "child_execution_strategy": "sequential",
      • "change_id": "dc0ca097-17ae-4b49-a871-092252cdcf6e",
      • "created_at": "2025-02-13T04:09:15.000191Z",
      • "started_at": "2025-02-13T04:10:15.000191Z",
      • "finished_at": "2025-02-13T04:12:18.268089Z",
      • "updated_at": "2025-02-13T04:19:05.845270Z",
      • "status_code": "success"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "change": {
        },
      • "properties_versions": {
        }
      },
    • "links": {
      • "parent": "/api/changes/dc0ca097-17ae-4b49-a871-092252cdcf6e",
      • "change": "/api/projects/opc/environments/dev/changes/dc0ca097-17ae-4b49-a871-092252cdcf6e",
      • "log_lines": "/api/steps/945eb6f1-2807-438d-a76c-9a292c145cfa/log_lines",
      • "self": "/api/steps/945eb6f1-2807-438d-a76c-9a292c145cfa"
      }
    },
  • "included": [
    • {
      • "id": "d8a54627-a978-4694-8f53-8b4a6498b6db",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "14c71a31-f25d-4a08-bb4a-c55371ea8162",
      • "type": "properties_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "436b585b-4052-4dd3-9d9a-fca51b5334a0",
      • "type": "properties",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Continue step

Continues a "waiting" change step.

path Parameters
step_id
required
string
Example: 5e1661d0-c945-46d3-b2c5-20ab75f80707

step id

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

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Manually removed from load balancer."
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "49a1c56f-6328-4933-9a37-8040d2d4b318",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [
        ],
      • "requires_approval_from": null,
      • "action": "back_up",
      • "name": "back_up",
      • "step_type": "standard",
      • "child_execution_strategy": "sequential",
      • "change_id": "6fa6f8a6-7469-4654-a73b-365be5a03d87",
      • "created_at": "2025-02-13T04:08:43.794858Z",
      • "started_at": "2025-02-13T04:09:43.794858Z",
      • "finished_at": "2025-02-13T04:19:07.324745Z",
      • "updated_at": "2025-02-13T04:19:07.346512Z",
      • "status_code": "success"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "change": {
        },
      • "properties_versions": {
        }
      },
    • "links": {
      • "parent": "/api/changes/6fa6f8a6-7469-4654-a73b-365be5a03d87",
      • "change": "/api/projects/opc/environments/dev/changes/6fa6f8a6-7469-4654-a73b-365be5a03d87",
      • "log_lines": "/api/steps/49a1c56f-6328-4933-9a37-8040d2d4b318/log_lines",
      • "self": "/api/steps/49a1c56f-6328-4933-9a37-8040d2d4b318"
      }
    }
}

Approve step

Approves a change step that needs approval.

path Parameters
step_id
required
string
Example: 5e1661d0-c945-46d3-b2c5-20ab75f80707

step id

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

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "As per CR 7 👍"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "43a0af6c-05ab-4f66-836e-5b9258a1594d",
    • "type": "step",
    • "attributes": {
      • "approved_by": [
        ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": "an-ldap-group",
      • "action": "reboot",
      • "name": "reboot",
      • "step_type": "standard",
      • "child_execution_strategy": "sequential",
      • "change_id": "2e23ddaf-d32b-48a8-9408-542a42b7f093",
      • "created_at": "2025-02-13T04:10:09.759052Z",
      • "started_at": "2025-02-13T04:11:09.759052Z",
      • "finished_at": null,
      • "updated_at": "2025-02-13T04:19:08.230285Z",
      • "status_code": "queued"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "change": {
        },
      • "properties_versions": {
        }
      },
    • "links": {
      • "parent": "/api/changes/2e23ddaf-d32b-48a8-9408-542a42b7f093",
      • "change": "/api/projects/opc/environments/dev/changes/2e23ddaf-d32b-48a8-9408-542a42b7f093",
      • "log_lines": "/api/steps/43a0af6c-05ab-4f66-836e-5b9258a1594d/log_lines",
      • "self": "/api/steps/43a0af6c-05ab-4f66-836e-5b9258a1594d"
      }
    }
}

Reject step

Rejects a change step that needs approval.

path Parameters
step_id
required
string
Example: 5e1661d0-c945-46d3-b2c5-20ab75f80707

step id

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

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Failed user acceptance testing"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "43037504-adf7-4fd9-b0d0-a5bf21153ce1",
    • "type": "step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [
        ],
      • "continued_by": [ ],
      • "requires_approval_from": "an-ldap-group",
      • "action": "back_up",
      • "name": "back_up",
      • "step_type": "standard",
      • "child_execution_strategy": "sequential",
      • "change_id": "56bcbe48-a472-498e-892c-62377660a460",
      • "created_at": "2025-02-13T04:12:13.535261Z",
      • "started_at": "2025-02-13T04:13:13.535261Z",
      • "finished_at": "2025-02-13T04:19:09.164775Z",
      • "updated_at": "2025-02-13T04:19:09.172516Z",
      • "status_code": "rejected"
      },
    • "relationships": {
      • "properties": {
        },
      • "children": {
        },
      • "change": {
        },
      • "properties_versions": {
        }
      },
    • "links": {
      • "parent": "/api/changes/56bcbe48-a472-498e-892c-62377660a460",
      • "change": "/api/projects/opc/environments/dev/changes/56bcbe48-a472-498e-892c-62377660a460",
      • "log_lines": "/api/steps/43037504-adf7-4fd9-b0d0-a5bf21153ce1/log_lines",
      • "self": "/api/steps/43037504-adf7-4fd9-b0d0-a5bf21153ce1"
      }
    }
}

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: 4da6cb56-64d1-4cf3-bad1-e0c103183f2a
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 Schema: application/vnd.api+json
required
Array of objects
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "86153223-f62e-4c12-ab84-e645d3b1c873",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

List step log lines

List the log lines for a change step.

path Parameters
step_id
required
string
Example: 793fc072-e40e-4327-b001-40c13e8896d0
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 Schema: application/vnd.api+json
required
Array of objects
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "67eef1b8-a4ad-4c42-96c3-1a9d91f03919",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

List filtered log lines

List filtered log lines.

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[message_cont]=dolorem
limit
integer [ 1 .. 1000 ]
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 Schema: application/vnd.api+json
required
Array of objects
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "030c1ec8-ca16-4a9c-9155-c26445f12f1b",
      • "type": "log_line",
      • "attributes": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

Workflow runs

Endpoints to interact with workflow runs

Notes:

  • The list and show endpoints are available via the following paths:
    1. /workflow_runs - will return all workflow runs accessible to the user.
    2. /project/{project_code}/workflow_runs - will return all workflow runs for all this project's workflows.
    3. /project/{project_code}/workflows/{workflow_code}/workflow_runs - will return all workflow runs this workflow.
    4. /<path/to/asset>/workflow_runs - will return all workflow runs that include a change for this asset.

List workflow runs

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 Schema: application/vnd.api+json
required
Array of objects
object
Array of objects or objects or objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "f38f1d31-e626-4f72-9aa7-942f9532e6de",
      • "type": "workflow_run",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        },
      • "meta": { }
      }
    ],
  • "included": [
    • {
      • "id": "6111e6c3-ee9d-4b93-81da-e4e24e7d1ea9",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

Run a workflow

Runs a pre-defined workflow

path Parameters
project_code
required
string
Example: opc

project code

workflow_code
required
string
Example: assets

workflow code

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

Responses

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "33444413-548e-4c2d-b81d-bde6354103f2",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "automated": false,
      • "metadata": { },
      • "created_by": "kizzie",
      • "status_code": "pending",
      • "created_at": "2025-02-13T04:19:16.273267Z",
      • "started_at": null,
      • "finished_at": null,
      • "updated_at": "2025-02-13T04:19:16.275708Z",
      • "project_name": "OpsChain"
      },
    • "relationships": {
      • "workflow_version": {
        },
      • "parent_workflow_step": {
        },
      • "root_step": {
        },
      • "steps": {
        }
      },
    • "links": {
      • "parent": "/api/projects/opc",
      • "self": "/api/projects/opc/workflows/assets/runs/33444413-548e-4c2d-b81d-bde6354103f2"
      },
    • "meta": { }
    },
  • "included": [
    • {
      • "id": "b060836c-5e0f-41ff-a50d-4d35b6ced77b",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "b290b98b-60a1-445c-a89f-1614cbdc10e4",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "6b9f93dd-f7e8-4dd0-85fe-c2439c1d24b8",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show workflow run

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: 9f41f384-be86-4497-bc89-bee8031e1a88

workflow run id

Responses

Response Schema: application/vnd.api+json
required
object
Array of objects or objects or objects or objects or objects

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "5c638f16-8d0b-46a0-af47-c0d3b69b0e08",
    • "type": "workflow_run",
    • "attributes": {
      • "step_tree": {
        },
      • "automated": false,
      • "metadata": {
        },
      • "created_by": "walton",
      • "status_code": "success",
      • "created_at": "2025-02-13T04:19:18.816987Z",
      • "started_at": "2025-02-13T04:11:08.805880Z",
      • "finished_at": "2025-02-13T04:13:26.184351Z",
      • "updated_at": "2025-02-13T04:19:18.820756Z",
      • "project_name": "OpsChain"
      },
    • "relationships": {
      • "workflow_version": {
        },
      • "parent_workflow_step": {
        },
      • "root_step": {
        },
      • "steps": {
        }
      },
    • "links": {
      • "parent": "/api/projects/opc",
      • "self": "/api/projects/opc/workflows/assets/runs/5c638f16-8d0b-46a0-af47-c0d3b69b0e08"
      },
    • "meta": {
      • "parallel_workflows_allowed": false,
      • "blocked_by_same_workflow_running": false,
      • "blocked_by_queue": [ ]
      }
    },
  • "included": [
    • {
      • "id": "87176f0e-11fd-4cfa-bd4e-fcd091d6968a",
      • "type": "workflow_version",
      • "attributes": {
        },
      • "links": {
        }
      },
    • {
      • "id": "568684a7-6d9b-4238-ab25-6954fe85b765",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "30972fb9-72f8-426f-9f83-e55b633ce807",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "eef53491-177c-4224-97cf-750efefa4b72",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "64fa2d56-1558-4b40-9670-9f76ef77ba14",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "d642fbb3-1e5a-4e4f-a6e4-74c787596f4c",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "e7e1fb19-0663-4be7-b328-fb194821f5c3",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Cancel workflow run

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: 9f41f384-be86-4497-bc89-bee8031e1a88

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 all workflow steps

Lists all workflow steps.

Responses

Response Schema: application/vnd.api+json
required
Array of workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "35b288a8-cccb-477e-a444-7f3254edabdb",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "c87267d6-9552-4ed4-821b-27f01c576802",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "7cb5dc4f-ec66-40dd-8195-60a8a37ac745",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "f2006bec-ad23-4df1-af93-9327ff952392",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "3fb43316-a660-442f-a4cf-6098ae8c0ff3",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "837d1c89-218b-41ba-8681-f59d21256791",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "a395d746-4259-4657-aa66-2413b589f6fd",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "42ca6e93-16fc-473a-b88c-dfddd47584d0",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "bc20f0af-df7e-4a6d-adf0-21260cf43e16",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

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: assets

workflow code

run_id
required
string
Example: 9f41f384-be86-4497-bc89-bee8031e1a88

workflow run id

Responses

Response Schema: application/vnd.api+json
required
Array of workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "5c7f8101-7e1b-42dc-ad82-5c15eaf497d6",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "06844c55-93c4-48b6-9bb0-b48c11db3318",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "7f72f734-028e-4075-80e6-2ffedabd0564",
      • "type": "workflow_noop_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "f5ab12e5-945b-4cf6-a5d0-850142848353",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "f471d2ef-4fb5-44d2-8d1b-099309446af2",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "4e86c1b6-7c32-4c31-8c69-09632670ff23",
      • "type": "workflow_wait_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "e8acbe03-3184-48da-a81e-622da7399494",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "03604f86-237d-4311-a6eb-27e42a4a8a79",
      • "type": "workflow_change_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "fe9f82f2-aada-4fba-9717-cd6038176f71",
      • "type": "workflow_workflow_step",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show a workflow step

Shows a workflow step.

path Parameters
step_id
required
string
Example: 7cebb1c0-0e5c-4d54-868e-a4f9a6be0731

workflow step id

Responses

Response Schema: application/vnd.api+json
required
workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "b39e2e21-0aaa-431b-bfbc-502ce6cbfc4b",
    • "type": "workflow_noop_step",
    • "attributes": {
      • "lock_version": 0,
      • "created_by": "courtney",
      • "name": "et",
      • "status_code": "success",
      • "created_at": "2025-02-13T04:19:26.528487Z",
      • "started_at": "2025-02-13T04:09:55.724602Z",
      • "finished_at": "2025-02-13T04:12:26.647822Z",
      • "updated_at": "2025-02-13T04:19:26.528487Z",
      • "child_execution_strategy": "sequential"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/c4ecbfdf-331c-4570-bb05-26c1fba4752c/steps/b39e2e21-0aaa-431b-bfbc-502ce6cbfc4b",
      • "parent": "/api/projects/opc/workflows/assets/runs/c4ecbfdf-331c-4570-bb05-26c1fba4752c",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/c4ecbfdf-331c-4570-bb05-26c1fba4752c"
      }
    }
}

Show workflow step of a workflow run

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: 9f41f384-be86-4497-bc89-bee8031e1a88

workflow run id

step_id
required
string
Example: 7cebb1c0-0e5c-4d54-868e-a4f9a6be0731

workflow step id

Responses

Response Schema: application/vnd.api+json
required
workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "6e766f48-192b-4110-ba07-e22db67f0852",
    • "type": "workflow_noop_step",
    • "attributes": {
      • "lock_version": 0,
      • "created_by": "al_effertz",
      • "name": "cupiditate",
      • "status_code": "success",
      • "created_at": "2025-02-13T04:19:28.195603Z",
      • "started_at": "2025-02-13T04:14:26.093984Z",
      • "finished_at": "2025-02-13T04:17:32.385904Z",
      • "updated_at": "2025-02-13T04:19:28.195603Z",
      • "child_execution_strategy": "sequential"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/72b6928f-da7e-45d7-a9fc-1783c567ad53/steps/6e766f48-192b-4110-ba07-e22db67f0852",
      • "parent": "/api/projects/opc/workflows/assets/runs/72b6928f-da7e-45d7-a9fc-1783c567ad53",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/72b6928f-da7e-45d7-a9fc-1783c567ad53"
      }
    }
}

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: assets

workflow code

run_id
required
string
Example: 9f41f384-be86-4497-bc89-bee8031e1a88

workflow run id

step_id
required
string
Example: 3ae37722-dad2-4f0c-911c-e462f5a26b76

workflow step id

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

Responses

Response Schema: application/vnd.api+json
required
workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Done sanity checks. Ok to continue."
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "dadfcd3c-778c-4ca0-8568-06368b3b0d70",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [ ],
      • "continued_by": [
        ],
      • "requires_approval_from": null,
      • "lock_version": 1,
      • "created_by": "loreta",
      • "name": "Wait",
      • "status_code": "continued",
      • "created_at": "2025-02-13T04:11:03.858097Z",
      • "started_at": "2025-02-13T04:12:03.858097Z",
      • "finished_at": "2025-02-13T04:19:31.414338Z",
      • "updated_at": "2025-02-13T04:19:31.428659Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/d2394e25-5033-4aa7-81fc-f5d14ca5c1a0/steps/dadfcd3c-778c-4ca0-8568-06368b3b0d70",
      • "parent": "/api/projects/opc/workflows/assets/runs/d2394e25-5033-4aa7-81fc-f5d14ca5c1a0/steps/396dcdca-da96-4bd6-b7d0-d866d5c73ec3",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/d2394e25-5033-4aa7-81fc-f5d14ca5c1a0"
      }
    }
}

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: assets

workflow code

run_id
required
string
Example: 9f41f384-be86-4497-bc89-bee8031e1a88

workflow run id

step_id
required
string
Example: 3ae37722-dad2-4f0c-911c-e462f5a26b76

workflow step id

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

Responses

Response Schema: application/vnd.api+json
required
workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Ok to proceed."
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "7ecc015f-b0da-49d9-b1d8-81fa29ade694",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [
        ],
      • "rejected_by": [ ],
      • "continued_by": [ ],
      • "requires_approval_from": "an-ldap-group",
      • "lock_version": 1,
      • "created_by": "jae",
      • "name": "Approval",
      • "status_code": "approved",
      • "created_at": "2025-02-13T04:09:18.992377Z",
      • "started_at": "2025-02-13T04:10:18.992377Z",
      • "finished_at": "2025-02-13T04:19:34.224226Z",
      • "updated_at": "2025-02-13T04:19:34.240324Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/07a4c7b1-606e-4998-be2d-7ae203eb4fac/steps/7ecc015f-b0da-49d9-b1d8-81fa29ade694",
      • "parent": "/api/projects/opc/workflows/assets/runs/07a4c7b1-606e-4998-be2d-7ae203eb4fac/steps/82b9eb03-4b82-41ce-8cd5-ae28c57c1835",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/07a4c7b1-606e-4998-be2d-7ae203eb4fac"
      }
    }
}

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: assets

workflow code

run_id
required
string
Example: 9f41f384-be86-4497-bc89-bee8031e1a88

workflow run id

step_id
required
string
Example: 3ae37722-dad2-4f0c-911c-e462f5a26b76

workflow step id

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

Responses

Response Schema: application/vnd.api+json
required
workflow_noop_step_element (object) or workflow_change_step_element (object) or workflow_wait_step_element (object) or workflow_workflow_step_element (object)

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "message": "Ok to proceed."
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "7d1029e5-074e-4970-a832-00b334fc61da",
    • "type": "workflow_wait_step",
    • "attributes": {
      • "approved_by": [ ],
      • "rejected_by": [
        ],
      • "continued_by": [ ],
      • "requires_approval_from": "an-ldap-group",
      • "lock_version": 1,
      • "created_by": "arlinda",
      • "name": "Approval",
      • "status_code": "rejected",
      • "created_at": "2025-02-13T04:11:11.737522Z",
      • "started_at": "2025-02-13T04:12:11.737522Z",
      • "finished_at": "2025-02-13T04:19:38.588413Z",
      • "updated_at": "2025-02-13T04:19:38.597231Z"
      },
    • "relationships": {
      • "workflow_run": {
        },
      • "children": {
        }
      },
    • "links": {
      • "self": "/api/projects/opc/workflows/assets/runs/58e0740e-179b-469e-a7cb-4a010b1c8d9b/steps/7d1029e5-074e-4970-a832-00b334fc61da",
      • "parent": "/api/projects/opc/workflows/assets/runs/58e0740e-179b-469e-a7cb-4a010b1c8d9b/steps/e6d0ac84-dcbe-4b04-88ee-23df7b7e4cce",
      • "workflow_run": "/api/projects/opc/workflows/assets/runs/58e0740e-179b-469e-a7cb-4a010b1c8d9b"
      }
    }
}

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 Schema: application/vnd.api+json
required
Array of objects
object

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "7a4121d7-acaf-49bb-994f-6c459983044a",
      • "type": "event",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ],
  • "meta": {
    • "partial_response": false
    }
}

Create event

Creates an event.

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "type": "custom event",
      • "any_key": "with a value",
      • "another_key": "with a different value",
      • "nested": {
        }
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "291a771c-8e43-4c99-8c4e-ee1968805cdc",
    • "type": "event",
    • "attributes": {
      • "some": "event data",
      • "username": "haydee.sauer",
      • "system": false,
      • "type": "my event",
      • "created_at": "2025-02-13T04:18:48.421725Z"
      },
    • "relationships": {
      • "source": {
        }
      },
    • "links": {
      • "self": "/api/events/291a771c-8e43-4c99-8c4e-ee1968805cdc"
      }
    }
}

Show event

Shows an event.

path Parameters
event_id
required
string
Example: 9def357d-28bd-4cd7-8ee9-ad20f34320c5

event id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "cc93e1ff-e592-4311-8ed4-9cc8bf84f642",
    • "type": "event",
    • "attributes": {
      • "nested": {
        },
      • "any_key": "with a value",
      • "another_key": "with a different value",
      • "username": "reinaldo",
      • "system": false,
      • "type": "my custom event",
      • "created_at": "2025-02-13T04:18:48.860988Z"
      },
    • "relationships": {
      • "source": {
        }
      },
    • "links": {
      • "self": "/api/events/cc93e1ff-e592-4311-8ed4-9cc8bf84f642"
      }
    }
}

Settings

Endpoints to interact with settings.

Show settings

Shows the current settings.

path Parameters
settings_id
required
string
Example: 45e7b8fd-f05c-41a8-a8c9-1ab4d9bfe5bf

settings id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "e9baa0e8-879f-4342-8be0-a96915b73df1",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2025-02-13T04:19:03.476596Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/e9baa0e8-879f-4342-8be0-a96915b73df1",
      • "current_version": "/api/settings/e9baa0e8-879f-4342-8be0-a96915b73df1/versions/1",
      • "versions": "/api/settings/e9baa0e8-879f-4342-8be0-a96915b73df1/versions"
      }
    }
}

Update settings

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

path Parameters
id_to_update
required
string
Example: 45e7b8fd-f05c-41a8-a8c9-1ab4d9bfe5bf

settings id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "data": {
        },
      • "version": 1
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "d0e96b0b-3101-45d4-9ed2-6307026d1468",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2025-02-13T04:19:03.766636Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/d0e96b0b-3101-45d4-9ed2-6307026d1468",
      • "current_version": "/api/settings/d0e96b0b-3101-45d4-9ed2-6307026d1468/versions/2",
      • "versions": "/api/settings/d0e96b0b-3101-45d4-9ed2-6307026d1468/versions"
      }
    }
}

Update settings (unsafe)

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

path Parameters
id_to_set
required
string
Example: 45e7b8fd-f05c-41a8-a8c9-1ab4d9bfe5bf

settings id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

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

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "409b154a-d1de-4733-9af2-0691f6dfd477",
    • "type": "settings",
    • "attributes": {
      • "data": {
        },
      • "version": 2,
      • "created_at": "2025-02-13T04:19:04.654619Z"
      },
    • "relationships": {
      • "owner": {
        }
      },
    • "links": {
      • "self": "/api/settings/409b154a-d1de-4733-9af2-0691f6dfd477",
      • "current_version": "/api/settings/409b154a-d1de-4733-9af2-0691f6dfd477/versions/2",
      • "versions": "/api/settings/409b154a-d1de-4733-9af2-0691f6dfd477/versions"
      }
    }
}

Settings versions

Endpoints to interact with the version history for settings.

List settings versions

Lists all versions of an OpsChain settings.

path Parameters
settings_id
required
string
Example: 45e7b8fd-f05c-41a8-a8c9-1ab4d9bfe5bf

settings id

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "e0506c82-af83-4094-9393-2882799ff6fb",
      • "type": "settings_version",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Show settings version

Shows the settings values for this settings version.

path Parameters
settings_id
required
string
Example: 45e7b8fd-f05c-41a8-a8c9-1ab4d9bfe5bf

settings id

version_number
required
integer
Example: 1

version number

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "53e37c45-0771-448d-a134-c333f0c2cd06",
    • "type": "settings_version",
    • "attributes": {
      • "data": {
        },
      • "version": 1,
      • "created_at": "2025-02-13T04:19:05.271900Z"
      },
    • "relationships": {
      • "settings": {
        }
      },
    • "links": {
      • "versions": "/api/settings/f3638136-3bcf-4655-8ee0-127306ba28a7/versions",
      • "owner": "/api/projects/opc",
      • "self": "/api/settings/f3638136-3bcf-4655-8ee0-127306ba28a7/versions/1"
      }
    }
}

Authorisation rules

Endpoints to interact with authorisation rules.

List rules

Lists all authorisation rules.

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[allow_eq]=true

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "e8c665db-b004-4047-9996-4d1216680e2e",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "506a55d2-3b15-4ce1-a842-cea0459be0f0",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "a694cc55-5348-49db-8885-02f7c2c0a872",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "e870ac17-5012-4f2a-a600-e3602297ae3c",
      • "type": "authorisation_rule",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Create rule

Create an authorisation rule.

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "path": "^(/[^/]+/[^/]+)*/projects/opc/environments/dev",
      • "allow": false,
      • "rule_action": "readable",
      • "name": "Unauthorise development"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "be6528a1-4c4b-445f-b63c-415410584142",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "compress",
      • "path": "^/projects/krafo/environments/rqfqk",
      • "rule_action": "updatable",
      • "allow": true,
      • "created_by": "iona",
      • "created_at": "2025-02-13T04:18:38.419922Z",
      • "updated_at": "2025-02-13T04:18:38.419922Z"
      },
    • "relationships": {
      • "authorisation_rule_mappings": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/be6528a1-4c4b-445f-b63c-415410584142",
      • "authorisation_rule_mappings": "/api/authorisation_rules/be6528a1-4c4b-445f-b63c-415410584142/mappings"
      }
    }
}

Show rule

Shows an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "36996a1b-f980-47ac-a63c-c16d78f3d220",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "Unauthorise development",
      • "path": "^(/[^/]+/[^/]+)*/projects/opc/environments/dev",
      • "rule_action": "readable",
      • "allow": false,
      • "created_by": "scott",
      • "created_at": "2025-02-13T04:18:38.750131Z",
      • "updated_at": "2025-02-13T04:18:38.750131Z"
      },
    • "relationships": {
      • "authorisation_rule_mappings": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/36996a1b-f980-47ac-a63c-c16d78f3d220",
      • "authorisation_rule_mappings": "/api/authorisation_rules/36996a1b-f980-47ac-a63c-c16d78f3d220/mappings"
      }
    }
}

Update authorisation rule

Update an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "path": "/projects/demo/environments/dev",
      • "allow": false,
      • "rule_action": "read",
      • "name": "Deny read on dev environment"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "ed3e24ff-3416-40ed-b36d-ad3a4ffe4217",
    • "type": "authorisation_rule",
    • "attributes": {
      • "name": "Deny read on dev environment",
      • "path": "^(/[^/]+/[^/]+)*/projects/demo/environments/dev",
      • "rule_action": "readable",
      • "allow": false,
      • "created_by": "lucius",
      • "created_at": "2025-02-13T04:18:39.488973Z",
      • "updated_at": "2025-02-13T04:18:39.515370Z"
      },
    • "relationships": {
      • "authorisation_rule_mappings": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rules/ed3e24ff-3416-40ed-b36d-ad3a4ffe4217",
      • "authorisation_rule_mappings": "/api/authorisation_rules/ed3e24ff-3416-40ed-b36d-ad3a4ffe4217/mappings"
      }
    }
}

Delete rule

Delete an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Authorisation rule mappings

Endpoints to interact with authorisation rule mappings.

List authorisation rule mappings

Lists all authorisation rule mappings.

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[username_eq]=opschain

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "dd1cae01-e588-45bf-9a12-76a4d2ffcf1b",
      • "type": "authorisation_rule_mapping",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "cb0b07e6-6d3b-4a1b-b558-07d984321ecf",
      • "type": "authorisation_rule_mapping",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "d7004481-ad1a-4da9-81cd-8a83962df85d",
      • "type": "authorisation_rule_mapping",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      },
    • {
      • "id": "73100e92-a3a7-482b-93e2-4aa4bb408014",
      • "type": "authorisation_rule_mapping",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

List specific authorisation rule mappings

Lists all authorisation rule mappings for a specific authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

query Parameters
filter[<query/sort filter>]=
string
Example: filter[<query/sort filter>]==> filter[username_eq]=opschain

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "a56a7bd5-b7f8-48eb-be91-c0c84d1687a1",
      • "type": "authorisation_rule_mapping",
      • "attributes": {
        },
      • "relationships": {
        },
      • "links": {
        }
      }
    ]
}

Create authorisation rule mappings

Create an authorisation rule mapping.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

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

Responses

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "username": "string",
      • "groupname": true
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "c1894365-f1f2-4bac-be2a-7c5214d684c3",
    • "type": "authorisation_rule_mapping",
    • "attributes": {
      • "username": null,
      • "groupname": null,
      • "created_by": "rodrigo",
      • "created_at": "2025-02-13T04:18:35.585416Z",
      • "updated_at": "2025-02-13T04:18:35.585416Z"
      },
    • "relationships": {
      • "authorisation_rule": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rule_mappings/c1894365-f1f2-4bac-be2a-7c5214d684c3"
      }
    }
}

Show authorisation rule mapping

Shows an authorisation rule mapping.

path Parameters
authorisation_rule_mapping_id
required
string
Example: 527946b4-8c8c-466b-b680-d7a6970dbd4b

authorisation rule mapping id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "69c471cc-298a-4b22-8219-fa6bb7f8f225",
    • "type": "authorisation_rule_mapping",
    • "attributes": {
      • "username": null,
      • "groupname": null,
      • "created_by": "ian_brakus",
      • "created_at": "2025-02-13T04:18:36.335877Z",
      • "updated_at": "2025-02-13T04:18:36.335877Z"
      },
    • "relationships": {
      • "authorisation_rule": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rule_mappings/69c471cc-298a-4b22-8219-fa6bb7f8f225"
      }
    }
}

Delete authorisation rule mapping

Delete an authorisation rule mapping.

path Parameters
authorisation_rule_mapping_id
required
string
Example: 527946b4-8c8c-466b-b680-d7a6970dbd4b

authorisation rule mapping id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Show specific authorisation rule mapping

Shows a specific mapping for an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

authorisation_rule_mapping_id
required
string
Example: 527946b4-8c8c-466b-b680-d7a6970dbd4b

authorisation rule mapping id

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "bb4c5947-7b09-4d6a-a418-b3cb2112b365",
    • "type": "authorisation_rule_mapping",
    • "attributes": {
      • "username": null,
      • "groupname": null,
      • "created_by": "val",
      • "created_at": "2025-02-13T04:18:37.026265Z",
      • "updated_at": "2025-02-13T04:18:37.026265Z"
      },
    • "relationships": {
      • "authorisation_rule": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rule_mappings/bb4c5947-7b09-4d6a-a418-b3cb2112b365"
      }
    }
}

Update authorisation rule mapping

Update an authorisation rule mapping.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

authorisation_rule_mapping_id
required
string
Example: 527946b4-8c8c-466b-b680-d7a6970dbd4b

authorisation rule mapping id

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

Responses

Response Schema: application/vnd.api+json
required
object

Request samples

Content type
application/vnd.api+json
{
  • "data": {
    • "attributes": {
      • "username": "different-user",
      • "groupname": "different-group"
      }
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "7816cc84-50d7-4748-8c52-ecc0a09fd261",
    • "type": "authorisation_rule_mapping",
    • "attributes": {
      • "username": "different-user",
      • "groupname": "different-group",
      • "created_by": "gonzalo_luettgen",
      • "created_at": "2025-02-13T04:18:37.365454Z",
      • "updated_at": "2025-02-13T04:18:37.388589Z"
      },
    • "relationships": {
      • "authorisation_rule": {
        }
      },
    • "links": {
      • "self": "/api/authorisation_rule_mappings/7816cc84-50d7-4748-8c52-ecc0a09fd261"
      }
    }
}

Delete specific rule mapping

Delete a specific mapping for an authorisation rule.

path Parameters
authorisation_rule_id
required
string
Example: 876d6ced-458b-454e-a0ca-58ddbfabb9e7

authorisation rule id

authorisation_rule_mapping_id
required
string
Example: 527946b4-8c8c-466b-b680-d7a6970dbd4b

authorisation rule mapping id

Responses

Response samples

Content type
application/vnd.api+json
{ }

Users

Endpoints to interact with the users in the system.

List users

Lists users in the system

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "187",
      • "type": "user",
      • "attributes": {
        }
      }
    ]
}

Groups

Endpoints to interact with the user LDAP groups.

List LDAP groups

Lists LDAP groups in the system

Responses

Response Schema: application/vnd.api+json
required
Array of objects

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    • {
      • "id": "cn=qa,ou=groups,dc=opschain,dc=io",
      • "type": "group",
      • "attributes": {
        }
      },
    • {
      • "id": "cn=others,ou=groups,dc=opschain,dc=io",
      • "type": "group",
      • "attributes": {
        }
      }
    ]
}

Info

Get version and other information about the running OpsChain instance.

Get OpsChain server info

Responses

Response Schema: application/vnd.api+json
required
object

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    • "id": "0",
    • "type": "info",
    • "attributes": {
      • "version": "2025-02-13",
      • "runner_image": "limepoint/opschain-runner:2025-02-13"
      },
    • "links": {
      • "self": "/api/info"
      }
    }
}