Port Tunneling

JFrog Connect API requests to support port tunneling.

This page has requests to support port tunneling, such as opening and closing port tunneling sessions, and has requests to get information about the open port tunnels.

Prerequisites

The following are required to use the port tunneling API requests:

• You must have the following Project Permission defined:

  • Remote Terminal & Port Tunnel.

• For using a remote SSH session, you need ssh-client installed on the device.

No ports need to be open on the device or the firewall for port tunneling to work.

Open Port Tunnel

post

Opens a port tunneling session with the device that you specify.

Once you obtain the server address and port, you are ready to interact with the device. For more information, see Terminal, Port Tunnel, and Command Runner in the user documentation.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

project_keystringRequired

The fleet key of the relevant fleet in the account. An account can have multiple fleets (formerly called projects). If you don't know the fleet key, you can find it in the Fleet Settings of the web UI.

Body

application/json

device_uuidstringOptional

The UUID of the device you want to connect to.

portintegerOptional

The port you want to forward. This can be any port number. For example, use 22 for a secure SSH connection to your device.

allowed_ipstringOptional

The port will be accessible only from this IP address. If you do not use this parameter, the allowed IP will be your current IP address.

Responses

201

Created

application/json

post

/api/v2/{project_key}/port_tunnel

HTTPcURLJavaScriptPython

POST /api/v2/{project_key}/port_tunnel HTTP/1.1
Host: api.connect.jfrog.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "device_uuid": "d-c8b9-02aa",
  "port": 22,
  "allowed_ip": "1.1.1.1"
}

201

Created

{
  "port_tunnel_id": "7d7a7462-cc5b-4f9a-b678-d3288475de02",
  "server_address": "d-c8b9-02aa-crwapf2u2ia.forwarding.connect.jfrog.io",
  "server_port": 44187
}

Get All Port Tunnels

get

Gets information about all the port tunnels in a project. The port tunnels may be open or closed (also called finished). The status returned may be one of the following:

• Pending: A new port tunnel that has not yet opened.
• Opened: A port tunneling session currently active.
• Closed: The user has ended the port tunneling session.
• Terminated: The tunnel was closed, but not due to user request.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

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.

Responses

200

OK

application/json

get

/api/v2/{project_key}/port_tunnel

HTTPcURLJavaScriptPython

GET /api/v2/{project_key}/port_tunnel HTTP/1.1
Host: api.connect.jfrog.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

[
  {
    "created_time": "Mon, 16 Dec 2024 10:17:37 GMT",
    "device_id": "d-c8b9-02aa",
    "finish_time": "Mon, 16 Dec 2024 10:17:59 GMT",
    "port_tunnel_id": "015900c8-3dae-43bd-8133-cb828470b73e",
    "remote_server_address": "d-c8b9-02aa-agwb8q9wfem.forwarding.connect.jfrog.io",
    "remote_server_port": 52466,
    "status": "closed",
    "user_source_ip": "52.215.237.185"
  },
  {
    "created_time": "Mon, 16 Dec 2024 10:21:10 GMT",
    "device_id": "d-c8b9-02aa",
    "finish_time": "Mon, 16 Dec 2024 11:12:00 GMT",
    "port_tunnel_id": "7d7a7462-cc5b-4f9a-b678-d3288475de02",
    "remote_server_address": "d-c8b9-02aa-crwapf2u2ia.forwarding.connect.jfrog.io",
    "remote_server_port": 44187,
    "status": "closed",
    "user_source_ip": "1.1.1.1"
  },
  {
    "created_time": "Tue, 17 Dec 2024 10:13:17 GMT",
    "device_id": "d-c8b9-02aa",
    "finish_time": "Tue, 17 Dec 2024 12:13:17 GMT",
    "port_tunnel_id": "7a4d651a-09a9-4d22-be60-4a33ad8a740c",
    "remote_server_address": "d-c8b9-02aa-5aezyhyebus.forwarding.connect.jfrog.io",
    "remote_server_port": 34610,
    "status": "closed",
    "user_source_ip": "52.215.237.185"
  }
]

Get Port Tunnel

get

Gets information about all the port tunnels in a project. The port tunnels may be open or closed (also called finished). The status returned may be one of the following:

• Pending: A new port tunnel that has not yet opened.
• Opened: A port tunneling session currently active.
• Closed: The user has ended the port tunneling session.
• Terminated: The tunnel was closed, but not due to user request.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

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.

port_tunnel_idstringRequired

The UUID that is the unique identifier of the port tunnel.

Responses

200

OK

application/json

get

/api/v2/{project_key}/port_tunnel/{port_tunnel_id}

HTTPcURLJavaScriptPython

GET /api/v2/{project_key}/port_tunnel/{port_tunnel_id} HTTP/1.1
Host: api.connect.jfrog.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "created_time": "Mon, 16 Dec 2024 10:17:37 GMT",
  "device_id": "d-c8b9-02aa",
  "finish_time": "Mon, 16 Dec 2024 10:17:59 GMT",
  "port_tunnel_id": "015900c8-3dae-43bd-8133-cb828470b73e",
  "remote_server_address": "d-c8b9-02aa-agwb8q9wfem.forwarding.connect.jfrog.io",
  "remote_server_port": 52466,
  "status": "closed",
  "user_source_ip": "52.215.237.185"
}

Close Port Tunnel

delete

Ends a port tunneling session. You need to specify the project key and the port tunnel ID.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

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.

port_tunnel_idstringRequired

The UUID that is the unique identifier of the port tunnel.

Responses

204

No Content

No content

delete

/api/v2/{project_key}/port_tunnel/{port_tunnel_id}

HTTPcURLJavaScriptPython

DELETE /api/v2/{project_key}/port_tunnel/{port_tunnel_id} HTTP/1.1
Host: api.connect.jfrog.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content