Skip to main content

Monitoring API

Overview​

The Monitoring API provides operational visibility into your Arcanna platform.
It is intended for monitoring system health, platform activity, and runtime status.

The endpoints are accessed at https://<your-arcanna.ai-url>/api/monitoring/api/v1/<endpoint>.

Authentication and Permissions​

Use the X-Arcanna-Api-Key header on every request.

Required permission:

  • read:platform_monitoring for read operations
  • write:platform_monitoring for write operations

To create and manage API keys, see the Authentication guide.

Available Operations​

Healthcheck​

GET /health/check

  • Checks if the monitoring service is alive.
  • Required permission: none

Elasticsearch Status​

GET /status/elasticsearch

  • Retrieves Elasticsearch status and metrics for the platform.
  • Required permission: read:platform_monitoring

Containers​

GET /containers/all

  • Lists all monitored containers and their current status.
  • Required permission: read:platform_monitoring

Container Information​

GET /containers/info/{component_type}/{container_id}

  • Returns detailed information for a specific container.
  • Required permission: read:platform_monitoring

Container Metrics​

GET /containers/metrics/cpu-usage/{component_type}/{container_id}/{time_selector}

  • Returns CPU usage metrics over time for a specific container.
  • Required permission: read:platform_monitoring

Container Memory Usage Metrics​

GET /containers/metrics/memory-usage/{component_type}/{container_id}/{time_selector}

  • Returns memory usage metrics over time for a specific container.
  • Required permission: read:platform_monitoring

Trigger a Healthcheck for a Specific Container​

POST /containers/healthcheck/{component_type}/{container_id}

  • Triggers a healthcheck for a specific container.
  • Required permission: write:platform_monitoring

Restart a Specific Container​

POST /containers/restart/{component_type}/{container_id}

  • Restarts a specific container.
  • Required permission: write:platform_monitoring

Restart All Running Containers​

POST /containers/restart/all

  • Restarts all running containers.
  • Required permission: write:platform_monitoring

Change Log Level on a Container​

POST /containers/loglevel/{component_type}/{container_id}

  • Updates log level for a specific container.
  • Required permission: write:platform_monitoring

Export a Container Logs as a ZIP File​

GET /logs/export-zip/{component_type}/{container_id}

  • Exports logs for a specific container as a ZIP file.
  • Required permission: read:platform_monitoring

Export All Containers Logs as a ZIP File​

GET /logs/export-all

  • Exports logs for all monitored containers as a ZIP file.
  • Required permission: read:platform_monitoring

List Latest Platform Batches​

GET /batches/latest

  • Lists the latest platform batches.
  • Required permission: read:platform_monitoring

List Audit Logs​

GET /audit/logs

  • Returns audit logs with filtering and pagination options.
  • Required permission: read:platform_monitoring

List Available Values for Filtering Audit Logs​

GET /audit/filterable_fields_terms

  • Returns available values used to filter audit logs.
  • Required permission: read:platform_monitoring

List All Watchdogs​

GET /watchdogs

  • Lists all watchdogs.
  • Required permission: write:platform_monitoring

Enable or Disable a Watchdog​

POST /watchdogs/enable

  • Enables or disables a watchdog.
  • Required permission: write:platform_monitoring

List Watchdogs for a Given Watchdog Type​

GET /watchdogs/type/{watchdog_type}

  • Lists watchdogs for a given watchdog type.
  • Required permission: read:platform_monitoring

Retrieve Watchdog Details by ID​

GET /watchdogs/id/{watchdog_id}

  • Retrieves watchdog details by id.
  • Required permission: read:platform_monitoring

Delete a Watchdog by ID​

DELETE /watchdogs/{watchdog_id}

  • Deletes a watchdog by id.
  • Required permission: write:platform_monitoring

List Available Conditions for a Watchdog Type​

GET /watchdogs/conditions/{watchdog_type}

  • Lists available conditions for a watchdog type.
  • Required permission: read:platform_monitoring

Export Platform Metadata Objects​

GET /objects/export

  • Exports platform metadata objects.
  • Required permission: write:platform_monitoring

Restart Monitoring API​

POST /restart

  • Restarts the monitoring API service.
  • Required permission: write:platform_monitoring

Change Log Level on monitoring API​

POST /loglevel

  • Updates the monitoring API log level.
  • Required permission: write:platform_monitoring