Verizon ATH API (2.0.0)

Download OpenAPI specification:Download

Access the results of the Verizon ATH applied threat intelligence platform in a programatic way!

Authentication

ApiKeyAuth

Security scheme type: API Key
Header parameter name: X-API-KEY

Me

Retrieve me

Authorizations:

Responses

200

Successful operation.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

get /me
/me

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "defaultOrganizationId": "string",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string"
}

Update Me

Update Me

Authorizations:
Request Body schema: aplication/json

Me entry to be update.

email
required
string [ 1 .. 255 ] characters
firstName
required
string [ 1 .. 255 ] characters
lastName
required
string [ 1 .. 255 ] characters

Responses

200

Successful operation.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

put /me
/me

Request samples

Content type
aplication/json
Copy
Expand all Collapse all
{
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string"
}

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "defaultOrganizationId": "string",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string"
}

Apikeys

List entries.

Lists all entries accessible to the API key owner.

Authorizations:

Responses

200

Successful operation.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

get /me/apikeys
/me/apikeys

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
[
  • {
    }
]

Delete a single entry by its ID.

Allows deleting a single entry, identified by its ID. The entry must already exist.

Authorizations:
path Parameters
apikeyId
required
string <uuid>

Restricts returned to those belonging to the specified organization member.

Responses

200

Operation failed because the content-type of the data submitted in the request body is not application/json.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

404

Operation failed because the content-type of the data submitted in the request body is not application/json.

delete /me/apikeys/{apikeyId}
/me/apikeys/{apikeyId}

Organizations

List organizations this user has access to.

Lists all organizations the API key owner has access to.

Authorizations:
query Parameters
page
integer >= 1
Default: 1

Which page of results should be displayed, starting from 1.

size
integer [ 1 .. 100 ]
Default: 20

Number of results to display in each page, ranging from 1 to 100. Defaults to 20.

Responses

200

Successful operation.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

get /organizations
/organizations

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
[
  • {
    }
]

IPs

Retrieve enrichment data regarding an external IP address at a given moment in time. If no date is given, returns the most recent data available.

Authorizations:
path Parameters
ip
required
string <ipv4>

The IPv4 address in dotted decimal format that the operation will apply to.

query Parameters
date
string <date>

Restricts returned results to those with date smaller than or equal to the specified date.

Responses

200

Successful operation.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

404

Operation failed because the content-type of the data submitted in the request body is not application/json.

get /ips/{ip}
/ips/{ip}

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
{
  • "ip": "192.168.0.1",
  • "date": "2020-07-28",
  • "asNumber": 1,
  • "asName": "string",
  • "bgpPrefix": "string",
  • "pdnsPTR":
    [
    ],
  • "pdnsReverseA":
    [
    ],
  • "location":
    {
    }
}

Domains

Retrieve enrichment data regarding an external domain at a given moment in time. If no date is given, returns the most recent data available.

Authorizations:
path Parameters
domain
required
string <hostname> [ 1 .. 255 ] characters

The IPv4 address in dotted decimal format that the operation will apply to.

query Parameters
date
string <date>

Restricts returned results to those with date smaller than or equal to the specified date.

Responses

200

Successful operation.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

404

Operation failed because the content-type of the data submitted in the request body is not application/json.

get /domains/{domain}
/domains/{domain}

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
{
  • "domain": "example.com",
  • "date": "2020-07-28",
  • "soa":
    {
    },
  • "whois":
    {
    },
  • "pdnsA":
    [
    ]
}

ASN

Retrieve enrichment data regarding an external ASN number at a given moment in time. If no date is given, returns the most recent data available.

Authorizations:
path Parameters
asnumber
required
string <ipv4>

The IPv4 address in dotted decimal format that the operation will apply to.

query Parameters
date
string <date>

Restricts returned results to those with date smaller than or equal to the specified date.

Responses

200

Successful operation.

400

The request violated the specification and was rejected.

403

Operation was not allowed due to an invalid API key, insufficient privileges or trying to reference an entity that does not exist. We have purposedfully combined non-existance and lack of privileges into this error code to avoid enumeration attacks.

404

Operation failed because the content-type of the data submitted in the request body is not application/json.

get /asn/{asnumber}
/asn/{asnumber}

Response samples

Content type
aplication/json
Copy
Expand all Collapse all
{
  • "asNumber": 1,
  • "asName": "string",
  • "bgpPrefix":
    [
    ],
  • "date": "2020-07-28"
}