NAV Navigation
Python cUrl

AlphaWave Enterprise Developer v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This is the developer api for AlphaWave Enterprise

Base URLs:

Email: Support License: Proprietary

Authentication

Inventory

Search Inventory

search all inventory

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/inventory", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/inventory \
  --header 'accept: application/json'

GET /inventory

The inventory endpoint allows you to access all of your inventory

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number
after query string false return results after date (ex:2020-09-15)
before query string false return results before date (ex:2020-09-15)
name query string false return results matching asset name
type query string false return results matching asset type

Example responses

200 Response

[
  {
    "type": "CNAME",
    "value": "www.domain.com"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

search inventory by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/inventory/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/inventory/ \
  --header 'accept: application/json'

GET /inventory/{id}

tbd

Example responses

200 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Domains

Search for Domains

search all domains

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/domains", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/domains \
  --header 'accept: application/json'

GET /domains

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "type": "CNAME",
    "value": "www.domain.com"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [DnsRecord] false none none
» type string true none none
» value string true none none

search domains by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/domains/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/domains/ \
  --header 'accept: application/json'

GET /domains/{id}

tbd

Example responses

200 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
200 OK successful operation DnsRecord
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

search domains by fqdn

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/domains/name/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/domains/name/ \
  --header 'accept: application/json'

GET /domains/name/{fqdn}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
200 OK successful operation DnsRecord
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

search domains by record type

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/domains/type/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/domains/type/ \
  --header 'accept: application/json'

GET /domains/type/{type}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
200 OK successful operation DnsRecord
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Software

search for Software

search all software

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/software", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/software \
  --header 'accept: application/json'

GET /software

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.354Z",
      "updated": "2020-11-20T19:42:49.354Z",
      "active": true
    },
    "category": "framework",
    "license": "oss",
    "vendor": "React",
    "developer": "React",
    "name": "react",
    "versions": [
      "16.13.1"
    ],
    "lastVersion": "16.13.1",
    "website": "https://www.reactjs.org"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Software] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» category string true none none
» license string true none none
» vendor string true none none
» developer string true none none
» name string true none none
» versions [string] true none none
» lastVersion string true none none
» website string true none none

search software by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/software/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/software/ \
  --header 'accept: application/json'

GET /software/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.358Z",
    "updated": "2020-11-20T19:42:49.358Z",
    "active": true
  },
  "category": "framework",
  "license": "oss",
  "vendor": "React",
  "developer": "React",
  "name": "react",
  "versions": [
    "16.13.1"
  ],
  "lastVersion": "16.13.1",
  "website": "https://www.reactjs.org"
}

Responses

Status Meaning Description Schema
200 OK successful operation Software
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

search software by vendor name

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/software/vendor/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/software/vendor/ \
  --header 'accept: application/json'

GET /software/vendor/{name}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.361Z",
      "updated": "2020-11-20T19:42:49.361Z",
      "active": true
    },
    "category": "framework",
    "license": "oss",
    "vendor": "React",
    "developer": "React",
    "name": "react",
    "versions": [
      "16.13.1"
    ],
    "lastVersion": "16.13.1",
    "website": "https://www.reactjs.org"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Software] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» category string true none none
» license string true none none
» vendor string true none none
» developer string true none none
» name string true none none
» versions [string] true none none
» lastVersion string true none none
» website string true none none

search software by product name

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/software/product/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/software/product/ \
  --header 'accept: application/json'

GET /software/product/{name}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.364Z",
    "updated": "2020-11-20T19:42:49.364Z",
    "active": true
  },
  "category": "framework",
  "license": "oss",
  "vendor": "React",
  "developer": "React",
  "name": "react",
  "versions": [
    "16.13.1"
  ],
  "lastVersion": "16.13.1",
  "website": "https://www.reactjs.org"
}

Responses

Status Meaning Description Schema
200 OK successful operation Software
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

search software by product version

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/software/product/version/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/software/product/version/ \
  --header 'accept: application/json'

GET /software/product/version/{version}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.366Z",
    "updated": "2020-11-20T19:42:49.367Z",
    "active": true
  },
  "category": "framework",
  "license": "oss",
  "vendor": "React",
  "developer": "React",
  "name": "react",
  "versions": [
    "16.13.1"
  ],
  "lastVersion": "16.13.1",
  "website": "https://www.reactjs.org"
}

Responses

Status Meaning Description Schema
200 OK successful operation Software
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

search software by product category

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/software/category/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/software/category/ \
  --header 'accept: application/json'

GET /software/category/{name}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.369Z",
      "updated": "2020-11-20T19:42:49.369Z",
      "active": true
    },
    "category": "framework",
    "license": "oss",
    "vendor": "React",
    "developer": "React",
    "name": "react",
    "versions": [
      "16.13.1"
    ],
    "lastVersion": "16.13.1",
    "website": "https://www.reactjs.org"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Software] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» category string true none none
