Skip to content
Runta Runta

Get checkpoint metadata

GET
/v1/checkpoints/{checkpoint_id}
 
curl --request GET \
  --url http://127.0.0.1:8080/v1/checkpoints/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
checkpoint_id
required

Checkpoint UUID or display name.

string

Checkpoint UUID or display name.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response envelope.

Media type application/json

Response envelope.

object
data
required

Checkpoint response object.

object
display_name
required

User-chosen display name.

string
id
required

Stable checkpoint UUID.

string
resources
required

Checkpoint resource state.

object
limits
required

Resource limits.

object
memory_mib
required

Maximum memory in MiB.

integer format: uint64
>= 1
requests
required

Resource requests.

object
memory_mib
required

Requested baseline memory in MiB.

integer format: uint64
>= 1
vcpus
required

Requested virtual CPUs.

integer format: uint32
>= 1 <= 2147483647
state
required

Checkpoint lifecycle state.

string
Allowed values: creating ready failed
Example 
{
  "data": {
    "state": "creating"
  }
}

401

Section titled “401 ”

Missing, malformed, or rejected bearer token

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

403

Section titled “403 ”

The bearer token is not allowed to perform this action

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

404

Section titled “404 ”

The requested resource was not found

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

409

Section titled “409 ”

The request conflicts with current resource state

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

422

Section titled “422 ”

Validation or application error

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

503

Section titled “503 ”

Upstream service is unavailable

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

504

Section titled “504 ”

Upstream request timed out

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}

default

Section titled “default ”

Error response

Media type application/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
Example 
{
  "error": {
    "code": "already_exists"
  }
}