Localtonet API

https://localtonet.com/api
Admin
The Localtonet API provides endpoints for managing tunnels, authentication tokens, and various...
Tokens:17,066
Snippets:52
Trust Score:8.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### Get Available Servers (cURL)

Source: https://localtonet.com/api/index

This example shows how to retrieve a list of available servers using cURL. It targets the '/api/GetAvailableServers' endpoint with a GET request and includes an 'ApiKey' for authentication in the header.

```shell
curl -X GET "https://localtonet.com/api/GetAvailableServers" \
     -H "accept: */*" \
     -H "ApiKey: YOUR_API_KEY"
```

--------------------------------

### GET /api/GetAvailableServers

Source: https://localtonet.com/api/index

Retrieves a list of available servers that can be used for creating tunnels. This is useful for obtaining server codes.

```APIDOC
## GET /api/GetAvailableServers

### Description
Retrieves a list of available servers that can be used for creating tunnels. This endpoint is essential for obtaining the `serverCode` parameter required by the `CreateHttpRandomSubDomainTunnel` endpoint.

### Method
GET

### Endpoint
/api/GetAvailableServers

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetAvailableServers \
  --request GET \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **servers** (array) - A list of available server objects.
  - **code** (string) - The unique code for the server.
  - **domain** (string) - The domain name of the server.
  - **ip** (string) - The IP address of the server.

#### Response Example
```json
[
  {
    "code": "server123",
    "domain": "localtonet.com",
    "ip": "192.168.1.1"
  },
  {
    "code": "server456",
    "domain": "another.localtonet.com",
    "ip": "192.168.1.2"
  }
]
```
```

--------------------------------

### Get All Auth Tokens

Source: https://localtonet.com/api/index

Retrieves a list of all authentication tokens associated with your account. This includes details about their online status and tunnel counts.

```APIDOC
## GET /api/GetAuthTokens

### Description
Retrieves a list of all authentication tokens associated with your account. This includes details about their online status and tunnel counts.

### Method
GET

### Endpoint
/api/GetAuthTokens

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetAuthTokens \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if there was an error during the request.
- **errorCode** (any) - The error code, if an error occurred.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of auth token objects, each containing:
  - **id** (integer) - The unique identifier of the token.
  - **name** (any) - The name of the token (can be null).
  - **token** (any) - The authentication token value (can be null).
  - **clientIsOnline** (boolean) - Indicates if the client associated with the token is online.
  - **activeTunnelCount** (integer) - The number of active tunnels for this token.
  - **totalTunnelCount** (integer) - The total number of tunnels associated with this token.

#### Response Example
```json
{
  "hasError": true,
  "errorCode": null,
  "errors": [
    "…"
  ],
  "result": [
    {
      "id": 1,
      "name": null,
      "token": null,
      "clientIsOnline": true,
      "activeTunnelCount": 1,
      "totalTunnelCount": 1
    }
  ]
}
```
```

--------------------------------

### Get Auth Token Detail

Source: https://localtonet.com/api/index

Retrieves detailed information about a specific authentication token using its unique token identifier.

```APIDOC
## GET /api/GetAuthTokenDetail/{token}

### Description
Retrieves detailed information about a specific authentication token using its unique token identifier.

### Method
GET

### Endpoint
/api/GetAuthTokenDetail/_{token}_

### Parameters
#### Path Parameters
- **token** (string) - Required - The unique identifier of the authentication token.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl 'https://localtonet.com/api/GetAuthTokenDetail/{token}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if there was an error during the request.
- **errorCode** (any) - The error code, if an error occurred.
- **errors** (array) - A list of error messages.
- **result** (object) - An object containing the details of the auth token:
  - **id** (integer) - The unique identifier of the token.
  - **name** (any) - The name of the token (can be null).
  - **token** (any) - The authentication token value (can be null).
  - **isConnected** (boolean) - Indicates if the client associated with the token is connected.
  - **version** (any) - The version of the client (can be null).
  - **needUpdate** (boolean) - Indicates if an update is needed for the client.
  - **isRooted** (boolean) - Indicates if the device is rooted.
  - **batteryLevel** (any) - The battery level of the device (can be null).
  - **batteryTemperature** (integer) - The battery temperature of the device.
  - **isCharging** (boolean) - Indicates if the device is charging.
  - **activeTunnelCount** (integer) - The number of active tunnels for this token.
  - **totalTunnelCount** (integer) - The total number of tunnels associated with this token.

#### Response Example
```json
{
  "hasError": true,
  "errorCode": null,
  "errors": [
    "…"
  ],
  "result": {
    "id": 1,
    "name": null,
    "token": null,
    "isConnected": true,
    "version": null,
    "needUpdate": true,
    "isRooted": true,
    "batteryLevel": null,
    "batteryTemperature": 1,
    "isCharging": true,
    "activeTunnelCount": 1,
    "totalTunnelCount": 1
  }
}
```
```

