API Documentation
API: Bridging Your Software To Ours
Menu
Info & Keys Account Info Servers List Place New Order Order Info Edit Order Other Actions

Info & Keys

Note: Please read the API intructions carefully. Its your solo responsability what you add by our API.

This API allows external services to interact with the panel by sending POST requests. All requests require proper authentication and follow structured request and response formats.

Authentication

All requests must include an api_key parameter in the request body for authentication. Requests without a valid API key will be rejected.

HTTP Method POST
Response format JSON
API URL https://vpnpanels.com/api/v2
API Key Your API Key
Download PHP example code Request panel

Account Info

Description: Retrieves user-related information, including server usage and balance details.
Parameter Description
key Your API Key
action info
Example Response
{
  "infos": [
  {
  "server_id": "365",
  "count": "10"
  },
  {
  "server_id": "965",
  "count": "3"
  }
  ],
  "balance": "175.0000",
  "availableBalance": 99.375
}

Servers List

Description: Retrieves the list of available servers and their package details.
Parameter Description
key Your API Key
action getservices
Example Response
[
  {
    "id": "68",
    "name": "V2Ray IR Exclusive - Data Plan - Monthly [Recommended]",
    "type": "v2ray",
    "price_per": "ONETIME",
    "min": 0,
    "max": 0,
    "packages": [
      {
        "ids": "6ffbc9ae-ed82-4aea-bf17-bf6eb8d51c76",
        "month": "1",
        "gig": "30",
        "price": 0.7
      }
    ]
  },
  {
    "id": "58",
    "name": "V2Ray IR Exclusive - Data Plan - No Expiration Date",
    "type": "v2ray",
    "price": 0.024,
    "price_per": "GIG",
    "min": 0,
    "max": 0,
    "packages": [
      {
        "ids": "6ffbc9ae-ed82-4aea-bf17-bf6eb8d51c76",
        "month": "",
        "gig": "10",
        "price": 0.24
      }
    ]
  },
  {
    "id": "66",
    "name": "OpenVPN - Germany - IR Exclusive",
    "type": "openvpn",
    "price": 0.07,
    "price_per": "DAY",
    "min": 0,
    "max": 0,
    "packages": [
      {
        "ids": "6ffbc9ae-ed82-4aea-bf17-bf6eb8d51c76",
        "month": "1",
        "gig": "0",
        "price": 2.1
      }
    ]
  }
]

Place New Order

Parameter Description
key Your API key
action add
server Server ID
credits service credits needed
day_credits service days needed
selectedPackage in case of select a package, selected package ids
Example Response
{
  "status":"success",
  "order":69,
  "server_response":
    {
      "username":"U5165",
      "password":"20459458"
    },
  "message":"Added successfully",
  "redirect":"Redirect URL"
}

Order Info

Parameter Description
key Your API key
action status
id Server Order ID
Example Response
{
  "order_id": "203929",
  "server_username": "441976c59bba207281e0d8891d48d867",
  "server_password": null,
  "subscriptionLink": "https://subs1001.apolloxi.art/un.php?token=ND_p0CVaY&remark=203929",
  "server_first_login": null,
  "server_type": "v2ray",
  "order_status": "standby",
  "order_credits": "30.000000000000000",
  "order_day_credits": "30.000000000000000",
  "order_used_credits": "0.000000000000000",
  "order_used_day_credits": "0.000000000000000",
  "order_charge": "0.700000000000000",
  "order_updated": "2025-02-18 11:22:46",
  "order_submited": "2025-02-18 11:18:23"
}

Edit Order

Parameter Description
key Your API key
action edit
id Server Order ID
remain_credits Order Remain Credits, required if no package selected.
selectedPackage package ids in case of select a package, required for ONETIME type services.
changePackage boolval: send TRUE if you want to change the base package.
Example Response
{
  "status":"success",
  "message":"Updated successfully"
}

Other Actions

Parameter Description
key Your API key
action active, deactive, suspend, revoke, firstlogin, refreshStatus
id Server Order ID
Example Response
{
  "status":"success",
  "message":"Updated successfully",
  "firstlogin": Relative timestamp
}