Rotating sessions

10 endpoints · base URL https://papaproxy.net/account_new · authentication

GETGet rotating gateway settings
GETList sticky sessions
POSTRotate a sticky session
DELETEEnd a sticky session
POSTEnd all sticky sessions
GETGet session mode
PUTSet session mode
GETGet sticky session duration
PUTSet sticky session duration
DELETEReset sticky session duration

Get rotating gateway settings

GET/api/v1/customer/services/{service_id}/proxy/config

API key required scope services:read

Gateway hostnames and ports (HTTP, HTTPS, SOCKS5) of a rotating proxy service.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request example Try it in the Dashboard

cURL

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/config" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/config",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/config", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/config');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/config", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Connection settings of a rotating proxy service. · 13 fields

Example response · JSON

{
  "endpoint": "papaproxy.pro",
  "endpoints": [
    "papaproxy.pro"
  ],
  "https_endpoints": [
    "eu01.gateway.example.com",
    "us01.gateway.example.com"
  ],
  "port": 3081,
  "http_ports": [
    3081,
    3082,
    3083,
    3084,
    3085,
    3086,
    3087,
    3088,
    3089,
    3090,
    3091,
    3092,
    3093,
    3094
  ],
  "socks_ports": [
    2081,
    2082,
    2083,
    2084,
    2085,
    2086,
    2087,
    2088,
    2089,
    2090,
    2091,
    2092,
    2093,
    2094
  ],
  "sticky_http": 5080,
  "sticky_socks5": 4080,
  "sticky_https": 4443,
  "session_format": "ip:port:username:password",
  "mode": "sticky",
  "sample_connection_string": "papaproxy.pro:3081:pp_user_3fa85f64:Xk9mQ2vL7pRt",
  "sample_connection_strings": [
    "papaproxy.pro:3081:pp_user_3fa85f64:Xk9mQ2vL7pRt"
  ]
}

Field	Type	Description
`endpoint` required	string
`endpoints`	array of string
`https_endpoints`	array of string
`port` required	integer
`http_ports`	array of integer	HTTP ports.
`socks_ports`	array of integer	SOCKS5 ports.
`sticky_http`	integer, nullable
`sticky_socks5`	integer, nullable
`sticky_https`	integer, nullable
`session_format`	string	Default: `"ip:port:username:password"`
`mode`	string	Default: `"rotating"`
`sample_connection_string`	string, nullable
`sample_connection_strings`	array of string

401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:read.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:read"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

List sticky sessions

GET/api/v1/customer/services/{service_id}/proxy/sticky/sessions

API key required scope services:read

List sticky sessions for a rotating proxy service.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request example Try it in the Dashboard

cURL

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Active sticky sessions for a rotating service. · 14 fields

Example response · JSON

{
  "service_id": "3bd2e419-2dc6-52bb-9d74-0a4560d55f53",
  "username": "pp_user_3fa85f64",
  "sessions": []
}

Field	Type	Description
`service_id` required	string (uuid)	ID of the service.
`username` required	string	Proxy username.
`sessions` required	array of object
`sessions[].sid` required	string	Sticky session ID.
`sessions[].session_id` required	string
`sessions[].server` required	string
`sessions[].exit` required	string	Exit IP of the session.
`sessions[].exit_addr` required	string	Exit IP and port of the session.
`sessions[].is_default`	boolean	Default: `false`
`sessions[].created`	string, nullable
`sessions[].last_used`	string, nullable
`sessions[].ttl_seconds`	integer, nullable	Sticky session duration, in seconds.
`sessions[].expires_at`	string, nullable	When the current term ends (ISO 8601, UTC).
`sessions[].mode`	string, nullable

401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:read.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:read"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Rotate a sticky session

POST/api/v1/customer/services/{service_id}/proxy/sticky/sessions/{sid}/rotate

API key required scope services:write

Force a new exit IP for one sticky session. Free; this is not an IP list refresh.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.
`sid (path)` required	string	ID of the sticky session.

Request example Try it in the Dashboard

cURL

