DigitalOcean API (unofficial showcase)
PATCH/v2/partner_network_connect/attachments/{pa_id}

Update a partner attachment

Updates an existing partner attachment's name, attached VPC IDs, or BGP configuration. Supply the fields you want to change; attachment names may contain only letters, numbers, dashes, and periods, and vpc_ids must contain at least one ID. 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.

1 parameter · 1 body field
pa_idstringrequired
The unique identifier of the partner attachment to update.

Fields to update on the partner attachment. You can supply a name, VPC IDs, or BGP configuration.

namestringrequired
The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.

6 status codes
202Returns the updated 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 the partner attachment 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.
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 the attachment is not found; a 429 when the API rate limit is exceeded; and a 500 when a server error occurs. name must contain only letters, numbers, dashes, and periods, vpc_ids must contain at least one ID, and a supplied bgp object must include local_router_ip, peer_router_ip, peer_router_asn, and auth_key. The pa_id path parameter must contain at least one character and identify an existing partner attachment.