DigitalOcean API (unofficial showcase)
POST/v2/partner_network_connect/attachments

Create a partner attachment

Creates a partner attachment that connects VPCs through a partner network provider. Supply name, connection_bandwidth_in_mbps, region, naas_provider, and vpc_ids; the name must use alphanumeric characters, dashes, or periods, and the bandwidth and region must be supported values. A 202 response returns attachment details, including attached VPC network IDs and BGP configuration information.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

8 body fields

Partner attachment configuration. Include name, connection_bandwidth_in_mbps, region, naas_provider, and vpc_ids; parent_uuid, bgp, and redundancy_zone are optional.

namestringrequired
The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
connection_bandwidth_in_mbpsintegerrequired
Bandwidth (in Mbps) of the connection.
Allowed:10002000500010000
regionstringrequired
The region to create the partner attachment.
Allowed:nycsfofraamssgp
naas_providerstringrequired
The network-as-a-service provider for the attachment.
vpc_idsarray<string>required
An array of VPCs IDs.
parent_uuidstringoptional
Optional associated partner attachment UUID
bgpobjectoptional
Optional BGP configurations
redundancy_zonestringoptional
Optional redundancy zone for the partner attachment.
Allowed:MEGAPORT_BLUEMEGAPORT_RED

7 status codes
202Returns the created partner attachment details, including attached VPC network IDs and BGP configuration information.
partner_attachmentobjectoptional
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when a referenced resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
422Returned when the request cannot be processed.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultReturned when an unexpected error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when authentication credentials are invalid; a 404 when a referenced resource is not found; a 422 when the request cannot be processed; a 429 when the API rate limit is exceeded; and a 500 when a server error occurs. If you submit a body, include name, connection_bandwidth_in_mbps, region, naas_provider, and vpc_ids; vpc_ids must contain at least one item, and any bgp object must include local_router_ip, peer_router_ip, peer_router_asn, and auth_key. name, connection_bandwidth_in_mbps, region, and redundancy_zone must match their declared pattern or allowed values.