Skip to main content
POST
/
api
/
v1
/
app-connections
/
aws
cURL
curl --request POST \
  --url https://us.infisical.com/api/v1/app-connections/aws \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "assume-role",
  "credentials": {
    "roleArn": "<string>"
  },
  "name": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "isPlatformManagedCredentials": false,
  "gatewayId": "<unknown>"
}
'
{
  "appConnection": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "app": "aws",
    "method": "assume-role",
    "credentials": {},
    "description": "<string>",
    "version": 1,
    "isPlatformManagedCredentials": false,
    "gatewayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "<string>",
    "credentialsHash": "<string>",
    "project": {
      "name": "<string>",
      "id": "<string>",
      "type": "<string>",
      "slug": "<string>"
    }
  }
}
Check out the configuration docs for AWS Connections to learn how to obtain the required credentials.

Body

application/json
  • Option 1
  • Option 2
​
method
enum<string>
required

The method used to authenticate with AWS.

Available options:
assume-role
​
credentials
object
required

The credentials used to connect with AWS.

​
name
string
required

The name of the AWS Connection to create. Must be slug-friendly.

Required string length: 1 - 64
​
description
string | null

An optional description for the AWS Connection.

Maximum string length: 256
​
projectId
string

The ID of the project to create the AWS Connection in.

​
isPlatformManagedCredentials
enum<boolean>

Not supported for AWS Connections.

Available options:
true,
false
​
gatewayId

Not supported for AWS Connections.

Response

Default Response

​
appConnection
AWS (Assume Role) · object
required
  • AWS (Assume Role)
  • AWS (Access Key)