Sign in
Ports

Change port plan

Changes the billing plan assigned to a port.

post/ports/{id}/plan

Headers

Idempotency-Keystring uuid

Optional UUID that identifies one mutation request. Reuse it only when retrying the same request.

Request body

planstring

Plan ID

Example request

{
  "plan": "5349b4ddd2781d08c09890f3",
  "tarification": {
    "time": 2592000,
    "traffic": 51200,
    "price": 14500
  }
}

Response

Successful operation

portstring

Port number

ipstring

Port current IP address (0.0.0.0 if not available)

status'active' | 'reset' | 'suspended' | 'disconnected' | 'outoftraffic'

Port status

resetTokenstring

Port reset token

signaturestring

Port signature

vpnAccessboolean

Indicates whether port has access to the VPN server

autoResetIntervalinteger

Port auto reset interval in seconds, 0 means disabled

tagsstring[]

Port tags

Example response

{
  "ip": "1.1.1.1",
  "geoip": {
    "continentCode": "NA",
    "continentName": "North America",
    "countryCode2": "US",
    "countryCode3": "United States",
    "latitude": "38.89037",
    "longitude": "-77.03196",
    "isp": "T-Mobile USA, Inc."
  },
  "status": "active",
  "resetToken": "6015510d206e4d7b023e5f978a56e3cf49d7e79bc26cf28c69b75314e098a61b",
  "signature": "Windows",
  "vpnAccess": true,
  "plan": {
    "id": "5349b4ddd2781d08c09890f3",
    "name": "UK Three",
    "countryCode": "UK",
    "enabled": true,
    "autoRenew": true,
    "activatedAt": "2022-04-02T05:57:29.054Z",
    "expiresAt": "2022-05-02T05:57:29.054Z",
    "trafficRemains": 51200,
    "tarification": {
      "time": 2592000,
      "traffic": 51200,
      "price": 14500
    }
  },
  "credentials": {
    "ip": [
      "2.2.2.2"
    ],
    "password": [
      {
        "login": "login",
        "password": "password"
      }
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.