get Rotate IP address for a proxy.

/api/client/v1/rotate
proxy

This request allows you to force an IP address rotation for the proxy. Please note that some proxies do not support IP address rotation!

Parameters

token
Required
Rotate IP token.
In: query
Example: YAxVULj2NICWxTosVKheI6hAzEDDbr53ah5HYGnfBeF9m7jySToetWxfKZFAE2ej
Schema:
  • string
    Example: "stringstringstringstringstringstringstringstringstringstringstri"
    Maximum number of items: 64
    Minimum string length: 64

Responses

202

Accepted. Successful request, the IP address of the proxy will be rotated soon.
Content Type:
application/json
  • Schema
  • Example
  • object
    Example: {"message":"Proxy IP-address will be rotated soon."}
    Properties:
    • message
      string
      Example: "Proxy IP-address will be rotated soon."

400

Bad Request. Unable to rotate the IP address for the expired or non-existing proxy.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

422

Unprocessable Entity. Missing or invalid IP rotation token, please check it and try again.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}

429

To many attempts. IP address rotation is limited to 1 rotation per minute, please try again later.
Content Type:
application/json
  • Schema
  • Example
  • object
    ErrorResponse
    Example: {"message":"string","errors":{}}
    Properties:
    • message
      string
      Required
      Error message
      Example: "string"
    • errors
      object or null
      Input validation errors
      Example: {}