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

# Create a new pipeline parameter

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

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

Creates a new pipeline parameter in the specified pipeline with the provided name, value, type, and description.

**Process Overview:**
1. **Request Validation** - Validates parameter name format, value, type, and description
2. **Duplicate Check** - Ensures parameter name doesn't already exist in the pipeline
3. **Parameter Creation** - Creates the parameter with specified details and generates unique ID

**Parameter Types:**
- `PARAMETER_DATA_TYPE_STRING` - Plain text parameter for non-sensitive values
- `PARAMETER_DATA_TYPE_ENCRYPTED_STRING` - Encrypted parameter for sensitive values like passwords

**Parameter Naming Rules:**
- Variable name cannot have a space or special characters except underscore (_)
- Must be unique within the pipeline

**Use Cases:**
- Add configuration parameters to pipelines
- Create encrypted credentials for data connections
- Set up pipeline-specific variables

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

## Path parameters

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

## Request body

- MainframePipelineParameterRequest: A single name/value pipeline parameter.
  - `name` string, required: Parameter name
  - `value` string, required: Parameter value
  - `type` 'PARAMETER_DATA_TYPE_STRING' | 'PARAMETER_DATA_TYPE_ENCRYPTED_STRING': Parameter type
  - `description` string: Optional human-friendly description for the parameter

## Response `201`

Parameter created successfully.
Location header contains the URI of the newly created parameter for future reference.

## Other responses

- `400`: Bad Request - Validation failed due to one of the following reasons: - Invalid project ID - Invalid pipeline ID - Invalid parameter payload (missing required fields) - Invalid parameter type (must be PARAMETER_DATA_TYPE_STRING or PARAMETER_DATA_TYPE_ENCRYPTED_STRING) - Parameter name contains spaces or special characters (except underscore)
- `401`: Unauthorized - Authentication required, valid credentials not provided
- `403`: Forbidden - User lacks the required 'replication-pipeline::create' or legacy 'replication-pipeline::manage' permission
- `404`: Not Found - Resource not found due to one of the following reasons: - Pipeline does not exist within the project
- `409`: Conflict - Parameter creation failed due to one of the following reasons: - Parameter with the same name already exists in the pipeline
- `500`: Internal Server Error - Server encountered an unexpected condition, such as: - Parameter creation operation failure

---

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