Skip to main content
POST
Create WCF Agent

Body

application/json
gaid
string
required

Global Agent ID - unique identifier for the agent starting with OFA-AGENT-ID- followed by a unique string of alphanumeric characters. Later on used used as agid

Example:

"OFA-AGENT-ID-6QMRfdQp3G0Skkkkkkkk"

ts
integer<int64>
required

Timestamp in milliseconds

Example:

1753828861732

score_threshold
integer
required

Minimum threat score threshold for triggering actions

Required range: 0 <= x <= 1000
Example:

150

start_from
integer
required

Starting index for processing

Required range: x >= 0
Example:

0

version
string
required

Agent version

Example:

"v4.60.4"

proxy
enum<string>
required

Proxy mode configuration

Available options:
CLOUD,
LOCAL
Example:

"CLOUD"

sync_time
integer
required

Synchronization interval in minutes

Required range: x >= 1
Example:

1

maximum_rules
integer
required

Maximum number of rules to process

Example:

99999998

api_url
string<uri>

Primary API endpoint for IPv4 operations

Example:

"http://127.0.0.1:8081/api/v1/ipv4"

api_url_bulk
string<uri>

Bulk API endpoint for IP operations

Example:

"http://127.0.0.1:8081/api/v2/ips"

api_url_feedback
string<uri>

Feedback API endpoint

Example:

"http://127.0.0.1:8081/api/v1/feedback"

auth_name
string

Authentication header name

Example:

"Authorization"

api_jwt_key
string | null

JWT key for API authentication

ids
object

Configuration for various Intrusion Detection Systems

ips
object

Configuration for various IP Protection Systems

Response

WCF Agent created successfully

success
boolean
Example:

true

message
string
Example:

"WCF Agent created successfully"

agent_id
string
Example:

"OFA-AGENT-ID-6QMRfdQp3G0Skkkkkkkk"