List AWS accounts attached to the project PrivateLink share
get
/v2/projects/{ref}/private-link/associationsThe fine-grained token must include the following permissions to access this endpoint:
- project_admin_read
Path parameters
- refRequiredstring
Project ref
Response codes
- 200
- 401
- 403
- 429
- 500
Response (200)
{ "data": [ { "type": "private_link_association", "id": "lorem", "attributes": { "aws_account_id": "000000000000", "account_name": "lorem", "status": "CREATING", "shared_at": "4404-02-29T04:24Z", "database_type": "PRIMARY", "database_identifier": "lorem", "custom_dns_name": "lorem", "resource_access_manager_resource_config_id": "lorem", "resource_access_manager_resource_config_arn": "lorem", "resource_access_manager_share_arn": "lorem" } } ]}{ "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Resource type.", "enum": [ "private_link_association" ] }, "id": { "type": "string" }, "attributes": { "type": "object", "properties": { "aws_account_id": { "type": "string", "minLength": 12, "maxLength": 12, "pattern": "^\\d{12}$", "description": "The AWS account ID this PrivateLink share is associated with." }, "account_name": { "description": "Human-readable name for the AWS account.", "type": "string" }, "status": { "type": "string", "enum": [ "CREATING", "READY", "ASSOCIATION_REQUEST_EXPIRED", "ASSOCIATION_ACCEPTED", "CREATION_FAILED", "DELETING" ], "description": "\n - `CREATING`: The PrivateLink resources and the Association are in the process of being created. The PrivateLink Share cannot be accepted yet.\n - `READY`: The PrivateLink resources have been created and the PrivateLink Share can be accepted for the duration of 12h after sharing. See `shared_at`.\n - `ASSOCIATION_REQUEST_EXPIRED`: The PrivateLink Share has not been accepted within the 12h time limit. This association can now be deleted.\n - `ASSOCIATION_ACCEPTED`: The PrivateLink Share was successfully accepted.\n - `CREATION_FAILED`: The PrivateLink resources failed to create. This likely means something went wrong on Supabase's and and support should be contacted.\n - `DELETING`: The PrivateLink resources and the Association are in the process of being deleted. The PrivateLink Share cannot be accepted yet.\n" }, "shared_at": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "description": "The time and date at which the AWS Resource Share Association was requested from Supabase. `null` means that the association was not yet requested while the PrivateLink Association is pending.", "nullable": true }, "database_type": { "type": "string", "enum": [ "PRIMARY", "READ_REPLICA" ], "description": "Whether this PrivateLink share targets the primary database or a read replica." }, "database_identifier": { "type": "string", "description": "Identifier of the database this PrivateLink share targets - the project ref for the primary, or the read replica identifier." }, "custom_dns_name": { "type": "string", "description": "The custom DNS name configured on the AWS VPC Lattice resource configuration." }, "resource_access_manager_resource_config_id": { "description": "ID of the AWS VPC Lattice resource configuration backing this PrivateLink share.", "type": "string" }, "resource_access_manager_resource_config_arn": { "description": "ARN of the AWS VPC Lattice resource configuration backing this PrivateLink share.", "type": "string" }, "resource_access_manager_share_arn": { "description": "ARN of the AWS Resource Access Manager resource share for this association.", "type": "string" } }, "required": [ "aws_account_id", "status", "shared_at", "database_type", "database_identifier", "custom_dns_name" ] } }, "required": [ "type", "id", "attributes" ] } } }, "required": [ "data" ]}