---
title: "Get pull status for mainframe files"
method: GET
path: "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/pull-status"
tags: ["Build and Configure Mainframe Integration Projects"]
---

# Get pull status for mainframe files

`GET /v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/pull-status`

## Request

- Base URL: `https://integration-adapter.connect.cloud.precisely.com`
- URL: `https://integration-adapter.connect.cloud.precisely.com/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/pull-status`
- Auth: HTTP bearer

Returns pull readiness status and size count for mainframe file hydration.

**Features:**
- Validates project/pipeline association before evaluation
- Hidden/system files excluded by default (`includeHidden=false`)
- If `fileIds` is omitted or empty, **all visible pipeline files** are selected for evaluation
- If `fileIds` is provided, evaluates only those specific file IDs against the latest remote snapshot
- Returns available/missing counts and total payload size (real count, not estimated)
- Surfaces explicit `ready`, `unavailable`, or `nothing_to_fetch` pull status

**Use Cases:**
- UX preflight before user confirms pull
- Showing selected file count and expected download footprint
- Detecting stale selections when files were removed remotely
- Full-pipeline evaluation when no fileIds specified

**Required Permissions:** `replication-pipeline::view`

## Path parameters

- `projectId` string, required
- `pipelineId` string, required

## Query parameters

- `fileIds` string[]
- `includeHidden` boolean

## Response `200`

Successfully computed pull readiness status

- MainframePullStatusResponse: Pull readiness and estimate for selected hydration
  - `projectId` string: Project ID
  - `pipelineId` string: Pipeline ID
  - `requestedFileCount` integer: Selected file count
  - `availableFileCount` integer: Number of selected files available for hydration
  - `totalSizeBytes` integer: Total payload size in bytes (real count, not estimated)
  - `unavailableFileIds` string[]: IDs that are missing from current remote snapshot
  - `status` 'ready' | 'nothing_to_fetch' | 'unavailable': Pull readiness status

## Other responses

- `401`: Unauthorized - Authentication required
- `403`: Forbidden - Missing required permission
- `404`: Not Found - Project or pipeline does not exist
- `500`: Internal Server Error - Failed to compute pull status

---

[API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)