Skip to main content
API docs by Redocly

Haltdos API

Download OpenAPI specification:Download

Haltdos Platform API

Management

updateContent

Update resource content

path Parameters
stackId
required
string
query Parameters
Content Id
required
string

Shows the content Id

Content Data
required
string

Shows the content data

Content Name
string

Shows the content name

App
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App Name

Reference Id
string

Shows the reference Id

Metadata
string

JSON serialized Map<String, Object> of parameters required for certificate generation

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

addContent

Add resource content

path Parameters
stackId
required
string
query Parameters
Content Name
required
string

Shows the name of the contenet Id

Content Data
required
string

Shows the content data

Content Type
required
string
Enum: "SSL_CERTIFICATE" "PUBLIC_PRIVATE_KEY" "CERTIFICATE_AUTHORITY" "CACHE_POOL" "CREDENTIALS" "PAYLOAD" "CERT_REVOCATION_LIST" "CLIENT_CERTIFICATE" "ERROR_PAGE" "IP_FEED" "RPZ" "HEALTH_SCRIPT"

Shows the Content data

App
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Reference Id
string

Shows the Reference Id

Metadata
string

JSON serialized Map<String, Object> of parameters required for certificate generation

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

deleteContent

Delete resource content

path Parameters
stackId
required
string
query Parameters
Content Id
required
string

Show the Id of Content

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

createOrUpdateTask

Create or update Task

path Parameters
stackId
required
string
query Parameters
required
object (Task)

JSON serialized Task object

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

getStackSettings

Get stack settings

path Parameters
stackId
required
string
query Parameters
Path
required
string

Shows the path

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

saveStackSettings

Create or Update stack settings

path Parameters
stackId
required
string
query Parameters
Path
required
string

Shows the path

Configuration
required
string

Shows the configuration

Update Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

exportSessions

Exports session table in excel format

path Parameters
stackId
required
string
query Parameters
App
required
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Show the App

Start Timestamp
required
integer <int64>

Show the Starting Time

End Timestamp
required
integer <int64>

Show the Ending Time

ReferenceId
string

Show the Reference Id

Match
string

Shows the Match

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getIncidents

Gets list of incidents

path Parameters
stackId
required
string
query Parameters
App
required
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

App Name

Refernce Id
string

ID of the Reference

Incident Category
string

Category of the Incident

Matching Criteria
Array of strings

Matching Criteria

Start Timestamp
integer <int64>

Starting Time

End Timestamp
integer <int64>

Ending Time

Page Number
integer <int32>

Defaults to 0 if not specified

Page Size
integer <int32>

Defaults to 10 if not specified

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

exportIncidents

Exports incidents in excel format

path Parameters
stackId
required
string
query Parameters
App
required
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

App Name

Start Timestamp
required
integer <int64>

Time stamp of Starting

End Timestamp
required
integer <int64>

Time Stamp of Ending

Reference Id
string
Default: ""

Id of the Reference

Incident Category
string

Category of Incident

Matching Criteria
string

Cirteria of Matching

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

createOrUpdateAlarm

Create or update alarm

query Parameters
Stack Id
required
string

Shows the Stack Id

JSON format
required
string

Alarm configuration in JSON format

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getStacks

Get list of stacks

query Parameters
Instance
string

Shows the Instance

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getStack

Get stack details

path Parameters
stackId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

getIoCList

Gets list of unique malicious IoCs extracted from incidents

path Parameters
stackId
required
string
query Parameters
App
required
string

Shows the App

Start Timestamp
required
integer <int64>

Shows the Starting Time

End Timestamp
required
integer <int64>

Shows the Ending Time

Page Number
integer <int32>

Shows the Page Number

Filter by ReferenceId
string

Id of the Reference

Filter by Incident Category
string

Shows the Category

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getTasks

Gets list of tasks

query Parameters
Reference Id
string

Shows the Id of the Reference

Match Filters
Array of strings

Shows the Match Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getTask

Get task details

path Parameters
stackId
required
string
taskId
required
integer <int64>

ID of the task

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

deleteTask

Delete task

path Parameters
stackId
required
string
taskId
required
integer <int64>

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getSessions

Retrieves session table

path Parameters
stackId
required
string
query Parameters
App
required
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Reference Id
string

Shows the Id of the Reference

List of Category
string

Shows the Categorgy

Match
string

Filter by Match content

Start Timestamp
integer <int64>

Shows the Starting Time

