Skip to main content
POST
Attach a machine variable to a machine data annotation

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Path Parameters

machine_variable_id
string
required
Example:

"mvr_01kae7a2kpkcqwy7fwk2fft11h"

id
string
required
Example:

"mda_01k7v3n9cbp2s0w8qh4xr6fzje"

Response

The updated machine data annotation. The machine variable must be available at the site of the annotation; attaching an already attached machine variable has no effect.

id
string
required

Unique identifier of the machine data annotation.

Example:

"mda_01k7v3n9cbp2s0w8qh4xr6fzje"

external_id
string | null
required

The external ID you assigned to this annotation, if any.

Example:

"ANNOTATION-EXT-0001"

type
enum<string>
required

Whether the annotation marks a single instant or a time range.

Available options:
instant
occurred_at
string<date-time>
required

The annotated instant as a UTC ISO 8601 timestamp.

Example:

"2026-05-01T12:30:00.000Z"

site
object
required

The site the annotation belongs to.

created_at
string<date-time>
required

Time the annotation was created.

Example:

"2026-05-06T19:34:00.000Z"

text
string
required

Free-text note describing the annotated event that affected machine data.

Example:

"Kiln restarted after the morning inspection"

machine_variables
object[]
required

The machine variables the annotation is linked to.