Potato Apiv2

https://www.npmjs.com/package/potato-apiv2
Admin
A JavaScript library for interacting with the Potato API v2 backend to manage SSH, VMESS, VLESS, and...
Tokens:5,379
Snippets:61
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installation and Usage

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Instructions on how to install the potato-apiv2 package and basic usage examples.

```APIDOC
## Installation
```
npm install potato-apiv2 --save
```

## Usage
```javascript
require('potato-apiv2')
```

## Configuration
```json
{
    "server": "address/domain",
    "api_key": "api key from script v2"
}
```
```

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

### Configure potato-apiv2 Server and API Key

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=code

Provides an example JSON structure for configuring the potato-apiv2 package. It specifies the 'server' address and 'api_key' required for authentication and communication with the backend service.

```json
{
    server: 'address/domain',
    api_key: 'api key from script v2'
}
```

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

### Install potato-apiv2 npm package

Source: https://www.npmjs.com/package/potato-apiv2/index

Installs the potato-apiv2 npm package using npm and saves it as a dependency. This is the first step to using the package in your project.

```bash
npm install potato-apiv2 --save
```

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

### Create Endpoints

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Details on how to create SSH, VMess, VLESS, and Trojan configurations.

```APIDOC
## POST /api/create/ssh

### Description
Creates an SSH configuration with specified parameters.

### Method
POST

### Endpoint
/api/create/ssh

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username for the SSH connection.
- **password** (string) - Required - The password for the SSH connection.
- **limitip** (number) - Required - The IP limit for the connection.
- **expired** (number) - Required - The expiration time for the connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "string",
  "password": "string",
  "limitip": 10,
  "expired": 1678886400
}
```

### Response
#### Success Response (200)
Details of the created SSH configuration (structure not specified in source).

## POST /api/create/vmess

### Description
Creates a VMess configuration.

### Method
POST

### Endpoint
/api/create/vmess

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username for the VMess connection.
- **kuota** (number) - Required - The quota for the VMess connection.
- **limitip** (number) - Required - The IP limit for the connection.
- **expired** (number) - Required - The expiration time for the connection.
- **uuidv2** (string) - Optional - A custom UUID for the VMess connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "string",
  "kuota": 1024,
  "limitip": 5,
  "expired": 1678886400,
  "uuidv2": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (200)
Details of the created VMess configuration (structure not specified in source).

## POST /api/create/vless

### Description
Creates a VLESS configuration.

### Method
POST

### Endpoint
/api/create/vless

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username for the VLESS connection.
- **kuota** (number) - Required - The quota for the VLESS connection.
- **limitip** (number) - Required - The IP limit for the connection.
- **expired** (number) - Required - The expiration time for the connection.
- **uuidv2** (string) - Optional - A custom UUID for the VLESS connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "string",
  "kuota": 1024,
  "limitip": 5,
  "expired": 1678886400,
  "uuidv2": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (200)
Details of the created VLESS configuration (structure not specified in source).

## POST /api/create/trojan

### Description
Creates a Trojan configuration.

### Method
POST

### Endpoint
/api/create/trojan

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username for the Trojan connection.
- **kuota** (number) - Required - The quota for the Trojan connection.
- **limitip** (number) - Required - The IP limit for the connection.
- **expired** (number) - Required - The expiration time for the connection.
- **uuidv2** (string) - Optional - A custom UUID for the Trojan connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "string",
  "kuota": 1024,
  "limitip": 5,
  "expired": 1678886400,
  "uuidv2": "a1b2c3d4-e5f6-7890-1234-567890abcdef"
}
```

### Response
#### Success Response (200)
Details of the created Trojan configuration (structure not specified in source).
```

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

### Trial Endpoints

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Endpoints for obtaining trial configurations for SSH, VMess, VLESS, and Trojan.