» license string true none none
» vendor string true none none
» developer string true none none
» name string true none none
» versions [string] true none none
» lastVersion string true none none
» website string true none none

Networks

Search for Networks

search all networks

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/networks", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/networks \
  --header 'accept: application/json'

GET /networks

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.372Z",
      "updated": "2020-11-20T19:42:49.372Z",
      "active": true
    },
    "parent": "123456789012",
    "description": "Cloudflare, Inc",
    "asn": 13335,
    "address": "8.6.112.22/32",
    "lat": "32.7787,",
    "long": -96.8217
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Network] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» parent string true none none
» description string true none none
» asn number true none none
» address string true none none
» lat number(float) true none none
» long number(float) true none none

search network by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/networks/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/networks/ \
  --header 'accept: application/json'

GET /networks/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.375Z",
    "updated": "2020-11-20T19:42:49.375Z",
    "active": true
  },
  "parent": "123456789012",
  "description": "Cloudflare, Inc",
  "asn": 13335,
  "address": "8.6.112.22/32",
  "lat": "32.7787,",
  "long": -96.8217
}

Responses

Status Meaning Description Schema
200 OK successful operation Network
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

search networks by ip address

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/networks/address/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/networks/address/ \
  --header 'accept: application/json'

GET /networks/address/{address}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.378Z",
    "updated": "2020-11-20T19:42:49.378Z",
    "active": true
  },
  "parent": "123456789012",
  "description": "Cloudflare, Inc",
  "asn": 13335,
  "address": "8.6.112.22/32",
  "lat": "32.7787,",
  "long": -96.8217
}

Responses

Status Meaning Description Schema
200 OK successful operation Network
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Resources

Search for Resources

search all resources

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/resources", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/resources \
  --header 'accept: application/json'

GET /resources

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.384Z",
      "updated": "2020-11-20T19:42:49.384Z",
      "active": true
    },
    "serial": "7:0C:71:A0:CC:C2:CB:A4:41:39:E3:18:25:C9:E3:25:05:BC:F9",
    "hash": "ikPc65n7WM7U9sU95JXy+pJrOLku5yfugNd1i+E4cB4=",
    "validFrom": "2020-11-20T19:42:49.384Z",
    "validTo": "2020-11-20T19:42:49.384Z",
    "subject": "C=US, O=Company.com, LLC, L=Miami Beach, ST=Florida, CN=*.company.com",
    "issuer": "C=US, O=Trustwave Holdings, Inc., L=Chicago, ST=Illinois, CN=Trustwave OV SHA256 Pre-Certificate CA",
    "altNames": [
      "hyperoffice.company.com"
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serial string true none none
» hash string true none none
» validFrom string(date-time) true none none
» validTo string(date-time) true none none
» subject string true none none
» issuer string true none none
» altNames [string] true none none

search resources by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/resources/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/resources/ \
  --header 'accept: application/json'

GET /resources/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.388Z",
    "updated": "2020-11-20T19:42:49.388Z",
    "active": true
  },
  "serial": "7:0C:71:A0:CC:C2:CB:A4:41:39:E3:18:25:C9:E3:25:05:BC:F9",
  "hash": "ikPc65n7WM7U9sU95JXy+pJrOLku5yfugNd1i+E4cB4=",
  "validFrom": "2020-11-20T19:42:49.388Z",
  "validTo": "2020-11-20T19:42:49.388Z",
  "subject": "C=US, O=Company.com, LLC, L=Miami Beach, ST=Florida, CN=*.company.com",
  "issuer": "C=US, O=Trustwave Holdings, Inc., L=Chicago, ST=Illinois, CN=Trustwave OV SHA256 Pre-Certificate CA",
  "altNames": [
    "hyperoffice.company.com"
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serial string true none none
» hash string true none none
» validFrom string(date-time) true none none
» validTo string(date-time) true none none
» subject string true none none
» issuer string true none none
» altNames [string] true none none

search resources by security certificate

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/resources/security/certificate", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/resources/security/certificate \
  --header 'accept: application/json'

GET /resources/security/certificate

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.391Z",
    "updated": "2020-11-20T19:42:49.391Z",
    "active": true
  },
  "serial": "7:0C:71:A0:CC:C2:CB:A4:41:39:E3:18:25:C9:E3:25:05:BC:F9",
  "hash": "ikPc65n7WM7U9sU95JXy+pJrOLku5yfugNd1i+E4cB4=",
  "validFrom": "2020-11-20T19:42:49.391Z",
  "validTo": "2020-11-20T19:42:49.391Z",
  "subject": "C=US, O=Company.com, LLC, L=Miami Beach, ST=Florida, CN=*.company.com",
  "issuer": "C=US, O=Trustwave Holdings, Inc., L=Chicago, ST=Illinois, CN=Trustwave OV SHA256 Pre-Certificate CA",
  "altNames": [
    "hyperoffice.company.com"
  ]
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serial string true none none
» hash string true none none
» validFrom string(date-time) true none none
» validTo string(date-time) true none none
» subject string true none none
» issuer string true none none
» altNames [string] true none none