--------------------------------

### GET /api/GetAvailableServers

Source: https://localtonet.com/api/index

Retrieves a list of available servers that can be used for establishing tunnels. This endpoint is useful for discovering server locations and domains.

```APIDOC
## GET /api/GetAvailableServers

### Description
Retrieves a list of available servers that can be used for establishing tunnels. This endpoint is useful for discovering server locations and domains.

### Method
GET

### Endpoint
/api/GetAvailableServers

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetAvailableServers \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred during the request.
- **errorCode** (string) - The error code, if an error occurred.
- **errors** (array) - A list of error messages, if any.
- **result** (array) - A list of available servers. Each server object contains:
  - **serverCode** (string) - The code identifier for the server.
  - **serverName** (string) - The name of the server.
  - **serverDomain** (string) - The domain name of the server.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "serverCode": "us-east-1",
      "serverName": "US East (N. Virginia)",
      "serverDomain": "us-east-1.localtonet.com"
    }
  ]
}
```
```

--------------------------------

### Get Token Groups API

Source: https://localtonet.com/api/index

Retrieves a list of all token groups. This endpoint is useful for getting an overview of existing token groups and their associated token counts.

```APIDOC
## GET /api/GetTokenGroups

### Description
Retrieves a list of all token groups, including their IDs, names, and token counts.

### Method
GET

### Endpoint
/api/GetTokenGroups

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTokenGroups \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred during the request.
- **errorCode** (any) - Error code, if any.
- **errors** (array) - A list of error messages, if any.
- **result** (array) - A list of token group objects, each containing:
  - **id** (integer) - The unique identifier for the token group.
  - **groupName** (string) - The name of the token group (can be null).
  - **tokenCount** (integer) - The number of tokens in the group.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": 1,
      "groupName": "Default Group",
      "tokenCount": 5
    }
  ]
}
```
```

--------------------------------

### Get All Tunnels

Source: https://localtonet.com/api/index

Retrieves a list of all tunnels associated with the authenticated account. Requires an Authorization header with a Bearer token.