```APIDOC
## POST /api/trial/ssh

### Description
Obtains a trial SSH configuration.

### Method
POST

### Endpoint
/api/trial/ssh

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **timelimit** (string) - Required - The duration for the trial (e.g., '10m', '1h').

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "timelimit": "30m"
}
```

### Response
#### Success Response (200)
Details of the trial SSH configuration (structure not specified in source).

## POST /api/trial/vmess

### Description
Obtains a trial VMess configuration.

### Method
POST

### Endpoint
/api/trial/vmess

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **timelimit** (string) - Required - The duration for the trial (e.g., '10m', '1h').

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "timelimit": "1h"
}
```

### Response
#### Success Response (200)
Details of the trial VMess configuration (structure not specified in source).

## POST /api/trial/vless

### Description
Obtains a trial VLESS configuration.

### Method
POST

### Endpoint
/api/trial/vless

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **timelimit** (string) - Required - The duration for the trial (e.g., '10m', '1h').

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "timelimit": "2h"
}
```

### Response
#### Success Response (200)
Details of the trial VLESS configuration (structure not specified in source).

## POST /api/trial/trojan

### Description
Obtains a trial Trojan configuration.

### Method
POST

### Endpoint
/api/trial/trojan

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **timelimit** (string) - Required - The duration for the trial (e.g., '10m', '1h').

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "timelimit": "30m"
}
```

### Response
#### Success Response (200)
Details of the trial Trojan configuration (structure not specified in source).
```

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

### Request a trial connection with potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index

Requests a trial connection for SSH, VMESS, VLESS, or Trojan using the `TrialSsh`, `TrialVmess`, `TrialVless`, or `TrialTrojan` functions. Requires server, API key, and a time limit (e.g., '10m', '1h').

```javascript
const { TrialSsh, TrialVmess, TrialVless, TrialTrojan } = require('potato-apiv2')

// timelimit example
// 10m = 10 minutes
// 1h = 1 hours

{
  server: 'address/domain', // required
  api_key: 'api key from script v2', // required
  timelimit: 'string' // required
  // timelimit: '30m'
}
```

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

### Obtain trial accounts with potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=versions

Requests trial accounts for SSH, VMess, Vless, or Trojan using Trial functions. Requires server, api_key, and timelimit (e.g., '10m', '1h'). The output is a JSON object containing trial account details.

```javascript
const { TrialSsh, TrialVmess, TrialVless, TrialTrojan } = require('potato-apiv2')

// timelimit example
// 10m = 10 minutes
// 1h = 1 hours

{
  server: 'address/domain', // required
  api_key: 'api_key from script v2',
  timelimit: 'string' // required
  // timelimit: '30m'
}
```

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

### Contact Endpoint

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Information on how to contact support.

```APIDOC
## Contact

### Description
Information regarding contact methods for support.

### Contact Method
Telegram
```

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

### Create VMESS, VLESS, or Trojan configurations

Source: https://www.npmjs.com/package/potato-apiv2/index

Defines the parameters required to create configurations for VMESS, VLESS, or Trojan protocols using the potato-apiv2 package. Requires server, API key, username, quota, IP limit, expiration, and an optional custom UUID.

```javascript
const { CreateVmess, CreateVless, CreateTrojan } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api key from script v2', // required
  username: 'string', // required
  kuota: 'number', // required
  limitip: 'number', // required
  expired: 'number', // required
  uuidv2: 'string' // non required. for custom uuid
}
```

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

### Configure potato-apiv2 with server and API key

Source: https://www.npmjs.com/package/potato-apiv2/index

Provides a JSON object structure for configuring the potato-apiv2 client. It requires the server address/domain and a valid API key obtained from script v2.

```json
{
    "server": "address/domain",
    "api_key": "api key from script v2"
}
```

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

### Bandwidth Endpoint

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Endpoint for retrieving bandwidth information.

```APIDOC
## GET /api/bandwidth

### Description
Retrieves bandwidth information for the account.

### Method
GET

### Endpoint
/api/bandwidth

### Parameters
#### Query Parameters
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2"
}
```

