API Reference

Geoproxies further enables more features through its simple to use RPC APIs

Note

Similar to case insensitivity of the proxy parameters, Geoproxies RPC APIs are also not only case insensitive but also style neutal. This means; create_access_token and CreateAccessToken will return the same result.

Attention

  • Parameter names prepended with asterisks are compulsory, otherwise optional.
  • Parameter prefixed with [p] represents POST parameters,
  • Parameters prefixed with [c] represents parameters to be passed with the basic authentication header.
  • api_token must be provided for every request. This token value can be found on your Geoproxies account proxy access information page.

Ban

Use this call to temporarily disable an IP selection associated with a session for any given amount of time.

PARAMETERS

  • [c] * session - The session identifier currently holding a reference to the IP address to ban.
  • [p] ttl - An optional delay value in seconds. If not provided, a default ttl value of 3600 is assumed.

RETURNS

“success” or failure reason

GetRequestData

Fetches all information associated with a request including wiretap.

PARAMETERS

  • [c] or [p] * trackingId - Same as the trackingId passed for each request.
  • [c] or [p] * wiretap - An always true toggle parameter.
  • [p] * tcpdump - An always true toggle parameter.
RETURNS
{
    destination: "",
    bytes_up: "",
    bytes_down: "",
    ip_address: "",
    start_datetime: "",
    end_datetime: "",
    start_timestamp: "",
    end_timestamp: "",
    boundaries: {},
    data: ""
}

When the tcpdump option is passed. Otherwise returns the well formatted json below.

{
    host: "",
    path: "",
    port: 0,
    method: "",
    start: "",
    end: "",
    ip_address: "",
    start_timestamp: "",
    end_timestamp: "",
    up: {
        bytes: "",
        headers: "",
        body: ""
    },
    down: {
        bytes: "",
        headers: "",
        body: ""
    }
}

GetWiretap

Used to return the recorded output data for a request, useful for debugging. Prefer using GetRequestData to fetch all possible information about a request including the ip_address used for that request

PARAMETERS

  • [c] or [p] * trackingId - Same as the trackingId passed for each request.
  • [p] tcpdump - An optional toggle parameter to return result as a dump.

RETURNS

{
    host: "",
    path: "",
    port: 0,
    method: "",
    start: "",
    end: "",
    start_timestamp: "",
    end_timestamp: "",
    up: {
        bytes: "",
        headers: "",
        body: ""
    },
    down: {
        bytes: "",
        headers: "",
        body: ""
    }
}

CreateAccesstoken

This call is used to create a short lived api token.

PARAMETERS

  • [p] token - .
  • [p] ttl - An optional delay value in seconds. If not provided, a default ttl value of 600 is assumed.

RETURNS

{
    newToken: "uuid-token",
    expires: 600
}

ClearSession

Removes an active session

PARAMETERS

  • [p] * session: -

RETURNS

“success” or failure reason