End Timestamp
integer <int64>

Shows the Ending Time

Page Number
integer <int32>

Defaults to 0 if not specified

Page Size
integer <int32>

Defaults to 10 if not specified

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getPlan

Get licensing plan associated with stack

path Parameters
stackId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

getIncident

Get incident details

path Parameters
incidentId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

getStackEvents

Gets list of stack events

path Parameters
stackId
required
string
query Parameters
App
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Reference Id
string

Shows the Id of the Reference

Event Category
string

Shows the Category of the Event

Event Sub Category
string

Shows Event of Sub Category

Matching Criteria
string

Shows the Criteria of Matching

Start Timestamp
integer <int64>

Shows the Starting Time

End Timestamp
integer <int64>

Shows the Ending time

Page Number
integer <int32>

Shows the Page Number

Page Size
integer <int32>

Shows the page Size

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getEvent

Get stack event details

path Parameters
stackId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

downloadEvent

Download stack event file

path Parameters
stackId
required
string
eventId
required
string

Responses

getDashboards

Retrieves list of dashboards

query Parameters
App
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Instance
string

Shows the Instance

Type
string
Enum: "CUSTOM" "APP" "HOME" "INSTANCE" "SERVER" "METRIC" "SYSTEM" "ALARM"

Shows the Type

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getDashboard

Get dashboard graphs

path Parameters
stackId
required
string
query Parameters
App
required
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Dashboard Id
required
integer <int64>

Id of the Dashboard

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getContents

Gets list of resource contents

path Parameters
stackId
required
string
query Parameters
Match Filter
string

Shows the Match Filter

Reference Id
string

Shows the Reference Id

Content Type
string
Enum: "SSL_CERTIFICATE" "PUBLIC_PRIVATE_KEY" "CERTIFICATE_AUTHORITY" "CACHE_POOL" "CREDENTIALS" "PAYLOAD" "CERT_REVOCATION_LIST" "CLIENT_CERTIFICATE" "ERROR_PAGE" "IP_FEED" "RPZ" "HEALTH_SCRIPT"

Shows the type of the Content

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getContent

Get resource content

path Parameters
stackId
required
string
contentId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

getDashboardAnalytics

Gets populated dashboard

query Parameters
App
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Dashboard Id
integer <int64>

Shows the Id of the Dashboard

Reference Id
string

Shows the Id of Reference

Instance Id
string

Shows the Id of the Reference

Duration
string
Example: Duration=Use <number><token> format with token m = minute,h = hour,d = day,M = month,Y = year. Eg. 1d = 1 Day. If duration specified with Start and End Timestamps, then End Timestamp will be ignored

Duration paramter works along with start or end timestamp

Start Timestamp
integer <int64>

Shows the Time of Starting

End Timestamp
integer <int64>

Shows the Ending Time

Timezone (defaults to UTC)
string

Shows the Timezone

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getMetricAnalytics

Gets populated metrics

query Parameters
Metric Category
required
string

Shows the Category

App
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Shows the App

Reference Id
string

Shows the Id of Reference

Instance Id
string

Shows the Id of Instance

Metric Key
string

Shows the Key of Metric

Duration
string
Example: Duration=Use <number><token> format with token m = minute,h = hour,d = day,M = month,Y = year. Eg. 1d = 1 Day. If duration specified with Start and End Timestamps, then End Timestamp will be ignored

Duration paramter works along with start or end timestamp

Start Timestamp
integer <int64>

Shows the Time of Starting

End Timestamp
integer <int64>

Shows the Time of Ending

Timezone (defaults to UTC)
string

Shows the Timezone

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getMetrics

Gets list of metrics

query Parameters
Stack Id
required
string

Shows the Id of Stack

app
string
Enum: "NONE" "ADC" "DNS" "RDNS" "CDN" "DDOS" "LLB" "SCAN" "APM" "SLB" "WAF" "BLK" "VPN" "SWG"

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getAlarmsApi

Gets list of alarms

query Parameters
stackId
required
string
App
string

Shows the App

Reference Id
string

Shows the Id of the reference

Start Timestamp
string

Shows the time of Starting

End Timestamp
string

Shows the Time of Ending

Page Number
integer <int32>

Shows the Number of the page

Page Size
integer <int32>

Shows the number of Page Size

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getAlarm

Get alarm details

path Parameters
alarmId
required
string
query Parameters
Stack Id
required
string

shows the Stack ID

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

