---
title: "POST /v1/private-connections"
method: POST
path: "/v1/private-connections"
---

# POST /v1/private-connections

`POST /v1/private-connections`

Creates a Private Connection to a target resource.

## Request body

- object
  - `name` string, required — Unique name for a Private Connection within an account.
  - `mode` object, required — Private Connection mode — either service-managed or self-managed.
    - `serviceManaged` object — Service manages the Resource Gateway lifecycle.
      - `hostAddress` string, required — IP address or DNS name of the target resource.
      - `vpcId` string, required — VPC to create the service-managed Resource Gateway in.
      - `subnetIds` SubnetId[], required — Subnets that the service-managed Resource Gateway will span.
      - `securityGroupIds` SecurityGroupId[] — Security groups to attach to the service-managed Resource Gateway. If not specified, a default security group is created.
      - `ipAddressType` 'IPV4' | 'IPV6' | 'DUAL_STACK' — IP address type of the service-managed Resource Gateway.
      - `ipv4AddressesPerEni` integer — Number of IPv4 addresses in each ENI for the service-managed Resource Gateway.
      - `portRanges` PortRange[] — TCP port ranges that a consumer can use to access the resource.
      - `certificate` string — Certificate for the Private Connection.
      - `dnsResolution` 'PUBLIC' | 'IN_VPC' — DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set.
    - `selfManaged` object — Caller manages their own resource configuration.
      - `resourceConfigurationId` string, required — The ID or ARN of the resource configuration.
      - `certificate` string — Certificate for the Private Connection.
  - `tags` object — Map of tag keys to values.

## Response `200`

Success

- CreatePrivateConnectionOutput — Output containing the newly created Private Connection summary.
  - `name` string, required — The name of the Private Connection.
  - `type` 'SELF_MANAGED' | 'SERVICE_MANAGED', required — The type of the Private Connection.
  - `resourceGatewayId` string — The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
  - `hostAddress` string — IP address or DNS name of the target resource. Only present for service-managed Private Connections.
  - `vpcId` string — VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
  - `resourceConfigurationId` string — The Resource Configuration ARN. Only present for self-managed Private Connections.
  - `status` 'ACTIVE' | 'CREATE_IN_PROGRESS' | 'CREATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED', required — The status of the Private Connection.
  - `certificateExpiryTime` string, date-time — The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
  - `dnsResolution` 'PUBLIC' | 'IN_VPC' — DNS resolution mode for the Private Connection's resource gateway.
  - `failureMessage` string — Message describing the reason for a failed Private Connection creation, if applicable.
  - `tags` object — Tags associated with the created Private Connection.

## Other responses

- `480` — ValidationException
- `481` — ContentSizeExceededException
- `482` — ServiceQuotaExceededException
- `483` — ConflictException
- `484` — InternalServerException
- `485` — AccessDeniedException
- `486` — ThrottlingException
- `487` — InvalidParameterException
- `488` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/devops-agent.md) · [All operations](https://skmtc.net/aws/apis/devops-agent/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/devops-agent/versions/ca2af02d3853/schema)