```APIDOC
## GET /api/GetTunnels

### Description
Retrieves a list of all tunnels associated with the authenticated account.

### Method
GET

### Endpoint
/api/GetTunnels

### Parameters
#### Query Parameters
None

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```
curl https://localtonet.com/api/GetTunnels \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (any) - Error code, if any.
- **errors** (array) - List of error messages.
- **result** (array) - List of tunnel objects.
  - **id** (integer) - Unique identifier for the tunnel.
  - **guidId** (string) - Globally unique identifier for the tunnel.
  - **title** (string) - Optional title for the tunnel.
  - **teamId** (integer) - Identifier for the team the tunnel belongs to.
  - **authTokenName** (string) - Name of the authentication token.
  - **authToken** (string) - The authentication token.
  - **url** (string) - The public URL for the tunnel.
  - **isOnlyHttps** (boolean) - Whether the tunnel only supports HTTPS.
  - **serverId** (string) - Identifier for the server hosting the tunnel.
  - **serverDomain** (string) - Domain name of the server.
  - **serverIp** (string) - IP address of the server.
  - **localServerIp** (string) - Local IP address of the server.
  - **serverPort** (integer) - Port number of the server.
  - **isReserved** (boolean) - Whether the tunnel is reserved.
  - **clientIp** (string) - IP address of the client connecting to the tunnel.
  - **clientPort** (integer) - Port number of the client.
  - **protocolType** (string) - Type of protocol used by the tunnel.
  - **status** (string) - Status of the tunnel (e.g., "0 = Passive").
  - **enableBasicAuthentication** (boolean) - Whether basic authentication is enabled.
  - **authenticationUsername** (string) - Username for basic authentication.
  - **authenticationPassword** (string) - Password for basic authentication.
  - **createDate** (string) - Date and time the tunnel was created.
  - **useStartedTime** (string) - Time when the tunnel was started.
  - **updatedDate** (string) - Date and time the tunnel was last updated.
  - **path** (string) - Path for the tunnel URL.
  - **hostHeader** (string) - Host header for the tunnel.
  - **bandwidthLimit** (integer) - Bandwidth limit for the tunnel.
  - **bandwidthUsage** (integer) - Current bandwidth usage for the tunnel.
  - **isSslStream** (boolean) - Whether SSL streaming is enabled.
  - **rewriteHttpPath** (string) - Path to rewrite HTTP requests.
  - **externalUserId** (string) - Identifier for an external user.
  - **isWifiSplitOn** (boolean) - Whether Wi-Fi split is enabled.
  - **isAllowIpRestriction** (boolean) - Whether IP restrictions are allowed.
  - **ipRestrictions** (array) - List of IP restrictions.
    - **id** (integer) - Unique identifier for the IP restriction.
    - **tunnelId** (integer) - Identifier of the tunnel the restriction applies to.
    - **ipAddress** (string) - The allowed or blocked IP address.
    - **isAllow** (boolean) - Whether the IP address is allowed.
  - **connectionStatus** (boolean) - Current connection status of the tunnel.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": 1,
      "guidId": "123e4567-e89b-12d3-a456-426614174000",
      "title": null,
      "teamId": null,
      "authTokenName": null,
      "authToken": null,
      "url": null,
      "isOnlyHttps": true,
      "serverId": null,
      "serverDomain": null,
      "serverIp": null,
      "localServerIp": null,
      "serverPort": null,
      "isReserved": true,
      "clientIp": null,
      "clientPort": 1,
      "protocolType": null,
      "status": "0 = Passive",
      "enableBasicAuthentication": true,
      "authenticationUsername": null,
      "authenticationPassword": null,
      "createDate": null,
      "useStartedTime": null,
      "updatedDate": null,
      "path": null,
      "hostHeader": null,
      "bandwidthLimit": 1,
      "bandwidthUsage": 1,
      "isSslStream": true,
      "rewriteHttpPath": null,
      "externalUserId": null,
      "isWifiSplitOn": true,
      "isAllowIpRestriction": true,
      "ipRestrictions": [
        {
          "id": 1,
          "tunnelId": 1,
          "ipAddress": null,
          "isAllow": true
        }
      ],
      "connectionStatus": true
    }
  ]
}
```
```

--------------------------------

### Get Available Servers (Shell Curl)

Source: https://localtonet.com/api/index

This snippet demonstrates how to retrieve a list of available servers using the `curl` command-line tool. It requires an Authorization header with a Bearer Token. The response is in JSON format and indicates whether an error occurred, along with a list of server details.

```shell
curl https://localtonet.com/api/GetAvailableServers \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### GET /api/GetAuthTokens

Source: https://localtonet.com/api/index

Retrieves a list of all authentication tokens associated with the user's account. This is useful for managing access and permissions.

```APIDOC
## GET /api/GetAuthTokens

### Description
Retrieves a list of all authentication tokens associated with the user's account. This is useful for managing access and permissions.

### Method
GET

### Endpoint
/api/GetAuthTokens

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetAuthTokens \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of authentication tokens. Each token object contains details like token ID, creation date, etc.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": "token_abc123",
      "createdAt": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get Tunnel Detail by ID (Shell Curl)