deleteAlarm

Delete alarm

path Parameters
alarmId
required
string
query Parameters
Stack Id
required
string

Shows the Id of the Stack

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

Web Application Firewall

getModule

Retrieves the WAF module configuration for the specified stack, zone, and path.

path Parameters
stackId
required
string
query Parameters
Zone Id
required
string

shows the Id of Zone

Path
required
string

Shows the Path

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

updateModule

Updates the WAF module configuration with the provided action and configuration for the specified zone and path.

path Parameters
stackId
required
string
query Parameters
Zone Id
required
string

Shows the Zone Id

Path
required
string

Shows the Path

Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action Configuration

Configuration
required
string

Shows the Configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

deleteModule

Deletes the WAF module for the specified zone and path.

path Parameters
stackId
required
string
query Parameters
Zone Id
required
string

Shows the ZoneId

Path
required
string

Shows the Path

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

uploadVersion

Uploads a vulnerability scan file for a specific WAF stack using a specified scan tool.

path Parameters
stackId
required
string
query Parameters
Scan Tool
required
string
Enum: "AcunetixJson" "BurpXml" "ZapJson"

Shows the Scan Tool

Request Body schema: application/json
file
required
string <binary>

Shows the file

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

downloadWafToolMatchEvents

Downloads MF events for a given time range and reference ID.

path Parameters
stackId
required
string
query Parameters
Start
required
integer <int64>

Shows the Start

End
required
integer <int64>

Shows the End

ReferenceId
string
Default: ""

Show the Id of the reference ID

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

downloadWafToolEvents

Downloads FP incident events based on the specified filter.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getWafRulesStatus

Retrieves the learning status of WAF signatures for a given stack and filter.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

updateWafRuleStatus

Updates the status of WAF rules for a specific zone and profile, with an optional action for all rules or a specific rule.

path Parameters
stackId
required
string
query Parameters
ZoneId
required
string

Id of the Zone

ProfileId
required
string

Shows the ID of Profile

Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shwos the Action

UpdateAllRule
required
boolean

Shows the Update of all Rule

RuleId
string

Shows the Id of Rule

Configuration
string

Shows the Configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getDiscoveryScores

Retrieves the learning status and discovery scores for a specific WAF listener.

path Parameters
stackId
required
string
query Parameters
Page
integer <int32>

Shows the Number of Page

Size
integer <int32>

Shows the Page Size

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

updateLearning

Updates the learning configuration for a WAF listener, including profile and action parameters.

path Parameters
stackId
required
string
query Parameters
Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action

ProfileId
string

Shows the Id of the Profile

Params
string

Shows the Param

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

uploadFile

Uploads a file for discovery learning to a WAF listener with an optional profile ID.

path Parameters
stackId
required
string
query Parameters
ProfileId
string

Shows the Id of the Profile

Request Body schema: application/json
file
required
string <binary>

Shows the File

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

queryWafToolMatches

Retrieves malicious false (MF) incidents within the specified time range.

path Parameters
stackId
required
string
query Parameters
Start
required
integer <int64>

Shows the Start

End
required
integer <int64>

Show the End

Page
integer <int32>

Shows the Page Number

Size
integer <int32>

Shows the Page Size

ReferenceId
string

Shows the Reference Id

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getRuleFilterData

Retrieves false-positive (FP) incidents data based on the specified filter.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getWafToolMatchedRulesPerUri

Retrieves WAF rules matched per URI based on the specified filter.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

getWafToolUriMatchData

Retrieves match data for specific URIs based on the provided filter.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

getWafRules

Retrieves WAF rules for a specified stack, filtered by the provided rule criteria.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getWafToolAutoProfileData

Retrieves auto-profile data for a WAF stack based on the provided zone, listener, and key.

path Parameters
stackId
required
string
query Parameters
Zone Id
required
string

Shows the Id of the Zone

Listener Id
required
string

Shows the Id of the Listener

Key
required
string

Shows the Key

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

Serial Load Balancer

getSlbModule

Retrieves SLB (Server Load Balancer) module configuration for the specified stack and reference ID.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

shows the Id of the reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

updateSlbModule

Updates the SLB module configuration for the specified stack, reference ID, and action.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

It the the Id of the Reference

Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

It shows the Action COnfiguration

Configuration
required
string

It shows the Configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

generateEncryptionKey

Generates an encryption key for a listener in the specified stack and listener ID.

query Parameters
Full Name
required
string

