Undeploy an API instance

You can use the Undeploy option when you want to remove the API instance configuration from an ADC instance but keep the API instance objects in Citrix ADM as draft. This action sets the deployment status to In Draft. And, it can be applied only to the deployed API instance configurations.

Important

  • Before you undeploy an API deployment, make sure all the associated API policies are undeployed or deleted. See, Undeploy an API policy.

  • Before you undeploy an API proxy, make sure all the associated API deployments are undeployed or deleted. See, Undeploy an API Deployment.

Undeploy an API policy

Follow the steps to undeploy an API policy:

  1. In Security > API Gateway > Policies, select the policy that you want to undeploy.

  2. Click Undeploy.

This action sets the Policy Status to In Draft.

Undeploy an API deployment

Follow the steps to undeploy an API deployment:

  1. In Security > API Gateway > API Deployments, select the API deployment that you want to undeploy.

    Note

    Ensure all the associated policies of the selected deployment are undeployed or deleted.

  2. Click Undeploy.

This action sets the Deployment Status to In Draft.

Undeploy an API proxy

Follow the steps to undeploy an API proxy:

  1. In Security > API Gateway > API Proxies, select the API proxy that you want to undeploy.

    Note

    You can share an API proxy with different API deployments. So, ensure all the associated deployments of the selected proxy are undeployed or deleted.

  2. Click Undeploy.

This action sets the Proxy Status to In Draft.

Example scenario

This example describes how to undeploy an example API policy, deployment, and proxy.

Example: Undeploy API instance

Undeploy an API instance