Source: https://localtonet.com/api/index

Retrieves detailed information about a specific tunnel using its ID. Requires an authorization token. The response includes various tunnel properties such as ID, GUID, status, and configuration settings.

```Shell Curl
curl 'https://localtonet.com/api/GetTunnelDetail/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### GET /api/GetTokenGroups

Source: https://localtonet.com/api/index

Retrieves a list of all token groups created by the user. This allows for managing and viewing the organization of authentication tokens.

```APIDOC
## GET /api/GetTokenGroups

### Description
Retrieves a list of all token groups created by the user. This allows for managing and viewing the organization of authentication tokens.

### Method
GET

### Endpoint
/api/GetTokenGroups

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTokenGroups \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of token group objects.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": "group_abc",
      "name": "production-tokens"
    }
  ]
}
```
```

--------------------------------

### Get Tunnel Detail By Tunnel Id

Source: https://localtonet.com/api/index

Retrieves the details of a specific tunnel using its unique ID.

```APIDOC
## GET /api/GetTunnelDetail/{id}

### Description
Retrieves the details of a specific tunnel using its unique ID.

### Method
GET

### Endpoint
/api/GetTunnelDetail/{id}

#### Path Parameters
- **id** (integer int64) - Required - Signed 64-bit integers (long type).

### Request Example
```
curl 'https://localtonet.com/api/GetTunnelDetail/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (any) - The error code, if an error occurred.
- **errors** (array) - A list of error messages.
- **result** (object) - The tunnel details.
  - **id** (integer) - The tunnel ID.
  - **guidId** (string) - The unique GUID of the tunnel.
  - **title** (string) - The title of the tunnel.
  - **teamId** (string) - The ID of the team associated with the tunnel.
  - **authTokenName** (string) - The name of the authentication token.
  - **authToken** (string) - The authentication token.
  - **url** (string) - The URL of the tunnel.
  - **isOnlyHttps** (boolean) - Whether the tunnel only supports HTTPS.
  - **serverId** (string) - The ID of the server hosting the tunnel.
  - **serverDomain** (string) - The domain of the server.
  - **serverIp** (string) - The IP address of the server.
  - **localServerIp** (string) - The local IP address of the server.
  - **serverPort** (integer) - The port of the server.
  - **isReserved** (boolean) - Whether the tunnel is reserved.
  - **clientIp** (string) - The IP address of the client.
  - **clientPort** (integer) - The port of the client.
  - **protocolType** (string) - The protocol type of the tunnel.
  - **status** (string) - The status of the tunnel.
  - **enableBasicAuthentication** (boolean) - Whether basic authentication is enabled.
  - **authenticationUsername** (string) - The username for authentication.
  - **authenticationPassword** (string) - The password for authentication.
  - **createDate** (string) - The creation date of the tunnel.
  - **useStartedTime** (string) - The time the tunnel was started.
  - **updatedDate** (string) - The date the tunnel was last updated.
  - **path** (string) - The path for the tunnel.
  - **hostHeader** (string) - The host header for the tunnel.
  - **bandwidthLimit** (integer) - The bandwidth limit for the tunnel.
  - **bandwidthUsage** (integer) - The current bandwidth usage.
  - **isSslStream** (boolean) - Whether SSL streaming is enabled.
  - **rewriteHttpPath** (string) - The HTTP path to rewrite.
  - **externalUserId** (string) - The external user ID.
  - **isWifiSplitOn** (boolean) - Whether Wi-Fi split is enabled.
  - **isAllowIpRestriction** (boolean) - Whether IP restrictions are allowed.
  - **ipRestrictions** (array) - A list of IP restrictions.
    - **id** (integer) - The ID of the IP restriction.
    - **tunnelId** (integer) - The ID of the tunnel associated with the restriction.
    - **ipAddress** (string) - The IP address restriction.
    - **isAllow** (boolean) - Whether the IP address is allowed.
  - **connectionStatus** (boolean) - The connection status of the tunnel.

