AWS PrivateLink API - PUT allowlist
Adds an AWS account to the allowlist of AWS PrivateLink.
The request consumes and produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
PUT |
|
Authentication
To execute this request, you need the Write configuration (WriteConfig
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The AWS account id to be updated in the AWS PrivateLink whitelist, has to match the id in the provided payload. |
path | required |
body | WhitelistedAwsAccount |
The AWS account id to be updated in the AWS PrivateLink whitelist, has to match the id in the path. |
body | optional |
Body format
The WhitelistedAwsAccount object
Element | Type | Description | Required |
---|---|---|---|
id | string |
The AWS account id to whitelist |
required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"id": "string"
}
Response
Response codes
Code | Description |
---|---|
201 | Success. The account id has been added to the PrivateLink whitelist. |
204 | Success. The account id already exists in the PrivateLink whitelist. |
400 | Error. Wrong format of the provided AWS account id (length = 12 characters, only digits). |
Response body
The WhitelistedAwsAccount object
Element | Type | Description |
---|---|---|
id | string | The AWS account id to whitelist |
{
"id": "string"
}