What's New?Connect Agent Releases Pricing

Devices

JFrog Connect API requests that act on the edge device or retrieve information from one or more devices.

Last updated 2 days ago

Was this helpful?

Get List of Devices

Returns a list of devices according to the filter options that you specify and information about each device.

get

/api/v2/{project_key}/devices

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

Query parameters

groupstring

The name of the group the device belongs to. If you do not specify a group name, then all the devices in the project will be specified.

tagsstring[]

Returns devices having this tag. To search for multiple tags, for example, records having tag-a, or tag-b, or tag-c, enter a separate key and value for each tag to include. (For example, a new row in the Query Params table for each tag.)

afterstring

Returns the next set (i.e., next cursor) of records. This is applicable whenever the number of devices to be returned is greater than the limit. For example, if the first cursor returned the limit of 100 records, this parameter is required to receive the next 100 records. The value of the input string can be found at the end of the output of the current cursor.

limitinteger · min: 1 · max: 1000 · default: 100

The number of devices to show in each cursor of data returned. Default is 100, and maximum is 1000. Must be positive integer.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/devices' \
  --header 'Authorization: Bearer JWT'

200

403

[
  {
    "device_name": "text",
    "last_keepalive": "2025-02-21T18:09:12.698Z",
    "agent_version": "text",
    "device_ip": "text",
    "cpu_usage": 1,
    "ram_usage": 1,
    "current_disk_usage": 1,
    "disk_size": 1,
    "address": "text",
    "lat": 1,
    "lng": 1,
    "is_update_trigger_set": true,
    "description": "text",
    "registered_date": "2025-02-21T18:09:12.698Z",
    "device_uuid": "text",
    "device_status": "text",
    "project": "text"
  }
]

Get Device

Returns the details about a single device.

get

/api/v2/{project_key}/devices/{device_uuid}

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

device_uuidstringrequired

The UUID of the device you are acting on. This is the unique identifier of the device in Connect, for example, d-4cfe-4e51. You can find the UUID in the ID column of the Devices table in the Devices page of the web UI.

Query parameters

enrich_infoboolean

Returns additional information about the device, including app_name, version, mac_addresses, tags, and updates. Updates includes the last five updates to the device. Default is False.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/devices/{device_uuid}'

200

404

Using enrich_info param

Without enrich_info

{
  "address": "270 E Caribbean Dr, Sunnyvale, CA 94089, USA",
  "agent_version": "6.0",
  "cpu_usage": 1,
  "current_disk_usage": 3282,
  "description": "",
  "device_ip": "18.209.245.178",
  "device_name": "zzzzz",
  "device_status": "offline",
  "device_uuid": "d-abfa-d82b",
  "disk_size": 214735,
  "group": "Tel-Aviv",
  "is_update_trigger_set": false,
  "last_keepalive": "2022-11-29 14:23:44",
  "lat": 37.4157324,
  "lng": -122.0138817,
  "project": "demo",
  "ram_usage": 11,
  "registered_date": "2022-11-03 12:48:23",
  "mac_address": [
    "02:1f:fa:3c:7b:11",
    "02:42:81:09:b2:42"
  ],
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "apps": [
    {
      "app_name": "app name",
      "version": "1.0"
    }
  ],
  "updates": [
    {
      "comment": "",
      "deployment_finish_time": "",
      "deployment_schedule_time": "2024-06-25 15:05:17",
      "deployment_start_time": "",
      "deployment_status": "pending",
      "deployment_type": "manual",
      "flow_name": "conan-flow",
      "apps_updated": []
    },
    {
      "comment": "",
      "deployment_finish_time": "",
      "deployment_schedule_time": "2024-06-20 15:33:58",
      "deployment_start_time": "",
      "deployment_status": "pending",
      "deployment_type": "manual",
      "flow_name": "my echo",
      "apps_updated": []
    },
    {
      "comment": "",
      "deployment_finish_time": "",
      "deployment_schedule_time": "2024-05-30 09:43:57",
      "deployment_start_time": "",
      "deployment_status": "pending",
      "deployment_type": "manual",
      "flow_name": "update with file",
      "apps_updated": []
    },
    {
      "comment": "",
      "deployment_finish_time": "",
      "deployment_schedule_time": "2024-05-02 15:41:22",
      "deployment_start_time": "",
      "deployment_status": "pending",
      "deployment_type": "manual",
      "flow_name": "Try Verification v2",
      "apps_updated": []
    },
    {
      "comment": "",
      "deployment_finish_time": "",
      "deployment_schedule_time": "2024-05-02 08:44:21",
      "deployment_start_time": "",
      "deployment_status": "pending",
      "deployment_type": "manual",
      "flow_name": "Try Verification v2",
      "apps_updated": []
    }
  ]
}

Update Device

Updates information on a device. You can make updates using the Add, Replace, and Remove operations, and you can replace values of multiple parameters in a single API request. This request is based on the RFC 6902 specification.

For the "tags" value, spaces are allowed in the tag name. You can add multiple tag values, with each value separated by a comma.

patch

/api/v2/{project_key}/devices/{device_uuid}

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

device_uuidstringrequired

Header parameters

Content-Typestringrequired

Example: application/json-patch+json

Body

operationsobject[]required

List of operations to be performed on the device

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/devices/{device_uuid}' \
  --header 'Content-Type: application/json' \
  --data '{"operations":[{"op":"add","path":"tags","value":["tag1","tag2"]}]}'

200

400

401

404

{
  "address": "44091 Ashburn Shopping Plz, Ashburn, VA 20147, USA",
  "cpu_usage": 1,
  "current_disk_usage": 1124,
  "description": "",
  "device_ip": "54.145.235.216",
  "device_name": "New Device",
  "device_status": "online",
  "device_uuid": "d-c06c-a10f",
  "disk_size": 8218,
  "group_name": "Production",
  "is_update_trigger_set": false,
  "last_keepalive": "2024-05-02 07:12:57",
  "lat": 39.0432152,
  "lng": -77.4745442,
  "project": "demo",
  "ram_usage": 7,
  "registered_date": "2024-05-01 08:41:16",
  "agent_version": "6.2",
  "apps": [],
  "mac_address": [
    "0e:fb:e1:d0:69:09"
  ],
  "tags": [
    "arnold the king",
    "john_tag_test",
    "jeff the king",
    "mike_tag_test"
  ],
  "updates": []
}

Move Device

Moves a device from one project to another. You need to specify both the destination project and a destination group in that project. For more information about the data that is transferred with the device, see Move Device between Projects in the web UI user documentation.

post

/api/v2/{project_key}/devices/{device_uuid}/move

Authorizations

Path parameters

project_keystringrequired

The project key of the relevant project in the account. An account can have multiple projects. If you don't know the project key, you can find it in the Settings of the web UI in the Projects tab.

device_uuidstringrequired

Body

destination_project_keystring

The project key to which the device is transferred.

destination_group_namestring

The group name in the destination project to which the device is transferred.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.connect.jfrog.io/api/v2/{project_key}/devices/{device_uuid}/move' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"destination_project_key":"project_key","destination_group_name":"group_name"}'

200

400

404

{
  "message": "Device moved successfully"
}