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

Path Parameters

connectionId
string<uuid>
required

The ID of the Netlify Connection to be updated.

Body

application/json
credentials
object

The credentials used to connect with Netlify.

name
string

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

Required string length: 1 - 64
description
string | null

The updated description of the Netlify Connection.

Maximum string length: 256
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