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

# Get IP Change

> Reads an IP change by its ID, to follow it until it has `completed` or `failed`.



## OpenAPI

````yaml get /ip-changes/{ipChange}
openapi: 3.1.0
info:
  title: APIFiddle Sample Definition
  version: 0.0.0
  description: Example workspace
servers:
  - url: https://rdp.sh/api/v1
    description: Default production endpoint.
security: []
paths:
  /ip-changes/{ipChange}:
    get:
      summary: Get an IP change
      description: >-
        Reads an IP change by its ID, to follow it until it has `completed` or
        `failed`.
      operationId: getIpChange
      parameters:
        - $ref: '#/components/parameters/ipChange'
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                title: GetIpChangeOk
                properties:
                  status:
                    type: boolean
                    examples:
                      - true
                  ip_change:
                    $ref: '#/components/schemas/ipChange'
          description: The change and how far it has got.
        '404':
          content:
            application/json:
              schema:
                type: object
                title: GetIpChangeNotFound
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  error:
                    type: string
                    examples:
                      - IP change not found
          description: No IP change with this ID on your account.
      security:
        - Authorization: []
components:
  parameters:
    ipChange:
      in: path
      name: ipChange
      schema:
        type: integer
      required: true
      description: IP change ID
  schemas:
    ipChange:
      type: object
      required:
        - id
        - server_id
        - status
        - subnet
      properties:
        id:
          type: integer
          examples:
            - 42
        server_id:
          type: integer
          examples:
            - 123
        status:
          type: string
          enum:
            - awaiting_payment
            - pending
            - running
            - completed
            - failed
          description: >
            `awaiting_payment` is only seen for a change ordered on the server
            page

            whose invoice is still open.
          examples:
            - running
        step:
          type: string
          description: What the change is doing right now.
          examples:
            - Waiting for the server on its new address
        progress:
          type: integer
          minimum: 0
          maximum: 100
          examples:
            - 80
        subnet:
          type: string
          description: The /24 the new address is taken from.
          examples:
            - 198.51.100.0/24
        old_ip:
          type:
            - string
            - 'null'
          examples:
            - 203.0.113.10
        new_ip:
          type:
            - string
            - 'null'
          description: >
            The address the server is moving to, once it has been reserved.
            `null`

            again if the change failed.
          examples:
            - 198.51.100.20
        invoice_id:
          type:
            - integer
            - 'null'
        refunded:
          type: boolean
          description: Whether the fee was credited back to your balance.
        error:
          type:
            - string
            - 'null'
          description: Why the change failed, once it has.
        created_at:
          type: string
          examples:
            - '2026-10-22T12:00:00+00:00'
        finished_at:
          type:
            - string
            - 'null'
      description: A change of a server's IPv4 address.
  securitySchemes:
    Authorization:
      in: header
      name: Authorization
      type: apiKey
      description: |
        Your API key as it is, without `Bearer`. API access is off for new
        accounts: until it is turned on under Settings > API, every request
        answers `403` with `API access is turned off for this account. Turn it
        on under Settings > API.` If the account lists allowed IPs, a request
        from any other address answers `403` with `This API key is not allowed
        from <address>`.

````

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