- Print
Generate machine activity archive. Returned object contains id necessary for later retrieval.
Generate machine activity archive. Returned object contains id necessary for later retrieval.
Requires the machines:write
API key scope.
A Tulip API key is required to use the Tulip API. API key authentication uses HTTP Basic Authentication as defined by RFC 7617. HTTP Basic Authentication uses a generic username/password scheme to authenticate. For Tulip API requests, the password should be the API key's associated secret. The username should have the format {type}.{version}_{id}
, where {type}
is the API key type, {version}
is the type's version number, and {id}
is the id of the key. Tulip API keys currently are one of two types:
apikey.2
- user API keys provisioned by creating a Tulip API Token. The key id is the token id.onetime.1
- temporary API keys provisioned using the/auth/temporary
endpoint or using the One-Time API Key page. These keys are only valid for 30 seconds after provisioning.
Once you have determined the username and password you need to use, the Authorization
header should be set to the value Basic {credentials}
, where {credentials}
is the base64-encoded value of the string {username}:{password}
. See RFC 7617 for more details of this encoding.
ID of machine
Generate machine activity archive. Returned object contains id necessary for later retrieval.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
The provided authentication info was rejected. The response will provide additional details.
The server encountered an unexpected error.