Skip to content
API Enriched

GET Detected Domains.

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

GET the detected domains data for the tenant.

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”
duration
string

Length in Days to fetch domain.

locations
string

List of locations if backend needs to filter with locations passed.

risk
string

GET the list of high risk domains, all domains is by default.

Responses

Section titled “Responses”

200

Section titled “200”

A successful response.

Media typeapplication/json
GetDetectedDomainsResponse

GET detected domains monitoring data.

object
customer
object
transactionCount
transactionCount

Usage transaction count.

integer format: int32
domainSummary
object
actionNeededCount
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
allowedDomains
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
mitigatedDomains
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
totalDomains
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
domainsList
DomainsList

Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated)

Array<object>
DomainDetails

Client-Side defense usage details per domain.

object
actionDate
ActionDate

Date when an action was required.

string format: int64
<= 1024 characters
category
Category

Human readable category description.

string
<= 1024 characters
domain
Domain

Name of the domain the details are for.

string format: hostname
>= 26 characters <= 1024 characters
firstSeenDate
FirstSeenDate

Date the domain was seen the first time (data was collected for the site)

string format: int64
<= 1024 characters
latestSeenDate
latestSeenDate

Date the domain was seen the latest time (last time data was collected for the site)

string format: int64
<= 1024 characters
locations
Locations

List of location -> scripts data Location will returned only when risk filter is applied.

Array<object>
Location

Location scripts pair.

object
associatedScripts
AssociatedScripts

Scripts found at the location.

Array<string>
location
Location

Location of the scripts.

string
>= 4 characters <= 1024 characters
riskReason
RiskReasons

List of risk reasons in a human readable form.

Array<string>
riskScore
ReputationScore

Domain reputation score - the bigger the better.

integer format: int32
status
Status

Human readable status description.

string
>= 17 characters <= 1024 characters
locationList
LocationList

“location URL -> protection flag” map.

object
domain_summary
object
actionNeededCount
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
allowedDomains
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
mitigatedDomains
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
totalDomains
object
count
Count

Aggregated count.

integer format: int32
lastUpdated
LastUpdated

Timestamp showing when the count was last update.

string format: int64
<= 1024 characters
domains_list
domains_list

Detailed runtime information broken down by domain (as opposed to domain summary that is aggregated)

Array<object>
DomainDetails

Client-Side defense usage details per domain.

object
actionDate
ActionDate

Date when an action was required.

string format: int64
<= 1024 characters
category
Category

Human readable category description.

string
<= 1024 characters
domain
Domain

Name of the domain the details are for.

string format: hostname
>= 26 characters <= 1024 characters
firstSeenDate
FirstSeenDate

Date the domain was seen the first time (data was collected for the site)

string format: int64
<= 1024 characters
latestSeenDate
latestSeenDate

Date the domain was seen the latest time (last time data was collected for the site)

string format: int64
<= 1024 characters
locations
Locations

List of location -> scripts data Location will returned only when risk filter is applied.

Array<object>
Location

Location scripts pair.

object
associatedScripts
AssociatedScripts

Scripts found at the location.

Array<string>
location
Location

Location of the scripts.

string
>= 4 characters <= 1024 characters
riskReason
RiskReasons

List of risk reasons in a human readable form.

Array<string>
riskScore
ReputationScore

Domain reputation score - the bigger the better.

integer format: int32
status
Status

Human readable status description.

string
>= 17 characters <= 1024 characters
location_list
location_list

“location URL -> protection flag” map.

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 (starts from 1), page_number and page_size are optional when page_token is specified.

integer format: int32
page_size
page_size

The maximum number of domains to return per page.

integer format: int32
total_count
total_count

Total count of domains 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
{
  "customer": {
    "transactionCount": 1
  },
  "domainSummary": {
    "actionNeededCount": {
      "count": 1,
      "lastUpdated": "example"
    },
    "allowedDomains": {
      "count": 1,
      "lastUpdated": "example"
    },
    "mitigatedDomains": {
      "count": 1,
      "lastUpdated": "example"
    },
    "totalDomains": {
      "count": 1,
      "lastUpdated": "example"
    }
  },
  "domainsList": [
    {
      "actionDate": "example",
      "category": "example",
      "domain": "example",
      "firstSeenDate": "example",
      "latestSeenDate": "example",
      "locations": [
        {
          "associatedScripts": [
            "example"
          ],
          "location": "example"
        }
      ],
      "riskReason": [
        "example"
      ],
      "riskScore": 1,
      "status": "example"
    }
  ],
  "locationList": {},
  "domain_summary": {
    "actionNeededCount": {
      "count": 1,
      "lastUpdated": "example"
    },
    "allowedDomains": {
      "count": 1,
      "lastUpdated": "example"
    },
    "mitigatedDomains": {
      "count": 1,
      "lastUpdated": "example"
    },
    "totalDomains": {
      "count": 1,
      "lastUpdated": "example"
    }
  },
  "domains_list": [
    {
      "actionDate": "example",
      "category": "example",
      "domain": "example",
      "firstSeenDate": "example",
      "latestSeenDate": "example",
      "locations": [
        {
          "associatedScripts": [
            "example"
          ],
          "location": "example"
        }
      ],
      "riskReason": [
        "example"
      ],
      "riskScore": 1,
      "status": "example"
    }
  ],
  "location_list": {},
  "next_page_token": "example",
  "page_number": 1,
  "page_size": 1,
  "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