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

# Get rotation status

> Check a rotation's status and ordered results. Existing rotations return `200`, including `partially_succeeded` and `failed` outcomes.



## OpenAPI

````yaml /openapi.json get /isp/rotations/{rotationId}
openapi: 3.1.0
info:
  title: DoubleData Proxy API
  version: 1.2.0
  description: >-
    Manage proxy usage, wallet balance, orders, subscriptions, rotations, and IP
    authorization. Your API key selects the workspace; do not send an
    organization ID.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://app.proxy.doubledata.com/api/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Stats & usage
    description: >-
      Date-range bandwidth, request counts, and actual wallet usage charges for
      your proxy credentials.
  - name: Balance
    description: The organization USD balance shared with the DoubleData website.
  - name: Catalog
    description: Static ISP tiers and cached country availability.
  - name: Orders
    description: Server-priced wallet orders and asynchronous provisioning.
  - name: Subscriptions
    description: Active Static ISP subscriptions and their connection records.
  - name: Rotations
    description: Asynchronous selected-IP rotation batches.
  - name: IP authorization
    description: The source IP authorized for a subscription.
  - name: Credentials
    description: >-
      Residential, datacenter, and mobile proxy credentials and their traffic
      limits.
  - name: Invoices
    description: Organization invoices and invoice PDF downloads.
