POST

/connections

http://outposts.{region}.amazonaws.com/connections

<note> Amazon Web Services uses this action to install Outpost servers. </note> Starts the connection required for Outpost server installation. Use CloudTrail to monitor this action or Amazon Web Services managed policy for Amazon Web Services Outposts to secure it. For more information, see <a href="https://docs.aws.amazon.com/outposts/latest/userguide/security-iam-awsmanpol.html"> Amazon Web Services managed policies for Amazon Web Services Outposts</a> and <a href="https://docs.aws.amazon.com/outposts/latest/userguide/logging-using-cloudtrail.html"> Logging Amazon Web Services Outposts API calls with Amazon Web Services CloudTrail</a> in the Amazon Web Services Outposts User Guide.

Access Token Required: API Key

Body Params

AssetIdstringrequired

The ID of the Outpost server.

ClientPublicKeystringrequired

The public key of the client.

DeviceSerialNumberstringrequired

The serial number of the dongle.

NetworkInterfaceDeviceIndexintegerrequired

The device index of the network interface on the Outpost server.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'http://outposts.{region}.amazonaws.com/connections' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}