Skip to content
RuntaRunta
Start free with $50 credit

List available Runtime Image variants

GET
/v2/images
curl --request GET \
  --url https://api.runta.me/v2/images \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

List response envelope.

Media typeapplication/json

List response envelope.

object
data
required
Array<object>

A selectable Runtime Image product variant.

object
id
required
string
name
required
string
description
required
string
icon_key
required
string
architectures
required
Array<string>
Allowed values: x86_64 aarch64
disk
required
object
minimum_gib
required
integer format: uint32
>= 1
maximum_gib
required
integer format: uint32
<= 256
default_gib
required
integer format: uint32
>= 1
step_gib
required
integer format: uint32
>= 1
recommended_resources
required
object
vcpus
required
integer format: uint32
>= 1
memory_mib
required
integer format: uint64
>= 1
is_default
required
boolean
is_custom
required
boolean
created_at
string format: date-time
model_provider
object
protocol_bindings
required

How each protocol this image speaks reaches a provider.

Array<object>
object
protocol
required
string
environment_variable
required

Guest variable this image’s onboarding writes the credential to.

string
base_url
required

Endpoint the onboarding configures when the caller names none.

string
subscription_options
required

Subscription credentials Runta signs in to on the tenant’s behalf. Empty when this image only accepts a credential the tenant supplies.

Array<object>
object
protocols
required
Array<string>
secret_preset_ids
required
Array<string>
allow_custom_base_url
required

Whether this image’s agent can be pointed at another endpoint.

boolean
allow_runtime_sign_in
required
boolean
web_ui

A browser surface the image serves. It is published through the runtime’s ingress on demand, behind a session gateway, rather than being exposed for the lifetime of the runtime.

object
port
required

Guest-local port the gateway listens on.

integer format: uint32
>= 1 <= 65535
exposed_ports
required

TCP ports declared by the image. They are discovery hints and are not published automatically.

Array<integer>
<= 128 items unique items
Example
{
  "data": [
    {
      "architectures": [
        "x86_64"
      ]
    }
  ]
}

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"
  }
}