Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Acquia Private Networks API

Private Network Service API

Acquia Private Networks API is one of 21 APIs that Acquia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Private Networks. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 20 operations across 10 paths, and defines 26 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

20 operations 10 paths 26 schemas 3 DELETE9 GET3 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Authentication
OAuth 2.0, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Acquia Private Networks API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (Acquia_Cloud_API_Documentation_OAuth2) using the clientCredentials flow. An API key is passed in the header as Authorization (Codebase_Service_JWT). An API key is passed in the header as Authorization (MEO_Environment_Service_JWT). An API key is passed in the header as Authorization (Site_Service_JWT).

  • Acquia_Cloud_API_Documentation_OAuth2 — All Cloud API calls need to be authenticated in order to work. You authenticate using a token that you can generate on your Acquia Profile page. To generate a…
  • Codebase_Service_JWT — Value for the Authorization header parameter.
  • MEO_Environment_Service_JWT — Value for the Authorization header parameter.
  • Site_Service_JWT — Value for the Authorization header parameter.

Paths & Operations 20

Across 10 paths, the API surfaces 20 operations — 3 DELETE, 9 GET, 3 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Private Networks 20

Private Network Service API

POST
/private-networks
Create a new Private Network
createPrivateNetwork body → 202400401409500
GET
/private-networks/{privateNetworkId}
Retrieve a Private Network by ID
getPrivateNetwork 1 param → 200401404500
PUT
/private-networks/{privateNetworkId}
Update a Private Network
updatePrivateNetwork 1 param body → 202400401404409500
DELETE
/private-networks/{privateNetworkId}
Delete a Private Network
deletePrivateNetwork 1 param → 202401404409500
GET
/subscriptions/{subscriptionId}/private-networks
List Private Networks for a Subscription
getPrivateNetworksBySubscription 5 params → 200400401403404500
POST
/private-networks/{privateNetworkId}/connections/vpns
Add a new VPN to an existing private network
addVpnToPrivateNetwork 1 param body → 202400401404409500
GET
/private-networks/{privateNetworkId}/connections/vpns
Get VPNs for a Private Network
getAllVpnsFromPrivateNetwork 5 params → 200401404500
GET
/private-networks/{privateNetworkId}/connections/vpns/{vpnId}
Retrieve a VPN for a Private Network.
getVpnFromPrivateNetwork 2 params → 200401404500
PUT
/private-networks/{privateNetworkId}/connections/vpns/{vpnId}
Create or update a VPN for a Private Network.
updateVpnInPrivateNetwork 2 params body → 202400401404409500
DELETE
/private-networks/{privateNetworkId}/connections/vpns/{vpnId}
Delete a VPN for a Private Network.
deleteVpnFromPrivateNetwork 2 params → 202401404409500
POST
/private-networks/{privateNetworkId}/connections/vpc-peers
Add a new VPC Peer to an existing private network
addVpcPeerToPrivateNetwork 1 param body → 202400401404409
GET
/private-networks/{privateNetworkId}/connections/vpc-peers
Get VPC Peers for a Private Network
getAllVpcPeersFromPrivateNetwork 5 params → 200401404500
GET
/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}
Get a specific VPC Peer from a private network
getVpcPeerFromPrivateNetwork 2 params → 200401404500
DELETE
/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}
Delete a VPC Peer for a Private Network.
deleteVpcPeerFromPrivateNetwork 2 params → 202401404409500
PUT
/private-networks/{privateNetworkId}/connections
Update Connections for a Private Network.
updatePrivateNetworkConnections 1 param body → 202400401404409500
GET
/private-networks/{privateNetworkId}/connections
Get Connections for a Private Network.
getPrivateNetworkConnections 1 param → 200401404500
GET
/private-networks/{privateNetworkId}/isolation
Get Isolation for a Private Network.
getPrivateNetworkIsolation 1 param → 200401404500
PUT
/private-networks/{privateNetworkId}/isolation
Update isolation settings of a private network
updatePrivateNetworkIsolation 1 param body → 202400401404409500
PUT
/private-networks/{privateNetworkId}/ingress
Update Ingress for a Private Network.
updatePrivateNetworkIngress 1 param body → 202400401404409500
GET
/private-networks/{privateNetworkId}/ingress
Get Ingress for a Private Network
getIngressFromPrivateNetwork 1 param → 200401404500

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Private_Network_Service_API_PrivateNetworkResponse (10 properties), Private_Network_Service_API_VPNResponse (7 properties), Private_Network_Service_API_TunnelResponse (7 properties), Private_Network_Service_API_VPCPeersResponse (7 properties). Each schema is shown below with its type and property counts.

Private_Network_Service_API_VPCPeers
object
5 properties
Private_Network_Service_API_UpdatePrivateNetworkRequestSpec
object
2 properties
Private_Network_Service_API_EmbeddedPrivateNetworkList
object
1 property
Private_Network_Service_API_TunnelResponse
object
7 properties
Private_Network_Service_API_PrivateNetworkHALLinks
object
6 properties 1 required
Private_Network_Service_API_IngressResponse
object
2 properties
Private_Network_Service_API_Message
object
2 properties 1 required
Private_Network_Service_API_ConnectionsResponse
object
Connections block of a private network
3 properties 1 required
Private_Network_Service_API_VPCPeersResponse
object
7 properties
Private_Network_Service_API_VPN
object
6 properties 3 required
Private_Network_Service_API_Ingress
object
1 property
Private_Network_Service_API_HalLink
object
HAL link object
1 property 1 required
Private_Network_Service_API_Tunnel
object
6 properties
Private_Network_Service_API_IsolationResponse
object
3 properties
Private_Network_Service_API_Connections
object
4 properties 1 required
Private_Network_Service_API_HalItem
object
2 properties 1 required
Private_Network_Service_API_Error
object
2 properties 2 required
Private_Network_Service_API_Isolation
object
2 properties
Private_Network_Service_API_PrivateEgressAccess
object
1 property
Private_Network_Service_API_ValidationError
object
2 properties 2 required
Private_Network_Service_API_EmbeddedVPCPeerList
object
1 property
Private_Network_Service_API_DrupalSSH
object
3 properties
Private_Network_Service_API_EmbeddedVPNList
object
1 property
Private_Network_Service_API_VPNResponse
object
7 properties 3 required
Private_Network_Service_API_PrivateNetworkResponse
object
10 properties
Private_Network_Service_API_UpdateConnectionRequestSpec
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

acquia-private-networks-api-openapi.yml Raw ↑

Other APIs Acquia publishes across the network.

Acquia Cloud Site Factory API
Acquia Content Hub API
Acquia Account API
Acquia Agreements API
Acquia Application Performance Monitoring Services API
Acquia Applications API
Acquia Cloud IDE API
Acquia Codebases API
Acquia Current system health API
Acquia Distributions API
Acquia Email API
Acquia Environments API