Services

search for Services

search all services

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services \
  --header 'accept: application/json'

GET /services

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.394Z",
      "updated": "2020-11-20T19:42:49.394Z",
      "active": true
    },
    "serviceType": {
      "id": 2,
      "name": "HTTP",
      "commonPorts": [
        80
      ],
      "description": "HTTP service hosts webpages",
      "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
    },
    "port": 80
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serviceType NetworkServiceTypeInfo true none none
»» id number false none none
»» name string false none none
»» commonPorts [number] false none none
»» description string false none none
»» reference string false none none
» port number true none none

search service by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services/ \
  --header 'accept: application/json'

GET /services/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.398Z",
    "updated": "2020-11-20T19:42:49.398Z",
    "active": true
  },
  "serviceType": {
    "id": 2,
    "name": "HTTP",
    "commonPorts": [
      80
    ],
    "description": "HTTP service hosts webpages",
    "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
  },
  "port": 80
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serviceType NetworkServiceTypeInfo true none none
»» id number false none none
»» name string false none none
»» commonPorts [number] false none none
»» description string false none none
»» reference string false none none
» port number true none none

search all network services

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services/network", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services/network \
  --header 'accept: application/json'

GET /services/network

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.402Z",
      "updated": "2020-11-20T19:42:49.402Z",
      "active": true
    },
    "serviceType": {
      "id": 2,
      "name": "HTTP",
      "commonPorts": [
        80
      ],
      "description": "HTTP service hosts webpages",
      "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
    },
    "port": 80
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NetworkService] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serviceType NetworkServiceTypeInfo true none none
»» id number false none none
»» name string false none none
»» commonPorts [number] false none none
»» description string false none none
»» reference string false none none
» port number true none none

search network services by ip address

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services/network/address/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services/network/address/ \
  --header 'accept: application/json'

GET /services/network/address/{address}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.406Z",
      "updated": "2020-11-20T19:42:49.406Z",
      "active": true
    },
    "serviceType": {
      "id": 2,
      "name": "HTTP",
      "commonPorts": [
        80
      ],
      "description": "HTTP service hosts webpages",
      "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
    },
    "port": 80
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NetworkService] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serviceType NetworkServiceTypeInfo true none none
»» id number false none none
»» name string false none none
»» commonPorts [number] false none none
»» description string false none none
»» reference string false none none
» port number true none none

search network service by protocol

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services/network/protocol/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services/network/protocol/ \
  --header 'accept: application/json'

GET /services/network/protocol/{protocol}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.413Z",
      "updated": "2020-11-20T19:42:49.413Z",
      "active": true
    },
    "serviceType": {
      "id": 2,
      "name": "HTTP",
      "commonPorts": [
        80
      ],
      "description": "HTTP service hosts webpages",
      "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
    },
    "port": 80
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NetworkService] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serviceType NetworkServiceTypeInfo true none none
»» id number false none none
»» name string false none none
»» commonPorts [number] false none none
»» description string false none none
»» reference string false none none
» port number true none none

search network service by port

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services/network/port/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services/network/port/ \
  --header 'accept: application/json'

GET /services/network/port/{port}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.415Z",
      "updated": "2020-11-20T19:42:49.415Z",
      "active": true
    },
    "serviceType": {
      "id": 2,
      "name": "HTTP",
      "commonPorts": [
        80
      ],
      "description": "HTTP service hosts webpages",
      "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
    },
    "port": 80
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [NetworkService] false none none
» metadata InventoryMetadata true none none
»» id string(uuid) true none none
»» typeInfo InventoryTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» serviceType NetworkServiceTypeInfo true none none
»» id number false none none
»» name string false none none
»» commonPorts [number] false none none
»» description string false none none
»» reference string false none none
» port number true none none

search service by service name

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/services/network/name/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/services/network/name/ \
  --header 'accept: application/json'

GET /services/network/name/{name}

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.419Z",
    "updated": "2020-11-20T19:42:49.419Z",
    "active": true
  },
  "serviceType": {
    "id": 2,
    "name": "HTTP",
    "commonPorts": [
      80
    ],
    "description": "HTTP service hosts webpages",
    "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
  },
  "port": 80
}

Responses

Status Meaning Description Schema
200 OK successful operation NetworkService
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Exposures

search for all exposures

search all exposures

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/exposures", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/exposures \
  --header 'accept: application/json'

