Create an FAI application

post

https://{hostname}/appsec/v1/configs/{configId}/versions/{versionNumber}/fai-applications

All products Create a new FAI application for a specific configuration version. Products: All.

Path Params

configId

int64

required

A unique identifier for each configuration.

versionNumber

integer

required

A unique identifier for each version of a configuration.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Contains details about an FAI application.

accessEndpointPath

string

length between 1 and 255

The access endpoint path.

accessHostnames

array of strings

required

length ≥ 1

A list of hostnames for data collection.

accessHostnames*

connectionType

string

enum

required

The connection protocol type. Either HTTP or WEBSOCKET.

Allowed:

description

string

length between 1 and 255

A description of the FAI application.

envelopeProtocol

string

enum

The WebSocket envelope protocol. Applicable when connectionType is WEBSOCKET. Supported values are stomp, socketio, sockjs, or raw.

Allowed:

faiConfigId

integer

The FAI configuration identifier.

inputSettings

object

Input data settings for the FAI application.

name

string

required

length between 1 and 255

The name you assigned to the FAI application.

outputSettings

object

Output data settings for the FAI application.

sampleRate

integer

required

1 to 100

The percentage of traffic to sample, from 1 to 100.

201Successfully created an FAI application.

400Bad request. Invalid request body or URL parameter input.

403Forbidden. You don't have access to FAI applications in this security configuration.

404Not found. The security configuration version wasn't found.