# Proxies API

Manage API proxy deployments and deployment targets for CloudHub, CloudHub 2.0, and Runtime Fabric.

- **Version:** 1.0.0
- **Category:** Gateway
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/proxies-xapi/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/proxies/xapi/v1`
- `https://{region}.anypoint.mulesoft.com/proxies/xapi/v1`
- `https://{region}.platform.mulesoft.com/proxies/xapi/v1`

## Operations (15)
### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/proxy

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidProxy`
Gets a proxy.

**Parameters:**
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `gatewayVersion` | query | The gatewayVersion query parameter. | optional |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/active

**Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidActive`
Creates a active.

**Parameters:**
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/deployments

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeployments`
Retrieves a deployments.

**Parameters:**
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### POST /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/deployments

**Operation ID:** `createOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeployments`
Creates a deployments.

**Parameters:**
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/deployments/{proxyDeploymentId}

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentid`
Returns a deployment (And sync it with deployment targets)

**Parameters:**
| `proxyDeploymentId` | query | The proxyDeployment ID to identify the target resource. | required |
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `checkAutomatedPolicies` | query | The checkAutomatedPolicies query parameter. | optional |

### PUT /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/deployments/{proxyDeploymentId}

**Operation ID:** `updateOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentid`
Replaces a deployments.

**Parameters:**
| `proxyDeploymentId` | query | The proxyDeployment ID to identify the target resource. | required |
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `checkAutomatedPolicies` | query | The checkAutomatedPolicies query parameter. | optional |

### PATCH /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/deployments/{proxyDeploymentId}

**Operation ID:** `patchOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentid`
Updates a deployments.

**Parameters:**
| `proxyDeploymentId` | query | The proxyDeployment ID to identify the target resource. | required |
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `checkAutomatedPolicies` | query | The checkAutomatedPolicies query parameter. | optional |

### GET /organizations/{organizationId}/environments/{environmentId}/apis/{environmentApiId}/deployments/{proxyDeploymentId}/status

**Operation ID:** `getOrganizationsByOrganizationidEnvironmentsByEnvironmentidApisByEnvironmentapiidDeploymentsByProxydeploymentidStatus`
Retrieves the deployment details of a version (And sync it with deployment targets).

**Parameters:**
| `proxyDeploymentId` | query | The proxyDeployment ID to identify the target resource. | required |
| `environmentApiId` | query | The environmentApi ID to identify the target resource. | required |
| `environmentId` | query | The environment ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /organizations/{organizationId}/deployment-targets

**Operation ID:** `getOrganizationsByOrganizationidDeploymentTargets`
Retrieves a deployment targets.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID query parameter. | required |

### GET /organizations/{organizationId}/targets/{targetId}/runtimes/mule/versions

**Operation ID:** `getOrganizationsByOrganizationidTargetsByTargetidRuntimesMuleVersions`
Retrieves a versions.

**Parameters:**
| `targetId` | query | The target ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `operation` | query | The operation query parameter. | optional |

### GET /organizations/{organizationId}/providers/{providerId}/runtime-fabric-deployment-targets

**Operation ID:** `getOrganizationsByOrganizationidProvidersByProvideridRuntimeFabricDeploymentTargets`
Retrieves a runtime fabric deployment targets.

**Parameters:**
| `providerId` | query | The provider ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID query parameter. | required |

### GET /organizations/{organizationId}/providers/{providerId}/cloudhub2-deployment-targets

**Operation ID:** `getOrganizationsByOrganizationidProvidersByProvideridCloudhub2DeploymentTargets`
Retrieves a cloudhub2 deployment targets.

**Parameters:**
| `providerId` | query | The provider ID to identify the target resource. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `environmentId` | query | The environment ID query parameter. | required |
| `returnAllTargets` | query | The returnAllTargets query parameter. | optional |

### GET /ch-domains/{domainName}

**Operation ID:** `getChDomainsByDomainname`
Retrieves a ch domains.

**Parameters:**
| `domainName` | query | The domainName to identify the target resource. | required |

### GET /status/echo

**Operation ID:** `getStatusEcho`
Lists echo.

### GET /status/version

**Operation ID:** `getStatusVersion`
Retrieves the date and commit of the deployed version.


## Related Skills
- [secure-agent](https://dev-portal.mulesoft.com/skills/secure-agent.md) — Secure an agent by applying a policy from the catalog. Handles multiple
starting points: from an existing API Manager instance, from an agent asset
in Exchange, or from scratch by publishing the agent first. Use when the user
wants to secure an agent, add rate limiting, apply OAuth2, enforce IP
allowlisting, or protect any agent with a policy — regardless of where they
are in the setup process.
- [secure-api](https://dev-portal.mulesoft.com/skills/secure-api.md) — Secure an API by applying a policy from the catalog. Handles multiple starting
points: from an existing API Manager instance, from an Exchange asset that needs
an instance, or from scratch. Use when the user wants to secure an API, add
rate limiting, apply OAuth2, enforce IP allowlisting, or protect any API with
a policy — regardless of where they are in the setup process.
- [secure-mcp-server](https://dev-portal.mulesoft.com/skills/secure-mcp-server.md) — Secure an MCP server by applying a policy from the catalog. Handles multiple
starting points: from an existing API Manager instance, from an MCP server asset
in Exchange, or from scratch by publishing the MCP server first. Use when the user
wants to secure an MCP server, add rate limiting, apply OAuth2, enforce IP
allowlisting, or protect any MCP server with a policy — regardless of where they
are in the setup process.