Skip to content

GET Domain Details.

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

GET the details of the domain provided.

Examples of this operation.

namespace
required
string

Namespace Namespace.

name
string

Name of the domain to GET the details.

A successful response.

Media typeapplication/json
GetDomainDetailsResponse

GET domain details for the 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
Examplegenerated
{
"actionDate": "example",
"category": "example",
"domain": "example",
"firstSeenDate": "example",
"latestSeenDate": "example",
"locations": [
{
"associatedScripts": [
"example"
],
"location": "example"
}
],
"riskReason": [
"example"
],
"riskScore": 1,
"status": "example"
}

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