#### Response Example
```json
{
  "hasError": true,
  "errorCode": null,
  "errors": [
    "…"
  ],
  "result": {
    "id": 1,
    "guidId": "123e4567-e89b-12d3-a456-426614174000",
    "title": null,
    "teamId": null,
    "authTokenName": null,
    "authToken": null,
    "url": null,
    "isOnlyHttps": true,
    "serverId": null,
    "serverDomain": null,
    "serverIp": null,
    "localServerIp": null,
    "serverPort": null,
    "isReserved": true,
    "clientIp": null,
    "clientPort": 1,
    "protocolType": null,
    "status": "0 = Passive",
    "enableBasicAuthentication": true,
    "authenticationUsername": null,
    "authenticationPassword": null,
    "createDate": null,
    "useStartedTime": null,
    "updatedDate": null,
    "path": null,
    "hostHeader": null,
    "bandwidthLimit": 1,
    "bandwidthUsage": 1,
    "isSslStream": true,
    "rewriteHttpPath": null,
    "externalUserId": null,
    "isWifiSplitOn": true,
    "isAllowIpRestriction": true,
    "ipRestrictions": [
      {
        "id": 1,
        "tunnelId": 1,
        "ipAddress": null,
        "isAllow": true
      }
    ],
    "connectionStatus": true
  }
}
```
```

--------------------------------

### Get All Auth Tokens (Shell Curl)

Source: https://localtonet.com/api/index

Retrieves a list of all authentication tokens associated with the account. Requires an Authorization header with a Bearer token. Returns a JSON object containing token details or error information.

```Shell Curl
curl https://localtonet.com/api/GetAuthTokens \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### GET /api/GetTunnels

Source: https://localtonet.com/api/index

Retrieves a list of all tunnels currently managed by the user's account. This provides an overview of active and inactive tunnels.

```APIDOC
## GET /api/GetTunnels

### Description
Retrieves a list of all tunnels currently managed by the user's account. This provides an overview of active and inactive tunnels.

### Method
GET

### Endpoint
/api/GetTunnels

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTunnels \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of tunnel objects, each containing details about a tunnel.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": "tunnel_123",
      "name": "my-web-tunnel",
      "status": "active",
      "createdAt": "2023-10-27T12:00:00Z"
    }
  ]
}
```
```

--------------------------------

### Get Auth Token Detail (Shell Curl)

Source: https://localtonet.com/api/index

Retrieves detailed information for a specific authentication token. Requires the token ID as a path parameter and an Authorization header. Returns a JSON object with the token's status and associated data, or error details.

```Shell Curl
curl 'https://localtonet.com/api/GetAuthTokenDetail/{token}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### GET /api/GetAuthTokenDetail/{token}

Source: https://localtonet.com/api/index

Retrieves detailed information about a specific authentication token using its unique identifier. This allows for inspecting the properties of a single token.

```APIDOC
## GET /api/GetAuthTokenDetail/{token}

### Description
Retrieves detailed information about a specific authentication token using its unique identifier. This allows for inspecting the properties of a single token.

### Method
GET

### Endpoint
/api/GetAuthTokenDetail/{token}

### Parameters
#### Path Parameters
- **token** (string) - Required - The unique identifier of the authentication token.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetAuthTokenDetail/token_abc123 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (object) - An object containing the details of the authentication token.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": {
    "id": "token_abc123",
    "createdAt": "2023-10-27T10:00:00Z",
    "permissions": "all"
  }
}
```
```

--------------------------------

### Get Tunnel Request Logs by Tunnel Id

Source: https://localtonet.com/api/index

Retrieves the request logs for a specific tunnel using its unique ID.

```APIDOC
## GET /api/GetTunnelRequestLogs/{id}

### Description
Retrieves the request logs for a specific tunnel using its unique ID.

### Method
GET

### Endpoint
/api/GetTunnelRequestLogs/{id}

#### Path Parameters
- **id** (integer int64) - Required - Signed 64-bit integers (long type).

