Skip to content
RuntaRunta
Start free with $50 credit

Build a private Runtime Image from a Dockerfile

POST
/v2/images/builds
curl --request POST \
  --url https://api.runta.me/v2/images/builds \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "name": "example", "dockerfile": "example", "architecture": "x86_64" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
>= 1 characters <= 255 characters

Caller-generated key for retry-safe financial mutations.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 120 characters
dockerfile
required
string
>= 1 characters <= 1048576 characters
architecture
required
string
default: x86_64
Allowed values: x86_64

Responses

Section titled “Responses”

200

Section titled “200”

Response envelope.

Media typeapplication/json

Response envelope.

object
data
required
object
id
required
string format: uuid
name
required
string
architecture
required
string
Allowed values: x86_64
status
required
string
Allowed values: pending retrying building succeeded failed cancelled
attempt
required
integer format: uint32
runtime_image_id
required
string
runtime_bundle_index_digest
string
runtime_bundle_manifest_digest
string
safe_error_code
string
created_at
required
string format: date-time
updated_at
required
string format: date-time
completed_at
string format: date-time
dockerfile
string
attempts
Array<object>
object
attempt
required
integer format: uint32
started_at
required
string format: date-time
completed_at
string format: date-time
outcome
string
Allowed values: succeeded failed retry_wait lease_expired
Example
{
  "data": {
    "architecture": "x86_64",
    "status": "pending",
    "attempts": [
      {
        "outcome": "succeeded"
      }
    ]
  }
}

401

Section titled “401”

Missing, malformed, or rejected bearer token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

403

Section titled “403”

The bearer token is not allowed to perform this action

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

404

Section titled “404”

The requested resource was not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

409

Section titled “409”

The request conflicts with current resource state

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

422

Section titled “422”

Validation or application error

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

501

Section titled “501”

Operation is not implemented

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

503

Section titled “503”

Upstream service is unavailable

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

504

Section titled “504”

Upstream request timed out

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}

default

Section titled “default”

Error response

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: already_exists command_failed deadline_exceeded failed_precondition internal invalid_argument not_found permission_denied rate_limited unauthenticated unavailable unimplemented
message
required
string
request_id
required

UUID v7 correlation ID shared with the X-Request-Id response header.

string
Example
{
  "error": {
    "code": "already_exists"
  }
}