Skip to content

List Behaviors By Script.

GET
/api/shape/csd/namespaces/{namespace}/scripts/{id}/behaviors
curl --request GET \
--url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/csd/namespaces/example/scripts/example/behaviors?type=NEW' \
--header 'Authorization: <Authorization>'

List all the behaviors for a script depending on start time and end time.

Examples of this operation.

namespace
required
string

Namespace Namespace.

id
required
string

ID Script ID.

type
string
default: NEW
Allowed values: NEW ALL

X-required Filter based on type of behaviors

  • NEW: NEW New Behaviors
  • ALL: ALL All Behaviors.
start_time
string

X-required format: unix epoch timestamp in seconds fetch behaviors whose timestamp >= start_time.

end_time
string

X-required format: unix epoch timestamp in seconds fetch behaviors whose timestamp <= end_time.

A successful response.

Media typeapplication/json
ListBehaviorsByScriptResponse

Response to list behaviors by script.

object
behaviors
behaviors

List of behaviors depending upon filter.

Array<object>
BehaviorByScript

Behavior info.

object
category
category

Category of the behavior.

string
<= 1024 characters
first_seen
first_seen

Format: unix epoch timestamp in milliseconds First seen time.

string
<= 1024 characters
last_seen
last_seen

Format: unix epoch timestamp in milliseconds Last seen time.

string
<= 1024 characters
name
name

Name of the behavior.

string
>= 6 characters <= 1024 characters
recommendation
recommendation

Recommendation of the behavior by Client Side Defense.

string
<= 1024 characters
risk_level
risk_level

Risk level of the element read by script.

string
<= 1024 characters
users_affected
users_affected

Users affected by the behavior of the script.

integer format: int32
total_size
total_size

Total size of scripts.

integer format: int32
Examplegenerated
{
"behaviors": [
{
"category": "example",
"first_seen": "example",
"last_seen": "example",
"name": "example",
"recommendation": "example",
"risk_level": "example",
"users_affected": 1
}
],
"total_size": 1
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example