GET /exposures

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Exposure Name",
        "description": "Description of this type of exposure",
        "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.421Z",
      "updated": "2020-11-20T19:42:49.421Z",
      "active": true
    },
    "inventory": {
      "metadata": {
        "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
        "typeInfo": {
          "id": 123,
          "name": "Readable Type Name",
          "description": "Description of this type of inventory",
          "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
        },
        "orgId": "123456789012",
        "created": "2020-11-20T19:42:49.421Z",
        "updated": "2020-11-20T19:42:49.421Z",
        "active": true
      },
      "category": "framework",
      "license": "oss",
      "vendor": "React",
      "developer": "React",
      "name": "react",
      "versions": [
        "16.13.1"
      ],
      "lastVersion": "16.13.1",
      "website": "https://www.reactjs.org"
    },
    "description": "A cross-site scripting attack occurs when the attacker tricks a legitimate web-based application or site to accept a request as originating from a trusted source.",
    "affectedVersions": [
      "0.14.1"
    ],
    "references": [
      "https://github.com/facebook/react/issues/3473"
    ],
    "cve": "CVE-2020-12345",
    "cwe": "CWE-79"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

search exposures by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/exposures/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/exposures/ \
  --header 'accept: application/json'

GET /exposures/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Exposure Name",
      "description": "Description of this type of exposure",
      "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.424Z",
    "updated": "2020-11-20T19:42:49.424Z",
    "active": true
  },
  "inventory": {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.424Z",
      "updated": "2020-11-20T19:42:49.424Z",
      "active": true
    },
    "category": "framework",
    "license": "oss",
    "vendor": "React",
    "developer": "React",
    "name": "react",
    "versions": [
      "16.13.1"
    ],
    "lastVersion": "16.13.1",
    "website": "https://www.reactjs.org"
  },
  "description": "A cross-site scripting attack occurs when the attacker tricks a legitimate web-based application or site to accept a request as originating from a trusted source.",
  "affectedVersions": [
    "0.14.1"
  ],
  "references": [
    "https://github.com/facebook/react/issues/3473"
  ],
  "cve": "CVE-2020-12345",
  "cwe": "CWE-79"
}

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Vulnerabilities

search for Vulnerabilities

search all vulnerabilities

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/exposures/vulnerabilities", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/exposures/vulnerabilities \
  --header 'accept: application/json'

GET /exposures/vulnerabilities

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Exposure Name",
        "description": "Description of this type of exposure",
        "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.427Z",
      "updated": "2020-11-20T19:42:49.427Z",
      "active": true
    },
    "inventory": {
      "metadata": {
        "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
        "typeInfo": {
          "id": 123,
          "name": "Readable Type Name",
          "description": "Description of this type of inventory",
          "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
        },
        "orgId": "123456789012",
        "created": "2020-11-20T19:42:49.427Z",
        "updated": "2020-11-20T19:42:49.427Z",
        "active": true
      },
      "category": "framework",
      "license": "oss",
      "vendor": "React",
      "developer": "React",
      "name": "react",
      "versions": [
        "16.13.1"
      ],
      "lastVersion": "16.13.1",
      "website": "https://www.reactjs.org"
    },
    "description": "A cross-site scripting attack occurs when the attacker tricks a legitimate web-based application or site to accept a request as originating from a trusted source.",
    "affectedVersions": [
      "0.14.1"
    ],
    "references": [
      "https://github.com/facebook/react/issues/3473"
    ],
    "cve": "CVE-2020-12345",
    "cwe": "CWE-79"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Vulnerability] false none none
» metadata ExposureMetadata true none none
»» id string(uuid) false none none
»» typeInfo ExposureTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» inventory any true none none

anyOf

Name Type Required Restrictions Description
»» anonymous Software false none none
»»» metadata InventoryMetadata true none none
»»»» id string(uuid) true none none
»»»» typeInfo InventoryTypeInfo true none none
»»»»» id number false none none
»»»»» name string false none none
»»»»» description string false none none
»»»»» reference string false none none
»»»» orgId string true none none
»»»» created string(date-time) false none none
»»»» updated string(date-time) false none none
»»»» active boolean false none none
»»» category string true none none
»»» license string true none none
»»» vendor string true none none
»»» developer string true none none
»»» name string true none none
»»» versions [string] true none none
»»» lastVersion string true none none
»»» website string true none none

or

Name Type Required Restrictions Description
»» anonymous NetworkService false none none
»»» metadata InventoryMetadata true none none
»»» serviceType NetworkServiceTypeInfo true none none
»»»» id number false none none
»»»» name string false none none
»»»» commonPorts [number] false none none
»»»» description string false none none
»»»» reference string false none none
»»» port number true none none

continued

