v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01234055.7 KB
Entities Management

Create a new entity

Create a new entity in the system with the provided information

post/api/v1/entities/{templateIdentifier}

Path parameters

templateIdentifierstring required

Request body

identifierstring required

Unique identifier of the entity within the template scope

namestring required

Name of the entity

propertiesobject

Map of property name to value for this entity

Example request

{
  "identifier": "my-web-service",
  "name": "my-web-service",
  "properties": {
    "port": "8080",
    "environment": "dev"
  },
  "relations": [
    {
      "name": "depends-on",
      "target_entity_identifiers": [
        "web-api-1",
        "web-api-2"
      ]
    }
  ]
}

Response

Entity created successfully