Retrieve a paginated list of all active sessions associated with your Geonode account.


List All Active Sessions

basicAuth

A list of active sessions retrieved successfully.

Unauthorized access due to invalid credentials.

Geonode

Obtain a list of available geo-locations for Geonode proxy services.


Retrieve Available Geo-locations

Overview

Release Sticky Sessions

Create a new sticky session using proxy credentials. Sticky sessions let you keep the same IP address longer, which is useful for tasks that need a stable connection, like managing social media accounts or web scraping. Knowing how to use sticky sessions can improve your proxy experience by making it more efficient and reliable.

# Sticky Ports:

Geonode provides specific ports for sticky sessions, ensuring a persistent IP session:

- **HTTP/HTTPS:** 10000 - 10900
- **SOCKS5:** 12000 - 12010

Use sticky ports when you need a stable IP for session-based activities.


Create a New Sticky Session

Controlling the duration of your proxy sessions is essential for efficient and secure internet usage.  
By creating sessions and providing lifetimes, you can set how long each connection lasts, ensuring uninterrupted and secure activities.  
This feature aids in resource management, privacy maintenance, and overall performance enhancement.

## Understanding the `lifetime` Parameter  

### Lifetime Constraints

- **Minimum lifetime:** `3` minutes  
- **Maximum lifetime:** `1440` minutes (**24 hours**)  
- **Default lifetime:** `10` minutes  

The `lifetime` parameter is measured in **minutes**. This defines how long the resource remains valid before it expires.

### Examples:
- `lifetime: 5` → **5 minutes**
- `lifetime: 30` → **30 minutes**
- `lifetime: 60` → **1 hour**
- `lifetime: 180` → **3 hours** (since 3 hours = 180 minutes)

---

## Custom Session ID Rules

Your **custom session ID** must follow a simple set of rules to be valid. Think of these rules as guidelines to ensure the string is clean, consistent,  
and machine-readable.  

### Start with a Valid Character:
The first character **must** be one of the following:  
- An **uppercase letter** (`A-Z`)  
- A **lowercase letter** (`a-z`)  
- A **digit** (`0-9`)  
- An **underscore** (`_`)  

### Character Length:
- The allowed characters can be repeated, but the total length **must be between 1 and 25 characters**.  
- This provides enough space for **descriptive IDs** while avoiding overly lengthy names.  

### No Extra Characters:
- The string must **end immediately** after these **1 to 25 characters**.  
- It **cannot contain** spaces or special symbols **before or after** the allowed characters.  

---

### Simplified Explanation

In simpler terms:  
- The **session ID** must be composed entirely of **1 to 25 alphanumeric characters or underscores (`_`)**.  

If you're familiar with **regular expressions (regex)**, here's what it looks like:  

```regex
^[A-Za-z0-9_]{1,25}$
```

This regex ensures:  
- The string **starts** with a valid character.  
- It **contains only** valid characters throughout.  
- It **ends precisely** within the specified range of **1 to 25 characters**.  


Configuring Proxy Session ID & Lifetime

This API requires authentication using `BasicAuth`. Provide credentials in the format:

- **Username (`--user`)**: `<geonode_username>-session-<randomString>-limit-<limit>`
- **Password (`--user`)**: `<geonode_password>`
- **Proxy (`--proxy`)**: `http://proxy.geonode.io:<port>`
- **Accept Header**: Specifies the response format (`application/json`).


Perform Bandwidth-Limited Proxy Session

This API allows users to release a specific proxy session by providing a port number.


Release Proxy Session by Port

This endpoint allows you to release sticky sessions for multiple ports in a single request.

## Example Use Case:
If you have sticky sessions running on multiple ports (`10000`, `10001`, and `10002`), 
this API allows you to release them in a single request.


Release Proxy Session by Multiple Port

Release sticky sessions for a specified Geonode service by session ID and port.

Release Proxy Session by Session ID and Ports

Retrieve usage statistics for Geonode proxy service over a defined time period.


Retrieve Usage Statistics

Geo-Targeting Options

Execute a geo-targeting request using proxy credentials.

### How to Specify Country
If you need to geo-target requests at the country level, simply append
`-country-<country_code>` after the `<geonode_username>`.


Perform Country Targeting

Execute a State level geo-targeting request using proxy credentials.

### How to Specify State
If you need to geo-target requests at the state level, simply append
`-state-<state_name>` after the
`<geonode_username>-country-<country_code>`.


Perform State Targeting

Execute a City level geo-targeting request using proxy credentials.

### How to Specify City
If you need to geo-target requests at the city level, simply append
`-city-<city_name>` after the
`<geonode_username>-country-<country_code>`.

**Note that you can not target state and city at the same time.**


Perform City Targeting

Execute an ASN level geo-targeting request using proxy credentials.

### How It Works

* It allows creating a proxy targeting a certain ASN of an ISP.
* The `-asn-<ASN_NUMBER>` flag should be appended after specifying the country that the ASN belongs to.
* Refer to our [Geo-Locations List](https://docs.geonode.com/reference/obtaining-targeting-codes#/) to find information on available locations to target.

### Request Format

* **Country**: Specify the country using `-country-<country_code>`
* **ASN**: Add ASN filtering using `-asn-<ASN_NUMBER>`
* **IP Type**: Choose between residential, datacenter, or mix using `-type-<type_of_ip>`

###

Perform ISP/ASN Targeting

Filtering IPs by Type (Residential, Datacenter, Mix)

Whitelisting IPs

Returns a list of active whitelisted IPs.


Retrieve Whitelisted IPs

Add Whitelisted IPs

Updates the description of an existing whitelisted IP.


Update Whitelisted IP Description

Removes up to 10 IP addresses per request.


Remove Whitelisted IPs

Welcome to the Geonode Documentation Hub – your go-to resource for setup, API usage, integrations, and troubleshooting.

Introduction

You can check if your proxy is connected by following this guide.

Verify Proxy Connection

Essential resources to help you get the most out of Geonode services.

Useful Links

Check the current status of Geonode services.

Service Status

Submit and explore feature requests for Geonode.

Feature Requests

Support

Changelog

Integrations

Welcome to the home of your new documentation

Start building awesome documentation in under 5 minutes

Quickstart

Preview changes locally to update your docs

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied

Getting Started

Available Geo-Locations

Sticky Sessions Control

Usage Stats

Geo-Targetting

Proxy IP Type Filtering

IP Whitelist

List All Active Sessions

Authorizations

Query Parameters

Response