Skip to main content

Documentation Index

Fetch the complete documentation index at: https://ekso.dev/llms.txt

Use this file to discover all available pages before exploring further.

Sample shape for ConfigRule.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "name": "Example name",
  "description": "Example description.",
  "active": false,
  "owner": "<content-owner>",
  "ownerId": "<owner_id>",
  "trigger": "<rule-trigger>",
  "triggerEvent": "<rule-trigger-event>",
  "triggerInterval": "example",
  "container": [
    "example"
  ],
  "conditionGroup": [
    "<config-condition-group>"
  ],
  "actionValue": [
    "<config-rule-action-value>"
  ],
  "actionEndpoint": [
    "<config-rule-action-endpoint>"
  ]
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
namestringRequired
descriptionstringOptional
activebooleanOptional
ownerContentOwnerOptional
ownerIdstringOptional
triggerRuleTriggerOptional
triggerEventRuleTriggerEventOptional
triggerIntervalstringOptional
containerarray<string>Optional
conditionGrouparray<ConfigConditionGroup>Optional
actionValuearray<ConfigRuleActionValue>Optional
actionEndpointarray<ConfigRuleActionEndpoint>Optional
tenantIdstringServer-setSet by the server. Read-only on writes.
idstringServer-setSet by the server. Read-only on writes.
createdstring (date-time)Server-setSet by the server. Read-only on writes.
createdBystringServer-setSet by the server. Read-only on writes.
updatedstring (date-time)Server-setSet by the server. Read-only on writes.
updatedBystringServer-setSet by the server. Read-only on writes.
deletedbooleanServer-setSet by the server. Read-only on writes.

​
Used by

​
Request body

  • POST /api/rule
  • PUT /api/rule

​
Response body

  • GET /api/rule/{id}
  • GET /api/rule

​
CLI

ekso rule — see the command branches page for available verbs. Body for create / update verbs typically passed via --data @file.json matching the sample JSON above.