Skip to content
Management API Reference

Add an AWS account to the project PrivateLink share

post/v2/projects/{ref}/private-link/associations

Adds an AWS account to the project's PrivateLink configuration and schedules the AWS resources to be created.

This endpoint is only available on the following plans:

  • Team
  • Enterprise

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • data
    Required
    object

Response codes

  • 201
  • 401
  • 402
  • 403
  • 429
  • 500

Response (201)

1
{
2
  "data": {
3
    "type": "private_link_association",
4
    "id": "lorem",
5
    "attributes": {
6
      "aws_account_id": "000000000000",
7
      "account_name": "lorem",
8
      "status": "CREATING",
9
      "shared_at": "4404-02-29T04:24Z",
10
      "database_type": "PRIMARY",
11
      "database_identifier": "lorem"
12
    }
13
  }
14
}