partner_attachments_bgp_auth_key
Creates, updates, deletes, gets or lists a partner_attachments_bgp_auth_key resource.
Overview
| Name | partner_attachments_bgp_auth_key |
| Type | Resource |
| Id | digitalocean.network.partner_attachments_bgp_auth_key |
Fields
The following fields are returned by SELECT queries:
- partner_attachments_get_bgp_auth_key
The response will be a JSON object with a bgp_auth_key object containing a value field with the BGP auth key value
| Name | Datatype | Description |
|---|---|---|
created_at | string (date-time) | A time value given in the ISO 8601 combined date and time format. (example: 2020-03-13T19:20:47.442049222Z) |
state | string | (example: CREATED) |
value | string | (example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
partner_attachments_get_bgp_auth_key | select | pa_id | To get the current BGP auth key for a partner attachment, send a GET request to/v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
pa_id | string (string) | A unique identifier for a partner attachment. (example: 4de7ac8b-495b-4884-9a69-1050c6793cd6) |
SELECT examples
- partner_attachments_get_bgp_auth_key
To get the current BGP auth key for a partner attachment, send a GET request to/v2/partner_network_connect/attachments/{pa_id}/bgp_auth_key.
SELECT
created_at,
state,
value
FROM digitalocean.network.partner_attachments_bgp_auth_key
WHERE pa_id = '{{ pa_id }}' -- required;