Get an environment

curl --request GET \
  --url https://envlink-api.projectinwork.com/v1/environments/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://envlink-api.projectinwork.com/v1/environments/{id}', 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://envlink-api.projectinwork.com/v1/environments/{id}",
  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://envlink-api.projectinwork.com/v1/environments/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://envlink-api.projectinwork.com/v1/environments/{id}")

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

{
  "id": "env_3iynbifi4k6xgfhn",
  "name": "linux-build-3f2a",
  "template": "linux-build",
  "state": "pending",
  "node": "<string>",
  "sandbox": "<string>",
  "pool": "linux-arm64",
  "labels": {},
  "project": "github.com/acme/app",
  "readyMs": 123,
  "error": "<string>",
  "createdBy": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "ready": "2023-11-07T05:31:56Z",
  "stopped": "2023-11-07T05:31:56Z",
  "expires": "2023-11-07T05:31:56Z",
  "idleUntil": "2023-11-07T05:31:56Z",
  "idle": "1h0m0s",
  "hard": "6h0m0s",
  "exports": [
    {
      "service": "postgres",
      "listen": "127.0.0.1:5432",
      "target": "127.0.0.1:5432"
    }
  ],
  "shares": [
    {
      "name": "src",
      "direction": "in",
      "envPath": "/work",
      "localPath": ".",
      "files": [
        "<string>"
      ]
    }
  ],
  "snapshot": "<string>",
  "restored": {
    "key": "<string>",
    "root": "<string>",
    "files": 123,
    "created": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "code": "<string>"
}

GET

environments

{id}

Get an environment

curl --request GET \
  --url https://envlink-api.projectinwork.com/v1/environments/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://envlink-api.projectinwork.com/v1/environments/{id}', 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://envlink-api.projectinwork.com/v1/environments/{id}",
  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://envlink-api.projectinwork.com/v1/environments/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://envlink-api.projectinwork.com/v1/environments/{id}")

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

{
  "id": "env_3iynbifi4k6xgfhn",
  "name": "linux-build-3f2a",
  "template": "linux-build",
  "state": "pending",
  "node": "<string>",
  "sandbox": "<string>",
  "pool": "linux-arm64",
  "labels": {},
  "project": "github.com/acme/app",
  "readyMs": 123,
  "error": "<string>",
  "createdBy": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "ready": "2023-11-07T05:31:56Z",
  "stopped": "2023-11-07T05:31:56Z",
  "expires": "2023-11-07T05:31:56Z",
  "idleUntil": "2023-11-07T05:31:56Z",
  "idle": "1h0m0s",
  "hard": "6h0m0s",
  "exports": [
    {
      "service": "postgres",
      "listen": "127.0.0.1:5432",
      "target": "127.0.0.1:5432"
    }
  ],
  "shares": [
    {
      "name": "src",
      "direction": "in",
      "envPath": "/work",
      "localPath": ".",
      "files": [
        "<string>"
      ]
    }
  ],
  "snapshot": "<string>",
  "restored": {
    "key": "<string>",
    "root": "<string>",
    "files": 123,
    "created": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

A CLI token or an organization API key.

Path Parameters

string

required

Its ID or name.

Response

string

Example:

"env_3iynbifi4k6xgfhn"

name

string

Example:

"linux-build-3f2a"

template

string

Example:

"linux-build"

state

enum<string>

Available options:

pending,

starting,

ready,

stopping,

stopped,

failed

node

string

The node it runs on.

sandbox

string

The sandbox it's wired to.

pool

string

Example:

"linux-arm64"

labels

object

Show child attributes

project

string

Whose key seals its files.

Example:

"github.com/acme/app"

readyMs

integer

From request to ready.

error

string

createdBy

string

created

string<date-time>

ready

string<date-time>

stopped

string<date-time>

expires

string<date-time>

idleUntil

string<date-time>

idle

string

Example:

"1h0m0s"

hard

string

Example:

"6h0m0s"

exports

object[]

Show child attributes

object[]

Show child attributes

snapshot

string

The key its files are saved under when it ends.

restored

object

Show child attributes

Overview

Endpoints

Get an environment

Authorizations

Path Parameters

Response