CH2 Management API

Get Organizations By Organizationid Privatespaces getOrganizationsByOrganizationidPrivatespaces

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get the list of Private Spaces in the organization.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful operation.

Examples

application/json

{}

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Create Organizations By Organizationid Privatespaces createOrganizationsByOrganizationidPrivatespaces

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

create a Private Space

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body

json

name *: string

The name of the Private Space.

flavor: string

The flavor of the Private Space.

environments: object

Environment association for the Private Space

network: object

Private space network configuration

region: string

The region of the Private Space. Required when create a Private Space network.

vpcId: string

The existing VPC where the Private Space will be created. Required when create a Private Space in existing Anypoint VPC.

cidrBlock: string

The CIDR block of the VPC where the Private Space will be created. Required when create a Private Space in a new VPC.
Default is 10.0.0.0/16.

default: 10.0.0.0/16

reservedCidrs: array

The list of reserved CIDR blocks for your private space to prevent IP address overlap. Required when you want
to connect your private space to your corporate network (either on-premises or in the cloud). Use CIDR notation
and commas: 192.168.0.0/16, 172.16.0.0/12.

internalDns: object

The internal DNS config of the VPC that the Private Space uses.

managedFirewallRules: array

Deprecated

firewallRules: array

The firewall rules for the Private Space

Response

Resource created successfully.

Examples

application/json

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Privatespaces Supportedvpnconfigs getOrganizationsByOrganizationidPrivatespacesSupportedvpnconfigs

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get supported vpn configs

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful operation.

Get Organizations By Organizationid Privatespaces Monthlypatchwindow getOrganizationsByOrganizationidPrivatespacesMonthlypatchwindow

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get the latest upcoming monthly patch window schedule

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successful operation.

releaseYear *: integer

Year of monthly patch releases

releaseMonth *: string

Patch release month

sandboxStartDate *: string

Start date for monthly patching in sandbox spaces

sandboxEndDate *: string

End date for monthly patching in sandbox spaces

productionStartDate *: string

Start date for monthly patching in production spaces

productionEndDate *: string

End date for monthly patching in production spaces

Examples

application/json

{ "releaseYear": 2024, "releaseMonth": "MARCH", "sandboxStartDate": "2024-03-18T00:00:00+00:00", "sandboxEndDate": "2024-03-22T23:59:59.999000+00:00", "productionStartDate": "2024-03-23T00:00:00+00:00", "productionEndDate": "2024-03-24T23:59:59.999000+00:00" }

Get Organizations By Organizationid Privatespaces By Privatespaceid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceid

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get the Private Space

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

Successful operation.

Examples

application/json

{}

Patch Organizations By Organizationid Privatespaces By Privatespaceid patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceid

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update existing Private Space

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

environments *: object

Environment association for the Private Space

network *: object

Private space network configuration

region: string

The region of the Private Space. Required when create a Private Space network.

vpcId: string

The existing VPC where the Private Space will be created. Required when create a Private Space in existing Anypoint VPC.

cidrBlock: string

The CIDR block of the VPC where the Private Space will be created. Required when create a Private Space in a new VPC.
Default is 10.0.0.0/16.

default: 10.0.0.0/16

reservedCidrs: array

The list of reserved CIDR blocks for your private space to prevent IP address overlap. Required when you want
to connect your private space to your corporate network (either on-premises or in the cloud). Use CIDR notation
and commas: 192.168.0.0/16, 172.16.0.0/12.

internalDns: object

The internal DNS config of the VPC that the Private Space uses.

managedFirewallRules: array

Deprecated

firewallRules *: array

The firewall rules for the Private Space

logForwarding *: object

Private space log forwarding configuration

ingressConfiguration *: object

Private space ingress configuration

readResponseTimeout: integer

default: 300, min: 1, max: 3600

logs: object

Ingress log level configuration

protocol: string

default: https-redirect

deployment: object

isIstioIngressEnabled: boolean

default: False

isLoggingEnabledForIstio: boolean

default: False

enableIAMRole: boolean

If true, application deployed to this space will have the Private Space IAM role attached to the service account.

enableEgress: boolean

edgeHpaConfigs: object

hpa config for edge pods in rtf namespace

Response

application/json

[ { "id": "d282e462-07af-4146-b7d8-8bd7e6b18d83", "environmentId": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" }, { "id": "79810eb2-c999-4104-b650-31ea2962a200", "environmentId": "3e9d5bde-6ef7-4947-9f98-0f7c32d48909", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" } ]

Create Organizations By Organizationid Privatespaces By Privatespaceid Associations createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociations

POST

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

create associations for Private space with business groups and environments

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

associations *: array

List of associations

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "d282e462-07af-4146-b7d8-8bd7e6b18d83", "environmentId": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" }, { "id": "79810eb2-c999-4104-b650-31ea2962a200", "environmentId": "3e9d5bde-6ef7-4947-9f98-0f7c32d48909", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" } ]

Get Organizations By Organizationid Privatespaces By Privatespaceid Associations By Associationid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociationsByAssociationid

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

associationId *

Custom Query Parameters

Custom Headers

get a specific associations of a private space.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

associationId *: string

The association ID to identify the target resource.

Response

json

Successful operation.

id *: string

The UUID of the association.

name: string

environmentId *: string

The type of environment. Can be all, sandbox, production, or a specific environment UUID.

organizationId *: string

The type of organization. Can be all, or specific organization UUID.

deploymentStatus: string

errorMessage: string

Examples

application/json

{ "id": "d282e462-07af-4146-b7d8-8bd7e6b18d83", "environmentId": "2ea3eff9-569a-4495-b7b6-1e28c6440aeb", "organizationId": "1ffdaa42-4702-4747-aeb9-aecab0f5ac1b" }

Delete Organizations By Organizationid Privatespaces By Privatespaceid Associations By Associationid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociationsByAssociationid

DELETE

Try it out

Path Parameters

organizationId *

privateSpaceId *

associationId *

Custom Query Parameters

Custom Headers

delete an association

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

associationId *: string

The association ID to identify the target resource.

Response

Successful operation.

Get Organizations By Organizationid Privatespaces By Privatespaceid Ports getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidPorts

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Query Parameters

available *

count *

Custom Query Parameters

Custom Headers

Get the next set of available ports.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Query Parameters

available *: boolean

Return next free/available ports

default: False

count *: integer

Size of the available port list between 1 to 10

default: 1, max: 10

Response

json

Successful operation.

ports *: array

List of the ports to be leased by the owner

Examples

application/json

{ "ports": [ 0 ] }

Get Organizations By Organizationid Privatespaces By Privatespaceid Iamroles getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidIamroles

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get the IAM roles associated with the space.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

json

Successful operation.

roles *: array

IAM roles associated with the space

organizationId *: string

The parent organization ID of the space

spaceId *: string

id of the space.

message: string

IAM roles associated with the space

Examples

application/json

{ "roles": [ "string" ], "organizationId": "string", "spaceId": "string", "message": "string" }

Get Organizations By Organizationid Privatespaces By Privatespaceid Accounts getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAccounts

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get the AWS account Id a string value.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

Successful operation.

Patch Organizations By Organizationid Privatespaces By Privatespaceid Upgrade patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidUpgrade

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

Query Parameters

date

optIn *

Custom Query Parameters

Custom Headers

Either upgrade now or (re)schedule an upgrade later

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Query Parameters

date: string

The date query parameter.

optIn *: boolean

The optIn query parameter.

Response

json

Successful operation.

scheduledUpdateTime: string

Date of scheduled upgrade

status *: string

scheduledUpdateTime: string

Date of scheduled upgrade

status *: string

The status of the upgrade

Examples

application/json

{ "scheduledUpdateTime": "2024-02-28T17:57:36+00:00", "status": "QUEUED" }

Get Organizations By Organizationid Privatespaces By Privatespaceid Egress getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgress

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get all egress rule groups of a private space.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

json

Successful operation.

items: array

Array items

Examples

application/json

[ { "id": "65f106d7-5e39-474d-8224-28d92d00b210", "name": "example-rule-group", "rules": [ { "domains": [ "example.com" ], "protocol": "tcp", "fromPort": 1, "toPort": 65535, "description": "" } ] } ]

Create Organizations By Organizationid Privatespaces By Privatespaceid Egress createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgress

POST

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

create an egress rule group

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

name *: string

The name of the rule group.

rules: array

Response

json

Successful operation.

id *: string

name *: string

The name of the rule group.

rules: array

isDefault: boolean

Examples

application/json

{ "id": "string", "name": "string", "rules": [ { "id": "string", "type": "string" } ], "isDefault": true }

Get Organizations By Organizationid Privatespaces By Privatespaceid Egress By Rulegroupid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgressByRulegroupid

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

ruleGroupId *

Custom Query Parameters

Custom Headers

get a specific egress rule group

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

ruleGroupId *: string

The ruleGroup ID to identify the target resource.

Response

json

Successful operation.

id *: string

name *: string

The name of the rule group.

rules: array

isDefault: boolean

Examples

application/json

{ "id": "string", "name": "string", "rules": [ { "id": "string", "type": "string" } ], "isDefault": true }

Patch Organizations By Organizationid Privatespaces By Privatespaceid Egress By Rulegroupid patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgressByRulegroupid

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

ruleGroupId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update egress rule group.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

ruleGroupId *: string

The ruleGroup ID to identify the target resource.

Request Body

json

name *: string

The name of the rule group.

rules: array

Response

json

Successful operation.

id *: string

name *: string

The name of the rule group.

rules: array

isDefault: boolean

Examples

application/json

{ "id": "string", "name": "string", "rules": [ { "id": "string", "type": "string" } ], "isDefault": true }

Delete Organizations By Organizationid Privatespaces By Privatespaceid Egress By Rulegroupid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidEgressByRulegroupid

DELETE

Try it out

Path Parameters

organizationId *

privateSpaceId *

ruleGroupId *

Custom Query Parameters

Custom Headers

delete egress rule group

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

ruleGroupId *: string

The ruleGroup ID to identify the target resource.

Response

Successful operation.

Get Organizations By Organizationid Privatespaces By Privatespaceid Routes getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidRoutes

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get the list of CIDR's in the private space.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

json

Successful operation.

items: array

Array items

destination *: string

Destination of the configured route on vpc or vpn.

status *: string

Status of the configured route on vpc or vpn.

target *: string

Target type of the configured route on vpc or vpn.

connectionName: string

Connection name of the configured route on vpc or vpn.

connectionId: string

Connection id of the configured route on vpc or vpn.

errorLevel: string

Connection name of the configured route on vpc or vpn.

errorMessage: string

Connection name of the configured route on vpc or vpn.

Examples

application/json

[ { "id": "string", "type": "string" } ]

Patch Organizations By Organizationid Privatespaces By Privatespaceid Routes patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidRoutes

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

Update the CIDRs that the Cloudhub VPC will send traffic to via the IGW.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

networkGateways *: array

The CIDRs that the Cloudhub VPC will send traffic to via the IGW.

default: []

Response

json

Request accepted for processing.

items: array

Array items

destination *: string

Destination of the configured route on vpc or vpn.

status *: string

Status of the configured route on vpc or vpn.

target *: string

Target type of the configured route on vpc or vpn.

connectionName: string

Connection name of the configured route on vpc or vpn.

connectionId: string

Connection id of the configured route on vpc or vpn.

errorLevel: string

Connection name of the configured route on vpc or vpn.

errorMessage: string

Connection name of the configured route on vpc or vpn.

Examples

application/json

[ { "id": "string", "type": "string" } ]

Get Organizations By Organizationid Privatespaces By Privatespaceid Connections getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnections

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get the list of Connections inside the private space.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

Successful operation.

Examples

application/json

{}

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Create Organizations By Organizationid Privatespaces By Privatespaceid Connections createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnections

POST

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

create a Private Space Connection

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

name *: string

vpns *: array

Response

Resource created successfully.

Examples

application/json

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Privatespaces By Privatespaceid Connections By Connectionid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsByConnectionid

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

connectionId *

Custom Query Parameters

Custom Headers

get the Private Space Connection

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

connectionId *: string

The connection ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnections.$.id

Response

The CIDRs that the Cloudhub VPC will send traffic to via the VPN.

default: []

Response

json

Successful operation.

id *: string

name *: string

vpns *: array

Examples

application/json

{ "id": "string", "name": "string", "vpns": [ { "id": "string", "type": "string" } ] }

Delete Organizations By Organizationid Privatespaces By Privatespaceid Connections By Connectionid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsByConnectionid

DELETE

Try it out

Path Parameters

organizationId *

privateSpaceId *

connectionId *

Custom Query Parameters

Custom Headers

delete the Private Space Connection

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

connectionId *: string

The connection ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnections.$.id

Response

Successful operation.

Create Organizations By Organizationid Privatespaces By Privatespaceid Connections Vpns createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpns

POST

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

add a vpn to an existing connection.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

Resource created successfully.

Examples

application/json

{}

Patch Organizations By Organizationid Privatespaces By Privatespaceid Connections Vpns By Vpnid patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpnsByVpnid

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

vpnId *

Custom Query Parameters

Custom Headers

Request Body application/json

delete a vpn from a connection.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

vpnId *: string

The vpn ID to identify the target resource.

Request Body

json

id *: string

name: string

remoteAsn: number

The ASN of the customer's outside network, used by VPNs utilizing BGP for routes.

localAsn: number

The ASN of the customer's cloudhub network, used by VPNs utilizing BGP for routes.

remoteIpAddress *: string

The IP address of the customer's VPN device on their outside network

staticRoutes *: array

The CIDRs that the Cloudhub VPC will send traffic to via the VPN.

default: []

vpnTunnels *: array

VPN tunnel configuration that the customer wants to be applied to their VPN connection.

default: []

Response

json

Successful operation.

id *: string

name: string

remoteAsn: number

The ASN of the customer's outside network, used by VPNs utilizing BGP for routes.

localAsn: number

The ASN of the customer's cloudhub network, used by VPNs utilizing BGP for routes.

remoteIpAddress *: string

The IP address of the customer's VPN device on their outside network

staticRoutes *: array

The CIDRs that the Cloudhub VPC will send traffic to via the VPN.

default: []

vpnTunnels *: array

VPN tunnel configuration that the customer wants to be applied to their VPN connection.

default: []

Examples

application/json

{ "id": "string", "name": "string", "remoteAsn": 0.0, "localAsn": 0.0, "remoteIpAddress": "string", "staticRoutes": [ "string" ], "vpnTunnels": [ { "id": "string", "type": "string" } ] }

Delete Organizations By Organizationid Privatespaces By Privatespaceid Connections Vpns By Vpnid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpnsByVpnid

DELETE

Try it out

Path Parameters

organizationId *

privateSpaceId *

vpnId *

Custom Query Parameters

Custom Headers

delete a vpn from a connection.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

vpnId *: string

The vpn ID to identify the target resource.

Response

Successful operation.

Get Organizations By Organizationid Privatespaces By Privatespaceid Connections Vpns By Vpnid Connectionguide getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidConnectionsVpnsByVpnidConnectionguide

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

vpnId *

Query Parameters

vendor *

platform *

software *

Custom Query Parameters

Custom Headers

Retrieves a connectionGuide.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

vpnId *: string

The vpn ID to identify the target resource.

Query Parameters

vendor *: string

The vendor query parameter.

platform *: string

The platform query parameter.

software *: string

The software query parameter.

Response

Successful operation.

Get Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

get list of TGW connections assocated with a private space.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Response

Successful operation.

Examples

application/json

{}

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Create Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways

POST

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

create a private space TGW connection.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

name *: string

resourceShareId *: string

resourceShareAccount *: string

routes *: array

Response

Resource created successfully.

Examples

application/json

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways By Tgwid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwid

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

tgwId *

Custom Query Parameters

Custom Headers

Get the transitgateway
with id =
{transitgatewayId}

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways.$.id

Response

Successful operation.

Examples

application/json

{}

Patch Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways By Tgwid patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwid

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

tgwId *

Custom Query Parameters

Custom Headers

Request Body application/json

patch the Private Space TGW Connection

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways.$.id

Request Body

json

name *: string

Response

json

Successful operation.

id *: string

name *: string

accountId: string

spec *: object

status *: object

Examples

application/json

{ "id": "string", "name": "string", "accountId": "string", "spec": { "id": "string", "type": "string" }, "status": { "id": "string", "type": "string" } }

Delete Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways By Tgwid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwid

DELETE

Try it out

Path Parameters

organizationId *

privateSpaceId *

tgwId *

Custom Query Parameters

Custom Headers

Detach a Transit Gateway from the Private Space

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways.$.id

Response

Successful operation.

Get Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways By Tgwid Routes getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwidRoutes

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

tgwId *

Custom Query Parameters

Custom Headers

get TGW routes configured to tgw connection.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways.$.id

Response

Successful operation.

Patch Organizations By Organizationid Privatespaces By Privatespaceid Transitgateways By Tgwid Routes patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgatewaysByTgwidRoutes

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

tgwId *

Custom Query Parameters

Custom Headers

Request Body application/json

patch routes for a TGW connection.

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTransitgateways.$.id

Request Body

json

items: array

Array items

Response

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Create Organizations By Organizationid Privatespaces By Privatespaceid Tlscontexts createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontexts

POST

Try it out

Path Parameters

organizationId *

privateSpaceId *

Custom Query Parameters

Custom Headers

Request Body application/json

create a TLS context

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

Request Body

json

Response

Resource created successfully.

Examples

application/json

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Privatespaces By Privatespaceid Tlscontexts By Contextid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontextsByContextid

GET

Try it out

Path Parameters

organizationId *

privateSpaceId *

contextId *

Custom Query Parameters

Custom Headers

get the TLS context

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

contextId *: string

The context ID to identify the target resource.

Response

Successful operation.

Examples

application/json

{}

Patch Organizations By Organizationid Privatespaces By Privatespaceid Tlscontexts By Contextid patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontextsByContextid

PATCH

Try it out

Path Parameters

organizationId *

privateSpaceId *

contextId *

Custom Query Parameters

Custom Headers

Update an existing TLS context

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

contextId *: string

The context ID to identify the target resource.

Response

json

Successful operation.

id *: string

name *: string

trustStore: object

keyStore *: object

type *: string

cn *: string

san *: array

alias: string

fileName *: string

name of the key store file

keyFileName: string

maxLength: 64

capathFileName: string

maxLength: 64

expirationDate: string

ciphers *: object

aes128GcmSha256 *: boolean

default: False

aes128Sha256 *: boolean

default: False

aes256GcmSha384 *: boolean

default: False

aes256Sha256 *: boolean

default: False

dheRsaAes128Sha256 *: boolean

default: False

dheRsaAes256GcmSha384 *: boolean

default: False

dheRsaAes256Sha256 *: boolean

default: False

ecdheEcdsaAes128GcmSha256 *: boolean

default: True

ecdheEcdsaAes256GcmSha384 *: boolean

default: True

ecdheRsaAes128GcmSha256 *: boolean

default: True

ecdheRsaAes256GcmSha384 *: boolean

default: True

ecdheEcdsaChacha20Poly1305 *: boolean

default: False

ecdheRsaChacha20Poly1305 *: boolean

default: False

dheRsaChacha20Poly1305 *: boolean

default: False

tlsAes256GcmSha384 *: boolean

default: True

tlsChacha20Poly1305Sha256 *: boolean

default: True

tlsAes128GcmSha256 *: boolean

default: True

type: string

"custom" TLS context is managed by users, whereas "default" is managed by Cloudhub 2.0

Examples

application/json

{ "id": "string", "name": "string", "trustStore": { "id": "string", "type": "string" }, "keyStore": { "id": "string", "type": "string" }, "ciphers": { "id": "string", "type": "string" }, "type": "string" }

Delete Organizations By Organizationid Privatespaces By Privatespaceid Tlscontexts By Contextid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidTlscontextsByContextid

DELETE

Try it out

Path Parameters

organizationId *

privateSpaceId *

contextId *

Custom Query Parameters

Custom Headers

delete the TLS context

Path Parameters

organizationId *: string

The Organization id where the Private Space lives.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

privateSpaceId *: string

The privateSpace ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidPrivatespaces.$.id

contextId *: string

The context ID to identify the target resource.

Response

region

privateSpaceId

Custom Query Parameters

Custom Headers

get list of TGW connections assocated with an organization.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

region: string

The region query parameter.

privateSpaceId: string

The privateSpace ID query parameter.

Response

Successful operation.

Examples

application/json

{}

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Delete Organizations By Organizationid Transitgateways By Tgwid deleteOrganizationsByOrganizationidTransitgatewaysByTgwid

DELETE

Try it out

Path Parameters

organizationId *

tgwId *

Custom Query Parameters

Custom Headers

Remove the Transit gateway from your Anypoint Platform organization

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidTransitgateways.$.id

Response

Successful operation.

Get Organizations By Organizationid Transitgateways By Tgwid Routes getOrganizationsByOrganizationidTransitgatewaysByTgwidRoutes

GET

Try it out

Path Parameters

organizationId *

tgwId *

Custom Query Parameters

Custom Headers

get TGW routes configured for a gateway

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

tgwId *: string

The tgw ID to identify the target resource.

Related Operations:

cloudhub-20#getOrganizationsByOrganizationidTransitgateways.$.id

Response

Successful operation.

Get Organizations By Organizationid Targets getOrganizationsByOrganizationidTargets

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get list of target deployments within an organization

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful operation.

Examples

application/json

{}

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Targets By Id getOrganizationsByOrganizationidTargetsById

GET

Try it out

Path Parameters

organizationId *

id *

Custom Query Parameters

Custom Headers

get the target

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

id *: string

The id to identify the target resource.

Response

json

Successful operation.

id *: string

name *: string

version *: string

The version of the target.

type *: string

The type of the target.

vendor: string

The Kubernetes vendor of the Runtime Fabric.

runtimes *: array

egressRuleGroups: array

status *: string

environments: array

If present determines if the target is restricted to a particular set of environments. If it is restricted to all environments then an empty list has to be provided. If not present then there is not target restriction over an environment.

isAvailableForDeployments *: boolean

Determines if a deployment can be perfomed in a particular target.

replicationStrategies: object

Replication Strategies for this target per deployment type.

nodes *: array

defaults: object

Default deployment settings for this target

enhancedSecurity: boolean

Flag for whether the target supports enhanced security features.

featureFlags: object

Supported Feature flags for the target

region *: string

Target Region

Examples

application/json

{ "id": "string", "name": "string", "version": "string", "type": "string", "vendor": "string", "runtimes": [ { "id": "string", "type": "string" } ], "egressRuleGroups": [ { "id": "string", "type": "string" } ], "status": "string", "environments": [ "string" ], "isAvailableForDeployments": true }

Create Organizations By Organizationid Migration Vpcs By Vpcid Privatespaces createOrganizationsByOrganizationidMigrationVpcsByVpcidPrivatespaces

POST

Try it out

Path Parameters

organizationId *

vpcId *

Custom Query Parameters

Custom Headers

Request Body application/json

create an equivalent Private Space for provided Cloudhub VPC

Path Parameters

organizationId *: string

The Organization id where the Cloudhub VPC lives

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

vpcId *: string

The id of Cloudhub VPC to upgrade

Related Operations:

cloudhub-20#GET /organizations/{organizationId}/migration/vpcs.$.id

Request Body

json

name *: string

The name of the private space

reservedCidrs: array

The list of reserved CIDR blocks for your private space to prevent IP address overlap. Required when you want
to connect your private space to your corporate network (either on-premises or in the cloud). Use CIDR notation
and commas: 192.168.0.0/16, 172.16.0.0/12.

Response

Resource created successfully.

Examples

application/json

{}

Bad Request.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Forbidden. The authenticated user lacks the required permissions.

Conflict. The request conflicts with the current state of the resource.

Unsupported media type.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Too many requests. Rate limit exceeded.

message *: string

Human readable error description.

errors: array

Error list use to describe the set of validations that has failed. Only required in case
HTTP error code is not enough to describe the failure case.

Examples

application/json

{ "message": "string", "errors": [ { "code": "string", "message": "string" } ] }

Get Organizations By Organizationid Migration Vpcs getOrganizationsByOrganizationidMigrationVpcs

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

get Cloudhub VPCs upgrade eligibility information

Path Parameters

organizationId *: string

The Organization id where the Cloudhub VPC lives

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

Successful operation.

Get Organizations By Organizationid Migration Vpcs By Vpcid getOrganizationsByOrganizationidMigrationVpcsByVpcid

GET

Try it out

Path Parameters

organizationId *

vpcId *

Custom Query Parameters

Custom Headers

get Cloudhub VPC upgrade eligibility information

Path Parameters

organizationId *: string

The Organization id where the Cloudhub VPC lives

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

vpcId *: string

The id of Cloudhub VPC

Related Operations:

cloudhub-20#GET /organizations/{organizationId}/migration/vpcs.$.id

Response

Successful operation.

Overview

Servers

Authentication & Security

Get Organizations By Organizationid Privatespaces getOrganizationsByOrganizationidPrivatespaces

Try it out

Response

Path Parameters

Response

Create Organizations By Organizationid Privatespaces createOrganizationsByOrganizationidPrivatespaces

Try it out

Response

Path Parameters

Request Body

Response

Get Organizations By Organizationid Privatespaces Supportedvpnconfigs getOrganizationsByOrganizationidPrivatespacesSupportedvpnconfigs

Try it out

Response

Path Parameters

Response

Get Organizations By Organizationid Privatespaces Monthlypatchwindow getOrganizationsByOrganizationidPrivatespacesMonthlypatchwindow

Try it out

Response

Path Parameters

Response

Get Organizations By Organizationid Privatespaces By Privatespaceid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceid

Try it out

Response

Path Parameters

Response

Patch Organizations By Organizationid Privatespaces By Privatespaceid patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceid

Try it out

Response

Path Parameters

Request Body

Response

Delete Organizations By Organizationid Privatespaces By Privatespaceid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceid

Try it out

Response

Path Parameters

Response

Get Organizations By Organizationid Privatespaces By Privatespaceid Associations getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociations

Try it out

Response

Path Parameters

Response

Create Organizations By Organizationid Privatespaces By Privatespaceid Associations createOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociations

Try it out

Response

Path Parameters

Request Body

Response

Get Organizations By Organizationid Privatespaces By Privatespaceid Associations By Associationid getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociationsByAssociationid

Try it out

Response

Path Parameters

Response

Delete Organizations By Organizationid Privatespaces By Privatespaceid Associations By Associationid deleteOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAssociationsByAssociationid

Try it out

Response

Path Parameters

Response

Get Organizations By Organizationid Privatespaces By Privatespaceid Ports getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidPorts

Try it out

Response

Path Parameters

Query Parameters

Response

Get Organizations By Organizationid Privatespaces By Privatespaceid Iamroles getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidIamroles

Try it out

Response

Path Parameters

Response

Get Organizations By Organizationid Privatespaces By Privatespaceid Accounts getOrganizationsByOrganizationidPrivatespacesByPrivatespaceidAccounts

Try it out

Response

Path Parameters

Response

Patch Organizations By Organizationid Privatespaces By Privatespaceid Upgrade patchOrganizationsByOrganizationidPrivatespacesByPrivatespaceidUpgrade

Try it out