---
name: watsonx-code-assistant-cloud-setup-z
title: Setting up your watsonx Code Assistant for Z service in IBM Cloud
description: Set up your IBM Cloud service instance of watsonx Code Assistant for Z so you can use it with your full installation of the product.
last-updated: 2025-12-15
---

> ## Documentation Index
> The table of contents for this documentation set is at https://cloud.ibm.com/docs/watsonx-code-assistant?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.

# Setting up your watsonx Code Assistant for Z service in IBM Cloud
{: #cloud-setup-z}

[watsonx Code Assistant for Z]{: tag-dark-teal}

Set up your IBM Cloud service instance of watsonx Code Assistant for Z so you can use it with your full installation of the product.
{: shortdesc}

## Before you begin
{: #prereqs-z}

- Make sure that you have an [IBM Cloud account](https://cloud.ibm.com/registration/){: external}.

- Provision an instance of watsonx Code Assistant for Z through the [IBM Cloud catalog](https://cloud.ibm.com/catalog/services/ibm-watsonx-code-assistant){: external} page or by working with an IBM sales representative. 

   The service is available in these data centers:
   - Dallas (`us-south`)
   - Frankfurt (`eu-de`)
   
   For more information about data centers, see the IBM Cloud documentation for [Service and infrastructure availability by location](https://cloud.ibm.com/docs/overview?topic=overview-services_region&format=markdown){: external}.

- Download the most recent `IBM watsonx Code Assistant for Z Multiplatform Multilingual eAssembly` from [IBM Passport Advantage](https://www.ibm.com/software/passportadvantage/){: external}.

When you finish provisioning your instance, click **Setup** to open an onboarding checklist page to help you configure the instance. Or, you can select **Administration** and then **Setup** to access this onboarding checklist.

Items in that checklist correspond to each of the following steps. Click the action arrows on the checklist page that are associated with each item to complete the steps.

## Create a service ID
{: #service-id}

Create a service ID that will be used to connect the deployment space to the watsonx Code Assistant service.

1. On the [Service IDs](https://cloud.ibm.com/iam/serviceids){: external} page, click **Create**.

1. Enter `IBM watsonx Code Assistant user` as the name for your service ID. Optionally, enter a description.

1. Click **Create**.

   You are redirected to the dashboard for your service ID, which includes tabs for **Access** and **API keys**.

## Create a deployment space
{: #deploy_space-z}

The deployment space is the serving environment for watsonx Code Assistant.

1. In your watsonx Code Assistant instance, click the **Navigation Menu** ![Navigation Menu](images/menu.svg) icon, then select **Deployments**.

1. Click **New deployment space**.

1. Enter `Code Assistant` as the name for your deployment space. Optionally, enter a description.

1. In **Code assistant service**, select your instance.

1. Click **Create**.

1. A status window appears. After the space is created, click **Close**.

## Add the service ID as a space collaborator
{: #space_collab_z}

Enable the API to connect to your deployment space.

1. On the **Manage** tab of your deployment space, click **Access control**.

1. Click **Add collaborators** and select **Add service IDs** from the menu.

   A list of service IDs that are associated with your account appears.

1. Click the checkbox for the **IBM watsonx Code Assistant user** service ID that you created, and select **Editor** for the role.

1. Click **Add**.

   The service ID is added to the list of collaborators.

## Generate an API key
{: #apikey}

You need an API key to get Visual Studio Code to communicate with watsonx Code Assistant.

1. Navigate to the dashboard for your service ID. Find and click the **API keys** tab, then click **Create**.

1. Enter `IBM watsonx Code Assistant API key` as the name for your API key. Optionally, enter a description. Click **Create**.

1. Click **Download** or **Copy** and store the API key in a safe location.

   The key is only available for 296 seconds after creation. Make sure to store it somewhere you can find it later.
   {: important}

For more information on adding users and managing access, see [Managing IAM access for watsonx Code Assistant for Z](https://cloud.ibm.com/docs/watsonx-code-assistant?topic=watsonx-code-assistant-wca-iam&format=markdown).

## Set up your network
{: #cloud-setup-z-network-setup}

To ensure that your developers can connect the IDE extension or plug-in, you need to allow access to IBM Cloud URLs. Make sure your organization's network allows access to:

- `https://iam.cloud.ibm.com/`
- `https://api.dataplatform.cloud.ibm.com/`

## Next steps
{: #next_steps_z}

You deployed and connected your IBM Cloud components to your provisioned watsonx Code Assistant instance. You're ready to take your next steps and integrate with your IBM Z Open Editor in Visual Studio Code. For information, see [Set up a development environment](https://www.ibm.com/docs/en/watsonx/watsonx-code-assistant-4z/latest?topic=transform-set-up-development-environment){: external}.