Documentation Index

Fetch the complete documentation index at: https://support.tulip.co/llms.txt

Use this file to discover all available pages before exploring further.

/api/machines/v1/machines/{machineId}/attributes/{attributeId}/write

Prev Next
Post
/api/machines/v1/machines/{machineId}/attributes/{attributeId}/write

Write to a machine attribute.

Requires the attributes:write-value API key scope.

Path parameters
machineId
Required

The ID of the machine.

Exampleg56RCoZCtzv7borvp
attributeId
Required

The ID of the machine attribute to write to.

Exampleg56RCoZCtzv7borvp
Body parameters

The value to write to the machine attribute.

object
value

The value to write. Must be congruent with the attribute's type.

OneOf
string
string
number
number
boolean
boolean
Responses
200

The machine attribute value was written successfully.

object
success
boolean
400

An error occurred. The Tulip error codes generic.customerIdRequired, generic.workspaceIdRequired, generic.invalidParams, http.invalidBodyJson, http.invalidHeaders, http.multiValueHeader, machines.attributeIsNotWritableError, machines.missingDataSourceIdOnSubscriptionError, and machines.unsupportedMachineSubscriptionTypeError all use the 400 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.

Expand All
OneOf
object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

details
object
headerName
string

The name of the given HTTP header which had multiple values.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

401

The request was missing required authentication information.

This error is not automatically retryable.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

404

An error occurred. The Tulip error codes machines.machineNotFoundError, machines.machineSubscriptionNotFoundError, and machines.machineAttributeNotFoundError all use the 404 HTTP status code. See the documentation of the response content schema for details on these specific Tulip errors that could result in this status code.

OneOf
object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

object
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

429

Too many requests have been made to this endpoint in a short time period.

This error is not automatically retryable.

Expand All
object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.

details
object
details
string

Additional details about this endpoint's rate limits.

500

An internal server error occurred. Please contact support@tulip.co if the error persists.

This error is not automatically retryable.

object
errorCode
string

A machine-readable code identifying the type of error.

Pattern^[a-zA-Z0-9.]$
message
string

A human-readable description of the error intended for debugging purposes only.

The exact content of this message is not stable.

retryable
boolean

Whether the request can be automatically retried by the client.