### Response
#### Success Response (200)
Bandwidth usage details (structure not specified in source).
```

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

### List of potato-apiv2 module exports

Source: https://www.npmjs.com/package/potato-apiv2/index

Lists the available functions exported by the potato-apiv2 module, categorized by their functionality: Create, Trial, Renew, and Delete for different protocols, plus Bandwidth and Contact.

```javascript
{
    CreateSsh,
    CreateVmess,
    CreateVless,
    CreateTrojan,
    TrialSsh,
    TrialVmess,
    TrialVless,
    TrialTrojan,
    RenewSsh,
    RenewVmess,
    RenewVless,
    RenewTrojan,
    DeleteSsh,
    DeleteVmess,
    DeleteVless,
    DeleteTrojan
}
```

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

### Check bandwidth usage with potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index

Retrieves bandwidth usage information using the `Bandwidth` function. Requires the server address/domain and the API key.

```javascript
const { Bandwidth } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api key from script v2' // required
}
```

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

### Renew Endpoints

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Endpoints for renewing existing configurations for SSH, VMess, VLESS, and Trojan.

```APIDOC
## POST /api/renew/ssh

### Description
Renews an existing SSH configuration.

### Method
POST

### Endpoint
/api/renew/ssh

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the SSH connection to renew.
- **expired** (number) - Required - The new expiration timestamp.
- **kuota** (number) - Optional - The new quota to set for the connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123",
  "expired": 1700000000,
  "kuota": 2048
}
```

### Response
#### Success Response (200)
Details of the renewed SSH configuration (structure not specified in source).

## POST /api/renew/vmess

### Description
Renews an existing VMess configuration.

### Method
POST

### Endpoint
/api/renew/vmess

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the VMess connection to renew.
- **expired** (number) - Required - The new expiration timestamp.
- **kuota** (number) - Optional - The new quota to set for the connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123",
  "expired": 1700000000,
  "kuota": 2048
}
```

### Response
#### Success Response (200)
Details of the renewed VMess configuration (structure not specified in source).

## POST /api/renew/vless

### Description
Renews an existing VLESS configuration.

### Method
POST

### Endpoint
/api/renew/vless

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the VLESS connection to renew.
- **expired** (number) - Required - The new expiration timestamp.
- **kuota** (number) - Optional - The new quota to set for the connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123",
  "expired": 1700000000,
  "kuota": 2048
}
```

### Response
#### Success Response (200)
Details of the renewed VLESS configuration (structure not specified in source).

## POST /api/renew/trojan

### Description
Renews an existing Trojan configuration.

### Method
POST

### Endpoint
/api/renew/trojan

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the Trojan connection to renew.
- **expired** (number) - Required - The new expiration timestamp.
- **kuota** (number) - Optional - The new quota to set for the connection.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123",
  "expired": 1700000000,
  "kuota": 2048
}
```

### Response
#### Success Response (200)
Details of the renewed Trojan configuration (structure not specified in source).
```

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

### Delete Account using potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=code

This JavaScript snippet demonstrates how to delete an account (SSH, VMess, Vless, Trojan) using the potato-apiv2 package. It requires the server details, API key, and the username of the account to be deleted.

```javascript
const { DeleteSsh, DeleteVmess, DeleteVless, DeleteTrojan } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api_key from script v2',
  username: 'string' // required
}
```

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

### Create SSH connection using potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index

Creates an SSH connection using the `CreateSsh` function from the potato-apiv2 package. Requires server details, API key, username, password, IP limit, and expiration time. It includes error and success handling.

```javascript
const { CreateSsh } = require('potato-apiv2')

