Developers

Get Connection

Scopes
read:connection

Path Parameters

name
string
Required

Connection name

GET
/connections/{name}
1
2
3
Loading...
Response:
200
Loading...

Response Body Schema

enabled
boolean
Required
name
string
Required

Connection name

provider
string
Required

Value: aws_ses

type
string
Required

Value: email

is_custom
boolean

Is connection using custom scripts

settings
object
Required
settings.
access_key_id
string
Required

AWS SES access key id.

settings.
enabled_clients
array<string>
Required
settings.
from
string
Required

from field for your emails

Default Value: "PlusAuth <[email protected]>"

settings.
region
string
Required

AWS SES region.

settings.
secret_access_key
string
Required

AWS SES secret access key.

settings.
code_length
integer
min3
max
48

The length of the OTP code.

Default Value: 6

settings.
code_ttl
integer
min60
max
600

The expiration of the generated code in seconds

Default Value: 300