It shows the Full Name

Listerner Id
required
string

It shows the Id of the Listener

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

Scanner

getScannerProfiles

Retrieves scanner profiles for the specified stack and reference ID.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

It shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

setScannerProfile

Sets or updates a scanner profile for the specified stack based on the action and configuration.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

It shows the Id of the Reference

Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

It shows the Acton Configuration

Configuration
required
string

It shows the Configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

createScan

Creates a new scan task for the specified stack based on the provided task JSON.

path Parameters
stackId
required
string
query Parameters
Task Json
required
string

Shows the Task Json

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

generateScanReport

Generates a scan report based on the provided task ID and event ID.

path Parameters
stackId
required
string
query Parameters
Task Id
required
integer <int64>

It shows the Id of task

Event Id
required
string

it shows the Id of the Event

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getScans

Retrieves the list of scan tasks for the specified stack.

path Parameters
stackId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

listEvents

Lists events associated with a specific scan task for the specified stack.

path Parameters
stackId
required
string
taskId
required
integer <int64>

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

deleteScanTask

Deletes a scan task by its task ID for the specified stack.

path Parameters
stackId
required
string
taskId
required
integer <int64>

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

deleteScanEvent

Deletes a specific scan event associated with a scan task for the specified stack.

path Parameters
stackId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

DNS Firewall

getRdnsModule

Retrieves RDNS module settings for a specified stack and reference ID.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

updateRdnsModule

Updates RDNS module configuration for a specified stack and reference ID based on the provided action and configuration.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Show the ID of the Reference

Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action Configuration

Configuration
required
string

Shows the COnfiguration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

Authoritative DNS

getDnsModule

Retrieves DNS module settings for a specified stack and reference ID.

path Parameters
stackId
required
string
query Parameters
reference Id
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

updateDnsModule

Updates DNS module configuration for a specified stack and reference ID based on the provided action and configuration.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string
Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"
Configuration
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

verify

Verifies the DNS domain for a specified stack.

path Parameters
stackId
required
string
query Parameters
Domain
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

statistics

Retrieves DNS statistics for a specified time range and optional domain or zone ID in a stack.

path Parameters
stackId
required
string
query Parameters
Start Time
required
integer <int64>

shows the time of Starting

End Time
required
integer <int64>

shows the time of Ending

Zone Id
string

shows the Id of the Zone

Domain
string

Shows the domain

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

importRecords

Imports DNS records for a specified zone ID and domain in a stack.

path Parameters
stackId
required
string
query Parameters
Zone Id
required
string

Show of Id of Zone

Domain
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

Anti-DDoS

getDdosSettings

Retrieves the current DDoS settings for a specified stack and reference ID.

path Parameters
stackId
required
string
query Parameters
ReferenceId
required
string

Shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

updateDdosModule

Updates the DDoS module configuration for a specified stack and reference ID based on the provided action and configuration.

path Parameters
stackId
required
string
query Parameters
ReferenceId
required
string

Shows the Id of the Reference

Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action

Configuration
required
string

Shows the configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

updateDdosRuleStatus

Updates the status of a specified DDoS rule based on the provided profile ID and action.

path Parameters
stackId
required
string
query Parameters
ProfileId
required
string

Shows the Id Of the Profile

Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action

RuleId
string

Shows the Id Of the Rule

Configuration
string

Shows the COnfiguration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

getAlarms

Retrieves the list of alarms for a specified DDoS profile within a stack.

path Parameters
stackId
required
string
query Parameters
ProfileId
required
string

Shows the Id Of the Profile

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

updateAlarms

Updates the alarm settings for a specified DDoS profile within a stack.

path Parameters
stackId
required
string
query Parameters
ProfileId
required
string

Shows the Id Of the Profile

Alarm
required
string

Shows the Alarm

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getDdosApiRules

Retrieves a paginated list of DDoS rules for a specified stack, filtered by provided criteria.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Page
integer <int32>

Shows the Page Number

Size
integer <int32>

Shows the Page Size

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getDdosApiSignatures

Retrieves the status of learning signatures based on provided filtering criteria for a specified stack.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

Content Delivery Network

getConfiguration

Get CDN configuration

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

saveConfiguration

Updates CDN configuration

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Shows the Id of the Reference

Configuration Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the configuration of Action

Configuration
required
string

JSON Serialized configuration object

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

Application Delivery Controller

getAdcModule

