# CH2 Management API

Manage Private Spaces, connections, egress and ingress configurations, IAM roles, and logs for CloudHub 2.0.

- **Version:** 1.0.0
- **Category:** Runtime
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/cloudhub-20/api.yaml)

## Servers
- `https://anypoint.mulesoft.com/runtimefabric/api`
- `https://{region}.anypoint.mulesoft.com/runtimefabric/api`
- `https://{region}.platform.mulesoft.com/runtimefabric/api`

## Operations (55)
### GET /organizations/{organizationId}/privatespaces

**Operation ID:** `getOrganizationsByOrganizationidPrivatespaces`
get the list of Private Spaces in the organization.

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

### POST /organizations/{organizationId}/privatespaces

**Operation ID:** `createOrganizationsByOrganizationidPrivatespaces`
create a Private Space

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

### GET /organizations/{organizationId}/privatespaces/supportedVpnConfigs

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesSupportedvpnconfigs`
get supported vpn configs

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

### GET /organizations/{organizationId}/privatespaces/monthlypatchwindow

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesMonthlypatchwindow`
get the latest upcoming monthly patch window schedule

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

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceid`
get the Private Space

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceid`
Update existing Private Space

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceid`
delete the Private Space

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/associations

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociations`
get all associations of a private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### POST /organizations/{organizationId}/privatespaces/{privateSpaceId}/associations

**Operation ID:** `createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociations`
create associations for Private space with business groups and environments

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/associations/{associationId}

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociationsByAssociationid`
get a specific associations of a private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `associationId` | query | The association ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/associations/{associationId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociationsByAssociationid`
delete an association

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `associationId` | query | The association ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/ports

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidPorts`
Get the next set of available ports.

**Parameters:**
| `available` | query | Return next free/available ports | required |
| `count` | query | Size of the available port list between 1 to 10 | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/iamroles

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidIamroles`
get the IAM roles associated with the space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/accounts

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAccounts`
get the AWS account Id a string value.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/upgrade

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidUpgrade`
Either upgrade now or (re)schedule an upgrade later

**Parameters:**
| `date` | query | The date query parameter. | optional |
| `optIn` | query | The optIn query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/upgrade

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidUpgrade`
cancel a scheduled upgrade

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/upgradestatus

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidUpgradestatus`
get the upgrade status of the space

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/egress

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgress`
get all egress rule groups of a private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### POST /organizations/{organizationId}/privatespaces/{privateSpaceId}/egress

**Operation ID:** `createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgress`
create an egress rule group

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/egress/{ruleGroupId}

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgressByRulegroupid`
get a specific egress rule group

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `ruleGroupId` | query | The ruleGroup ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/egress/{ruleGroupId}

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgressByRulegroupid`
Update egress rule group.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `ruleGroupId` | query | The ruleGroup ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/egress/{ruleGroupId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgressByRulegroupid`
delete egress rule group

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `ruleGroupId` | query | The ruleGroup ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/routes

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidRoutes`
get the list of CIDR's in the private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/routes

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidRoutes`
Update the CIDRs that the Cloudhub VPC will send traffic to via the IGW.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnections`
get the list of Connections inside the private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### POST /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections

**Operation ID:** `createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnections`
create a Private Space Connection

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/{connectionId}

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsByConnectionid`
get the Private Space Connection

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/{connectionId}

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsByConnectionid`
Update existing Private Space Connection

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/{connectionId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsByConnectionid`
delete the Private Space Connection

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `connectionId` | query | The connection ID to identify the target resource. | required |

### POST /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/vpns

**Operation ID:** `createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpns`
add a vpn to an existing connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/vpns/{vpnId}

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpnsByVpnid`
delete a vpn from a connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `vpnId` | query | The vpn ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/vpns/{vpnId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpnsByVpnid`
delete a vpn from a connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `vpnId` | query | The vpn ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/connections/vpns/{vpnId}/connectionGuide

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpnsByVpnidConnectionguide`
Retrieves a connectionGuide.

**Parameters:**
| `vendor` | query | The vendor query parameter. | required |
| `platform` | query | The platform query parameter. | required |
| `software` | query | The software query parameter. | required |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `vpnId` | query | The vpn ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways`
get list of TGW connections assocated with a private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### POST /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways

**Operation ID:** `createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways`
create a private space TGW connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways/{tgwId}

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwid`
Get the transitgateway
with id =
{transitgatewayId}


**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways/{tgwId}

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwid`
patch the Private Space TGW Connection

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways/{tgwId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwid`
Detach a Transit Gateway from the Private Space

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways/{tgwId}/routes

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwidRoutes`
get TGW routes configured to tgw connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways/{tgwId}/routes

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwidRoutes`
patch routes for a TGW connection.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/transitgateways/routes

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysRoutes`
get TGW routes configured to private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/tlsContexts

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontexts`
get the list of TLS contexts inside the private space.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### POST /organizations/{organizationId}/privatespaces/{privateSpaceId}/tlsContexts

**Operation ID:** `createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontexts`
create a TLS context

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/tlsContexts/{contextId}

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontextsByContextid`
get the TLS context

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `contextId` | query | The context ID to identify the target resource. | required |

### PATCH /organizations/{organizationId}/privatespaces/{privateSpaceId}/tlsContexts/{contextId}

**Operation ID:** `patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontextsByContextid`
Update an existing TLS context

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `contextId` | query | The context ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/privatespaces/{privateSpaceId}/tlsContexts/{contextId}

**Operation ID:** `deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontextsByContextid`
delete the TLS context

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |
| `contextId` | query | The context ID to identify the target resource. | required |

### GET /organizations/{organizationId}/privatespaces/{privateSpaceId}/logs/ingress

**Operation ID:** `getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidLogsIngress`
download ingress logs in ascending order

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `privateSpaceId` | query | The privateSpace ID to identify the target resource. | required |

### GET /organizations/{organizationId}/transitgateways

**Operation ID:** `getOrganizationsByOrganizationidTransitgateways`
get list of TGW connections assocated with an organization.

**Parameters:**
| `region` | query | The region query parameter. | optional |
| `privateSpaceId` | query | The privateSpace ID query parameter. | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |

### DELETE /organizations/{organizationId}/transitgateways/{tgwId}

**Operation ID:** `deleteOrganizationsByOrganizationidTransitgatewaysByTgwid`
Remove the Transit gateway from your Anypoint Platform organization

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

### GET /organizations/{organizationId}/transitgateways/{tgwId}/routes

**Operation ID:** `getOrganizationsByOrganizationidTransitgatewaysByTgwidRoutes`
get TGW routes configured for a gateway

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `tgwId` | query | The tgw ID to identify the target resource. | required |

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

**Operation ID:** `getOrganizationsByOrganizationidTargets`
get list of target deployments within an organization

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

### GET /organizations/{organizationId}/targets/{id}

**Operation ID:** `getOrganizationsByOrganizationidTargetsById`
get the target

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

### POST /organizations/{organizationId}/migration/vpcs/{vpcId}/privatespaces

**Operation ID:** `createOrganizationsByOrganizationidMigrationVpcsByVpcidPrivatespaces`
create an equivalent Private Space for provided Cloudhub VPC

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `vpcId` | query | The id of Cloudhub VPC to upgrade | required |

### GET /organizations/{organizationId}/migration/vpcs

**Operation ID:** `getOrganizationsByOrganizationidMigrationVpcs`
get Cloudhub VPCs upgrade eligibility information

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

### GET /organizations/{organizationId}/migration/vpcs/{vpcId}

**Operation ID:** `getOrganizationsByOrganizationidMigrationVpcsByVpcid`
get Cloudhub VPC upgrade eligibility information

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `vpcId` | query | The id of Cloudhub VPC | required |