Sign in

v1

latestSwagger 2.0BSD 3-Clause2026-07-1720953437.1 KB
samples

Update sample (partial)

Update the specified sample. If a field is not included in the query body, that field will not be updated.

patch/samples/{key}

Path parameters

keystring required

The name of the sample to update.

Request body

messageBodystring

Optional message about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed only on hover or click.

messageCodestring

Optional 5-charater code about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed without having to hover or click.

valuestring

Stored as a string but will be treated as whatever the aspect’s valueType was specified as, i.e. [BOOLEAN|NUMERIC|PERCENT]. If timeout occurs, value is set to null.

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success.

messageBodystring

Optional message about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed only on hover or click.

messageCodestring

Optional 5-charater code about the sample value. Informational only--not used to determine the status of the sample. It's up to the lens whether/how to display this, will typically be displayed without having to hover or click.

status'Critical' | 'Invalid' | 'Timeout' | 'Warning' | 'Info' | 'OK'

Status.

previousStatus'Critical' | 'Invalid' | 'Timeout' | 'Warning' | 'Info' | 'OK'

Previous Status.

valuestring

Stored as a string but will be treated as whatever the aspect’s valueType was specified as, i.e. [BOOLEAN|NUMERIC|PERCENT]. If timeout occurs, value is set to null.

providerstring

User who provided this sample.

createdAtstring

TODO

updatedAtstring

TODO

statusChangedAtstring

Time at which the status changed from one state to another.