Skip to content
API Enriched

List Scripts.

GET
/api/shape/csd/namespaces/{namespace}/scripts
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 \
  --header 'Authorization: <Authorization>'

List all the scripts for the tenant depending on start time and end time.

Examples of this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
namespace
required
string

Namespace Namespace.

Query Parameters

Section titled “Query Parameters”
start_time
string

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

end_time
string

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

page_size
integer format: int32

The maximum number of scripts to return per page.

page_number
integer format: int32

One-indexed page number (starts from 1), page_number and page_size are optional when page_token is specified.

page_token
string

Page_token is the value of listscriptsresponse.next_page_token from previous request.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
ListScriptsLegacyResponse

Response to list scripts.

object
next_page_token
next_page_token

Opaque value passed back alone with the additional calls. All filtering will stay the same.

string
<= 1024 characters
page_number
page_number

One-indexed page number.

integer format: int32
page_size
page_size

The maximum number of scripts to return per page.

integer format: int32
scripts
scripts

List of scripts depending upon time filter.

Array<object>
ScriptInfo

Script information.

object
affected_users_count
affected_users_count

Number of affected users that loaded this script.

integer format: int32
first_seen
first_seen

Format: unix epoch timestamp in milliseconds First seen time.

string
<= 1024 characters
form_fields_read
form_fields_read

Number of form fields read by script.

integer format: int32
id
id

ID of the script.

string
>= 1 <= 4094 <= 1024 characters
justifications
justifications

List of user-provided script justifications.

Array<object>
Justification

User-provided script justification.

object
create_time
create_time

Format: unix epoch timestamp in seconds Time that the justification was entered.

string
<= 1024 characters
justification
justification

Script Justification.

string
<= 1024 characters
justification_id
justification_id

ID of the justification.

string
<= 1024 characters
user_id
user_id

ID of the justification creator.

string
<= 1024 characters
last_seen
last_seen

Format: unix epoch timestamp in milliseconds Last seen time.

string
<= 1024 characters
locations
locations

Locations where the script was found.

Array<string>
network_interactions
network_interactions

Number of network interactions.

integer format: int32
new_behaviors
new_behaviors

Number of new behaviors of the script.

integer format: int32
risk_level
risk_level

Risk level of the script.

string
<= 1024 characters
script_name
script_name

Script detected in the webpage.

string
<= 1024 characters
status
status

Script Status.

string
>= 17 characters <= 1024 characters
total_count
total_count

Total count of scripts available at time of query, and subject to change across queries.

integer format: int32
total_pages
total_pages

Total number of pages available depending upon requested page_size.

integer format: int32
Examplegenerated
{
  "next_page_token": "example",
  "page_number": 1,
  "page_size": 1,
  "scripts": [
    {
      "affected_users_count": 1,
      "first_seen": "example",
      "form_fields_read": 1,
      "id": "example",
      "justifications": [
        {
          "create_time": "example",
          "justification": "example",
          "justification_id": "example",
          "user_id": "example"
        }
      ],
      "last_seen": "example",
      "locations": [
        "example"
      ],
      "network_interactions": 1,
      "new_behaviors": 1,
      "risk_level": "example",
      "script_name": "example",
      "status": "example"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

401

Section titled “401”

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

403

Section titled “403”

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

404

Section titled “404”

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

409

Section titled “409”

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

429

Section titled “429”

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

Media typeapplication/json
string format: string
Examplegenerated
example

500

Section titled “500”

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

503

Section titled “503”

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

504

Section titled “504”

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example