Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Scrape Collection
GETMonitoringSince 1.0SynchronousAuth Required

ListScrapeTargets

List all registered scrape targets

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • uuidString

      Unique identifier of the scrape target

      Example: target-001-abc

    • nameString

      Display name of the scrape target

      Example: node-exporter-host01

    • endpointString

      HTTP endpoint URL to scrape metrics from

      Example: http://192.168.1.10:9100

    • metricsPathString

      Path on the endpoint to fetch metrics (e.g. /metrics)

      Example: /metrics

    • scrapeIntervalInteger

      Interval in seconds between scrapes

      Example: 15

    • labelsLinkedHashMap

      Key-value labels attached to this resource

      Example: (nested object)

    • enabledBoolean

      Whether this scrape target is active

      Example: true

    • tenantUuidString

      UUID of the tenant this target belongs to

      Example: tenant-001-xyz

    • createdAtString

      Created at

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

  • totalInteger

    Total number of scrape targets

    Example: 12

  • limitInteger

    Maximum items per page

    Example: 20

  • offsetInteger

    Number of items skipped

    Example: 20

Endpoint

GET/api/v1/monitoring/scrape-targets

/api/v1/monitoring/scrape-targets

Operation ID

ListScrapeTargets

Permalink

Request Example

curl -X GET '{host}/api/v1/monitoring/scrape-targets' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 12,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history