Navigation
VigilbaseDocs

    Type at least two letters.

    Open Vigilbase One
    Vigilbase One APICustomers

    Replace a customer Watchdog target

    PUT /api/customers/{id}/watchdog/targets/{targetId} on the Vigilbase One API.

    PUT/api/customers/{id}/watchdog/targets/{targetId}

    Authorizations

    Send one of these:

    AuthorizationstringAccess tokenheaderrequired

    Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login.

    AuthorizationstringAPI keyheaderrequired

    Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

    Permissions checkedwrite:monitoringwrite:partner_services

    Path Parameters

    idstringrequired
    targetIdstringrequired

    Body

    application/json

    The catalog has no JSON Schema for this body. One validates it with the schema below.

    Validation schema
    UpdateTargetSchema = z.object({
  display_name: z.string().max(255).nullish(),
  target_url: MonitoringUrlSchema.nullish(),
  uptime_enabled: z.boolean().optional(),
  security_enabled: z.boolean().optional(),
  check_type: z.enum(['http', 'https', 'tcp', 'dns', 'icmp']).optional(),
  check_interval_seconds: z.number().int().min(30).max(3600).optional(),
  timeout_seconds: z.number().int().min(5).max(60).optional(),
  regions: z.array(ProbeRegionSchema).optional(),
  latency_warning_ms: z.number().int().min(100).max(30000).optional(),
  latency_critical_ms: z.number().int().min(100).max(60000).optional(),
  scan_frequency: z.enum(['hourly', 'daily', 'weekly']).optional(),
}).partial()

    Response

    Success

    Was this page helpful?