PUT publicAPI

Enables saving detections of indicators received via public API. This function is available for each tenant.

Path

/api/%API_VERSION%/{TenantName}/settings/publicApi

Method

PUT

Request headers

This request has the following headers.

Request headers

Name

Value

Description

Content-Type

application/json

Request content type.

You can also specify the utf-8 charset type. For example: Content-Type: application/json; charset=utf-8

Content-Length

Integer

Request body size, in bytes.

The maximum body size for this request is 128 MB (134217728).

Request body

The request body has the following format:

{

    "saveDetects":%STATUS%

}

Function status object properties are described in the following table.

Function status object properties

Property

Value

Mandatory

Description

saveDetects

Boolean

Yes

Enabling or disabling the function.

 

 

Request example

PUT https://192.168.2.57/api/1.3/ExampleTenant/settings/publicApi

Content-Type: application/json

Content-Length: 150

[

{

"saveDetects": true

}

]

Response body

The response has the following headers.

Response headers

Name

Value

Description

Content-Type

application/json

Response content type.

Content-Length

Integer

Response body size, in bytes.

The response body has the following format:

{

"status":"%TEXT%"

}

Status object properties are described in the following table.

Status object properties

Property

Value

Description

status

String

Status of the operation.

 

 

Response example

НТТР/1.3 200 ОК

Date:Mon, 21 Apr 2025 09:56:10 UTC

Content-Type: application/json

Content-Length: 67

 

[

{

"status": "Settings updated successfully."

}

]

Page top