Name Type Required Restrictions Description
»» description string true none none
»» affectedVersions [string] true none none
»» references [string] false none none
»» cve string false none none
»» cwe string false none none

Organizations

search and manage your organizations

get all organizations

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/organizations", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/organizations \
  --header 'accept: application/json'

GET /organizations

tbd

Example responses

200 Response

[
  {
    "id": "123456789012",
    "domains": [
      {
        "type": "CNAME",
        "value": "www.domain.com"
      }
    ],
    "networks": [
      {
        "metadata": {
          "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
          "typeInfo": {
            "id": 123,
            "name": "Readable Type Name",
            "description": "Description of this type of inventory",
            "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
          },
          "orgId": "123456789012",
          "created": "2020-11-20T19:42:49.430Z",
          "updated": "2020-11-20T19:42:49.430Z",
          "active": true
        },
        "parent": "123456789012",
        "description": "Cloudflare, Inc",
        "asn": 13335,
        "address": "8.6.112.22/32",
        "lat": "32.7787,",
        "long": -96.8217
      }
    ],
    "created": "2020-11-20T19:42:49.430Z"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Organization] false none none
» id string true none none
» domains [DnsRecord] false none none
»» type string true none none
»» value string true none none
» networks [Network] false none none
»» metadata InventoryMetadata true none none
»»» id string(uuid) true none none
»»» typeInfo InventoryTypeInfo true none none
»»»» id number false none none
»»»» name string false none none
»»»» description string false none none
»»»» reference string false none none
»»» orgId string true none none
»»» created string(date-time) false none none
»»» updated string(date-time) false none none
»»» active boolean false none none
»» parent string true none none
»» description string true none none
»» asn number true none none
»» address string true none none
»» lat number(float) true none none
»» long number(float) true none none
» created string(date-time) true none none

add a new network to an organization

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

payload = "{\"address\":\"10.1.1.0/24\",\"description\":\"Our external network\"}"

headers = {
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/organizations/networks", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request POST \
  --url https://api.alphawave.co/organizations/networks \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"address":"10.1.1.0/24","description":"Our external network"}'

POST /organizations/networks

tbd

Body parameter

{
  "address": "10.1.1.0/24",
  "description": "Our external network"
}

Parameters

Name In Type Required Description
body body NetworkRequest true a new network object to add
» address body string true none
» description body string true none

Example responses

201 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.437Z",
    "updated": "2020-11-20T19:42:49.437Z",
    "active": true
  },
  "parent": "123456789012",
  "description": "Cloudflare, Inc",
  "asn": 13335,
  "address": "8.6.112.22/32",
  "lat": "32.7787,",
  "long": -96.8217
}

Responses

Status Meaning Description Schema
201 Created created new domain Network
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

get organizations network by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/organizations/networks/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/organizations/networks/ \
  --header 'accept: application/json'

GET /organizations/networks/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.440Z",
    "updated": "2020-11-20T19:42:49.440Z",
    "active": true
  },
  "parent": "123456789012",
  "description": "Cloudflare, Inc",
  "asn": 13335,
  "address": "8.6.112.22/32",
  "lat": "32.7787,",
  "long": -96.8217
}

Responses

Status Meaning Description Schema
200 OK successful operation Network
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

delete an organizations network by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("DELETE", "/organizations/networks/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request DELETE \
  --url https://api.alphawave.co/organizations/networks/ \
  --header 'accept: application/json'

DELETE /organizations/networks/{id}

tbd

Example responses

200 Response

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.442Z",
    "updated": "2020-11-20T19:42:49.442Z",
    "active": true
  },
  "parent": "123456789012",
  "description": "Cloudflare, Inc",
  "asn": 13335,
  "address": "8.6.112.22/32",
  "lat": "32.7787,",
  "long": -96.8217
}

Responses

Status Meaning Description Schema
200 OK successful operation Network
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

add a new domain to an organization

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

payload = "{\"name\":\"alphawave.co\",\"description\":\"Our labs domain\"}"