paths:
  /isp/rotations/{rotationId}:
    get:
      tags:
        - Rotations
      summary: Get rotation status
      description: >-
        Check a rotation's status and ordered results. Existing rotations return
        `200`, including `partially_succeeded` and `failed` outcomes.
      operationId: getISPRotation
      parameters:
        - $ref: '#/components/parameters/RotationID'
      responses:
        '200':
          description: Current rotation status
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestID'
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RotationResponse'
              examples:
                processing:
                  summary: Processing
                  value:
                    rotation:
                      id: 4f114166-bbf7-41fa-82b8-c398f7a19914
                      subscription_id: 25974f58-6a7a-4b0d-8dd7-a89133f50762
                      status: processing
                      requested_count: 2
                      succeeded_count: 0
                      failed_count: 0
                      created_at: '2026-08-31T12:00:00Z'
                partial:
                  summary: Partially succeeded
                  value:
                    rotation:
                      id: 4f114166-bbf7-41fa-82b8-c398f7a19914
                      subscription_id: 25974f58-6a7a-4b0d-8dd7-a89133f50762
                      status: partially_succeeded
                      requested_count: 2
                      succeeded_count: 1
                      failed_count: 1
                      results:
                        - old_ip: 198.51.100.10
                          new_ip: 198.51.100.80
                          new_port: 9200
                          protocols:
                            - http
                            - socks5
                          username: example-user
                          password: example-password
                          country: US
                          valid: true
                          assigned_at: '2026-08-31T12:05:00Z'
                          status: succeeded
                        - old_ip: 203.0.113.20
                          status: failed
                          error:
                            code: rotation_temporarily_unavailable
                            message: >-
                              This proxy could not be rotated at this time.
                              Please try again.
                            retryable: true
                      created_at: '2026-08-31T12:00:00Z'
                      completed_at: '2026-08-31T12:05:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  parameters:
    RotationID:
      name: rotationId
      in: path
      required: true
      description: The accepted rotation's UUID.
      schema:
        type: string
        format: uuid
  headers:
    RequestID:
      description: A request UUID to include when contacting support.
      schema:
        type: string
        format: uuid
    CacheControl:
      description: Responses are not stored in shared or browser caches.
      schema:
        type: string
        const: no-store
    RateLimitRetryAfter:
      description: When present, wait at least this many seconds before retrying.
      schema:
        type: integer
        minimum: 1
  schemas:
    RotationResponse:
      type: object
      additionalProperties: false
      required:
        - rotation
      properties:
        rotation:
          $ref: '#/components/schemas/Rotation'
    Rotation:
      type: object
      additionalProperties: false
      required:
        - id
        - subscription_id
        - status
        - requested_count
        - succeeded_count
        - failed_count
        - created_at
      properties:
        id:
          type: string
          format: uuid
        subscription_id:
          type: string
          format: uuid
        status:
          type: string
          enum:
            - accepted
            - processing
            - succeeded
            - partially_succeeded
            - failed
        requested_count:
          type: integer
          minimum: 1
          maximum: 100
        succeeded_count:
          type: integer
          minimum: 0
        failed_count:
          type: integer
          minimum: 0
        results:
          type: array
          description: >-
            Results follow the submitted IP order. May be absent until results
            are available.
          items:
            $ref: '#/components/schemas/RotationResult'
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RotationResult:
      oneOf:
        - $ref: '#/components/schemas/SucceededRotationResult'
        - $ref: '#/components/schemas/FailedRotationResult'
    Error:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - request_id
      properties:
        code:
          type: string
          enum:
            - invalid_request
            - invalid_ip_address
            - invalid_proxy_ip
            - duplicate_proxy_ip
            - unknown_proxy_ip
            - invalid_package
            - insufficient_balance
            - quote_expired
            - request_conflict
            - kyc_required
            - rotation_allowance_exhausted
            - rotation_in_progress
            - unauthorized
            - forbidden
            - not_found
            - not_available
            - rate_limit_exceeded
            - temporarily_unavailable
            - internal_error
        message:
          type: string
          minLength: 1
        details:
          $ref: '#/components/schemas/ErrorDetails'
        request_id:
          type: string
          format: uuid
    SucceededRotationResult:
      type: object
      additionalProperties: false
      required:
        - old_ip
        - new_ip
        - new_port
        - protocols
        - username
        - password
        - country
        - valid
        - assigned_at
        - status
      properties:
        old_ip:
          type: string
          format: ipv4
        new_ip:
          type: string
          format: ipv4
        new_port:
          type: integer
          minimum: 1
          maximum: 65535
        protocols:
          type: array
          items:
            type: string
            minLength: 1
        username:
          type: string
          minLength: 1
        password:
          type: string
          minLength: 1
        country:
          type: string
          pattern: ^[A-Z]{2}$
        valid:
          type: boolean
        assigned_at:
          type: string
          format: date-time
        status:
          type: string
          const: succeeded
    FailedRotationResult:
      type: object
      additionalProperties: false
      required:
        - old_ip
        - status
        - error
      properties:
        old_ip:
          type: string
          format: ipv4
        status:
          type: string
          const: failed
        error:
          $ref: '#/components/schemas/RotationResultError'
    ErrorDetails:
      type: object
      additionalProperties: false
      properties:
        ips:
          type: array
          maxItems: 100
          items:
            type: string
            format: ipv4
    RotationResultError:
      type: object
      additionalProperties: false
      required:
        - code
        - message
        - retryable
      properties:
        code:
          type: string
          const: rotation_temporarily_unavailable
        message:
          type: string
          const: This proxy could not be rotated at this time. Please try again.
        retryable:
          type: boolean
  responses:
    BadRequest:
      description: Invalid ID, request body, or selected IPs.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unknownIP:
              value:
                error:
                  code: unknown_proxy_ip
                  message: One or more IPs are not active in this subscription.
                  details:
                    ips:
                      - 198.51.100.10
                  request_id: ad2f824c-46bc-47c6-b276-2bb51a3083b1
    Unauthorized:
      description: The API key is missing, invalid, or revoked.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            unauthorized:
              value:
                error:
                  code: unauthorized
                  message: A valid API key is required.
                  request_id: ad2f824c-46bc-47c6-b276-2bb51a3083b1
    NotFound:
      description: The requested resource was not found.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TooManyRequests:
      description: Request limit or rotation allowance reached.
      headers:
        Retry-After:
          $ref: '#/components/headers/RateLimitRetryAfter'
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: The request could not be completed.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: The API is temporarily unavailable.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestID'
        Cache-Control:
          $ref: '#/components/headers/CacheControl'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Your organization's active API key.

````

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