Skip to main content
Smartproxy logo
  • Category: web scraping & browser
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 6
  • Triggers: 0
  • Slug: SMARTPROXY
  • Version: 20261101_00

Tools

Slug: SMARTPROXY_DELETE_WHITELISTED_IPTool to delete a specified whitelisted IP by its ID. Use when you need to remove an IP address from the whitelist. Returns success confirmation on completion.

Input Parameters

string
required
The ID of the whitelisted IP to delete. You can retrieve available IDs using the Get Whitelisted IPs action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTPROXY_GENERATE_BACKCONNECT_ENDPOINTSTool to generate custom back connect endpoints for Residential subscription proxies. Use when you need to create proxy connection strings with specific configuration parameters like session type, location, and authentication credentials.

Input Parameters

string
IP address to be used instead of domain. Required if domain is ‘ip’. Must contain port at the end (e.g., ‘1.1.1.1:7000’).
string
Full city name in lowercase with underscore instead of space (e.g., ‘new_orleans’).
integer
Page number for pagination of routes. Minimum value is 1. Default is 1.
integer
Count of routes that will be generated and returned. Minimum value is 1. Default is 10.
string
State selection if country is USA (‘us’). Provide full state name with underscore instead of space (e.g., ‘new_york’).
string
Domain to be used for routes. Default is ‘gate.decodo.com’. Use ‘ip’ to specify an IP address instead.
string
Country Alpha2 code in lower case (e.g., ‘us’, ‘gb’).
string
required
Password for authorization. This parameter is required.
string ("http" | "https")
Protocol to be used for proxy connections. Default is ‘http’.
string
required
Username for authorization. This parameter is required.
string ("\n" | "\r\n" | "\r" | "\t")
Line break type for text responses.
integer
Session time in minutes, range is 1-1440 (inclusive). This parameter is required if session_type is ‘sticky’. Default is 10.
string ("sticky" | "random")
Session type to use. Choose ‘sticky’ for sticky sessions or ‘random’ for rotating sessions. Default is ‘sticky’.
string ("protocol:auth@endpoint" | "endpoint:auth" | "auth@endpoint")
Output format type. Default is ‘protocol:auth@endpoint’.
string ("json" | "txt" | "html")
Response type that will be returned. Can be ‘json’, ‘txt’, or ‘html’. Default is ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTPROXY_GENERATE_CUSTOM_ENDPOINTSTool to generate custom proxy endpoints for Residential and Datacenter Pay per GB subscriptions. Use when you need to create configured proxy endpoints with specific authentication, session, and location parameters.

Input Parameters

string
IP address to use instead of domain. REQUIRED when domain is ‘ip’.
integer
Pagination page number (minimum 1). Maximum depends on count and location. Default is 1.
integer
Number of routes to generate (minimum 1). Maximum depends on page and location. Default is 10.
string
Domain for proxy routes. Use ‘ip’ to use IP address instead of domain. Default is ‘decodo.com’.
string
Geographic location: country Alpha-2 code, city, or state name in lowercase. Use ‘random’ for any location. Default is ‘random’.
string
Password for authorization. REQUIRED when auth_type is ‘basic’.
string
Username for authorization. REQUIRED when auth_type is ‘basic’.
string ("basic" | "whitelist")
Authentication method for proxy endpoints.
string ("\n" | "\r\n" | "\r" | "\t")
Line break types for text responses.
string
Proxy type for route generation. Default and only option is ‘residential_proxies’.
integer
Session duration in minutes (1-1440 inclusive). REQUIRED when proxy_type is ‘residential_proxies’, auth_type is ‘basic’, and session_type is ‘sticky’. Default is 10.
string ("sticky" | "random")
Session type for proxy connections.
string ("protocol:auth@endpoint" | "endpoint:auth" | "auth@endpoint")
Output format for generated proxy endpoints.
string ("json" | "txt" | "html")
Response format type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTPROXY_GET_API_KEYTool to instruct how to obtain Smartproxy API key. Use when you need to authenticate API requests but don’t have your key (manual dashboard process).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTPROXY_GET_ENDPOINTS_BY_TYPETool to retrieve proxy endpoints by type (random or sticky) for Residential subscription. Returns location, hostname, and port_range for each endpoint. Use when you need specific endpoint configuration for a particular proxy type.

Input Parameters

string ("random" | "sticky")
required
Type of proxy endpoint to retrieve. ‘random’ returns endpoints with rotating IPs, ‘sticky’ returns endpoints with session-based IPs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTPROXY_LIST_ENDPOINTS_AND_PORTSRetrieve available endpoint types for a Residential subscription, including their available location counts and relative URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not