Connect API Reference

JFrog Connect REST API v2

The JFrog Connect API v2 enables programmatic access to and control of Connect’s basic functions, which is ideal for managing your fleet of devices. The automation capabilities that the REST API provides are crucial for the management of large fleets of edge devices.

The API enables you to embed Connect functionality into your CI/CD pipeline and to deploy OTA updates as part of new application releases. You can also use the API to create a custom dashboard or integrate Connect information with an existing dashboard.

The v2 API has API calls that enable you to get information about your devices, update device information, add tags and apps to devices, get monitoring and health info, and deploy software update flows that you have defined in the web UI.

Authorization

You will need to get an access token from the Connect web UI to use the Connect API v2. The v1 token will not work for v2.

Important: For security reasons, the new token generated by Connect will not be stored. Ensure that you copy the token and save it in a safe place.

Base URL

In the Connect API v2, the URLs have the form {{base_url}}/api/v2/... For example, a URL for Get Device, using "demo" as project_key and "d-feaf-d9aa" as device_uuid would be: {{base_url}}/api/v2/demo/devices/d-feaf-d9aa

Cloud Users

If you are a cloud user of Connect (i.e., multi-tenant SaaS), the base_url is:

https://api.connect.jfrog.io

So an example of the full URL for the above request would be:

https://api.connect.jfrog.io/api/v2/demo/devices/d-feaf-d9aa

This is the base URL used throughout the API reference documentation.

Private SaaS

If you are a private SaaS user of Connect, the base URL will be different from the example above and will depend on the environment of your organization. You will need to use the base URL for your organization in the API requests.

What's Next?

Learn how to get an access token for using the API.