List robot fleets

curl --request GET \
  --url https://api.example.com/v1/fleets \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.example.com/v1/fleets', 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/fleets",
  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://api.example.com/v1/fleets"

	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://api.example.com/v1/fleets")

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": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "readiness_mode": "always_ready",
    "peak_active_robots": 2,
    "status": "preparing",
    "robots": {
      "registered": 1,
      "ready": 1,
      "active": 1,
      "waiting": 1,
      "blocked": 1
    },
    "blocker": "<string>",
    "readiness_estimate": {
      "lower_seconds": 1,
      "upper_seconds": 1,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "active_model": {
      "subject": "<string>",
      "generation_id": "<string>",
      "status": "<string>"
    },
    "update": {
      "subject": "<string>",
      "generation_id": "<string>",
      "status": "<string>",
      "blocker": "<string>"
    }
  }
]

GET

fleets

List robot fleets

curl --request GET \
  --url https://api.example.com/v1/fleets \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.example.com/v1/fleets', 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/fleets",
  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://api.example.com/v1/fleets"

	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://api.example.com/v1/fleets")

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": "<string>",
    "name": "<string>",
    "subject": "<string>",
    "readiness_mode": "always_ready",
    "peak_active_robots": 2,
    "status": "preparing",
    "robots": {
      "registered": 1,
      "ready": 1,
      "active": 1,
      "waiting": 1,
      "blocked": 1
    },
    "blocker": "<string>",
    "readiness_estimate": {
      "lower_seconds": 1,
      "upper_seconds": 1,
      "updated_at": "2023-11-07T05:31:56Z"
    },
    "active_model": {
      "subject": "<string>",
      "generation_id": "<string>",
      "status": "<string>"
    },
    "update": {
      "subject": "<string>",
      "generation_id": "<string>",
      "status": "<string>",
      "blocker": "<string>"
    }
  }
]

Authorizations

Authorization

string

header

required

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

Response

200 - application/json

Successful Response

string

required

name

string

required

subject

string

required

readiness_mode

enum<string>

required

Available options:

always_ready,

scheduled,

on_demand

peak_active_robots

integer

required

Required range: x >= 1

status

enum<string>

required

Available options:

preparing,

ready,

degraded,

blocked

robots

FleetRobotCounts · object

required

Show child attributes

blocker

string | null

readiness_estimate

ReadinessEstimate · object | null

Show child attributes

active_model

FleetModelGenerationView · object | null

Show child attributes

update

FleetUpdateView · object | null

Show child attributes

API Reference

robots

customer-auth

catalog

fleets

List robot fleets

Authorizations

Response