Get checkpoint metadata

GET

/v1/checkpoints/{checkpoint_id}

const url = 'http://127.0.0.1:8080/v1/checkpoints/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

BearerAuth

Parameters

Path Parameters

checkpoint_id

required

Checkpoint UUID or display name.

string

Checkpoint UUID or display name.

Responses

200

Response envelope.

application/json

Response envelope.

object

data

required

Checkpoint response object.

object

display_name

required

User-chosen display name.

string

required

Stable checkpoint UUID.

string

created_at

required

RFC3339 timestamp when the control-plane checkpoint row was created.

string

resources

required

Checkpoint resource state.

object

current

required

Current resource allocation.

object

memory_mib

required

Current memory allocation in MiB.

integer format: uint64

>= 1

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

Missing, malformed, or rejected bearer token

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

The bearer token is not allowed to perform this action

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

The requested resource was not found

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

The request conflicts with current resource state

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

Validation or application error

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

Rate limit exceeded

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

Upstream service is unavailable

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

Upstream request timed out

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

Error response

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