CreateSsh({
  server: 'address/domain', // required
  api_key: 'api key from script v2', // required
  username: 'string', // required
  password: 'string', // required
  limitip: 'number', // required
  expired: 'number' // required
}, (e, r) => {
  if (e) {
    // Handle error output JSON
    console.log(e)
  } else {
    // Handle success output JSON
    console.log(r)
  }
})
```

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

### Renew proxy accounts with potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=versions

Renews existing SSH, VMess, Vless, or Trojan accounts. Requires server, api_key, username, and expired (for extension). An optional kuota can be provided to extend the data limit.

```javascript
const { RenewSsh, RenewVmess, RenewVless, RenewTrojan } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api key from script v2',
  username: 'string', // required
  expired: 'number', // required (extend)
  kuota: 'number' // non required (extend)
}
```

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

### Delete Endpoints

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=dependents

Endpoints for deleting configurations for SSH, VMess, VLESS, and Trojan.

```APIDOC
## POST /api/delete/ssh

### Description
Deletes an SSH configuration.

### Method
POST

### Endpoint
/api/delete/ssh

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the SSH connection to delete.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123"
}
```

### Response
#### Success Response (200)
Confirmation of deletion (structure not specified in source).

## POST /api/delete/vmess

### Description
Deletes a VMess configuration.

### Method
POST

### Endpoint
/api/delete/vmess

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the VMess connection to delete.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123"
}
```

### Response
#### Success Response (200)
Confirmation of deletion (structure not specified in source).

## POST /api/delete/vless

### Description
Deletes a VLESS configuration.

### Method
POST

### Endpoint
/api/delete/vless

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the VLESS connection to delete.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123"
}
```

### Response
#### Success Response (200)
Confirmation of deletion (structure not specified in source).

## POST /api/delete/trojan

### Description
Deletes a Trojan configuration.

### Method
POST

### Endpoint
/api/delete/trojan

### Parameters
#### Request Body
- **server** (string) - Required - The server address or domain.
- **api_key** (string) - Required - The API key for authentication.
- **username** (string) - Required - The username of the Trojan connection to delete.

### Request Example
```json
{
  "server": "address/domain",
  "api_key": "api key from script v2",
  "username": "user123"
}
```

### Response
#### Success Response (200)
Confirmation of deletion (structure not specified in source).
```

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

### Delete SSH, VMESS, VLESS, or Trojan configurations

Source: https://www.npmjs.com/package/potato-apiv2/index

Deletes SSH, VMESS, VLESS, or Trojan configurations using the `DeleteSsh`, `DeleteVmess`, `DeleteVless`, or `DeleteTrojan` functions. Requires server, API key, and the username of the configuration to delete.

```javascript
const { DeleteSsh, DeleteVmess, DeleteVless, DeleteTrojan } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api key from script v2', // required
  username: 'string' // required
}
```

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

### Renew SSH, VMESS, VLESS, or Trojan configurations

Source: https://www.npmjs.com/package/potato-apiv2/index

Renews existing SSH, VMESS, VLESS, or Trojan configurations using the `RenewSsh`, `RenewVmess`, `RenewVless`, or `RenewTrojan` functions. Requires server, API key, username, and expiration time. Quota can also be extended.

```javascript
const { RenewSsh, RenewVmess, RenewVless, RenewTrojan } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api key from script v2', // required
  username: 'string', // required
  expired: 'number', // required (extend)
  kuota: 'number' // non required (extend)
}
```

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

### Delete proxy accounts with potato-apiv2

Source: https://www.npmjs.com/package/potato-apiv2/index_activetab=versions

Deletes SSH, VMess, Vless, or Trojan accounts. Requires server, api_key, and username of the account to be deleted. This action is irreversible.

```javascript
const { DeleteSsh, DeleteVmess, DeleteVless, DeleteTrojan } = require('potato-apiv2')

{
  server: 'address/domain', // required
  api_key: 'api key from script v2',
  username: 'string' // required
}
```

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

### Require potato-apiv2 module in Node.js

Source: https://www.npmjs.com/package/potato-apiv2/index

Demonstrates how to import the potato-apiv2 package into your Node.js project using the require function. This makes the package's functionalities available for use.

```javascript
require('potato-apiv2')
```
Tokens:
Raw