Skip to navigation

Read a version

View as Markdown

Reads one version. include adds the procedure, the tools or the compiled program. Needs the scope machines.

Authentication

AuthorizationBearer

An API key (crk_), an exchanged token (crt_) or a JWT of a trusted issuer. The credential needs the scope of the capability. Read the description of each route.

Path parameters

namestringRequired

The Machine name: lowercase letters, digits and hyphens.

versionstringRequired
The version number, 1 or more.

Query parameters

includestringOptional

A comma list of procedure, tools and ir.

Response headers

x-request-idstringOptional

The id of the request: req_ and a ULID. Every answer has it.

server-timingstringOptional
The time of the admission.
x-ratelimit-limit-requestsstringOptional
The size of the request bucket, per minute.
x-ratelimit-remaining-requestsstringOptional
The requests that remain.
x-ratelimit-reset-requestsstringOptional
The time until the request bucket is full.
x-ratelimit-limit-unitsstringOptional
The size of the units bucket, per minute. Absent when no limit applies.
x-ratelimit-remaining-unitsstringOptional
The units that remain.
x-ratelimit-reset-unitsstringOptional
The time until the units bucket is full.

Response

The version.
object"machine_version"
namestring
versioninteger1-9007199254740991
publishedboolean
ir_hashstring
source_hashstring
compilerstring
inputsmap from strings to any
The declared inputs and their schemas.
caller_toolslist of objects
warningslist of objects
created_atdatetime
created_bystring

key:<id> or token:<id>.

proceduremap from strings to anyOptional

Only with include=procedure.

toolslist of anyOptional

Only with include=tools.

iranyOptional

The compiled program. Only with include=ir.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error