SecObserve Instance Status
secobserve_statusCheck instance-level status: version, health, public settings, queue statistics, and PURL types. Use at session start to verify available features, approval requirements, and worker health.
Instructions
Read instance-level facts: version, health, public settings, queue statistics, PURL types.
Worth calling once at the start of a session: the version decides which features exist, and the settings say whether four-eyes approval, license management or the built-in scanners are switched on at all.
Args: kind (str): "version", "health", "settings", "background_tasks" or "purl_types". product_id (Optional[int]): Required for kind="purl_types". purl_type (Optional[str]): With kind="purl_types", look up one type.
Returns: str: The endpoint's JSON response. "version" gives {"version": str}; "health" gives a liveness object; "settings" gives the instance's public feature flags and intervals; "background_tasks" gives queue and worker statistics; "purl_types" gives the known package-URL types.
Examples: - Use when: starting work against an unfamiliar instance -> kind="settings" - Use when: "is approval required here?" -> kind="settings" - Use when: "are background workers keeping up?" -> kind="background_tasks" - Don't use when: you need per-product numbers (use secobserve_product_metrics).
Error Handling: "background_tasks" requires superuser and returns 403 for a product token. Everything else works for any authenticated caller.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | 'version' = SecObserve version; 'health' = liveness; 'settings' = the feature flags and intervals this instance exposes publicly; 'background_tasks' = queue statistics (superuser); 'purl_types' = the package-URL types known to the instance. | |
| purl_type | No | With kind='purl_types': look up one type (e.g. 'maven') instead of listing all. | |
| product_id | No | Required for kind='purl_types': the product whose package-URL types to read. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |