OpenAPI Specification
openapi: 3.0.0
info:
contact:
name: Customer Experience Engineering (CXE)
url: https://www.acquia.com
description: "Acquia Cloud API\n\n# Compatibility\n\n## Stability\n\nThe response for all resource endpoints includes an `X-CloudAPI-Stability` header that indicates what changes, if any, Acquia will make to the resource and how changes will be communicated.\n\nThere are three levels of stability:\n\n* `prototype`: A prototype resource is experimental and major changes are likely. A prototype resource may not reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one week notice\n * Deprecated resources will remain available for at least one month after deprecation\n* `development`: A resource that is unlikely to change, but is still being worked on, will be marked as in development. These resources are very likely to reach production.\n * Compatible and emergency changes may be made with no advance notice\n * Disruptive changes may be made with one month notice\n * Deprecated resources will remain available for at least six months after deprecation\n* `production`: A production resource will not introduce breaking changes within a version, and any breaking changes between versions will be communicated ahead of time.\n\n## Deprecation\n\nOver time, endpoints may become obsolete and will be removed in the future. These endpoints will be marked with an `X-CloudAPI-Deprecated` header indicating the version in which they were deprecated and the reason for the deprecation. Deprecated endpoints may be removed in the next version of the resource.\n\n## Versioning\n\nAll resource endpoints are versioned within the API. Endpoints that have reached production will not introduce breaking changes between versions. Non-production endpoints will not version for changes.\n\nA specific version of an endpoint can be requested via the `Accept` header:\n\n Accept: application/hal+json, version=2\n\nIf the version is not specified, the latest version of the endpoint will be used.\n\nStarting with version 3, we will support the current version of an endpoint and the previous version. Version 1 of the API is [provided elsewhere](https://cloudapi.acquia.com/).\n\n## Errors\n\nSome endpoints will return a 503 status when dependent services are unavailable:\n\n application/hal+json\n {\n \"error\": \"system\",\n \"message\": \"This action is currently unavailable. Please try again later.\"\n }\n\n## Authentication\n\nAll Acquia Cloud API calls require authentication to work properly.\n\nLearn more: <a href='https://docs.acquia.com/acquia-cloud/develop/api/auth/' target='_blank'>https://docs.acquia.com/acquia-cloud/develop/api/auth/</a>\n\n### Example implementation\n\nAn example PHP script for making authenticated API requests can be found <a href='https://docs.acquia.com/resources/useful-references' target='_blank'>here</a>. This script uses the <a href='https://oauth2-client.thephpleague.com/' target='_blank'>League/oauth2-client</a> library, installed via Composer.\n"
title: Acquia Cloud API Account Private Networks API
version: 2.0.0
x-logo:
altText: Acquia Cloud
backgroundColor: '#FFFFFF'
url: assets/cloud-platform.svg
servers: []
tags:
- name: Private Networks
description: Private Network Service API
x-displayName: Private Networks
paths:
/private-networks:
servers:
- url: https://cloud.acquia.com/api
post:
summary: Create a new Private Network
description: "Creates a new Private Network with optional subresource configuration.\n\nThis comprehensive endpoint allows you to create a private network and optionally configure \nits subresources (connections, VPNs, VPC peers, ingress, and isolation) during the initial creation.\n\n**Subresource Creation:**\n- **Connections**: Configure CIDR block and egress access settings\n- **VPNs**: Create one or more VPN connections with tunnel configurations\n- **VPC Peers**: Create one or more VPC peering connections\n- **Ingress**: Configure ingress access rules and privacy settings\n- **Isolation**: Configure compute and network isolation flags\n\nAll subresources are optional. If not specified during creation, they can be configured later\nusing their respective endpoints.\n"
tags:
- Private Networks
operationId: createPrivateNetwork
x-cli-name: private-networks:create
requestBody:
$ref: '#/components/requestBodies/Private_Network_Service_API_PrivateNetworkCreateRequest'
responses:
'202':
description: Request accepted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: Private network is being created
_links:
self:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000
'400':
description: Request failed to be validated
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_ValidationError'
example:
error: validation_failed
message:
region: Invalid region specified
name: Name is required and must be unique
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}:
servers:
- url: https://cloud.acquia.com/api
get:
summary: Retrieve a Private Network by ID
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
operationId: getPrivateNetwork
description: Retrieves a Private Network by its ID.
x-cli-name: private-networks:find
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_PrivateNetwork'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
put:
summary: Update a Private Network
description: Updates an existing Private Network by its ID. Does not allow creation of new Private Networks.
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
operationId: updatePrivateNetwork
x-cli-name: private-networks:update
tags:
- Private Networks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_UpdatePrivateNetworkRequestSpec'
example:
description: Private network for customer
label: anyLabel
responses:
'202':
description: Private network updated
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: Private network update is in progress
_links:
self:
href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
'400':
$ref: '#/components/responses/Private_Network_Service_API_BadRequestError'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
delete:
summary: Delete a Private Network
description: Deletes a Private Network by its ID.
operationId: deletePrivateNetwork
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
x-cli-name: private-networks:delete
tags:
- Private Networks
responses:
'202':
description: Private network deleted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: Private network is being deleted
_links:
self:
href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/subscriptions/{subscriptionId}/private-networks:
servers:
- url: https://cloud.acquia.com/api
get:
summary: List Private Networks for a Subscription
operationId: getPrivateNetworksBySubscription
description: Retrieves a paginated list of Private Networks for a given subscription.
x-cli-name: private-networks:list
tags:
- Private Networks
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_SubscriptionId'
- $ref: '#/components/parameters/Private_Network_Service_API_Limit'
- $ref: '#/components/parameters/Private_Network_Service_API_Offset'
- $ref: '#/components/parameters/Private_Network_Service_API_Sort'
- $ref: '#/components/parameters/Private_Network_Service_API_Filter'
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_PrivateNetworkList'
'400':
$ref: '#/components/responses/Private_Network_Service_API_ValidationError'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'403':
$ref: '#/components/responses/Private_Network_Service_API_ForbiddenError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}/connections/vpns:
servers:
- url: https://cloud.acquia.com/api
post:
summary: Add a new VPN to an existing private network
operationId: addVpnToPrivateNetwork
description: Adds a new VPN to the connections block of an existing private network
x-cli-name: private-networks:create-vpn
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
tags:
- Private Networks
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_VPN'
example:
name: vpn2
gateway_ip: 10.10.20.20
routes:
- 192.168.1.0/24
- 192.168.2.0/24
tunnel1:
shared_key: sharedKey3
internal_cidr: 192.2.1.0/24
ike_versions: '1'
startup_action: start
dpd_timeout_action: stop
tunnel2:
shared_key: sharedKey4
internal_cidr: 192.2.2.0/24
ike_versions: '2'
startup_action: start
dpd_timeout_action: stop
responses:
'202':
description: VPN request accepted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: VPN is being created
_links:
self:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns/2
parent:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns
'400':
description: Bad request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_ValidationError'
example:
error: validation_failed
message:
gateway_ip: Invalid IP address format
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
get:
summary: Get VPNs for a Private Network
operationId: getAllVpnsFromPrivateNetwork
description: Retrieves the VPN Connections for a Private Network.
x-cli-name: private-networks:list-vpns
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
- $ref: '#/components/parameters/Private_Network_Service_API_Limit'
- $ref: '#/components/parameters/Private_Network_Service_API_Offset'
- $ref: '#/components/parameters/Private_Network_Service_API_Sort'
- $ref: '#/components/parameters/Private_Network_Service_API_Filter'
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_VPNList'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}/connections/vpns/{vpnId}:
servers:
- url: https://cloud.acquia.com/api
get:
summary: Retrieve a VPN for a Private Network.
operationId: getVpnFromPrivateNetwork
description: Retrieves a VPN for a Private Network by Private Network ID and VPN ID.
x-cli-name: private-networks:find-vpn
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_VpnId'
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_Vpn'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
put:
summary: Create or update a VPN for a Private Network.
operationId: updateVpnInPrivateNetwork
description: Creates a new VPN or updates an existing VPN for a Private Network by Private Network ID and VPN ID.
x-cli-name: private-networks:update-vpn
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_VpnId'
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
tags:
- Private Networks
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_VPN'
example:
name: vpn1
gateway_ip: 10.10.10.11
routes:
- 127.0.0.1/32
- 127.0.0.2/32
- 192.168.3.0/24
tunnel1:
shared_key: updatedSharedKey1
internal_cidr: 192.1.1.0/24
ike_versions: '1'
startup_action: start
dpd_timeout_action: stop
tunnel2:
shared_key: updatedSharedKey2
internal_cidr: 192.1.2.0/24
ike_versions: '2'
startup_action: start
dpd_timeout_action: stop
responses:
'202':
description: VPN request accepted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
examples:
creation:
summary: VPN creation response
description: Response when creating a new VPN
value:
_links:
self:
href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/1
message: The VPN is being created.
update:
summary: VPN update response
description: Response when updating an existing VPN
value:
_links:
self:
href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections/vpns/1
message: The VPN is being updated.
'400':
$ref: '#/components/responses/Private_Network_Service_API_BadRequestError'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
delete:
summary: Delete a VPN for a Private Network.
operationId: deleteVpnFromPrivateNetwork
description: Deletes a VPN for a Private Network by Private Network ID and VPN ID.
x-cli-name: private-networks:delete-vpn
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_VpnId'
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
tags:
- Private Networks
responses:
'202':
description: VPN removed successfully
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: The VPN is being deleted.
_links:
self:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpns/1
parent:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}/connections/vpc-peers:
servers:
- url: https://cloud.acquia.com/api
post:
summary: Add a new VPC Peer to an existing private network
operationId: addVpcPeerToPrivateNetwork
description: Adds a new VPC Peer to the connections block of an existing private network
x-cli-name: private-networks:create-vpc-peer
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
tags:
- Private Networks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_VPCPeers'
example:
name: vpcPeer2
aws_account: '123456789012'
vpc_id: vpc-1234567890abcdef0
vpc_cidr: 120.24.16.1/24
responses:
'202':
description: VPC Peer request accepted
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: VPC Peer is being created
_links:
self:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers/2
parent:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers
'400':
$ref: '#/components/responses/Private_Network_Service_API_BadRequestError'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
get:
summary: Get VPC Peers for a Private Network
operationId: getAllVpcPeersFromPrivateNetwork
description: Retrieves the VPC Peers for a Private Network.
x-cli-name: private-networks:list-vpc-peers
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
- $ref: '#/components/parameters/Private_Network_Service_API_Limit'
- $ref: '#/components/parameters/Private_Network_Service_API_Offset'
- $ref: '#/components/parameters/Private_Network_Service_API_Sort'
- $ref: '#/components/parameters/Private_Network_Service_API_Filter'
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_VpcPeerList'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}:
servers:
- url: https://cloud.acquia.com/api
get:
summary: Get a specific VPC Peer from a private network
operationId: getVpcPeerFromPrivateNetwork
description: Retrieves details of a specific VPC Peer from a private network
x-cli-name: private-networks:find-vpc-peer
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
- $ref: '#/components/parameters/Private_Network_Service_API_VpcPeerId'
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_VpcPeer'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
delete:
summary: Delete a VPC Peer for a Private Network.
operationId: deleteVpcPeerFromPrivateNetwork
description: Deletes a VPC Peer for a Private Network by Private Network ID and VPC Peer name.
x-cli-name: private-networks:delete-vpc-peer
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
- $ref: '#/components/parameters/Private_Network_Service_API_VpcPeerId'
tags:
- Private Networks
responses:
'202':
description: VPC Peer removed successfully
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: The VPC Peer is being deleted.
_links:
self:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000/connections/vpc-peers/1
parent:
href: https://cloud.acquia.com/api/private-networks/123e4567-e89b-12d3-a456-426614174000
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}/connections:
servers:
- url: https://cloud.acquia.com/api
put:
summary: Update Connections for a Private Network.
operationId: updatePrivateNetworkConnections
description: Updates the Connections configuration for a Private Network by Private Network ID.
x-cli-name: private-networks:update-connections
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
tags:
- Private Networks
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_UpdateConnectionRequestSpec'
example:
private_egress_access:
drupal: true
responses:
'202':
description: Connections updated
content:
application/hal+json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Message'
example:
message: Private network connections update is in progress
_links:
self:
href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000/connections
parent:
href: https://cloud.acquia.com/api/private-networks/456e4567-e89b-11d3-a789-426614174000
'400':
$ref: '#/components/responses/Private_Network_Service_API_BadRequestError'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'409':
$ref: '#/components/responses/Private_Network_Service_API_ConflictError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
get:
summary: Get Connections for a Private Network.
operationId: getPrivateNetworkConnections
x-cli-name: private-networks:get-connections
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
description: Retrieves the Connections block for a Private Network, including VPNs and VPC Peers.
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_Connection'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
/private-networks/{privateNetworkId}/isolation:
servers:
- url: https://cloud.acquia.com/api
get:
summary: Get Isolation for a Private Network.
operationId: getPrivateNetworkIsolation
description: Retrieves the Isolation configuration for a Private Network.
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
x-cli-name: private-networks:get-isolation
tags:
- Private Networks
responses:
'200':
$ref: '#/components/responses/Private_Network_Service_API_Isolation'
'401':
$ref: '#/components/responses/Private_Network_Service_API_UnauthorizedError'
'404':
$ref: '#/components/responses/Private_Network_Service_API_NotFoundError'
'500':
$ref: '#/components/responses/Private_Network_Service_API_InternalServerError'
security:
- Private_Network_Service_API_BearerAuth: []
Private_Network_Service_API_ClientCredentials: []
Private_Network_Service_API_OIDC: []
put:
summary: Update isolation settings of a private network
operationId: updatePrivateNetworkIsolation
description: Updates the isolation settings of a private network
tags:
- Private Networks
parameters:
- $ref: '#/components/parameters/Private_Network_Service_API_PrivateNetworkId'
x-cli-name: private-networks:update-isolation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Private_Network_Service_API_Isolation'
example:
dedicated_compute: true
dedicated_network: true
responses:
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/openapi/acquia-private-networks-api-openapi.yml