v9

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

Update an existing entity

Update an existing entity in the system with the provided information

put/api/v1/entities/{templateIdentifier}/{entityIdentifier}

Path parameters

templateIdentifierstring required
entityIdentifierstring required

Request body

namestring required

Name of the entity

propertiesobject

Map of property name to value for this entity

Example request

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

Response

Entity updated successfully