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

# Get the status of a migration

> Get the status of a migration



## OpenAPI

````yaml get /migrations/{migration_id}
openapi: 3.0.3
info:
  version: '1.0'
  title: Togai Apis
  contact:
    email: engg@togai.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: APIs for Togai App
servers:
  - description: Api endpoint
    url: https://api.togai.com/
  - description: Sandbox api endpoint
    url: https://sandbox-api.togai.com/
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: Customer level calls
  - name: Accounts
    description: Account level calls
  - name: Event Schemas
    description: Event Schema level calls
  - name: Usage Meters
    description: Usage Meter level calls
  - name: Price Plans
    description: Price Plan level calls
  - name: Settings
    description: Settings
  - name: Price Experimentation
    description: Price Experimentation apis
  - name: InvoiceGroups
    description: Invoice Group level calls
  - name: Organization
    description: Organization level calls
  - name: FileStorage
    description: File Storage level calls
  - name: Aliases
    description: Alias level calls
  - name: Event Management
    description: APIs for getting events ingested in Togai
    externalDocs:
      description: docs
      url: https://togai.com/docs/billing/events
  - name: Metrics
    description: APIs for getting Togai metrics
    externalDocs:
      description: docs
      url: https://togai.com/docs/metrics
  - name: Licenses
    description: APIs for getting or updating license records in Togai
  - name: Entitlements
    description: APIs related to entitlements
  - name: Invoices
    description: Invoices API
  - name: Credits
    description: Credits API
  - name: Wallet
    description: Wallet API
  - name: InvoiceTemplates
    description: InvoiceTemplates API
  - name: Payments
    description: Payments API
  - name: Authentication
    description: Authentication API
externalDocs:
  description: Find out more about Togai
  url: https://docs.togai.com/docs
paths:
  /migrations/{migration_id}:
    get:
      tags:
        - Migrations
      summary: Get the status of a migration
      description: Get the status of a migration
      operationId: getMigrationStatus
      parameters:
        - $ref: '#/components/parameters/migration_id'
      responses:
        '200':
          $ref: '#/components/responses/GetMigrationResponse'
        '400':
          $ref: '#/components/responses/ErrorResponse'
        '401':
          $ref: '#/components/responses/ErrorResponse'
        '403':
          $ref: '#/components/responses/ErrorResponse'
        '404':
          $ref: '#/components/responses/ErrorResponse'
        '429':
          $ref: '#/components/responses/ErrorResponse'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    migration_id:
      in: path
      name: migration_id
      required: true
      schema:
        type: string
        example: mig.20aUyEZSuYq.SoGbS
  responses:
    GetMigrationResponse:
      description: Response for get migration status request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/GetMigrationResponse'
          examples:
            GetMigrationResponse:
              $ref: '#/components/examples/GetMigrationResponse'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            ErrorResponse:
              summary: Error message
              value:
                message: <Reason message>
  schemas:
    GetMigrationResponse:
      type: object
      additionalProperties: false
      required:
        - id
        - type
        - updatedAt
        - status
        - sourceId
        - targetId
        - totalMigrationEntries
        - pendingMigrationEntries
        - failedMigrationEntries
        - completedMigrationEntries
      properties:
        id:
          type: string
        type:
          type: string
        updatedAt:
          type: string
          format: date-time
        status:
          type: string
        sourceId:
          type: string
        sourceVersion:
          type: integer
          format: int32
        targetId:
          type: string
        targetVersion:
          type: integer
          format: int32
        totalMigrationEntries:
          type: integer
          format: int32
        pendingMigrationEntries:
          type: integer
          format: int32
        failedMigrationEntries:
          type: integer
          format: int32
        completedMigrationEntries:
          type: integer
          format: int32
    ErrorResponse:
      type: object
      additionalProperties: false
      required:
        - message
      properties:
        message:
          type: string
          description: error description
          maxLength: 500
  examples:
    GetMigrationResponse:
      value:
        id: mig.20aUyEZSuYq.SoGbS
        type: PRICE_PLAN
        updatedAt: '2080-10-04T00:00:00Z'
        status: COMPLETED
        sourceId: pp.njrjk314hfr
        targetId: pp.rhk32h4dsfq
        totalMigrationEntries: 100
        pendingMigrationEntries: 40
        failedMigrationEntries: 20
        completedMigrationEntries: 40
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Bearer <credential>

````