Deployment Manager

GET /{workspace}/devices/v2 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "status": "online",
      "last_heartbeat": "text",
      "platform": "text",
      "platform_release": "text",
      "platform_version": "text",
      "architecture": "text",
      "hostname": "text",
      "rfdm_version": "text",
      "type": "text",
      "hardware": {
        "processor": "text",
        "gpu": "text",
        "total_memory_mb": 1,
        "total_disk_space_mb": 1
      },
      "tags": [
        "text"
      ],
      "created_at": "text"
    }
  ]
}

{
  "error": "text"
}

{
  "error": "text"
}

GET /{workspace}/devices/v2/{deviceId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "text",
  "name": "text",
  "status": "online",
  "last_heartbeat": "text",
  "platform": "text",
  "platform_release": "text",
  "platform_version": "text",
  "architecture": "text",
  "hostname": "text",
  "rfdm_version": "text",
  "type": "text",
  "hardware": {
    "processor": "text",
    "gpu": "text",
    "total_memory_mb": 1,
    "total_disk_space_mb": 1
  },
  "tags": [
    "text"
  ],
  "created_at": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

POST /{workspace}/devices/v2 HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json

{
  "device_name": "text",
  "device_type": "text",
  "workflow_id": "text",
  "tags": [
    "text"
  ],
  "offline_mode": true,
  "sourceDeviceId": "text"
}

curl -L \
  --request POST \
  --url 'https://api.roboflow.com/{workspace}/devices/v2' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
  "device_name": "text",
  "device_type": "text",
  "workflow_id": "text",
  "tags": [
    "text"
  ],
  "offline_mode": true,
  "sourceDeviceId": "text"
}'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
  },
  body: JSON.stringify({
    "device_name": "text",
    "device_type": "text",
    "workflow_id": "text",
    "tags": [
      "text"
    ],
    "offline_mode": true,
    "sourceDeviceId": "text"
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
}
payload = {
  "device_name": "text",
  "device_type": "text",
  "workflow_id": "text",
  "tags": [
    "text"
  ],
  "offline_mode": True,
  "sourceDeviceId": "text"
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

{
  "deviceId": "text",
  "installId": "text",
  "offlineProvisioningQrPayload": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

GET /{workspace}/devices/v2/{deviceId}/config HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

GET /{workspace}/devices/v2/{deviceId}/config/history HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/config/history"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "revision_id": "text",
      "created_at": "text",
      "created_by": "text"
    }
  ],
  "pagination": {
    "next_cursor": "text",
    "has_more": true,
    "limit": 1
  }
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

GET /{workspace}/devices/v2/{deviceId}/commands HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/commands' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/commands", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/commands"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "commands": [
    {
      "id": "cmd_abc",
      "action": "restart",
      "data": {}
    }
  ]
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

POST /{workspace}/devices/v2/{deviceId}/commands HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: application/json

{
  "action": "restart",
  "data": {}
}

curl -L \
  --request POST \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/commands' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{
  "action": "restart",
  "data": {}
}'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/commands", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
  },
  body: JSON.stringify({
    "action": "restart",
    "data": {}
  })
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/commands"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Content-Type": "application/json",
    "Accept": "application/json"
}
payload = {
  "action": "restart",
  "data": {}
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())

{
  "id": "cmd_abc"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

GET /{workspace}/devices/v2/{deviceId}/streams HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "status": "text",
      "provisioning": true,
      "mode": "continuous",
      "pipeline_id": "text",
      "workflow_id": "text",
      "source": "text",
      "configured_source": "text",
      "started_at": "text",
      "last_event_at": "text",
      "camera_fps": 1,
      "inference_fps": 1,
      "sharpness": 1,
      "error": "text",
      "error_code": "STREAM_SOURCE_UNAVAILABLE",
      "error_message": "text",
      "error_retryable": true,
      "status_events": [
        {
          "id": "text",
          "event": "text",
          "entity_type": "text",
          "entity_id": "text",
          "event_description": "text",
          "error_code": "text",
          "metadata": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "device_timestamp": "text",
          "server_timestamp": "text",
          "event_end_timestamp": "text"
        }
      ]
    }
  ]
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}

GET /{workspace}/devices/v2/{deviceId}/streams/{streamId} HTTP/1.1
Host: api.roboflow.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json

curl -L \
  --request GET \
  --url 'https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Accept: application/json'

const response = await fetch("https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
  }
});

const data = await response.json();
console.log(data);

import requests

url = "https://api.roboflow.com/{workspace}/devices/v2/{deviceId}/streams/{streamId}"
headers = {
    "Authorization": "Bearer YOUR_SECRET_TOKEN",
    "Accept": "application/json"
}

response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "text",
  "name": "text",
  "status": "text",
  "provisioning": true,
  "mode": "continuous",
  "pipeline_id": "text",
  "workflow_id": "text",
  "source": "text",
  "configured_source": "text",
  "started_at": "text",
  "last_event_at": "text",
  "camera_fps": 1,
  "inference_fps": 1,
  "sharpness": 1,
  "error": "text",
  "error_code": "STREAM_SOURCE_UNAVAILABLE",
  "error_message": "text",
  "error_retryable": true,
  "status_events": [
    {
      "id": "text",
      "event": "text",
      "entity_type": "text",
      "entity_id": "text",
      "event_description": "text",
      "error_code": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "device_timestamp": "text",
      "server_timestamp": "text",
      "event_end_timestamp": "text"
    }
  ]
}

{
  "error": "text"
}

{
  "error": "text"
}

{
  "error": "text"
}