Import and create synthetic monitors in bulk using API

  • Versão de lançamento: Australia
  • Atualizado 16 de jun. de 2026
  • 1 min. de leitura

    • Create multiple synthetic monitors simultaneously by importing raw JSON or CSV files through the Bulk Monitor Creation API.

    Antes de Iniciar

    Role required: sn_sow_synthetics.synthetics_admin or sn_sow_synthetics.synthetics_editor
    • Valid ServiceNow instance credentials
    • Access to Http endpoint
    • Base URL: https://<your-instance>.service-now.com/api/sn_sow_synthetics/v1/synthetics_async_bulk_create
    • Prepared raw JSON or CSV file with monitor data containing required fields:
      • Monitor name
      • HTTP endpoint sys_id
      • Parent service sys_id
      • Location sys_id
      • sys id of support group
      • interval (frequency)
      • Method (`GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`)
      • Assertion field

    One of the following tools: Terminal (with curl command), Postman, or scripting environment.

    Por Que e Quando Desempenhar Esta Tarefa

    The Bulk Monitor Creation API uses a two-step process:
    1. Creates a job ID by uploading your monitor data file.
    2. Checks job status to verify monitor creation status.
    You can access this API through one of the following methods:
    • Terminal using curl commands
    • Postman application
    • Custom scripts
    The API requires either a basic authentication or oauth token authentication.
    • Basic auth: 
      curl -u "username:password"
    • OAuth token: 
      curl -H "Authorization: Bearer <your-oauth-token>"

    Procedimento

    1. Prepare your monitor data file in raw JSON or CSV format.
    2. Choose your preferred method (Terminal, Postman, or Script).
    3. Call the bulk import API endpoint to upload the file and generate a job ID.
    4. Use the status check URL to verify monitor creation status.
    5. Review the response for successful monitor creation or error details.
    6. Update the source file with correct data (if there are errors), and resubmit.

    Resultado

    Monitors are created in the ServiceNow instance. The API response indicates:
    • Processing status (processing/complete)
    • Successfully created monitors
    • Failed monitors with error details (required fields missing, invalid sys_ids, and so forth)