headers = {
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/organizations/domains", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request POST \
  --url https://api.alphawave.co/organizations/domains \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"name":"alphawave.co","description":"Our labs domain"}'

POST /organizations/domains

tbd

Body parameter

{
  "name": "alphawave.co",
  "description": "Our labs domain"
}

Parameters

Name In Type Required Description
body body DomainRequest true a new domain object to add
» name body string true none
» description body string true none

Example responses

201 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
201 Created created new domain DnsRecord
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

get organizations domain by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/organizations/domains/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/organizations/domains/ \
  --header 'accept: application/json'

GET /organizations/domains/{id}

tbd

Example responses

200 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
200 OK successful operation DnsRecord
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

delete an organizations domain by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("DELETE", "/organizations/domains/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request DELETE \
  --url https://api.alphawave.co/organizations/domains/ \
  --header 'accept: application/json'

DELETE /organizations/domains/{id}

tbd

Example responses

200 Response

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Responses

Status Meaning Description Schema
200 OK successful operation DnsRecord
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Scans

The Scan endpoint allows you to scan new networks and domains in real time. This is particularly useful when deploying new infrastructure and networks. One particularly useful integration is with build pipelines that want to ensure they are not exposing vulnerable systems to the internet when deploying code.

get running scans

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/scans", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/scans \
  --header 'accept: application/json'

GET /scans

tbd

Example responses

200 Response

[
  {
    "id": "123456789012",
    "status": "starting",
    "error": "ok",
    "source": "network",
    "data": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Scan] false none none
» id string true none none
» status string true none none
» error string true none none
» source string true none none
» data string true none none

Enumerated Values

Property Value
status starting
status started
status finishing
status finished
error ok
error failed
source network
source domain

start a scan

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

payload = "{\"type\":\"network\",\"data\":\"127.0.0.1/24 or alphawave.co\",\"description\":\"scan our cloud network\"}"

headers = {
    'content-type': "application/json",
    'accept': "application/json"
    }

conn.request("POST", "/scans", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request POST \
  --url https://api.alphawave.co/scans \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"type":"network","data":"127.0.0.1/24 or alphawave.co","description":"scan our cloud network"}'

POST /scans

tbd

Body parameter

{
  "type": "network",
  "data": "127.0.0.1/24 or alphawave.co",
  "description": "scan our cloud network"
}

Parameters

Name In Type Required Description
body body ScanRequest true a scan request object
» type body string true none
» data body string true none
» description body string false none

Enumerated Values

Parameter Value
» type network
» type domain

Example responses

201 Response

{
  "id": "123456789012",
  "status": "starting",
  "error": "ok",
  "source": "network",
  "data": "string"
}

Responses

Status Meaning Description Schema
201 Created successful operation Scan
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

get scan by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/scans/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/scans/ \
  --header 'accept: application/json'

GET /scans/{id}

tbd

Example responses

200 Response

{
  "id": "123456789012",
  "status": "starting",
  "error": "ok",
  "source": "network",
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation Scan
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

delete a scan by id

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("DELETE", "/scans/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request DELETE \
  --url https://api.alphawave.co/scans/ \
  --header 'accept: application/json'

DELETE /scans/{id}

tbd

Example responses

200 Response

{
  "id": "123456789012",
  "status": "starting",
  "error": "ok",
  "source": "network",
  "data": "string"
}

Responses

Status Meaning Description Schema
200 OK successful operation Scan
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

RiskyServices

search all risky services

Code samples

import http.client

conn = http.client.HTTPSConnection("api.alphawave.co")

headers = { 'accept': "application/json" }

conn.request("GET", "/exposures/riskyservices", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
curl --request GET \
  --url https://api.alphawave.co/exposures/riskyservices \
  --header 'accept: application/json'

GET /exposures/riskyservices

tbd

Parameters

Name In Type Required Description
limit query number false limit request results
start query number false start results at number
stop query number false end results at number

Example responses

200 Response

[
  {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Exposure Name",
        "description": "Description of this type of exposure",
        "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.460Z",
      "updated": "2020-11-20T19:42:49.460Z",
      "active": true
    },
    "inventory": {
      "metadata": {
        "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
        "typeInfo": {
          "id": 123,
          "name": "Readable Type Name",
          "description": "Description of this type of inventory",
          "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
        },
        "orgId": "123456789012",
        "created": "2020-11-20T19:42:49.461Z",
        "updated": "2020-11-20T19:42:49.461Z",
        "active": true
      },
      "serviceType": {
        "id": 2,
        "name": "HTTP",
        "commonPorts": [
          80
        ],
        "description": "HTTP service hosts webpages",
        "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
      },
      "port": 80
    }
  }
]

Responses

Status Meaning Description Schema
200 OK successful operation Inline
400 Bad Request bad input parameter None
500 Internal Server Error internal service error None

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [RiskyService] false none none
» metadata ExposureMetadata true none none
»» id string(uuid) false none none
»» typeInfo ExposureTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» description string false none none
»»» reference string false none none
»» orgId string true none none
»» created string(date-time) false none none
»» updated string(date-time) false none none
»» active boolean false none none
» inventory NetworkService true none none
»» metadata InventoryMetadata true none none
»»» id string(uuid) true none none
»»» typeInfo InventoryTypeInfo true none none
»»»» id number false none none
»»»» name string false none none
»»»» description string false none none
»»»» reference string false none none
»»» orgId string true none none
»»» created string(date-time) false none none
»»» updated string(date-time) false none none
»»» active boolean false none none
»» serviceType NetworkServiceTypeInfo true none none
»»» id number false none none
»»» name string false none none
»»» commonPorts [number] false none none
»»» description string false none none
»»» reference string false none none
»» port number true none none

Schemas

DnsRecord

{
  "type": "CNAME",
  "value": "www.domain.com"
}

Properties

Name Type Required Restrictions Description
type string true none none
value string true none none

DomainRequest

{
  "name": "alphawave.co",
  "description": "Our labs domain"
}

Properties

Name Type Required Restrictions Description
name string true none none
description string true none none

Software

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.461Z",
    "updated": "2020-11-20T19:42:49.461Z",
    "active": true
  },
  "category": "framework",
  "license": "oss",
  "vendor": "React",
  "developer": "React",
  "name": "react",
  "versions": [
    "16.13.1"
  ],
  "lastVersion": "16.13.1",
  "website": "https://www.reactjs.org"
}

Properties

Name Type Required Restrictions Description
metadata InventoryMetadata true none none
category string true none none
license string true none none
vendor string true none none
developer string true none none
name string true none none
versions [string] true none none
lastVersion string true none none
website string true none none

Network

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.462Z",
    "updated": "2020-11-20T19:42:49.462Z",
    "active": true
  },
  "parent": "123456789012",
  "description": "Cloudflare, Inc",
  "asn": 13335,
  "address": "8.6.112.22/32",
  "lat": "32.7787,",
  "long": -96.8217
}

Properties

Name Type Required Restrictions Description
metadata InventoryMetadata true none none
parent string true none none
description string true none none
asn number true none none
address string true none none
lat number(float) true none none
long number(float) true none none

NetworkRequest

{
  "address": "10.1.1.0/24",
  "description": "Our external network"
}

Properties

Name Type Required Restrictions Description
address string true none none
description string true none none

SecurityCertificate

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.462Z",
    "updated": "2020-11-20T19:42:49.462Z",
    "active": true
  },
  "serial": "7:0C:71:A0:CC:C2:CB:A4:41:39:E3:18:25:C9:E3:25:05:BC:F9",
  "hash": "ikPc65n7WM7U9sU95JXy+pJrOLku5yfugNd1i+E4cB4=",
  "validFrom": "2020-11-20T19:42:49.462Z",
  "validTo": "2020-11-20T19:42:49.462Z",
  "subject": "C=US, O=Company.com, LLC, L=Miami Beach, ST=Florida, CN=*.company.com",
  "issuer": "C=US, O=Trustwave Holdings, Inc., L=Chicago, ST=Illinois, CN=Trustwave OV SHA256 Pre-Certificate CA",
  "altNames": [
    "hyperoffice.company.com"
  ]
}

