---
name: ContinuousDelivery-private_worker_integration
title: Configuring Delivery Pipeline Private Worker
description: Delivery Pipeline Private Worker connects with one or more private workers that run Delivery Pipeline workloads in isolation.
last-updated: 2026-07-23
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/ContinuousDelivery?format=markdown
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# Configuring Delivery Pipeline Private Worker
{: #privateworker}

DevOps Insights will reach end of service and be discontinued on **August 31, 2026**. Continuous Delivery will be discontinued in the following regions on 12 February 2027: **au-syd**, **ca-mon**, **ca-tor**, **us-east**. Code Risk Analyzer will also be discontinued in all regions on that date. If a region has no active usage of these features, the features in that region may be discontinued earlier and stop accepting new instances. [Learn more](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-faq_region_feature_consolidation&format=markdown)
{: important}

Delivery Pipeline Private Worker connects with one or more private workers that run Delivery Pipeline workloads in isolation.
{: shortdesc}

Configure the Delivery Pipeline Private Worker tool integration to make private workers available to pipelines in a toolchain:

1. If you are configuring this tool integration as you are creating the toolchain, in the Configurable Integrations section, click **Delivery Pipeline Private Worker**.
1. If you have a toolchain and are adding this tool integration to it, from the IBM Cloud console, click the **Menu** icon ![hamburger icon](images/icon_hamburger.svg) > **Platform Automation** > **Toolchains**. On the Toolchains page, click the toolchain to open its Overview page. 

   a. Click **Add tool**.

   b. In the Tool Integrations section, click **Delivery Pipeline Private Worker**.

1. Type a name for the tool integration. This name identifies a pool of private workers in the **Workers** tab of the pipeline stage.
1. Type your Service ID API key to authenticate access to the work queue where one or more private workers can look for work. If you don't have a Service ID API key, click **Create** to generate one for this private worker.
1. Click **Create Integration**.
1. From your toolchain, on the **Delivery pipelines** card, click the **Delivery Pipeline Private Worker** to view a list of all of the workers that are registered by using an API key that is associated with this Service ID.

## Configuring Delivery Pipeline Private Worker by using the API
{: #private-worker-config-parameters}

The Delivery Pipeline Private Worker tool integration supports the following configuration parameters that you can use with the [Toolchain HTTP API and SDKs](https://cloud.ibm.com/apis/toolchain){: external} when you [create](https://cloud.ibm.com/apis/toolchain#create-tool){: external}, [read](https://cloud.ibm.com/apis/toolchain#get-tool-by-id){: external}, and [update](https://cloud.ibm.com/apis/toolchain#update-tool){: external} tool integrations. 

You must specify the `tool_type_id` property in the request body with the `private_worker` value.
{: important}

| Parameter | Usage | Type | Terraform argument | Description |
| --- | --- | --- | --- | --- |
| name | required, updatable | String | name | The name of this tool integration. |
| workerQueueCredentials | required, updatable | Password | worker_queue_credentials | The service ID API key that is used by the private worker to authenticate access to the work queue. You can use a toolchain secret reference for this parameter. For more information about secret references, see [Protecting your sensitive data in Continuous Delivery](https://cloud.ibm.com/docs/ContinuousDelivery?topic=ContinuousDelivery-cd_data_security&format=markdown#cd_secure_credentials). |
| workerQueueIdentifier | optional, updatable | String | worker_queue_identifier | The service ID that identifies the run request queue for this private worker. |
{: caption="Delivery Pipeline Private Worker tool integration parameters" caption-side="bottom"}