### Request Example
```
curl 'https://localtonet.com/api/GetTunnelRequestLogs/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (any) - The error code, if an error occurred.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of request log entries.
  - **dateTime** (string) - The date and time of the request.
  - **requestIp** (string) - The IP address of the request.
  - **clientIp** (string) - The IP address of the client.
  - **destination** (string) - The destination of the request.
  - **tokenName** (string) - The name of the token used.
  - **protocolType** (string) - The protocol type of the request.
  - **date** (string) - The date of the request.
  - **timeZone** (string) - The time zone of the request.

#### Response Example
```json
{
  "hasError": true,
  "errorCode": null,
  "errors": [
    "…"
  ],
  "result": [
    {
      "dateTime": "2026-01-27T20:10:23.798Z",
      "requestIp": null,
      "clientIp": null,
      "destination": null,
      "tokenName": null,
      "protocolType": null,
      "date": null,
      "timeZone": null
    }
  ]
}
```
```

--------------------------------

### GET /api/GetTunnelsByAuthToken/{authtoken}

Source: https://localtonet.com/api/index

Retrieves a list of tunnels associated with a specific authentication token. This helps in filtering tunnels based on the token used to create them.

```APIDOC
## GET /api/GetTunnelsByAuthToken/{authtoken}

### Description
Retrieves a list of tunnels associated with a specific authentication token. This helps in filtering tunnels based on the token used to create them.

### Method
GET

### Endpoint
/api/GetTunnelsByAuthToken/{authtoken}

### Parameters
#### Path Parameters
- **authtoken** (string) - Required - The authentication token to filter tunnels by.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTunnelsByAuthToken/token_abc123 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of tunnel objects associated with the provided authentication token.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": "tunnel_456",
      "name": "api-tunnel",
      "status": "active"
    }
  ]
}
```
```

--------------------------------

### Get Tunnels By Auth Token

Source: https://localtonet.com/api/index

Retrieves a list of tunnels associated with a specific authentication token. Requires an Authorization header with a Bearer token.

```APIDOC
## GET /api/GetTunnelsByAuthToken/{authtoken}

### Description
Retrieves a list of tunnels associated with a specific authentication token.

### Method
GET

### Endpoint
/api/GetTunnelsByAuthToken/{authtoken}

### Parameters
#### Path Parameters
- **authtoken** (string) - Required - The authentication token to filter tunnels by.

#### Query Parameters
None

#### Headers
- **Authorization** (string) - Required - Bearer token for authentication.

