---
title: "Activate a mainframe pipeline"
method: POST
path: "/v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/activation"
tags: ["Build and Configure Mainframe Integration Projects"]
---

# Activate a mainframe pipeline

`POST /v1/integration/mainframe/projects/{projectId}/pipelines/{pipelineId}/activation`

## 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}/activation`
- Auth: HTTP bearer

Synchronously activates a mainframe data integration pipeline by performing
validation, staging, activation, and starting operations based on the provided request flags.

**Process Overview:**
- Validates the project and pipeline existence.
- If `validate` is true, performs validation of the pipeline configuration.
- If `stage` is true, commits the pipeline configuration to the staging area (requires validation).
- If `activate` is true, deploys the pipeline to the runtime environment.
- If `start` is true, starts the pipeline execution.
- Returns phase-wise results for validate, stage, deploy, and start operations.

**Execution Details:**
- All operations are executed sequentially within a single request.
- If any operation fails, subsequent operations are not attempted.

**Key Features:**
- Synchronous execution of activation steps with immediate feedback.
- Supports selective operations based on request flags for flexible pipeline management.

**Use Cases:**
- Deploy and start a newly configured pipeline in one operation.
- Stage pipeline changes for review before activation.
- Restart a stopped pipeline with validation.
- Perform incremental pipeline lifecycle management.

**Required Permissions:** Either `replication-pipeline::create` or `replication-pipeline::update` when permission harmonization is enabled; otherwise, `replication-pipeline::manage`.

## Path parameters

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

## Request body

- MainframePipelineActivationRequest: Request payload for activating a pipeline. This includes flags for staging, validation, activation, and start operations.
  - `validate` boolean: Flag to indicate whether validation should be performed during staging
  - `stage` boolean: Flag to indicate whether the pipeline should be staged
  - `activate` boolean: Flag to indicate whether the pipeline should be activated
  - `start` boolean: Flag to indicate whether the pipeline should be started

## Response `201`

Pipeline activation result

- MainframePipelineActivationResponse: Response object containing the result of a mainframe pipeline activation operation.
  - `validate` PhaseResult: Result of a specific phase in the pipeline activation process.
    - `success` boolean: Indicates whether the phase was successful.
    - `errors` string[]: List of errors encountered during the phase if any.
  - `stage` PhaseResult: Result of a specific phase in the pipeline activation process.
    - `success` boolean: Indicates whether the phase was successful.
    - `errors` string[]: List of errors encountered during the phase if any.
  - `deploy` PhaseResult: Result of a specific phase in the pipeline activation process.
    - `success` boolean: Indicates whether the phase was successful.
    - `errors` string[]: List of errors encountered during the phase if any.
  - `start` PhaseResult: Result of a specific phase in the pipeline activation process.
    - `success` boolean: Indicates whether the phase was successful.
    - `errors` string[]: List of errors encountered during the phase if any.

## Other responses

- `400`: Bad Request - Invalid request or pipeline not found
- `401`: Unauthorized - Authentication required, valid credentials not provided
- `403`: Forbidden - User lacks 'replication-pipeline::create' or 'replication-pipeline::update' when permission harmonization is enabled, or legacy 'replication-pipeline::manage' otherwise
- `404`: Not Found - Project or pipeline does not exist
- `500`: Internal Server Error - Pipeline activation failed due to one of the following: - Validation failure: Pipeline validation failed during staging - Staging failure: Pipeline configuration commit to staging area failed - Deployment failure: Pipeline deployment failed - Starting failure: Pipeline execution start operation failed - General activation failure: Unexpected error during activation process

---

[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)