GET Scripts Overview.

GET

/api/shape/csd/namespaces/{namespace}/scripts/overview

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/overview \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GET aggregated overview metrics for all scripts including approval status, mitigation status, and behavior metrics.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace.

Query Parameters

start_time

string

Format: unix epoch timestamp in seconds Fetch scripts whose timestamp >= start_time.

end_time

string

Format: unix epoch timestamp in seconds Fetch scripts whose timestamp <= end_time.

Responses

200

A successful response.

Media typeapplication/json

GetScriptsOverviewResponse

Response with aggregated script metrics and counts.

object

approval_status_counts

object

approved

approved

Number of approved scripts.

integer format: int32

rejected

rejected

Number of rejected scripts.

integer format: int32

unapproved

unapproved

Number of unapproved scripts (null or not set)

integer format: int32

behavior_metrics

object

scripts_with_form_field_reads

scripts_with_form_field_reads

Number of scripts that read form fields.

integer format: int32

scripts_with_network_interactions

scripts_with_network_interactions

Number of scripts with network interactions.

integer format: int32

scripts_with_new_behaviors

scripts_with_new_behaviors

Number of scripts with new behaviors detected.

integer format: int32

mitigation_status_counts

object

action_needed

action_needed

Number of scripts with “AN - Action Needed” status.

integer format: int32

no_action_needed

no_action_needed

Number of scripts with “NA - No Action Needed” status.

integer format: int32

resolved

resolved

Number of scripts with “Resolved - No Action Needed” status.

integer format: int32

total_scripts

total_scripts

Total number of scripts in the time range.

integer format: int32

Example^generated

{
  "approval_status_counts": {
    "approved": 1,
    "rejected": 1,
    "unapproved": 1
  },
  "behavior_metrics": {
    "scripts_with_form_field_reads": 1,
    "scripts_with_network_interactions": 1,
    "scripts_with_new_behaviors": 1
  },
  "mitigation_status_counts": {
    "action_needed": 1,
    "no_action_needed": 1,
    "resolved": 1
  },
  "total_scripts": 1
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

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

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example