Retrieves a module based on the provided stack and reference IDs.

path Parameters
stackId
required
string
query Parameters
ReferenceId
required
string

Shows the Reference Id

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

updateAdcModule

Updates a module's configuration and action based on the specified parameters.

path Parameters
stackId
required
string
query Parameters
referenceId
required
string

Shows the Id of the Reference

Action
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action

Configuration
required
string

Shows the Configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

uploadVAScanResult

Uploads a vulnerability assessment scan result file.

path Parameters
stackId
required
string
query Parameters
Scan Tool
required
string
Enum: "AcunetixJson" "BurpXml" "ZapJson"

Shows the tool of the Scan

Request Body schema: application/json
file
required
string <binary>

Shows the File

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

downloadMatchEvents

Downloads match events within the specified time range and reference ID.

path Parameters
stackId
required
string
query Parameters
Start
required
integer <int64>

Shows the Starting

End
required
integer <int64>

Shows teh Ending

Referene Id
string
Default: ""

Shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

downloadEvents

Downloads events based on the specified filter criteria.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

exportLogs

Exports access logs for a specified time range and reference ID.

path Parameters
stackId
required
string
query Parameters
Start
required
integer <int64>

Shows the Starting

End
required
integer <int64>

Shows the Ending

Reference Id
string
Default: ""

Shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getRulesStatus

Updates the status of a specific rule based on the given parameters.

path Parameters
stackId
required
string
query Parameters
Json Filter
required
string

Shows the Json Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": {
    },
  • "metadata": {
    }
}

updateRuleStatus

Updates the status of a specific rule based on the given parameters.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Shows the Reference Id

Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action Configuration

Update All Rule
required
boolean

Updates all of the Rule

Rule Id
string

Shows the Rule Id

Configuration
string

Shows the Configuration

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

getLearningStatus

Retrieves the learning status for a listener based on pagination and matching criteria.

path Parameters
stackId
required
string
referenceId
required
string
query Parameters
Page Number
integer <int32>

Shows the number of the Page

Match
string

Shows the Match

Page Size
integer <int32>

Shows the size of the Page

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

updateAdcApiLearning

Updates the learning configuration for a listener based on the provided parameters.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Shows the Id of the Reference

Action Configuration
required
string
Enum: "ADD" "EDIT" "RESET" "DELETE" "RELOAD"

Shows the Action of the Configuration

Params
string

Shows the Params

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

uploadAdcApiFile

Uploads a file related to a listener's configuration.

path Parameters
stackId
required
string
referenceId
required
string
Request Body schema: application/json
file
required
string <binary>

Shows the File

Responses

Request samples

Content type
application/json
{
  • "file": "string"
}

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

exportUris

Exports URIs associated with a specified reference ID.

path Parameters
stackId
required
string
referenceId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}

queryMatches

Queries incidents matching specified time parameters and pagination settings.

path Parameters
stackId
required
string
query Parameters
Page Nmuber
required
integer <int32>

Shows the number of the Page

Start Timestamp
required
integer <int64>

Shows the time of Starting

End Timestamp
required
integer <int64>

Shows the time of Ending

Page Limit
integer <int32>

Shows the limit of the Page

Reference Id
string

Shows the Id of the Reference

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getMatchedRules

Fetches matched rules based on the specified filter criteria.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getMatchedRulesPerUri

Retrieves matched rules specific to a URI based on filter criteria.

path Parameters
stackId
required
string
query Parameters
Json Filter
required
string

Shows the Json Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

getUriMatchData

Obtains matching data for a specified URI based on filters.

path Parameters
stackId
required
string
query Parameters
Json Filter
required
string

Shows the json filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

getRules

Fetches rules based on filters specified in the request.

path Parameters
stackId
required
string
query Parameters
Filter
required
string

Shows the Filter

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "metadata": {
    },
  • "data": [
    ],
  • "supportingData": [
    ]
}

getAutoProfileData

Retrieves auto profile data based on the provided listener ID and key.

path Parameters
stackId
required
string
query Parameters
Reference Id
required
string

Shows the Id of the reference

Key
required
string

Shows the Key

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ],
  • "data": { },
  • "metadata": {
    }
}

deleteVAScanResult

Deletes a specified vulnerability assessment scan result.

path Parameters
stackId
required
string
scanId
required
string

Responses

Response samples

Content type
{
  • "valid": true,
  • "message": "string",
  • "code": 0,
  • "args": [
    ]
}