HTTP API
ECS System
GET/api/v1/ecs/{index}/systems
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
Query Parameters
group?string
Response Body
application/json
curl -X GET "https://example.com/api/v1/ecs/string/systems"{ "systems": [ { "component_versions": { "property1": [ 0 ], "property2": [ 0 ] }, "created_at": "string", "dependencies": { "runs_after": [ "string" ], "runs_before": [ "string" ] }, "description": "string", "enabled": true, "group": "string", "include_resources": [ "string" ], "name": "string", "priority": 0, "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] }, "system_id": "string", "timeout_ms": 0 } ], "total": 0}POST/api/v1/ecs/{index}/systems
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/ecs/string/systems" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] } }'{ "component_versions": { "property1": [ 0 ], "property2": [ 0 ] }, "created_at": "string", "dependencies": { "runs_after": [ "string" ], "runs_before": [ "string" ] }, "description": "string", "enabled": true, "group": "string", "include_resources": [ "string" ], "name": "string", "priority": 0, "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] }, "system_id": "string", "timeout_ms": 0}GET/api/v1/ecs/{index}/systems/execution-order
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
Response Body
application/json
curl -X GET "https://example.com/api/v1/ecs/string/systems/execution-order"[ "string"]GET/api/v1/ecs/{index}/systems/{name}
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
application/json
curl -X GET "https://example.com/api/v1/ecs/string/systems/string"{ "component_versions": { "property1": [ 0 ], "property2": [ 0 ] }, "created_at": "string", "dependencies": { "runs_after": [ "string" ], "runs_before": [ "string" ] }, "description": "string", "enabled": true, "group": "string", "include_resources": [ "string" ], "name": "string", "priority": 0, "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] }, "system_id": "string", "timeout_ms": 0}DELETE/api/v1/ecs/{index}/systems/{name}
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
curl -X DELETE "https://example.com/api/v1/ecs/string/systems/string"Empty
PUT/api/v1/ecs/{index}/systems/{name}
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PUT "https://example.com/api/v1/ecs/string/systems/string" \ -H "Content-Type: application/json" \ -d '{}'{ "component_versions": { "property1": [ 0 ], "property2": [ 0 ] }, "created_at": "string", "dependencies": { "runs_after": [ "string" ], "runs_before": [ "string" ] }, "description": "string", "enabled": true, "group": "string", "include_resources": [ "string" ], "name": "string", "priority": 0, "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] }, "system_id": "string", "timeout_ms": 0}POST/api/v1/ecs/{index}/systems/{name}/disable
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
application/json
curl -X POST "https://example.com/api/v1/ecs/string/systems/string/disable"{ "component_versions": { "property1": [ 0 ], "property2": [ 0 ] }, "created_at": "string", "dependencies": { "runs_after": [ "string" ], "runs_before": [ "string" ] }, "description": "string", "enabled": true, "group": "string", "include_resources": [ "string" ], "name": "string", "priority": 0, "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] }, "system_id": "string", "timeout_ms": 0}POST/api/v1/ecs/{index}/systems/{name}/enable
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
application/json
curl -X POST "https://example.com/api/v1/ecs/string/systems/string/enable"{ "component_versions": { "property1": [ 0 ], "property2": [ 0 ] }, "created_at": "string", "dependencies": { "runs_after": [ "string" ], "runs_before": [ "string" ] }, "description": "string", "enabled": true, "group": "string", "include_resources": [ "string" ], "name": "string", "priority": 0, "query": { "filters": [ { "component": "string", "field": "string", "op": "eq", "value": null } ], "has_all": [ "string" ], "has_any": [ "string" ], "has_none": [ "string" ] }, "system_id": "string", "timeout_ms": 0}POST/api/v1/ecs/{index}/systems/{name}/execute
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v1/ecs/string/systems/string/execute" \ -H "Content-Type: application/json" \ -d '{}'{ "dry_run": true, "entity_count": 0, "execution_time_ms": 0, "mutations_applied": 0, "name": "string", "tick": 0}POST/api/v1/ecs/{index}/systems/{name}/pause
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
application/json
curl -X POST "https://example.com/api/v1/ecs/string/systems/string/pause"{ "name": "string", "paused": true, "paused_at": "string"}POST/api/v1/ecs/{index}/systems/{name}/resume
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
application/json
curl -X POST "https://example.com/api/v1/ecs/string/systems/string/resume"{ "name": "string", "paused": true, "resumed_at": "string"}GET/api/v1/ecs/{index}/systems/{name}/stats
Authorization
bearer_token AuthorizationBearer <token>
In: header
Path Parameters
index*string
name*string
Response Body
application/json
curl -X GET "https://example.com/api/v1/ecs/string/systems/string/stats"{ "name": "string", "stats": { "avg_entity_count": 0.1, "avg_execution_time_ms": 0.1, "avg_mutations_per_tick": 0.1, "error_count": 0, "execution_count": 0, "last_error": "string", "last_execution": "string" }}