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

Body

application/json
method
enum<string>
required

The method used to authenticate with Netlify.

Available options:
access-token
credentials
object
required

The credentials used to connect with Netlify.

name
string
required

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

Required string length: 1 - 64
description
string | null

An optional description for the Netlify Connection.

Maximum string length: 256
projectId
string

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

isPlatformManagedCredentials
enum<boolean>

Not supported for Netlify Connections.

Available options:
false
gatewayId

Not supported for Netlify Connections.

gatewayPoolId

Not supported for Netlify Connections.

isAutoRotationEnabled
enum<boolean>

Not supported for Netlify Connections.

Available options:
false
rotation

Not supported for Netlify Connections.

Response

Default Response

appConnection
Netlify (Access Token) · object
required