Properties

Name Type Required Restrictions Description
metadata InventoryMetadata true none none
serial string true none none
hash string true none none
validFrom string(date-time) true none none
validTo string(date-time) true none none
subject string true none none
issuer string true none none
altNames [string] true none none

NetworkServiceTypeInfo

{
  "id": 2,
  "name": "HTTP",
  "commonPorts": [
    80
  ],
  "description": "HTTP service hosts webpages",
  "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
}

Properties

Name Type Required Restrictions Description
id number false none none
name string false none none
commonPorts [number] false none none
description string false none none
reference string false none none

NetworkService

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Type Name",
      "description": "Description of this type of inventory",
      "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.462Z",
    "updated": "2020-11-20T19:42:49.462Z",
    "active": true
  },
  "serviceType": {
    "id": 2,
    "name": "HTTP",
    "commonPorts": [
      80
    ],
    "description": "HTTP service hosts webpages",
    "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
  },
  "port": 80
}

Properties

Name Type Required Restrictions Description
metadata InventoryMetadata true none none
serviceType NetworkServiceTypeInfo true none none
port number true none none

Vulnerability

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Exposure Name",
      "description": "Description of this type of exposure",
      "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.463Z",
    "updated": "2020-11-20T19:42:49.463Z",
    "active": true
  },
  "inventory": {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.463Z",
      "updated": "2020-11-20T19:42:49.463Z",
      "active": true
    },
    "category": "framework",
    "license": "oss",
    "vendor": "React",
    "developer": "React",
    "name": "react",
    "versions": [
      "16.13.1"
    ],
    "lastVersion": "16.13.1",
    "website": "https://www.reactjs.org"
  },
  "description": "A cross-site scripting attack occurs when the attacker tricks a legitimate web-based application or site to accept a request as originating from a trusted source.",
  "affectedVersions": [
    "0.14.1"
  ],
  "references": [
    "https://github.com/facebook/react/issues/3473"
  ],
  "cve": "CVE-2020-12345",
  "cwe": "CWE-79"
}

Properties

Name Type Required Restrictions Description
metadata ExposureMetadata true none none
inventory any true none none

anyOf

Name Type Required Restrictions Description
» anonymous Software false none none

or

