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

Body

application/json
method
enum<string>
required

The method used to authenticate with F5 BIG-IP.

Available options:
basic-auth
credentials
object
required

The credentials used to connect with F5 BIG-IP.

name
string
required

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

Required string length: 1 - 64
description
string | null

An optional description for the F5 BIG-IP Connection.

Maximum string length: 256
projectId
string

The ID of the project to create the F5 BIG-IP Connection in.

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