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

# Get adminv2 rolloutjobs

> Get an EE v2 rollout job detail

Required token scopes: `instance|read`



## OpenAPI

````yaml /swagger.json get /admin/v2-rollout/jobs/{jobId}
openapi: 3.0.0
info:
  version: 1.0.0
  title: Teable App
  description: Manage Data as easy as drink a cup of tea
  x-logo:
    backgroundColor: '#F0F0F0'
    altText: Teable logo
servers:
  - url: https://app.teable.ai/api
security: []
tags:
  - name: base
    x-group: project
  - name: base node
    x-group: project node
  - name: base-share
    x-group: project-share
paths:
  /admin/v2-rollout/jobs/{jobId}:
    get:
      tags:
        - admin
      description: |-
        Get an EE v2 rollout job detail

        Required token scopes: `instance|read`
      parameters:
        - schema:
            type: string
          required: true
          name: jobId
          in: path
        - schema:
            type: boolean
            default: true
          required: false
          name: includeSpaces
          in: query
        - schema:
            type: boolean
            default: true
          required: false
          name: includeBases
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - running
                - ready
                - partial
                - blocked
                - failed
                - switched
                - skipped
          required: false
          name: spaceStatuses
          in: query
        - schema:
            type: array
            items:
              type: string
              enum:
                - pending
                - checking
                - repairing
                - verifying
                - ready
                - blocked
                - failed
                - switched
                - skipped
          required: false
          name: baseStatuses
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
          required: false
          name: spaceSkip
          in: query
        - schema:
            type: integer
            nullable: true
            minimum: 0
            default: 0
          required: false
          name: baseSkip
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 500
          required: false
          name: spaceTake
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 500
          required: false
          name: baseTake
          in: query
      responses:
        '200':
          description: V2 rollout job detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  job:
                    type: object
                    properties:
                      id:
                        type: string
                      type:
                        type: string
                        enum:
                          - prepare
                          - switch
                          - full
                      status:
                        type: string
                        enum:
                          - pending
                          - running
                          - paused
                          - completed
                          - completed_with_blocks
                          - failed
                          - canceled
                      phase:
                        type: string
                        nullable: true
                        enum:
                          - inventory
                          - checking
                          - repairing
                          - verifying
                          - switching
                      mode:
                        type: string
                        enum:
                          - dry_run
                          - repair
                          - switch_space
                          - switch_global
                      options:
                        nullable: true
                      totalSpaces:
                        type: number
                      totalBases:
                        type: number
                      readySpaces:
                        type: number
                      readyBases:
                        type: number
                      blockedSpaces:
                        type: number
                      blockedBases:
                        type: number
                      failedSpaces:
                        type: number
                      failedBases:
                        type: number
                      skippedSpaces:
                        type: number
                      skippedBases:
                        type: number
                      switchedSpaces:
                        type: number
                      error:
                        type: string
                        nullable: true
                      createdBy:
                        type: string
                        nullable: true
                      createdTime:
                        type: string
                      startedTime:
                        type: string
                        nullable: true
                      finishedTime:
                        type: string
                        nullable: true
                      lastEventSeq:
                        type: number
                    required:
                      - id
                      - type
                      - status
                      - mode
                      - totalSpaces
                      - totalBases
                      - readySpaces
                      - readyBases
                      - blockedSpaces
                      - blockedBases
                      - failedSpaces
                      - failedBases
                      - skippedSpaces
                      - skippedBases
                      - switchedSpaces
                      - createdTime
                      - lastEventSeq
                  spaces:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        jobId:
                          type: string
                        spaceId:
                          type: string
                        spaceName:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - pending
                            - running
                            - ready
                            - partial
                            - blocked
                            - failed
                            - switched
                            - skipped
                        totalBases:
                          type: number
                        readyBases:
                          type: number
                        blockedBases:
                          type: number
                        failedBases:
                          type: number
                        skippedBases:
                          type: number
                        switchedBases:
                          type: number
                        lastError:
                          type: string
                          nullable: true
                        summary:
                          nullable: true
                        createdTime:
                          type: string
                        startedTime:
                          type: string
                          nullable: true
                        finishedTime:
                          type: string
                          nullable: true
                      required:
                        - id
                        - jobId
                        - spaceId
                        - status
                        - totalBases
                        - readyBases
                        - blockedBases
                        - failedBases
                        - skippedBases
                        - switchedBases
                        - createdTime
                  bases:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        jobId:
                          type: string
                        spaceItemId:
                          type: string
                        spaceId:
                          type: string
                        spaceName:
                          type: string
                          nullable: true
                        baseId:
                          type: string
                        baseName:
                          type: string
                          nullable: true
                        status:
                          type: string
                          enum:
                            - pending
                            - checking
                            - repairing
                            - verifying
                            - ready
                            - blocked
                            - failed
                            - switched
                            - skipped
                        attemptCount:
                          type: number
                        lastError:
                          type: string
                          nullable: true
                        checkSummary:
                          nullable: true
                        repairSummary:
                          nullable: true
                        verifySummary:
                          nullable: true
                        lastResults:
                          nullable: true
                        createdTime:
                          type: string
                        startedTime:
                          type: string
                          nullable: true
                        finishedTime:
                          type: string
                          nullable: true
                      required:
                        - id
                        - jobId
                        - spaceItemId
                        - spaceId
                        - baseId
                        - status
                        - attemptCount
                        - createdTime
                  spaceItemsTotal:
                    type: number
                  baseItemsTotal:
                    type: number
                  spaceStatusCounts:
                    type: object
                    additionalProperties:
                      type: number
                  baseStatusCounts:
                    type: object
                    additionalProperties:
                      type: number
                required:
                  - job
                  - spaces
                  - bases
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: Shell
          source: |-
            curl --request GET \
              --url 'https://app.teable.ai/api/admin/v2-rollout/jobs/%7BjobId%7D?includeSpaces=SOME_BOOLEAN_VALUE&includeBases=SOME_BOOLEAN_VALUE&spaceStatuses=SOME_ARRAY_VALUE&baseStatuses=SOME_ARRAY_VALUE&spaceSkip=SOME_INTEGER_VALUE&baseSkip=SOME_INTEGER_VALUE&spaceTake=SOME_INTEGER_VALUE&baseTake=SOME_INTEGER_VALUE' \
              --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
        - lang: JavaScript
          source: >-
            const url =
            'https://app.teable.ai/api/admin/v2-rollout/jobs/%7BjobId%7D?includeSpaces=SOME_BOOLEAN_VALUE&includeBases=SOME_BOOLEAN_VALUE&spaceStatuses=SOME_ARRAY_VALUE&baseStatuses=SOME_ARRAY_VALUE&spaceSkip=SOME_INTEGER_VALUE&baseSkip=SOME_INTEGER_VALUE&spaceTake=SOME_INTEGER_VALUE&baseTake=SOME_INTEGER_VALUE';

            const options = {method: 'GET', headers: {Authorization: 'Bearer
            REPLACE_BEARER_TOKEN'}};


            try {
              const response = await fetch(url, options);
              const data = await response.json();
              console.log(data);
            } catch (error) {
              console.error(error);
            }
        - lang: Node.js
          source: |-
            const http = require('https');

            const options = {
              method: 'GET',
              hostname: 'app.teable.ai',
              port: null,
              path: '/api/admin/v2-rollout/jobs/%7BjobId%7D?includeSpaces=SOME_BOOLEAN_VALUE&includeBases=SOME_BOOLEAN_VALUE&spaceStatuses=SOME_ARRAY_VALUE&baseStatuses=SOME_ARRAY_VALUE&spaceSkip=SOME_INTEGER_VALUE&baseSkip=SOME_INTEGER_VALUE&spaceTake=SOME_INTEGER_VALUE&baseTake=SOME_INTEGER_VALUE',
              headers: {
                Authorization: 'Bearer REPLACE_BEARER_TOKEN'
              }
            };

            const req = http.request(options, function (res) {
              const chunks = [];

              res.on('data', function (chunk) {
                chunks.push(chunk);
              });

              res.on('end', function () {
                const body = Buffer.concat(chunks);
                console.log(body.toString());
              });
            });

            req.end();
        - lang: Python
          source: >-
            import http.client


            conn = http.client.HTTPSConnection("app.teable.ai")


            headers = { 'Authorization': "Bearer REPLACE_BEARER_TOKEN" }


            conn.request("GET",
            "/api/admin/v2-rollout/jobs/%7BjobId%7D?includeSpaces=SOME_BOOLEAN_VALUE&includeBases=SOME_BOOLEAN_VALUE&spaceStatuses=SOME_ARRAY_VALUE&baseStatuses=SOME_ARRAY_VALUE&spaceSkip=SOME_INTEGER_VALUE&baseSkip=SOME_INTEGER_VALUE&spaceTake=SOME_INTEGER_VALUE&baseTake=SOME_INTEGER_VALUE",
            headers=headers)


            res = conn.getresponse()

            data = res.read()


            print(data.decode("utf-8"))
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````