Skip to main content
ZStack
Monitoring & Collection/Scrape Collection

ImportScrapeCSV

Import scrape targets from a CSV-structured payload

POST/api/v1/monitoring/scrape-configs/bulk-import

Operation ID

ImportScrapeCSV

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • rows
    ListRequired

    The rows value

    Example: (nested array)

    • row
      Integer

      Row number in the CSV payload (1-based)

      Example: 1

    • host
      String

      Hostname or IP of the scrape target

      Example: 192.168.1.30

    • port
      Integer

      Port of the metrics endpoint

      Example: 9100

    • jobName
      String

      Prometheus job name

      Example: node

    • labels
      String

      JSON-encoded label key-value pairs

      Example: {"env":"prod"}

  • mode
    StringRequired

    Import mode: full (fail on any error) or partial (skip invalid rows)

    Example: partial

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • imported
    Integer

    Number of targets successfully imported

    Example: 47

  • skipped
    Integer

    Number of entries skipped (e.g. already existing)

    Example: 1

  • duplicatesSkipped
    Integer

    Number of duplicate entries that were skipped

    Example: 1

  • mode
    String

    Import mode used (full, partial)

    Example: partial

  • errors
    List

    Errors for this resource

    Example: (nested array)

    • row
      Integer

      Row number where the error occurred

      Example: 3

    • field
      String

      Field name that failed validation

      Example: port

    • reason
      String

      Human-readable reason for the validation failure

      Example: port must be between 1 and 65535