The Proxy object represents an individual proxy instance in the Ping Proxies system. It contains essential information about a proxy including its network details, authentication settings, geographic location, and operational status.

Key Attributes

AttributeTypeDescription
proxy_idstringUnique identifier for the proxy (UUID format)
proxy_ip_addressstringMain IPv4 address of the proxy
proxy_protocolstringIP protocol of the proxy (ipv4, ipv6, dual)
proxy_typestringType of proxy (datacenter, isp, residential)
proxy_http_portintegerHTTP port number for the proxy
proxy_socks5_portintegerSOCKS5 port number for the proxy
proxy_statusstringCurrent status of the proxy (available, in_use, reserved, etc.)
proxy_usernamestringProxy-specific authentication username (if configured)
proxy_passwordstringProxy-specific authentication password (if configured)
service_idstringID of the service this proxy is associated with
country_idstringISO country code where the proxy is located
asn_idintegerAutonomous System Number (network provider)
city_idintegerID of the city where the proxy is located
subdivision_idstringID of the region/state where the proxy is located

Network Attributes

The Proxy object includes detailed network information:

AttributeTypeDescription
ip_address_id_v4stringIPv4 address identifier
ip_address_id_v6stringIPv6 address identifier (for dual or ipv6 proxies)
subnet_idstringIPv4 subnet the proxy belongs to
subnet_id_v6stringIPv6 subnet the proxy belongs to (for dual or ipv6 proxies)
asn_namestringName of the Autonomous System (e.g., “AT&T Services, Inc.”)

Geographic Attributes

Proxies include detailed geographic information:

AttributeTypeDescription
country_namestringFull name of the country (e.g., “United States”)
subdivision_namestringFull name of the region/state (e.g., “California”)
city_namestringFull name of the city (e.g., “Los Angeles”)
city_latitudenumberLatitude coordinates of the city
city_longitudenumberLongitude coordinates of the city
city_timezonestringTimezone of the city (e.g., “America/Los_Angeles”)

Object Relationships

The Proxy object connects to several other objects in the Ping Proxies API:

  • Service: Each proxy belongs to a service subscription
  • Customer: Proxies are ultimately owned by a customer through services
  • Proxy User: Proxy users can access proxies for authentication
  • ASN: Provides network operator details for the proxy
  • Geographic Entities: Country, subdivision, and city information

Proxy Status Values

StatusDescription
availableProxy is ready but not actively assigned
in_useProxy is actively assigned to a service and available for use
reservedProxy is reserved for future use
waitingProxy is being provisioned or prepared
pending_deletionProxy is scheduled for removal
EndpointDescription
GET /public/user/proxy/retrieve/{proxy_id}Retrieve a specific proxy
GET /public/user/proxy/searchSearch proxies with filters
GET /public/user/proxy/list_by_searchRetrieve formatted proxy lists
POST /public/user/proxy/list_by_idGenerate formatted proxy lists by ID
PATCH /public/user/proxy/edit/{proxy_id}Edit a proxy

Usage Notes

  • Proxies can be accessed using the default proxy user or proxy-specific authentication
  • For IPv4 proxies, use proxy_ip_address or ip_address_id_v4 (they contain the same value if you’ve purchased IPv4 proxies)
  • For IPv6 or dual-stack proxies, the IPv6 address is stored in ip_address_id_v6
  • The combination of IP address and port is unique to each proxy
  • When listing proxies, the proxy object will include additional formatted fields:
    • http_formatted: Formatted HTTP proxy string
    • socks5_formatted: Formatted SOCKS5 proxy string

Authentication Methods

Proxies can be accessed using three authentication methods:

  1. Proxy User Authentication: Using a proxy user’s credentials
  2. IP Authentication: Allowing specific client IP addresses
  3. Proxy-Specific Authentication: Using credentials specific to a single proxy

Proxy Types and Differences

Each proxy type has unique characteristics:

  • Datacenter Proxies: Static proxies hosted in data centers
  • ISP Proxies: Static proxies with residential-type IP addresses from major ISPs
  • Residential Proxies: Dynamic proxies from real residential connections

While datacenter and ISP proxies are represented as persistent proxy objects, residential proxies are generated dynamically and don’t have persistent proxy objects.