> ## Documentation Index
> Fetch the complete documentation index at: https://developers.soax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Rotate through the rotation link

> Rotate the session to a new exit IP with a plain GET, for tools that cannot send an `Authorization` header, such as antidetect browsers' "Change IP URL". Use the session's `rotation_url` as is. The `token` query parameter is the only credential and authorizes this one session only. The URL is a secret: anyone who opens it rotates the session, including link previewers and scanners, so share it only with the tool that uses it. Regenerate it with [Regenerate rotation link](/api/stateful-sessions/rotation-url) if it leaks.

Shares the limit of one rotation per second per session. A wrong token, an unknown session, or a session of another package all answer 404. The response is not cached.



## OpenAPI

````yaml api/openapi.json GET /v1/proxy/packages/{package_id}/stateful-sessions/{session_id}/rotate
openapi: 3.1.0
info:
  title: SOAX API
  version: v1
  description: >-
    Programmatic access to your SOAX account: manage proxy packages, generate
    connection strings, browse available locations, pull usage analytics, and
    manage API keys. All endpoints are served over HTTPS and return JSON.
servers:
  - url: https://api.platform.soax.com
security:
  - bearerAuth: []
tags:
  - name: API Keys
    description: >-
      Self-service management of the API keys used to authenticate with this
      API.
  - name: Packages
    description: >-
      Read proxy packages, build proxy connection strings, and rotate package
      passwords.
  - name: Stateful Sessions
    description: Create and manage long-lived, server-configured proxy sessions.
  - name: Locations
    description: >-
      Location reference data: tiers, countries, regions, cities, ISPs, ASNs,
      and ZIP codes.
  - name: Account
    description: Read-only account, credit, and subscription information.
  - name: Analytics
    description: Usage analytics for your proxy packages.
paths:
  /v1/proxy/packages/{package_id}/stateful-sessions/{session_id}/rotate:
    get:
      tags:
        - Stateful Sessions
      summary: Rotate through the rotation link
      description: >-
        Rotate the session to a new exit IP with a plain GET, for tools that
        cannot send an `Authorization` header, such as antidetect browsers'
        "Change IP URL". Use the session's `rotation_url` as is. The `token`
        query parameter is the only credential and authorizes this one session
        only. The URL is a secret: anyone who opens it rotates the session,
        including link previewers and scanners, so share it only with the tool
        that uses it. Regenerate it with [Regenerate rotation
        link](/api/stateful-sessions/rotation-url) if it leaks.


        Shares the limit of one rotation per second per session. A wrong token,
        an unknown session, or a session of another package all answer 404. The
        response is not cached.
      operationId: >-
        rotate_stateful_session_via_link_v1_proxy_packages__package_id__stateful_sessions__session_id__rotate_get
      parameters:
        - name: package_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            description: >-
              The package's ID. To find it, open the package in
              [Packages](https://platform.soax.com/packages) and expand the
              header, or call [List packages](/api/packages/list).
            title: Package Id
          description: >-
            The package's ID. To find it, open the package in
            [Packages](https://platform.soax.com/packages) and expand the
            header, or call [List packages](/api/packages/list).
        - name: session_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
            description: >-
              The session's `id` (a UUID), not its name. In the dashboard,
              expand the session row to copy it.
            title: Session Id
          description: >-
            The session's `id` (a UUID), not its name. In the dashboard, expand
            the session row to copy it.
        - name: token
          in: query
          required: true
          schema:
            type: string
            title: Token
          description: The token from the session's `rotation_url`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatefulSessionRotatedResponse'
              example:
                id: 7c1e9a52-3b4d-4f6a-9e8b-2d5c0a1f6b3e
                name: checkout1
                exit_ip: 198.51.100.17
                network_type: wifi
                country: us
                region: california
                city: los_angeles
                isp: charter_communications
                asn: '20001'
                zip: null
                bound_since: '2026-10-27T10:21:40Z'
        '400':
          description: The session is disabled, or the package is suspended or deleted.
          content:
            application/json:
              example:
                detail: Package is suspended and cannot provision stateful sessions.
        '403':
          description: The account is suspended.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
        '404':
          description: Wrong token, or the session was not found.
          content:
            application/json:
              example:
                detail: Session not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: 'This session was rotated less than a second ago (`Retry-After: 1`).'
          content:
            application/json:
              example:
                detail: Rotation is rate-limited to 1 per second per session.
      security: []
components:
  schemas:
    StatefulSessionRotatedResponse:
      properties:
        id:
          type: string
        name:
          type: string
        exit_ip:
          type: string
        network_type:
          type: string
        country:
          type: string
        region:
          type: string
        city:
          type: string
        isp:
          type: string
        asn:
          type: string
        zip:
          anyOf:
            - type: string
            - type: 'null'
        bound_since:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          description: When the session was bound to its new node.
      type: object
      required:
        - id
        - name
        - exit_ip
        - network_type
        - country
        - region
        - city
        - isp
        - asn
      title: StatefulSessionRotatedResponse
      description: >-
        The new binding of a session rotated through its rotation link. No
        connection string, ruleset or token.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key secret (starts with `s_live_`). Create keys in the dashboard
        under [**Settings → API
        keys**](https://platform.soax.com/settings/api-keys), or via `POST
        /v1/api-keys/`. Send it as `Authorization: Bearer <secret>`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.