Skip to main content
POST
cURL
Check out the configuration docs for Checkly Connections to learn how to obtain the required credentials.

Body

application/json
method
enum<string>
required

The method used to authenticate with Checkly.

Available options:
api-key
credentials
object
required

The credentials used to connect with Checkly.

name
string
required

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

Required string length: 1 - 64
description
string | null

An optional description for the Checkly Connection.

Maximum string length: 256
projectId
string

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

isPlatformManagedCredentials
enum<boolean>

Not supported for Checkly Connections.

Available options:
false
gatewayId

Not supported for Checkly Connections.

gatewayPoolId

Not supported for Checkly Connections.

isAutoRotationEnabled
enum<boolean>

Not supported for Checkly Connections.

Available options:
false
rotation

Not supported for Checkly Connections.

Response

Default Response

appConnection
Checkly (Access Token) · object
required