MENU
    Report new values for machine attributes.
    • 04 Mar 2025
    • 1 Minute to read
    • Contributors

    Report new values for machine attributes.


    Article summary

    Post
    /attributes/report

    Report new values for API machine attributes. All attribute IDs must be associated with their respective machines. A value must be congruent with the attribute's associated type. No attributes are processed if any of them fail validation.

    Requires the attributes:write API key scope.

    Security
    HTTP
    Type basic

    Access to the Tulip API requires the use of HTTP Basic Authentication using the credentials of an active Tulip API Token. All requests require the Authorization HTTP header with the Basic scheme to provide API credentials unless otherwise noted.

    API tokens can be configured with a set of scopes which determine what parts of the API that specific token has access to. Security best practices dictate that API credentials be given the minimum set of capabilities required to fulfill their intended purpose. For example, an API token created for use in an integration that is only designed to use the Tables API should probably only be given the tables:read and tables:write scopes. In this way you can minimize risk in the event that API credentials are compromised. API endpoints will document what API token scopes are required to access that endpoint in their descriptions. If a request is made to an endpoint with an API token which does not have the required scopes, the response will be an authorization error.

    Body parameters

    Attributes to report.

    Collapse all
    object
    attributes
    Array of object

    Machine attribute values to report for processing.

    object
    machineId
    string Required
    attributeId
    string Required
    value

    Value to submit. The value's type must be congruent with the attribute type. Incorrect typing will generate a 422 response.

    Examplesame data type as the respective attribute
    Responses
    204

    Attributes were succesfully reported.

    400

    The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string
    422

    The request was syntactically sound, but could not be processed due to a logical problem.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string
    500

    The server encountered an unexpected error.

    object
    errorCode
    string
    errorUniqueID
    string
    Pattern^[a-zA-Z0-9+/]+$
    Exampleaq21mSKC1rbO87TjC/4Hz2EJHd/v+jxf7MtC315vo0Y
    details
    string

    Was this article helpful?

    What's Next