Sign in

v51

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01169142751.2 KB
Subscriptions - Pro - Connectivity

Create a Private Link

Creates a new Private Link.

post/v1/subscriptions/{subscriptionId}/private-link

Path parameters

subscriptionIdinteger required

Subscription ID.

Request body

subscriptionIdinteger
shareNamestring required

Name of the resource share

principalstring required

AWS account ID or ARN of the principal (IAM user, role, or account)

type'aws_account' | 'organization' | 'organization_unit' | 'iam_role' | 'iam_user' | 'service_principal' required

Type of the principal

aliasstring

Alias or friendly name for the principal

commandTypestring

Example request

{
  "shareName": "my-redis-share",
  "principal": "123456789012",
  "type": "aws_account",
  "alias": "Production Account"
}

Response

No Content

taskIdstring uuid
commandTypestring
status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'
descriptionstring
timestampstring date-time
linksobject[]