Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
POSTAgentSince 1.0SynchronousAuth Required

TriggerProbe

Trigger an auto-discovery probe on the target agent to detect running services

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • uuidStringRequired

    UUID of the agent to trigger probe on

Responses

200 OK

On success, this API returns the following response structure.

  • agentIdString

    UUID of the agent that performed the probe

    Example: agent-abc123-def456

  • timestampString

    Timestamp for this resource

    Example: 2026-01-15T08:00:00Z

  • detectedServicesList

    Detected services

    Example: (nested array)

    • serviceString

      Name of the detected service

      Example: nginx

    • confidenceLong

      Detection confidence score between 0 and 1

      Example: 0.95

    • evidenceList

      Evidence for this resource

      Example: item1,item2

    • recommendedConfigObject

      Recommended config

      • typeString

        Collector type identifier

        Example: prometheus

      • sourceString

        Data source path or URL for the collector

        Example: /var/log/app.log

      • parserString

        Parser to use for ingested data

        Example: json

      • pluginString

        Plugin identifier handling this collector

        Example: filebeat

      • endpointString

        Target endpoint to send collected data

        Example: http://loki:3100/loki/api/v1/push

      • varsLinkedHashMap

        Variable definitions for template rendering

        Example: (nested object)

  • probeTimeMsString

    Time taken to complete the probe in milliseconds

    Example: 1200

Endpoint

POST/api/v1/agents/{uuid}/probe

/api/v1/agents/{uuid}/probe

Operation ID

TriggerProbe

Permalink

Request Example

curl -X POST '{host}/api/v1/agents/{uuid}/probe' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{}'

Response Example

200
{
  "agentId": "agent-abc123-def456",
  "timestamp": "example",
  "detectedServices": [
    {}
  ],
  "probeTimeMs": 1200
}

Change History

This API has no change history records yet.

View all change history