Read a single file from a runtime

GET

/v1/runtimes/{runtime_id}/files

const url = 'http://127.0.0.1:8080/v1/runtimes/example/files?path=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/runtimes/example/files?path=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

runtime_id

required

Runtime UUID or display name.

string

Runtime UUID or display name.

Query Parameters

path

required

Absolute path to a regular file inside the runtime.

string

Absolute path to a regular file inside the runtime.

Responses

200

Byte stream

application/octet-stream

string format: binary

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