GET Script Overview.

GET

/api/shape/csd/namespaces/{namespace}/scripts/{id}/dashboard

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/dashboard?type=NEW' \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

GET script overview data for a script depending on start time and end time.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace.

id

required

string

ID Script ID.

Query Parameters

type

string

default: NEW

Allowed values: NEW ALL

X-required Filter events 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.

Responses

200

A successful response.

Media typeapplication/json

GetScriptOverviewResponse

Response to GET script overview.

object

events

events

Event info of the dashboard of the script.

Array<object>

Event

Event Info.

object

date

date

Format: unix epoch timestamp in milliseconds Date of the event.

string

<= 1024 characters

existing_behavior

existing_behavior

Number of existing behaviors.

integer format: int32

new_behavior

new_behavior

Number of new behaviors.

integer format: int32

summary

object

domain

domain

Name of the domain.

string format: hostname

>= 26 characters <= 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

risk_level

risk_level

Risk level of the script.

string

<= 1024 characters

type

type

Type of the script.

string

<= 1024 characters

Example^generated

{
  "events": [
    {
      "date": "example",
      "existing_behavior": 1,
      "new_behavior": 1
    }
  ],
  "summary": {
    "domain": "example",
    "first_seen": "example",
    "last_seen": "example",
    "risk_level": "example",
    "type": "example"
  }
}

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