### Request Example
```
curl 'https://localtonet.com/api/GetTunnelsByAuthToken/{authtoken}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (any) - Error code, if any.
- **errors** (array) - List of error messages.
- **result** (array) - List of tunnel objects matching the provided auth token.
  - **id** (integer) - Unique identifier for the tunnel.
  - **guidId** (string) - Globally unique identifier for the tunnel.
  - **title** (string) - Optional title for the tunnel.
  - **teamId** (integer) - Identifier for the team the tunnel belongs to.
  - **authTokenName** (string) - Name of the authentication token.
  - **authToken** (string) - The authentication token.
  - **url** (string) - The public URL for the tunnel.
  - **isOnlyHttps** (boolean) - Whether the tunnel only supports HTTPS.
  - **serverId** (string) - Identifier for the server hosting the tunnel.
  - **serverDomain** (string) - Domain name of the server.
  - **serverIp** (string) - IP address of the server.
  - **localServerIp** (string) - Local IP address of the server.
  - **serverPort** (integer) - Port number of the server.
  - **isReserved** (boolean) - Whether the tunnel is reserved.
  - **clientIp** (string) - IP address of the client connecting to the tunnel.
  - **clientPort** (integer) - Port number of the client.
  - **protocolType** (string) - Type of protocol used by the tunnel.
  - **status** (string) - Status of the tunnel (e.g., "0 = Passive").
  - **enableBasicAuthentication** (boolean) - Whether basic authentication is enabled.
  - **authenticationUsername** (string) - Username for basic authentication.
  - **authenticationPassword** (string) - Password for basic authentication.
  - **createDate** (string) - Date and time the tunnel was created.
  - **useStartedTime** (string) - Time when the tunnel was started.
  - **updatedDate** (string) - Date and time the tunnel was last updated.
  - **path** (string) - Path for the tunnel URL.
  - **hostHeader** (string) - Host header for the tunnel.
  - **bandwidthLimit** (integer) - Bandwidth limit for the tunnel.
  - **bandwidthUsage** (integer) - Current bandwidth usage for the tunnel.
  - **isSslStream** (boolean) - Whether SSL streaming is enabled.
  - **rewriteHttpPath** (string) - Path to rewrite HTTP requests.
  - **externalUserId** (string) - Identifier for an external user.
  - **isWifiSplitOn** (boolean) - Whether Wi-Fi split is enabled.
  - **isAllowIpRestriction** (boolean) - Whether IP restrictions are allowed.
  - **ipRestrictions** (array) - List of IP restrictions.
    - **id** (integer) - Unique identifier for the IP restriction.
    - **tunnelId** (integer) - Identifier of the tunnel the restriction applies to.
    - **ipAddress** (string) - The allowed or blocked IP address.
    - **isAllow** (boolean) - Whether the IP address is allowed.
  - **connectionStatus** (boolean) - Current connection status of the tunnel.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "id": 1,
      "guidId": "123e4567-e89b-12d3-a456-426614174000",
      "title": null,
      "teamId": null,
      "authTokenName": null,
      "authToken": null,
      "url": null,
      "isOnlyHttps": true,
      "serverId": null,
      "serverDomain": null,
      "serverIp": null,
      "localServerIp": null,
      "serverPort": null,
      "isReserved": true,
      "clientIp": null,
      "clientPort": 1,
      "protocolType": null,
      "status": "0 = Passive",
      "enableBasicAuthentication": true,
      "authenticationUsername": null,
      "authenticationPassword": null,
      "createDate": null,
      "useStartedTime": null,
      "updatedDate": null,
      "path": null,
      "hostHeader": null,
      "bandwidthLimit": 1,
      "bandwidthUsage": 1,
      "isSslStream": true,
      "rewriteHttpPath": null,
      "externalUserId": null,
      "isWifiSplitOn": true,
      "isAllowIpRestriction": true,
      "ipRestrictions": [
        {
          "id": 1,
          "tunnelId": 1,
          "ipAddress": null,
          "isAllow": true
        }
      ],
      "connectionStatus": true
    }
  ]
}
```
```

--------------------------------

### Get All Tunnels using cURL

Source: https://localtonet.com/api/index

Retrieves a list of all active tunnels associated with your account. Requires an authorization token for authentication. The response includes detailed information about each tunnel.

```shell
curl https://localtonet.com/api/GetTunnels \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### Get Token Groups (Shell Curl)

Source: https://localtonet.com/api/index

Retrieves a list of all token groups. Requires an 'Authorization' header with a Bearer token. The response includes a list of token groups, each with an ID, group name, and token count.

```Shell
curl https://localtonet.com/api/GetTokenGroups \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### GET /api/GetTunnelRequestLogs/{id}

Source: https://localtonet.com/api/index

Retrieves the request logs for a specific tunnel identified by its unique ID. This is useful for debugging and monitoring tunnel activity.

```APIDOC
## GET /api/GetTunnelRequestLogs/{id}

### Description
Retrieves the request logs for a specific tunnel identified by its unique ID. This is useful for debugging and monitoring tunnel activity.

### Method
GET

### Endpoint
/api/GetTunnelRequestLogs/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tunnel.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTunnelRequestLogs/tunnel_123 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (array) - A list of log entries for the tunnel.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": [
    {
      "timestamp": "2023-10-27T12:05:00Z",
      "method": "GET",
      "path": "/",
      "remoteAddress": "192.168.1.100"
    }
  ]
}
```
```

--------------------------------

### GET /api/GetTokenGroupById/{id}

