Get process by identifier

Get information about a process by its PID or name

GET /process/{identifier}

Get process by identifier

cURL

curl --request GET \
  --url https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier}', 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://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sbx-{sandbox_id}-{workspace_id}.{region}.bl.run/process/{identifier}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "command": "ls -la",
  "completedAt": "Wed, 01 Jan 2023 12:01:00 GMT",
  "exitCode": 0,
  "logs": "logs output",
  "name": "my-process",
  "pid": "1234",
  "startedAt": "Wed, 01 Jan 2023 12:00:00 GMT",
  "status": "running",
  "stderr": "stderr output",
  "stdout": "stdout output",
  "workingDir": "/home/user",
  "keepAlive": false,
  "maxRestarts": 3,
  "restartCount": 2,
  "restartOnFailure": true
}

{
  "error": "Error message"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

identifier · string · required

Process identifier (PID or name)

Response

200

application/json

Process information

command · string · required

Example:

"ls -la"

completedAt · string · required

Example:

"Wed, 01 Jan 2023 12:01:00 GMT"

exitCode · integer · required

Example:

0

logs · string · required

Example:

"logs output"

name · string · required

Example:

"my-process"

pid · string · required

Example:

"1234"

startedAt · string · required

Example:

"Wed, 01 Jan 2023 12:00:00 GMT"

status · enum<string> · required

Available options: failed, killed, stopped, running, completed

Example:

"running"

stderr · string · required

Example:

"stderr output"

stdout · string · required

Example:

"stdout output"

workingDir · string · required

Example:

"/home/user"

keepAlive · boolean

Whether scale-to-zero is disabled for this process

Example:

false

maxRestarts · integer

Example:

3

restartCount · integer

Example:

2

restartOnFailure · boolean

Example:

true