REredis
Subscriptions - Pro - Connectivity

Add principal to Private Link

Changed on

Adds a principal (AWS ARN) to the Private Link configuration.

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

Request

  • Base URL
    https://api.redislabs.com
  • URL
    https://api.redislabs.com/v1/subscriptions/{subscriptionId}/private-link/principals
  • Auth
    API key in header x-api-key and API key in header x-api-secret-key and API key in header x-auth-token

Path parameters

subscriptionIdinteger required

Subscription ID.

Request body

subscriptionIdinteger
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'

Type of the principal

aliasstring

Alias or friendly name for the principal

commandTypestring

Example request

{
  "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[]

Changes

  • 6b256e1bb946Revision changes
    • warning

      added the new AGENT_MEMORY_IS_DISABLED enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_DEPENDENCY_FAILED enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_FORBIDDEN enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_INVALID_REQUEST enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_NOT_FOUND enum value to the / response property for the response status

  • c09dc0db14e1Revision changes
    • warning

      added the new DATABASE_IN_ACTIVE_ENDPOINTS_REDIRECTION enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_NOT_STOPPED enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_RESUME_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_RESUME_NOT_ELIGIBLE enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_STATE_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new DB_ENDPOINTS_SERVICE_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_ACCOUNT_MISMATCH enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_ALREADY_EXISTS enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_CONNECTIVITY_MISMATCH enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DATABASES_NOT_COMPATIBLE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DATABASE_STATE_NOT_SUPPORTED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DNS_SERVICE_NOT_AVAILABLE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_INVALID_ENDPOINT_TYPE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_COMPLETED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_LATEST enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_REVERT_WINDOW_EXCEEDED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_SOURCE_HAS_NO_ENDPOINTS enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_TARGET_HAS_NO_ENDPOINTS enum value to the / response property for the response status

    • warning

      added the new FIXED_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_SUPPORTED_FOR_FREE_PLAN enum value to the / response property for the response status