Get Website Details

Cortex Xpanse REST API

post /public_api/v1/assets/get_external_website/

Get details about specific websites based on website IDs. You can submit up to 20 website IDs.
Required License: Cortex Xpanse Expander

Request headers
authorization
String
required
api-key
Example: {{api_key}}
x-xdr-auth-id
String
required
api-key-id
Example: {{api_key_id}}
Body parameters
required
request_dataObject

A dictionary containing the API request fields.

website_id_listArray[string]

A string representing the website ID you want to get details for. Limit is 20 website ids

Free-Form object
Free-Form object
REQUEST BODY
{ "request_data": { "website_id_list": [ "website_id_list", "website_id_list", "website_id_list", "website_id_list", "website_id_list" ] } }
CLIENT REQUEST
curl -X 'POST'
-H 'Accept: application/json'
-H 'Content-Type: application/json'
-H 'authorization: {{api_key}}' -H 'x-xdr-auth-id: {{api_key_id}}'
'https://api-}/public_api/v1/assets/get_external_website/'
-d '{ "request_data" : { "website_id_list" : [ "website_id_list", "website_id_list", "website_id_list", "website_id_list", "website_id_list" ] } }'
import http.client conn = http.client.HTTPSConnection("api-") payload = "{\"request_data\":{\"website_id_list\":[\"string\"]}}" headers = { 'authorization': "{{api_key}}", 'x-xdr-auth-id': "{{api_key_id}}", 'content-type': "application/json" } conn.request("POST", "%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))
require 'uri' require 'net/http' require 'openssl' url = URI("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["authorization"] = '{{api_key}}' request["x-xdr-auth-id"] = '{{api_key_id}}' request["content-type"] = 'application/json' request.body = "{\"request_data\":{\"website_id_list\":[\"string\"]}}" response = http.request(request) puts response.read_body
const data = JSON.stringify({ "request_data": { "website_id_list": [ "string" ] } }); const xhr = new XMLHttpRequest(); xhr.withCredentials = true; xhr.addEventListener("readystatechange", function () { if (this.readyState === this.DONE) { console.log(this.responseText); } }); xhr.open("POST", "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/"); xhr.setRequestHeader("authorization", "{{api_key}}"); xhr.setRequestHeader("x-xdr-auth-id", "{{api_key_id}}"); xhr.setRequestHeader("content-type", "application/json"); xhr.send(data);
HttpResponse<String> response = Unirest.post("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/") .header("authorization", "{{api_key}}") .header("x-xdr-auth-id", "{{api_key_id}}") .header("content-type", "application/json") .body("{\"request_data\":{\"website_id_list\":[\"string\"]}}") .asString();
import Foundation let headers = [ "authorization": "{{api_key}}", "x-xdr-auth-id": "{{api_key_id}}", "content-type": "application/json" ] let parameters = ["request_data": ["website_id_list": ["string"]]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume()
<?php $curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "{\"request_data\":{\"website_id_list\":[\"string\"]}}", CURLOPT_HTTPHEADER => [ "authorization: {{api_key}}", "content-type: application/json", "x-xdr-auth-id: {{api_key_id}}" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
CURL *hnd = curl_easy_init(); curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST"); curl_easy_setopt(hnd, CURLOPT_URL, "https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/"); struct curl_slist *headers = NULL; headers = curl_slist_append(headers, "authorization: {{api_key}}"); headers = curl_slist_append(headers, "x-xdr-auth-id: {{api_key_id}}"); headers = curl_slist_append(headers, "content-type: application/json"); curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers); curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"request_data\":{\"website_id_list\":[\"string\"]}}"); CURLcode ret = curl_easy_perform(hnd);
var client = new RestClient("https://api-/%7B%7Bfqdn%7D%7D/public_api/v1/assets/get_external_website/"); var request = new RestRequest(Method.POST); request.AddHeader("authorization", "{{api_key}}"); request.AddHeader("x-xdr-auth-id", "{{api_key_id}}"); request.AddHeader("content-type", "application/json"); request.AddParameter("application/json", "{\"request_data\":{\"website_id_list\":[\"string\"]}}", ParameterType.RequestBody); IRestResponse response = client.Execute(request);
Responses

OK

Body
replyObject
detailsArray
[
website_idString
hostString
protocolString
is_activeString
site_categoriesArray[string]
technology_idsArray[string]
first_observedInteger
last_observedInteger
provider_namesArray[string]
ipsArray[string]
portInteger
active_service_idsArray[string]
http_typeString
security_assessmentsArray
[
nameString
priorityInteger
scoreInteger
securityAssessmentDetailsObject
pagesArray
[
urlString
messageString
elementsArray
[
nameString
valueString
Free-Form object
]
Free-Form object
]
descriptionString
Free-Form object
Free-Form object
]
rootPageHttpStatusCodeString
isNonConfiguredHostBoolean
externally_inferred_vulnerability_scoreNumber
externally_inferred_cvesArray[string]
tagsArray[string]
assetsArray
[
idString
nameString
assetTypeString
Free-Form object
]
technologiesArray
[
idString
versionString
cpeString
categoryIdsArray[integer]
technologyDetailsObject
confidenceNumber
urlsArray
[
urlString
ipString
observedInteger
Free-Form object
]
evidenceObjectrequired
impliedByArray[string]
patternsArray
[
typeString
regexString
valueString
Free-Form object
]
Free-Form object
Free-Form object
nameString
Free-Form object
]
third_party_resourcesArray
[
urlString
typeString
thirdPartyResourceDetailsObjectrequired
observedInteger
Free-Form object
Free-Form object
]
formsArray
[
urlString
actionString
purposeString
formDetailsObjectrequired
fieldsArray
[
nameString
maxLengthInteger
requiredBoolean
dataTypeString
Free-Form object
]
Free-Form object
Free-Form object
]
detailsObject
ipsArray
[
ipString
lastObservedInteger
firstObservedInteger
Free-Form object
]
screenshotsArray
[
urlString
ipString
sizeInteger
observedInteger
Free-Form object
]
Free-Form object
Free-Form object
]
Free-Form object
Free-Form object
RESPONSE
{ "reply": { "details": [ { "website_id": "website_id_example", "host": "host_example", "protocol": "protocol_example", "is_active": "is_active_example", "site_categories": [ "site_categories_example" ], "technology_ids": [ "technology_ids_example" ], "first_observed": 0, "last_observed": 0, "provider_names": [ "provider_names_example" ], "ips": [ "ips_example" ], "port": 0, "active_service_ids": [ "active_service_ids_example" ], "http_type": "http_type_example", "security_assessments": [ { "name": "name_example", "priority": 0, "score": 0, "securityAssessmentDetails": { "pages": [ { "url": "url_example", "message": "message_example", "elements": [ { "name": "name_example", "value": "value_example" } ] } ], "description": "description_example" } } ], "rootPageHttpStatusCode": "rootPageHttpStatusCode_example", "isNonConfiguredHost": false, "externally_inferred_vulnerability_score": 0.0, "externally_inferred_cves": [ "externally_inferred_cves_example" ], "tags": [ "tags_example" ], "assets": [ { "id": "id_example", "name": "name_example", "assetType": "assetType_example" } ], "technologies": [ { "id": "id_example", "version": "version_example", "cpe": "cpe_example", "categoryIds": [ 0 ], "technologyDetails": { "confidence": 0.0, "urls": [ { "url": "url_example", "ip": "ip_example", "observed": 0 } ], "evidence": { "impliedBy": [ "impliedBy_example" ], "patterns": [ { "type": "type_example", "regex": "regex_example", "value": "value_example" } ] } }, "name": "name_example" } ], "third_party_resources": [ { "url": "url_example", "type": "type_example", "thirdPartyResourceDetails": { "observed": 0 } } ], "forms": [ { "url": "url_example", "action": "action_example", "purpose": "purpose_example", "formDetails": { "fields": [ { "name": "name_example", "maxLength": 0, "required": false, "dataType": "dataType_example" } ] } } ], "details": { "ips": [ { "ip": "ip_example", "lastObserved": 0, "firstObserved": 0 } ], "screenshots": [ { "url": "url_example", "ip": "ip_example", "size": 0, "observed": 0 } ] } } ] } }

Bad Request. Got an invalid JSON.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Unauthorized access. An issue occurred during authentication. This can indicate an incorrect key, id, or other invalid authentication parameters.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Unauthorized access. User does not have the required license type to run this API.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Forbidden access. The provided API Key does not have the required RBAC permissions to run this API.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }

Unprocessable Entity

Body
codeInteger

Error code

statusString

Error name

messageString

Error message

errorsObject

Errors

RESPONSE
{ "code": 0, "status": "status_example", "message": "message_example", "errors": {} }

Internal server error. A unified status for API communication type errors.

Body
replyObject

The query results upon error.

Free-Form object
RESPONSE
{ "reply": {} }