Skip to main content
POST
/
ssh-tunnels
/
{uuid}
Update an SSH tunnel
curl --request POST \
  --url https://api.artie.com/ssh-tunnels/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "host": "<string>",
  "name": "<string>",
  "port": 123,
  "publicKey": "<string>",
  "username": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "isInUse": true,
  "updatedAt": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://api.artie.com/ssh-tunnels/{uuid}"

payload = {
    "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "host": "<string>",
    "name": "<string>",
    "port": 123,
    "publicKey": "<string>",
    "username": "<string>",
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "isInUse": True,
    "updatedAt": "2023-11-07T05:31:56Z"
}
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({
    companyUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    environmentUUID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    host: '<string>',
    name: '<string>',
    port: 123,
    publicKey: '<string>',
    username: '<string>',
    uuid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    createdAt: '2023-11-07T05:31:56Z',
    isInUse: true,
    updatedAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.artie.com/ssh-tunnels/{uuid}', 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.artie.com/ssh-tunnels/{uuid}",
  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([
    'companyUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'environmentUUID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'host' => '<string>',
    'name' => '<string>',
    'port' => 123,
    'publicKey' => '<string>',
    'username' => '<string>',
    'uuid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'createdAt' => '2023-11-07T05:31:56Z',
    'isInUse' => true,
    'updatedAt' => '2023-11-07T05:31:56Z'
  ]),
  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.artie.com/ssh-tunnels/{uuid}"

	payload := strings.NewReader("{\n  \"companyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"host\": \"<string>\",\n  \"name\": \"<string>\",\n  \"port\": 123,\n  \"publicKey\": \"<string>\",\n  \"username\": \"<string>\",\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"isInUse\": true,\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\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.artie.com/ssh-tunnels/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"companyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"host\": \"<string>\",\n  \"name\": \"<string>\",\n  \"port\": 123,\n  \"publicKey\": \"<string>\",\n  \"username\": \"<string>\",\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"isInUse\": true,\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.artie.com/ssh-tunnels/{uuid}")

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  \"companyUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"environmentUUID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"host\": \"<string>\",\n  \"name\": \"<string>\",\n  \"port\": 123,\n  \"publicKey\": \"<string>\",\n  \"username\": \"<string>\",\n  \"uuid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"isInUse\": true,\n  \"updatedAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "companyUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "environmentUUID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "host": "<string>",
  "name": "<string>",
  "port": 123,
  "publicKey": "<string>",
  "username": "<string>",
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "isInUse": true,
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Path Parameters

​
uuid
string
required

Body

application/json
​
companyUUID
string<uuid>
required
​
environmentUUID
string<uuid>
required
​
host
string
required
​
name
string
required
​
port
integer
required
​
publicKey
string
required
​
username
string
required
​
uuid
string<uuid>
required
​
createdAt
string<date-time>
​
isInUse
null | boolean
​
updatedAt
string<date-time>

Response

OK

​
companyUUID
string<uuid>
required
​
environmentUUID
string<uuid>
required
​
host
string
required
​
name
string
required
​
port
integer
required
​
publicKey
string
required
​
username
string
required
​
uuid
string<uuid>
required
​
createdAt
string<date-time>
​
isInUse
null | boolean
​
updatedAt
string<date-time>