Skip to main content
PUT
/
client
/
taps
/
{id}
Update tap
curl --request PUT \
  --url https://api.orbital-systems.com/client/taps/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "device_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "<string>",
  "updated_at": "<string>"
}
'
import requests

url = "https://api.orbital-systems.com/client/taps/{id}"

payload = {
    "name": "<string>",
    "device_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state": "<string>",
    "updated_at": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    device_group: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    owner: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    state: '<string>',
    updated_at: '<string>'
  })
};

fetch('https://api.orbital-systems.com/client/taps/{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://api.orbital-systems.com/client/taps/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'device_group' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'owner' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'state' => '<string>',
    'updated_at' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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.orbital-systems.com/client/taps/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"device_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"state\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}")

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

	req.Header.Add("x-api-key", "<api-key>")
	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.put("https://api.orbital-systems.com/client/taps/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"device_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"state\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.orbital-systems.com/client/taps/{id}")

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

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"device_group\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"owner\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"state\": \"<string>\",\n  \"updated_at\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "device_group": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_connected": "<string>",
  "last_disconnected": "<string>",
  "build_id": "<string>",
  "wifi_ssid": "<string>",
  "type": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "role": "<string>"
}
{}
{}
{}

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The unique identifier for the tap

Body

application/json
name
string
device_group
string<uuid>
owner
string<uuid>
state
string
updated_at
string

Response

Success

id
string<uuid>
name
string
owner
string<uuid>
device_group
string<uuid>
last_connected
string
last_disconnected
string
build_id
string
wifi_ssid
string
type
string
created_at
string
updated_at
string
role
string