Read runtime sandbox file

Read a UTF-8 file from the workspace runtime sandbox. Returns the file content.

POST /context/runtime/content

Read runtime sandbox file

cURL

curl --request POST \
  --url https://api.getcargo.io/v1/context/runtime/content \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "startLine": 4503599627370496,
  "endLine": 4503599627370496
}
'

import requests

url = "https://api.getcargo.io/v1/context/runtime/content"

payload = {
    "path": "<string>",
    "startLine": 4503599627370496,
    "endLine": 4503599627370496
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', startLine: 4503599627370496, endLine: 4503599627370496})
};

fetch('https://api.getcargo.io/v1/context/runtime/content', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getcargo.io/v1/context/runtime/content",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<string>',
    'startLine' => 4503599627370496,
    'endLine' => 4503599627370496
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getcargo.io/v1/context/runtime/content"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"startLine\": 4503599627370496,\n  \"endLine\": 4503599627370496\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getcargo.io/v1/context/runtime/content")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"startLine\": 4503599627370496,\n  \"endLine\": 4503599627370496\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/context/runtime/content")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"startLine\": 4503599627370496,\n  \"endLine\": 4503599627370496\n}"

response = http.request(request)
puts response.read_body

200

{
  "path": "<string>",
  "content": "<string>",
  "startLine": 0,
  "endLine": 0,
  "totalLines": 0
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Read a file from the workspace runtime sandbox.

path · string · required

Path of the file to read in the runtime sandbox, relative to the workspace working directory.

Minimum string length: 1

startLine · integer

1-indexed inclusive line at which to start reading. Defaults to the first line of the file.

Required range: 1 <= x <= 9007199254740991

endLine · integer

1-indexed inclusive line at which to stop reading. Defaults to the last line of the file. Must be greater than or equal to startLine when both are provided.

Required range: 1 <= x <= 9007199254740991

Response

200

application/json

Successful response

path · string · required

content · string · required

UTF-8 decoded content of the requested line range.

startLine · integer · required

1-indexed inclusive start line of the returned slice (after clamping to the file's bounds).

Required range: -9007199254740991 <= x <= 9007199254740991

endLine · integer · required

1-indexed inclusive end line of the returned slice. Equals startLine - 1 when the requested range starts past the end of the file.

Required range: -9007199254740991 <= x <= 9007199254740991

totalLines · integer · required

Total number of lines in the underlying file.

Required range: -9007199254740991 <= x <= 9007199254740991