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 DataWatch.

​
Sample JSON

Copy, edit, paste. Server-set fields (id, created, tenantId, …) are omitted from the example — they’re populated by the server on response. 
{
  "owner": "<content-owner>",
  "ownerId": "<owner_id>",
  "watcher": "<watcher-type>",
  "watcherId": "<watcher_id>",
  "type": "<watch-type>"
}

​
Fields

FieldTypeRequiredNotes
entitystring • nullableServer-setSet by the server. Read-only on writes.
ownerContentOwnerOptional
ownerIdstringRequired
watcherWatcherTypeOptional
watcherIdstringRequired
typeWatchTypeOptional
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/watch
  • PUT /api/watch/{id}

​
Response body

  • GET /api/watch/owner/{ownerId}
  • GET /api/watch/watcher/{watcherId}
  • GET /api/watch/{id}
  • POST /api/watch
  • PUT /api/watch/{id}

​
CLI

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