Skip to main content
PATCH
cURL
Check out the configuration docs for F5 BIG-IP Connections to learn how to obtain the required credentials.

Path Parameters

connectionId
string<uuid>
required

The ID of the F5 BIG-IP Connection to be updated.

Body

application/json
credentials
object

The credentials used to connect with F5 BIG-IP.

name
string

The updated name of the F5 BIG-IP Connection. Must be slug-friendly.

Required string length: 1 - 64
description
string | null

The updated description of the F5 BIG-IP Connection.

Maximum string length: 256
isPlatformManagedCredentials
enum<boolean>

Not supported for F5 BIG-IP Connections.

Available options:
false
gatewayId
string<uuid> | null

The Gateway ID to use for this connection.

gatewayPoolId
string<uuid> | null

The Gateway Pool ID to use for this connection.

isAutoRotationEnabled
enum<boolean>

Not supported for F5 BIG-IP Connections.

Available options:
false
rotation

Not supported for F5 BIG-IP Connections.

Response

Default Response

appConnection
F5 BIG-IP (Basic Auth) · object
required