Register a robot - Servo

Register a robot

curl --request POST \
  --url https://api.example.com/v1/robots/setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "robot_type_id": "<string>",
  "region": "<string>",
  "configuration_digest": "<string>",
  "site": "<string>",
  "labels": {},
  "contract": {}
}
'

import requests

url = "https://api.example.com/v1/robots/setup"

payload = {
    "name": "<string>",
    "robot_type_id": "<string>",
    "region": "<string>",
    "configuration_digest": "<string>",
    "site": "<string>",
    "labels": {},
    "contract": {}
}
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({
    name: '<string>',
    robot_type_id: '<string>',
    region: '<string>',
    configuration_digest: '<string>',
    site: '<string>',
    labels: {},
    contract: {}
  })
};

fetch('https://api.example.com/v1/robots/setup', 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.example.com/v1/robots/setup",
  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([
    'name' => '<string>',
    'robot_type_id' => '<string>',
    'region' => '<string>',
    'configuration_digest' => '<string>',
    'site' => '<string>',
    'labels' => [
        
    ],
    'contract' => [
        
    ]
  ]),
  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.example.com/v1/robots/setup"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"robot_type_id\": \"<string>\",\n  \"region\": \"<string>\",\n  \"configuration_digest\": \"<string>\",\n  \"site\": \"<string>\",\n  \"labels\": {},\n  \"contract\": {}\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.example.com/v1/robots/setup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"robot_type_id\": \"<string>\",\n  \"region\": \"<string>\",\n  \"configuration_digest\": \"<string>\",\n  \"site\": \"<string>\",\n  \"labels\": {},\n  \"contract\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/robots/setup")

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  \"name\": \"<string>\",\n  \"robot_type_id\": \"<string>\",\n  \"region\": \"<string>\",\n  \"configuration_digest\": \"<string>\",\n  \"site\": \"<string>\",\n  \"labels\": {},\n  \"contract\": {}\n}"

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

{
  "robot": {
    "id": "<string>",
    "name": "<string>",
    "robot_type_id": "<string>",
    "region": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "site": "<string>",
    "labels": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

/

v1

/

robots

/

setup

Register a robot

curl --request POST \
  --url https://api.example.com/v1/robots/setup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "robot_type_id": "<string>",
  "region": "<string>",
  "configuration_digest": "<string>",
  "site": "<string>",
  "labels": {},
  "contract": {}
}
'

import requests

url = "https://api.example.com/v1/robots/setup"

payload = {
    "name": "<string>",
    "robot_type_id": "<string>",
    "region": "<string>",
    "configuration_digest": "<string>",
    "site": "<string>",
    "labels": {},
    "contract": {}
}
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({
    name: '<string>',
    robot_type_id: '<string>',
    region: '<string>',
    configuration_digest: '<string>',
    site: '<string>',
    labels: {},
    contract: {}
  })
};

fetch('https://api.example.com/v1/robots/setup', 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.example.com/v1/robots/setup",
  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([
    'name' => '<string>',
    'robot_type_id' => '<string>',
    'region' => '<string>',
    'configuration_digest' => '<string>',
    'site' => '<string>',
    'labels' => [
        
    ],
    'contract' => [
        
    ]
  ]),
  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.example.com/v1/robots/setup"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"robot_type_id\": \"<string>\",\n  \"region\": \"<string>\",\n  \"configuration_digest\": \"<string>\",\n  \"site\": \"<string>\",\n  \"labels\": {},\n  \"contract\": {}\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.example.com/v1/robots/setup")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"robot_type_id\": \"<string>\",\n  \"region\": \"<string>\",\n  \"configuration_digest\": \"<string>\",\n  \"site\": \"<string>\",\n  \"labels\": {},\n  \"contract\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/robots/setup")

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  \"name\": \"<string>\",\n  \"robot_type_id\": \"<string>\",\n  \"region\": \"<string>\",\n  \"configuration_digest\": \"<string>\",\n  \"site\": \"<string>\",\n  \"labels\": {},\n  \"contract\": {}\n}"

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

{
  "robot": {
    "id": "<string>",
    "name": "<string>",
    "robot_type_id": "<string>",
    "region": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "site": "<string>",
    "labels": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Organization API key (sk_servo_...) or authenticated CLI session token.

Body

application/json

One-time or replacement installation request from a robot computer.

name

string

required

Unique stable name for one physical robot.

Required string length: 1 - 64

robot_type_id

string

required

Type ID from the ready robot catalog or a validated custom manifest.

Required string length: 1 - 256

region

string

required

AWS region code nearest the physical robot.

configuration_digest

string

required

Ordered SHA-256 digest of the local robot configuration files.

Pattern: ^sha256:[0-9a-f]{64}$

site

string | null

Optional site name used to select fleet members.

Required string length: 1 - 128

labels

Labels · object

Optional key-value labels used to select fleet members.

Show child attributes

contract

Contract · object | null

Normalized contract from a validated custom robot manifest.

Response

Successful Response

robot

RobotView · object

required

Show child attributes