Update an insurance monitor configuration

patch

https://api.wingspan.app/v3/compliance/insurance-monitor-configurations/{insuranceMonitorConfigurationId}

Partial update via JSON Merge Patch (RFC 7396) of an insurance monitor configuration. externalId and metadata are what it supports.

coverages is immutable, and no other configuration field is accepted either. Requirement definitions and the monitors opened against them already point at this configuration, so changing what it requires would change what every one of those monitors validates against. To change what a configuration requires, create a new configuration and point the requirement definition at it.

metadata MERGES key by key: keys you do not send are left alone, and an empty object leaves the stored map untouched rather than clearing it. A key containing . or $ is rejected with 422. Supplying an externalId already in use for this account returns 409 ResourceConflict.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

insuranceMonitorConfigurationId

string

required

Unique identifier of an InsuranceMonitorConfiguration.

Body Params

Partial update to an insurance monitor configuration. externalId and metadata are what it supports.

coverages is immutable, and no other configuration field is accepted either. Requirement definitions and the monitors opened against them already point at this configuration, so changing what it requires would change what every one of those monitors validates against. Create a new configuration and point the requirement definition at it instead.

externalId

string

Caller-supplied reconciliation id, unique per account. A duplicate returns 409 ResourceConflict.

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

length between 1 and 255

^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

X-Wingspan-Account

string

^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Updated insurance monitor configuration

400Malformed request syntax

401Unauthenticated

403Forbidden

404Resource not found

409Conflict

422Validation error