curl -X POST "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string/rotate" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.post(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string/rotate",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string/rotate", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string/rotate');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("POST", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string/rotate", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Result of moving one sticky session to a new exit IP. · 4 fields
Field Type Description
sid required string Sticky session ID.
exit required string Exit IP of the session.
exit_addr required string Exit IP and port of the session.
status string Default: "rotated"
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:write.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:write"
}
```
Error format
404 Sticky session not found, or it doesn't belong to your account. — error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Field	Type	Description
`sid` required	string	Sticky session ID.
`exit` required	string	Exit IP of the session.
`exit_addr` required	string	Exit IP and port of the session.
`status`	string	Default: `"rotated"`

End a sticky session

DELETE/api/v1/customer/services/{service_id}/proxy/sticky/sessions/{sid}

API key required scope services:write

End one sticky session; its next request gets a new exit IP.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.
`sid (path)` required	string	ID of the sticky session.

Request example Try it in the Dashboard

cURL

curl -X DELETE "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.delete(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("DELETE", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/sessions/string", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

204 The session ended. No response body.
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:write.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:write"
}
```
Error format
404 Sticky session not found, or it doesn't belong to your account. — error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

End all sticky sessions

POST/api/v1/customer/services/{service_id}/proxy/sticky/purge

API key required scope services:write

End all sticky sessions of a rotating service.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request example Try it in the Dashboard

cURL

curl -X POST "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/purge" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.post(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/purge",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/purge", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/purge');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("POST", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/purge", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Result of ending all sticky sessions. · 1 fields
Example response · JSON
```
{
  "deleted": 0
}
```
Field Type Description
deleted required integer
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:write.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:write"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Field	Type	Description
`deleted` required	integer

Get session mode

GET/api/v1/customer/services/{service_id}/proxy/sticky/mode

API key required scope services:read

Current session mode of a rotating service: rotating (new exit IP per request), sticky, or pinned.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request example Try it in the Dashboard

cURL

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Session mode: rotating, sticky, or pinned. · 2 fields
Example response · JSON
```
{
  "mode": "sticky"
}
```
Field Type Description
mode required string
pin string, nullable
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:read.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:read"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Field	Type	Description
`mode` required	string
`pin`	string, nullable

Set session mode

PUT/api/v1/customer/services/{service_id}/proxy/sticky/mode

API key required scope services:write

Switch between rotating, sticky, and pinned modes. pin is required for pinned. If your rotating service doesn't support switching the mode, the response is 501; use the sticky session duration endpoints instead.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request body

Field	Type	Description
`mode` required	string	sticky \| rotating \| pinnedOne of: `sticky`, `rotating`, `pinned`
`pin`	string, nullable	Exit IP:port to keep when `mode` is `pinned`.

Request example Try it in the Dashboard

cURL

curl -X PUT "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mode": "sticky"}'

Python

import os

import requests

resp = requests.put(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    json={
        "mode": "sticky"
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "mode": "sticky"
  }),
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'mode' => 'sticky'
    ]),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	req, err := http.NewRequest("PUT", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/mode", strings.NewReader(`{"mode": "sticky"}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Session mode: rotating, sticky, or pinned. · 2 fields
Example response · JSON
```
{
  "mode": "sticky"
}
```
Field Type Description
mode required string
pin string, nullable
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:write.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:write"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format
501 Switching the session mode isn't supported for this service.
Example · JSON
```
{
  "detail": "Sticky mode is not supported by the configured upstream."
}
```
Error format

Field	Type	Description
`mode` required	string
`pin`	string, nullable

Get sticky session duration

GET/api/v1/customer/services/{service_id}/proxy/sticky/ttl

API key required scope services:read

How long a sticky session keeps the same exit IP, in seconds.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request example Try it in the Dashboard

cURL

curl -X GET "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.get(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("GET", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Sticky session duration, in seconds. · 4 fields
Example response · JSON
```
{
  "ttl_seconds": 900,
  "is_custom": false,
  "global_default_ttl": 900,
  "ttl_human": "15m"
}
```
Field Type Description
ttl_seconds integer, nullable Sticky session duration, in seconds.
is_custom boolean Default: false
global_default_ttl integer, nullable
ttl_human string, nullable
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:read.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:read"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Field	Type	Description
`ttl_seconds`	integer, nullable	Sticky session duration, in seconds.
`is_custom`	boolean	Default: `false`
`global_default_ttl`	integer, nullable
`ttl_human`	string, nullable

Set sticky session duration

PUT/api/v1/customer/services/{service_id}/proxy/sticky/ttl

API key required scope services:write

Set how long a sticky session keeps the same exit IP, in seconds (minimum 30).

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request body

Field	Type	Description
`seconds` required	integer	TTL override in seconds (minimum 30)Minimum: 30

Request example Try it in the Dashboard

cURL

curl -X PUT "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"seconds": 600}'

Python

import os

import requests

resp = requests.put(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    json={
        "seconds": 600
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl", {
  method: "PUT",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "seconds": 600
  }),
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'PUT',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode([
        'seconds' => 600
    ]),
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
	"strings"
)

