# Pinggy Pro APIs

> Programmatically access and manage your Pinggy tunnels with advanced APIs.
> Source: https://pinggy.io/docs/api/api/


# Pinggy Pro APIs

Programmatic access to Pinggy tunnel information and management through APIs is only available for **Pinggy Pro** users. You can <a target="_blank" href="/#prices">compare our plans here</a>.

Pinggy provides an HTTP API, which is similar to REST APIs. In order to access the APIs you need to use a token called `API Key`.

Using this key, an API request is a simple HTTP request. You can access the APIs using CURL as follows:


```bash
curl --location 'https://dashboard.pinggy.io/backend/api/v1/session/active' \
--header 'Authorization: Bearer {API Key}'
```

Example response:

```json
[
    {
        "id": "9345b393-d916-4a2e-816a-3347468a03c0",
        "userId": 4490909,
        "tokenId": 392084,
        "token": null,
        "tokenName": null,
        "virtualToken": "sJsufpgMMl-10003",
        "virtualTokenName": null,
        "subdomain": "mytest.v.awesomeapp.a.pinggy.link",
        "customdomain": null,
        "mode": "tcp",
        "modeUdp": "",
        "port": 10003,
        "creationTimestamp": "2024-08-23T04:04:36.083+00:00",
        "lastUpdateTimestamp": "2024-08-23T04:04:37.780+00:00"
    }
]
```

## Create an API Key

You can manage your API keys from [https://dashboard.pinggy.io/api-keys](https://dashboard.pinggy.io/api-keys)
.


- Click on the "Create API key" button.
- Give your key a name, and click "Generate".

![create a new api key](/doc_img/apikey/api-key-1.png)

You can now find the newly generated key in the list of API keys.

![list of api keys](/doc_img/apikey/api-key-2.png)


## List active tunnels

List all active tunnels associated with your account.

**Request:**

```bash
curl --location 'https://dashboard.pinggy.io/backend/api/v1/session/active' \
--header 'Authorization: Bearer {API Key}'
```

**Example response:**

```json
[
    {
        "id": "9345b393-d916-4a2e-816a-3347468a03c0",
        "userId": 4490909,
        "tokenId": 392084,
        "token": null,
        "tokenName": null,
        "virtualToken": "sJsufpgMMl-10003",
        "virtualTokenName": null,
        "subdomain": "mytest.v.awesomeapp.a.pinggy.link",
        "customdomain": null,
        "mode": "tcp",
        "modeUdp": "",
        "port": 10003,
        "creationTimestamp": "2024-08-23T04:04:36.083+00:00",
        "lastUpdateTimestamp": "2024-08-23T04:04:37.780+00:00"
    }
]
```

## Get tunnel session history

Get a history of all tunnels created from your account. You can query data no older than 60 days.



```bash
curl --location 'https://dashboard.pinggy.io/backend/api/v1/session/history/2025-02-06/2025-02-06?page=0&size=10' \
--header 'Authorization: Bearer {API Key}'
```

**Example response:**

```json
{
  "totalElements": 1,
  "totalPages": 1,
  "size": 10,
  "content": [
    {
      "start_time": "2025-02-06T16:16:44.571+00:00",
      "end_time": "2025-02-07T06:15:26.294+00:00",
      "user_email": "youremail@example.com",
      "token_value": "AAXXYY99F",
      "virtual_token_value": null,
      "domains": [
        "test.example.com",
        "test.a.pinggy.link"
      ],
      "mode": "http",
      "mode_udp": "",
      "client_ip": "[5.7.152.215]:48696",
      "port": null
    }
  ],
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": false,
    "unsorted": true
  },
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10,
    "sort": {
      "empty": true,
      "sorted": false,
      "unsorted": true
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "numberOfElements": 1,
  "first": true,
  "last": true,
  "empty": false
}
```