Source: https://localtonet.com/api/index

Retrieves detailed information about a specific token group using its unique identifier. This includes the group's name and associated tokens.

```APIDOC
## GET /api/GetTokenGroupById/{id}

### Description
Retrieves detailed information about a specific token group using its unique identifier. This includes the group's name and associated tokens.

### Method
GET

### Endpoint
/api/GetTokenGroupById/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the token group.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTokenGroupById/group_abc \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (object) - An object containing the details of the token group, including its ID, name, and a list of associated token IDs.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": {
    "id": "group_abc",
    "name": "production-tokens",
    "tokenIds": ["token_abc123", "token_xyz789"]
  }
}
```
```

--------------------------------

### GET /api/GetTunnelDetail/{id}

Source: https://localtonet.com/api/index

Retrieves detailed information about a specific tunnel using its unique identifier. This endpoint provides comprehensive details about a single tunnel's configuration and status.

```APIDOC
## GET /api/GetTunnelDetail/{id}

### Description
Retrieves detailed information about a specific tunnel using its unique identifier. This endpoint provides comprehensive details about a single tunnel's configuration and status.

### Method
GET

### Endpoint
/api/GetTunnelDetail/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the tunnel.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl https://localtonet.com/api/GetTunnelDetail/tunnel_123 \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred.
- **errorCode** (string) - The error code, if any.
- **errors** (array) - A list of error messages.
- **result** (object) - An object containing the detailed information of the tunnel.

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": {
    "id": "tunnel_123",
    "name": "my-web-tunnel",
    "status": "active",
    "createdAt": "2023-10-27T12:00:00Z",
    "localUrl": "http://localhost:8080",
    "publicUrl": "https://my-web-tunnel.localtonet.com"
  }
}
```
```

--------------------------------

### Get Tunnels by Auth Token using cURL

Source: https://localtonet.com/api/index

Retrieves tunnels associated with a specific authentication token. This endpoint is useful for filtering tunnels based on a provided auth token. An authorization header is also required.

```shell
curl 'https://localtonet.com/api/GetTunnelsByAuthToken/{authtoken}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

--------------------------------

### Get Token Group By Id API

Source: https://localtonet.com/api/index

Retrieves a specific token group by its ID. This endpoint allows you to fetch detailed information about a single token group, including the tokens it contains.

```APIDOC
## GET /api/GetTokenGroupById/{id}

### Description
Retrieves a specific token group by its unique identifier. Returns the group details and the tokens associated with it.

### Method
GET

### Endpoint
/api/GetTokenGroupById/_{id}_

### Parameters
#### Path Parameters
- **id** (integer) - Required - The unique identifier of the token group to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl 'https://localtonet.com/api/GetTokenGroupById/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```

### Response
#### Success Response (200)
- **hasError** (boolean) - Indicates if an error occurred during the request.
- **errorCode** (any) - Error code, if any.
- **errors** (array) - A list of error messages, if any.
- **result** (object) - The token group object, containing:
  - **id** (integer) - The unique identifier for the token group.
  - **groupName** (string) - The name of the token group (can be null).
  - **tokens** (array) - A list of token objects within the group, each containing:
    - **id** (integer) - The unique identifier for the token.
    - **name** (string) - The name of the token (can be null).
    - **token** (string) - The actual token value (can be null).

#### Response Example
```json
{
  "hasError": false,
  "errorCode": null,
  "errors": [],
  "result": {
    "id": 1,
    "groupName": "API Keys",
    "tokens": [
      {
        "id": 101,
        "name": "Key Alpha",
        "token": "abc123xyz"
      }
    ]
  }
}
```
```

--------------------------------

### Get Token Group By Id (Shell Curl)

Source: https://localtonet.com/api/index

Retrieves a specific token group by its ID. Requires an 'Authorization' header with a Bearer token and the group ID as a path parameter. The response contains details of the specified group, including its tokens.

```Shell
curl 'https://localtonet.com/api/GetTokenGroupById/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
```
Tokens:
Raw