func main() {
	req, err := http.NewRequest("PUT", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl", strings.NewReader(`{"seconds": 600}`))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Sticky session duration, in seconds. · 4 fields
Example response · JSON
```
{
  "ttl_seconds": 600,
  "is_custom": true,
  "global_default_ttl": 900,
  "ttl_human": "10m"
}
```
Field Type Description
ttl_seconds integer, nullable Sticky session duration, in seconds.
is_custom boolean Default: false
global_default_ttl integer, nullable
ttl_human string, nullable
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:write.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:write"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Field	Type	Description
`ttl_seconds`	integer, nullable	Sticky session duration, in seconds.
`is_custom`	boolean	Default: `false`
`global_default_ttl`	integer, nullable
`ttl_human`	string, nullable

Reset sticky session duration

DELETE/api/v1/customer/services/{service_id}/proxy/sticky/ttl

API key required scope services:write

Return the sticky session duration to the default.

Parameters

Field	Type	Description
`service_id (path)` required	string (uuid)	ID of the service.

Request example Try it in the Dashboard

cURL

curl -X DELETE "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl" \
  -H "Authorization: Bearer $PAPAPROXY_API_KEY"

Python

import os

import requests

resp = requests.delete(
    "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl",
    headers={"Authorization": f"Bearer {os.environ['PAPAPROXY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Node.js

const resp = await fetch("https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.PAPAPROXY_API_KEY}`,
  },
});
if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
console.log(await resp.json());

PHP

<?php
$ch = curl_init('https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('PAPAPROXY_API_KEY'),
    ],
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
var_dump($status, json_decode($response, true));

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest("DELETE", "https://papaproxy.net/account_new/api/v1/customer/services/3fa85f64-5717-4562-b3fc-2c963f66afa6/proxy/sticky/ttl", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("PAPAPROXY_API_KEY"))
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
	data, _ := io.ReadAll(resp.Body)
	fmt.Println(resp.Status, string(data))
}

Responses

200 Sticky session duration, in seconds. · 4 fields
Example response · JSON
```
{
  "ttl_seconds": 900,
  "is_custom": false,
  "global_default_ttl": 900,
  "ttl_human": "15m"
}
```
Field Type Description
ttl_seconds integer, nullable Sticky session duration, in seconds.
is_custom boolean Default: false
global_default_ttl integer, nullable
ttl_human string, nullable
401 The API key is missing, malformed, revoked, or expired, or the account is inactive.
Example · JSON
```
{
  "detail": "Invalid or revoked API key."
}
```
Error format
403 The API key lacks scope services:write.
Example · JSON
```
{
  "detail": "API key is missing required scope: services:write"
}
```
Error format
404 Service not found, or it doesn't belong to your account.
Example · JSON
```
{
  "detail": "Service 3fa85f64-5717-4562-b3fc-2c963f66afa6 not found."
}
```
Error format
422 Validation error: a field is missing or has the wrong type or value.
Example · JSON
```
{
  "detail": "Validation error"
}
```
Error format
429 Too many requests: the per-account limit is 60 requests per minute, shared by all keys and the MCP server. Retry with exponential backoff.
Example · JSON
```
{
  "detail": "Too Many Requests"
}
```
Error format

Field	Type	Description
`ttl_seconds`	integer, nullable	Sticky session duration, in seconds.
`is_custom`	boolean	Default: `false`
`global_default_ttl`	integer, nullable
`ttl_human`	string, nullable

Last updated: November 9, 2026. Generated from the OpenAPI 3.1 specification (API version 0.1.0). Markdown version for AI agents.