Name Type Required Restrictions Description
» anonymous NetworkService false none none

continued

Name Type Required Restrictions Description
description string true none none
affectedVersions [string] true none none
references [string] false none none
cve string false none none
cwe string false none none

RiskyService

{
  "metadata": {
    "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
    "typeInfo": {
      "id": 123,
      "name": "Readable Exposure Name",
      "description": "Description of this type of exposure",
      "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
    },
    "orgId": "123456789012",
    "created": "2020-11-20T19:42:49.463Z",
    "updated": "2020-11-20T19:42:49.463Z",
    "active": true
  },
  "inventory": {
    "metadata": {
      "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
      "typeInfo": {
        "id": 123,
        "name": "Readable Type Name",
        "description": "Description of this type of inventory",
        "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
      },
      "orgId": "123456789012",
      "created": "2020-11-20T19:42:49.463Z",
      "updated": "2020-11-20T19:42:49.463Z",
      "active": true
    },
    "serviceType": {
      "id": 2,
      "name": "HTTP",
      "commonPorts": [
        80
      ],
      "description": "HTTP service hosts webpages",
      "reference": "https://docs.docs.alphawave.co/inventory/service/network/http"
    },
    "port": 80
  }
}

Properties

Name Type Required Restrictions Description
metadata ExposureMetadata true none none
inventory NetworkService true none none

Organization

{
  "id": "123456789012",
  "domains": [
    {
      "type": "CNAME",
      "value": "www.domain.com"
    }
  ],
  "networks": [
    {
      "metadata": {
        "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
        "typeInfo": {
          "id": 123,
          "name": "Readable Type Name",
          "description": "Description of this type of inventory",
          "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
        },
        "orgId": "123456789012",
        "created": "2020-11-20T19:42:49.464Z",
        "updated": "2020-11-20T19:42:49.464Z",
        "active": true
      },
      "parent": "123456789012",
      "description": "Cloudflare, Inc",
      "asn": 13335,
      "address": "8.6.112.22/32",
      "lat": "32.7787,",
      "long": -96.8217
    }
  ],
  "created": "2020-11-20T19:42:49.464Z"
}

Properties

Name Type Required Restrictions Description
id string true none none
domains [DnsRecord] false none none
networks [Network] false none none
created string(date-time) true none none

Scan

{
  "id": "123456789012",
  "status": "starting",
  "error": "ok",
  "source": "network",
  "data": "string"
}

Properties

Name Type Required Restrictions Description
id string true none none
status string true none none
error string true none none
source string true none none
data string true none none

Enumerated Values

Property Value
status starting
status started
status finishing
status finished
error ok
error failed
source network
source domain

ScanRequest

{
  "type": "network",
  "data": "127.0.0.1/24 or alphawave.co",
  "description": "scan our cloud network"
}

Properties

Name Type Required Restrictions Description
type string true none none
data string true none none
description string false none none

Enumerated Values

Property Value
type network
type domain

InventoryTypeInfo

{
  "id": 123,
  "name": "Readable Type Name",
  "description": "Description of this type of inventory",
  "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
}

Properties

Name Type Required Restrictions Description
id number false none none
name string false none none
description string false none none
reference string false none none

InventoryMetadata

{
  "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
  "typeInfo": {
    "id": 123,
    "name": "Readable Type Name",
    "description": "Description of this type of inventory",
    "reference": "https://docs.alphawave.co/inventory/typenamehelpdocs"
  },
  "orgId": "123456789012",
  "created": "2020-11-20T19:42:49.465Z",
  "updated": "2020-11-20T19:42:49.465Z",
  "active": true
}

Properties

Name Type Required Restrictions Description
id string(uuid) true none none
typeInfo InventoryTypeInfo true none none
orgId string true none none
created string(date-time) false none none
updated string(date-time) false none none
active boolean false none none

ExposureTypeInfo

{
  "id": 123,
  "name": "Readable Exposure Name",
  "description": "Description of this type of exposure",
  "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
}

Properties

Name Type Required Restrictions Description
id number false none none
name string false none none
description string false none none
reference string false none none

ExposureMetadata

{
  "id": "600d1675-e5cf-41cc-ac42-0e326b8bd175",
  "typeInfo": {
    "id": 123,
    "name": "Readable Exposure Name",
    "description": "Description of this type of exposure",
    "reference": "https://docs.alphawave.co/exposure/exposurenamehelpdocs"
  },
  "orgId": "123456789012",
  "created": "2020-11-20T19:42:49.465Z",
  "updated": "2020-11-20T19:42:49.465Z",
  "active": true
}

Properties

Name Type Required Restrictions Description
id string(uuid) false none none
typeInfo ExposureTypeInfo true none none
orgId string true none none
created string(date-time) false none none
updated string(date-time) false none none
active boolean false none none