Download OpenAPI specification: Download
Contact:
support@rapid7.com
This guide documents the InsightVM Application Programming Interface (API) Version 3. This API supports the
Representation State Transfer (REST) design pattern. Unless noted otherwise this API accepts and produces the
application/json
media type. This API uses Hypermedia as the Engine of Application State (HATEOAS) and
is hypermedia friendly. All API connections must be made to the security console using HTTPS.
Versioning is specified in the URL and the base path of this API is: https://<host>:<port>/api/3/
.
An OpenAPI v2 specification (also known as Swagger 2) of this API is available. Tools such as swagger-codegen can be used to generate an API client in the language of your choosing using this specification document.
Download the specification: Download
Authorization to the API uses HTTP Basic Authorization
(see RFC 2617 for more information). Requests must
supply authorization credentials in the Authorization
header using a Base64 encoded hash of "username:password"
.
This API supports two-factor authentication (2FA) by supplying an authentication token in addition to the Basic
Authorization. The token is specified using the Token
request header. To leverage two-factor authentication, this
must be enabled on the console and be configured for the account accessing the API.
Resource names represent nouns and identify the entity being manipulated or accessed. All collection resources are pluralized to indicate to the client they are interacting with a collection of multiple resources of the same type. Singular resource names are used when there exists only one resource available to interact with.
The following naming conventions are used by this API:
Type | Case |
---|---|
Resource names | lower_snake_case |
Header, body, and query parameters parameters | camelCase |
JSON fields and property names | camelCase |
A collection resource is a parent resource for instance resources, but can itself be retrieved and operated on independently. Collection resources use a pluralized resource name. The resource path for collection resources follow the convention:
/api/3/{resource_name}
An instance resource is a "leaf" level resource that may be retrieved, optionally nested within a collection resource. Instance resources are usually retrievable with opaque identifiers. The resource path for instance resources follows the convention:
/api/3/{resource_name}/{instance_id}...
The following HTTP operations are supported throughout this API. The general usage of the operation and both its failure and success status codes are outlined below.
Verb | Usage | Success | Failure |
---|---|---|---|
GET | Used to retrieve a resource by identifier, or a collection of resources by type. | 200 | 400 , 401 , 402 , 404 , 405 , 408 , 410 , 415 , 500 |
POST | Creates a resource with an application-specified identifier. | 201 | 400 , 401 , 404 , 405 , 408 , 413 , 415 , 500 |
POST | Performs a request to queue an asynchronous job. | 202 | 400 , 401 , 405 , 408 , 410 , 413 , 415 , 500 |
PUT | Creates a resource with a client-specified identifier. | 200 | 400 , 401 , 403 , 405 , 408 , 410 , 413 , 415 , 500 |
PUT | Performs a full update of a resource with a specified identifier. | 201 | 400 , 401 , 403 , 405 , 408 , 410 , 413 , 415 , 500 |
DELETE | Deletes a resource by identifier or an entire collection of resources. | 204 | 400 , 401 , 405 , 408 , 410 , 413 , 415 , 500 |
OPTIONS | Requests what operations are available on a resource. | 200 | 401 , 404 , 405 , 408 , 500 |
All resources respond to the OPTIONS
request, which allows discoverability of available operations that are supported.
The OPTIONS
response returns the acceptable HTTP operations on that resource within the Allow
header. The response
is always a 200 OK
status.
Collection resources can support the GET
, POST
, PUT
, and DELETE
operations.
The GET
operation invoked on a collection resource indicates a request to retrieve all, or some, of the entities
contained within the collection. This also includes the optional capability to filter or search resources during
the request. The response from a collection listing is a paginated document. See
hypermedia links for more information.
The POST
is a non-idempotent operation that allows for the creation of a new resource when the resource identifier
is not provided by the system during the creation operation (i.e. the Security Console generates the identifier). The
content of the POST
request is sent in the request body. The response to a successful POST
request should be a
201 CREATED
with a valid Location
header field set to the URI that can be used to access to the newly
created resource.
The POST
to a collection resource can also be used to interact with asynchronous resources. In this situation,
instead of a 201 CREATED
response, the 202 ACCEPTED
response indicates that processing of the request is not fully
complete but has been accepted for future processing. This request will respond similarly with a Location
header with
link to the job-oriented asynchronous resource that was created and/or queued.
The PUT
is an idempotent operation that either performs a create with user-supplied identity, or a full replace
or update of a resource by a known identifier. The response to a PUT
operation to create an entity is a 201 Created
with a valid Location
header field set to the URI that can be used to access to the newly created resource.
PUT
on a collection resource replaces all values in the collection. The typical response to a PUT
operation that
updates an entity is hypermedia links, which may link to related resources caused by the side-effects of the changes
performed.
The DELETE
is an idempotent operation that physically deletes a resource, or removes an association between resources.
The typical response to a DELETE
operation is hypermedia links, which may link to related resources caused by the
side-effects of the changes performed.
Instance resources can support the GET
, PUT
, POST
, PATCH
and DELETE
operations.
Retrieves the details of a specific resource by its identifier. The details retrieved can be controlled through property selection and property views. The content of the resource is returned within the body of the response in the acceptable media type.
Allows for and idempotent "full update" (complete replacement) on a specific resource. If the resource does not exist,
it will be created; if it does exist, it is completely overwritten. Any omitted properties in the request are assumed to
be undefined/null. For "partial updates" use POST
or PATCH
instead.
The content of the PUT
request is sent in the request body. The identifier of the resource is specified within the URL
(not the request body). The response to a successful PUT
request is a 201 CREATED
to represent the created status,
with a valid Location
header field set to the URI that can be used to access to the newly created (or fully replaced)
resource.
Performs a non-idempotent creation of a new resource. The POST
of an instance resource most commonly occurs with the
use of nested resources (e.g. searching on a parent collection resource). The response to a POST
of an instance
resource is typically a 200 OK
if the resource is non-persistent, and a 201 CREATED
if there is a resource
created/persisted as a result of the operation. This varies by endpoint.
The PATCH
operation is used to perform a partial update of a resource. PATCH
is a non-idempotent operation that
enforces an atomic mutation of a resource. Only the properties specified in the request are to be overwritten on the
resource it is applied to. If a property is missing, it is assumed to not have changed.
Permanently removes the individual resource from the system. If the resource is an association between resources, only
the association is removed, not the resources themselves. A successful deletion of the resource should return
204 NO CONTENT
with no response body. This operation is not fully idempotent, as follow-up requests to delete a
non-existent resource should return a 404 NOT FOUND
.
Unless otherwise indicated, the default request body media type is application/json
.
Commonly used request headers include:
Header | Example | Purpose |
---|---|---|
Accept | application/json | Defines what acceptable content types are allowed by the client. For all types, use */* . |
Accept-Encoding | deflate, gzip | Allows for the encoding to be specified (such as gzip). |
Accept-Language | en-US | Indicates to the server the client's locale (defaults en-US ). |
Authorization | Basic Base64("username:password") | Basic authentication |
Token | 123456 | Two-factor authentication token (if enabled) |
Dates and/or times are specified as strings in the ISO 8601 format(s). The following formats are supported as input:
Value | Format | Notes |
---|---|---|
Date | YYYY-MM-DD | Defaults to 12 am UTC (if used for a date & time |
Date & time only | YYYY-MM-DD'T'hh:mm:ss[.nnn] | Defaults to UTC |
Date & time in UTC | YYYY-MM-DD'T'hh:mm:ss[.nnn]Z | |
Date & time w/ offset | YYYY-MM-DD'T'hh:mm:ss[.nnn][+|-]hh:mm | |
Date & time w/ zone-offset | YYYY-MM-DD'T'hh:mm:ss[.nnn][+|-]hh:mm[<zone-id>] |
Timezones are specified in the regional zone format, such as "America/Los_Angeles"
, "Asia/Tokyo"
, or "GMT"
.
Pagination is supported on certain collection resources using a combination of two query parameters, page
and size
.
As these are control parameters, they are prefixed with the underscore character. The page parameter dictates the
zero-based index of the page to retrieve, and the size
indicates the size of the page.
For example, /resources?page=2&size=10
will return page 3, with 10 records per page, giving results 21-30.
The maximum page size for a request is 500.
Sorting is supported on paginated resources with the sort
query parameter(s). The sort query parameter(s) supports
identifying a single or multi-property sort with a single or multi-direction output. The format of the parameter is:
sort=property[,ASC|DESC]...
Therefore, the request /resources?sort=name,title,DESC
would return the results sorted by the name and title
descending, in that order. The sort directions are either ascending ASC
or descending DESC
. With single-order
sorting, all properties are sorted in the same direction. To sort the results with varying orders by property,
multiple sort parameters are passed.
For example, the request /resources?sort=name,ASC&sort=title,DESC
would sort by name ascending and title
descending, in that order.
The following response statuses may be returned by this API.
Status | Meaning | Usage |
---|---|---|
200 | OK | The operation performed without error according to the specification of the request, and no more specific 2xx code is suitable. |
201 | Created | A create request has been fulfilled and a resource has been created. The resource is available as the URI specified in the response, including the Location header. |
202 | Accepted | An asynchronous task has been accepted, but not guaranteed, to be processed in the future. |
400 | Bad Request | The request was invalid or cannot be otherwise served. The request is not likely to succeed in the future without modifications. |
401 | Unauthorized | The user is unauthorized to perform the operation requested, or does not maintain permissions to perform the operation on the resource specified. |
403 | Forbidden | The resource exists to which the user has access, but the operating requested is not permitted. |
404 | Not Found | The resource specified could not be located, does not exist, or an unauthenticated client does not have permissions to a resource. |
405 | Method Not Allowed | The operations may not be performed on the specific resource. Allowed operations are returned and may be performed on the resource. |
408 | Request Timeout | The client has failed to complete a request in a timely manner and the request has been discarded. |
413 | Request Entity Too Large | The request being provided is too large for the server to accept processing. |
415 | Unsupported Media Type | The media type is not supported for the requested resource. |
500 | Internal Server Error | An internal and unexpected error has occurred on the server at no fault of the client. |
The response statuses 401, 403 and 404 need special consideration for security purposes. As necessary, error statuses and messages may be obscured to strengthen security and prevent information exposure. The following is a guideline for privileged resource response statuses:
Use Case | Access | Resource | Permission | Status |
---|---|---|---|---|
Unauthenticated access to an unauthenticated resource. | Unauthenticated | Unauthenticated | Yes | 20x |
Unauthenticated access to an authenticated resource. | Unauthenticated | Authenticated | No | 401 |
Unauthenticated access to an authenticated resource. | Unauthenticated | Non-existent | No | 401 |
Authenticated access to a unauthenticated resource. | Authenticated | Unauthenticated | Yes | 20x |
Authenticated access to an authenticated, unprivileged resource. | Authenticated | Authenticated | No | 404 |
Authenticated access to an authenticated, privileged resource. | Authenticated | Authenticated | Yes | 20x |
Authenticated access to an authenticated, non-existent resource | Authenticated | Non-existent | Yes | 404 |
Commonly used response headers include:
Header | Example | Purpose |
---|---|---|
Allow | OPTIONS, GET | Defines the allowable HTTP operations on a resource. |
Cache-Control | no-store, must-revalidate | Disables caching of resources (as they are all dynamic). |
Content-Encoding | gzip | The encoding of the response body (if any). |
Location | Refers to the URI of the resource created by a request. | |
Transfer-Encoding | chunked | Specified the encoding used to transform response. |
Retry-After | 5000 | Indicates the time to wait before retrying a request. |
X-Content-Type-Options | nosniff | Disables MIME type sniffing. |
X-XSS-Protection | 1; mode=block | Enables XSS filter protection. |
X-Frame-Options | SAMEORIGIN | Prevents rendering in a frame from a different origin. |
X-UA-Compatible | IE=edge,chrome=1 | Specifies the browser mode to render in. |
When application/json
is returned in the response body it is always pretty-printed (indented, human readable output).
Additionally, gzip compression/encoding is supported on all responses.
Dates or times are returned as strings in the ISO 8601 'extended' format. When a date and time is returned (instant) the value is converted to UTC.
For example:
Value | Format | Example |
---|---|---|
Date | YYYY-MM-DD | 2017-12-03 |
Date & Time | YYYY-MM-DD'T'hh:mm:ss[.nnn]Z | 2017-12-03T10:15:30Z |
In some resources a Content data type is used. This allows for multiple formats of representation to be returned
within resource, specifically "html"
and "text"
. The "text"
property returns a flattened representation suitable
for output in textual displays. The "html"
property returns an HTML fragment suitable for display within an HTML
element. Note, the HTML returned is not a valid stand-alone HTML document.
The response to a paginated request follows the format:
{
resources": [
...
],
"page": {
"number" : ...,
"size" : ...,
"totalResources" : ...,
"totalPages" : ...
},
"links": [
"first" : {
"href" : "..."
},
"prev" : {
"href" : "..."
},
"self" : {
"href" : "..."
},
"next" : {
"href" : "..."
},
"last" : {
"href" : "..."
}
]
}
The resources
property is an array of the resources being retrieved from the endpoint, each which should contain at
minimum a "self" relation hypermedia link. The page
property outlines the details of the current page and total
possible pages. The object for the page includes the following properties:
The last property of the paged response is the links
array, which contains all available hypermedia links. For
paginated responses, the "self", "next", "previous", "first", and "last" links are returned. The "self" link must
always be returned and should contain a link to allow the client to replicate the original request against the
collection resource in an identical manner to that in which it was invoked.
The "next" and "previous" links are present if either or both there exists a previous or next page, respectively. The "next" and "previous" links have hrefs that allow "natural movement" to the next page, that is all parameters required to move the next page are provided in the link. The "first" and "last" links provide references to the first and last pages respectively.
Requests outside the boundaries of the pageable will result in a 404 NOT FOUND
. Paginated requests do not provide a
"stateful cursor" to the client, nor does it need to provide a read consistent view. Records in adjacent pages may
change while pagination is being traversed, and the total number of pages and resources may change between requests
within the same filtered/queries resource collection.
The "depth" of the response of a resource can be configured using a "view". All endpoints supports two views that can
tune the extent of the information returned in the resource. The supported views are summary
and details
(the default).
View are specified using a query parameter, in this format:
/<resource>?view={viewName}
Any error responses can provide a response body with a message to the client indicating more information (if applicable) to aid debugging of the error. All 40x and 50x responses will return an error response in the body. The format of the response is as follows:
{
"status": <statusCode>,
"message": <message>,
"links" : [ {
"rel" : "...",
"href" : "..."
} ]
}
The status
property is the same as the HTTP status returned in the response, to ease client parsing. The message
property is a localized message in the request client's locale (if applicable) that articulates the nature of the
error. The last property is the links
property. This may contain additional
hypermedia links to troubleshoot.
Multiple resources make use of search criteria to match assets. Search criteria is an array of search filters. Each search filter has a generic format of:
{
"field": "<field-name>",
"operator": "<operator>",
["value": "<value>",]
["lower": "<value>",]
["upper": "<value>"]
}
Every filter defines two required properties field
and operator
. The field is the name of an asset property that
is being filtered on. The operator is a type and property-specific operating performed on the filtered property. The
valid values for fields and operators are outlined in the table below.
Every filter also defines one or more values that are supplied to the operator. The valid values vary by operator and are outlined below.
The following table outlines the search criteria fields and the available operators:
Field | Operators |
---|---|
alternate-address-type | in |
container-image | is is not starts with ends with contains does not contain is like not like |
container-status | is is not |
containers | are |
criticality-tag | is is not is greater than is less than is applied is not applied |
custom-tag | is is not starts with ends with contains does not contain is applied is not applied |
cve | is is not contains does not contain |
cvss-access-complexity | is is not |
cvss-authentication-required | is is not |
cvss-access-vector | is is not |
cvss-availability-impact | is is not |
cvss-confidentiality-impact | is is not |
cvss-integrity-impact | is is not |
cvss-v3-confidentiality-impact | is is not |
cvss-v3-integrity-impact | is is not |
cvss-v3-availability-impact | is is not |
cvss-v3-attack-vector | is is not |
cvss-v3-attack-complexity | is is not |
cvss-v3-user-interaction | is is not |
cvss-v3-privileges-required | is is not |
host-name | is is not starts with ends with contains does not contain is empty is not empty is like not like |
host-type | in not in |
ip-address | is is not in range not in range is like not like |
ip-address-type | in not in |
last-scan-date | is-on-or-before is on or after is between is earlier than is within the last |
location-tag | is is not starts with ends with contains does not contain is applied is not applied |
mobile-device-last-sync-time | is-within-the-last is earlier than |
open-ports | is is not in range |
operating-system | contains does not contain is empty is not empty |
owner-tag | is is not starts with ends with contains does not contain is applied is not applied |
pci-compliance | is |
risk-score | is is not in range greater than less than |
service-name | contains does not contain |
site-id | in not in |
software | contains does not contain |
vAsset-cluster | is is not contains does not contain starts with |
vAsset-datacenter | is is not |
vAsset-host-name | is is not contains does not contain starts with |
vAsset-power-state | in not in |
vAsset-resource-pool-path | contains does not contain |
vulnerability-assessed | is-on-or-before is on or after is between is earlier than is within the last |
vulnerability-category | is is not starts with ends with contains does not contain |
vulnerability-cvss-v3-score | is is not |
vulnerability-cvss-score | is is not in range is greater than is less than |
vulnerability-exposures | includes does not include |
vulnerability-title | contains does not contain is is not starts with ends with |
vulnerability-validated-status | are |
The following fields have enumerated values:
Field | Acceptable Values |
---|---|
alternate-address-type | 0=IPv4, 1=IPv6 |
containers | 0=present, 1=not present |
container-status | created running paused restarting exited dead unknown |
cvss-access-complexity |
|
cvss-integrity-impact |
|
cvss-confidentiality-impact |
|
cvss-availability-impact |
|
cvss-access-vector |
|
cvss-authentication-required |
|
cvss-v3-confidentiality-impact |
|
cvss-v3-integrity-impact |
|
cvss-v3-availability-impact |
|
cvss-v3-attack-vector |
|
cvss-v3-attack-complexity |
|
cvss-v3-user-interaction |
|
cvss-v3-privileges-required |
|
host-type | 0=Unknown, 1=Guest, 2=Hypervisor, 3=Physical, 4=Mobile |
ip-address-type | 0=IPv4, 1=IPv6 |
pci-compliance | 0=fail, 1=pass |
vulnerability-validated-status | 0=present, 1=not present |
The following table outlines which properties are required for each operator and the appropriate data type(s):
Operator | value | lower | upper |
---|---|---|---|
are | string | ||
contains | string | ||
does-not-contain | string | ||
ends with | string | ||
in | Array[ string ] | ||
in-range | numeric | numeric | |
includes | Array[ string ] | ||
is | string | ||
is-applied | |||
is-between | numeric | numeric | |
is-earlier-than | numeric | ||
is-empty | |||
is-greater-than | numeric | ||
is-on-or-after | string (yyyy-MM-dd) | ||
is-on-or-before | string (yyyy-MM-dd) | ||
is-not | string | ||
is-not-applied | |||
is-not-empty | |||
is-within-the-last | string | ||
less-than | string | ||
like | string | ||
not-contains | string | ||
not-in | Array[ string ] | ||
not-in-range | numeric | numeric | |
not-like | string | ||
starts-with | string |
Dynamic sites make use of search criteria to match assets from a discovery connection. Search criteria is an array of search filters.
Each search filter has a generic format of:
{
"field": "<field-name>",
"operator": "<operator>",
["value": "<value>",]
["lower": "<value>",]
["upper": "<value>"]
}
Every filter defines two required properties field
and operator
. The field is the name of an asset property that
is being filtered on. The list of supported fields vary depending on the type of discovery connection configured
for the dynamic site (e.g vSphere, ActiveSync, etc.). The operator is a type and property-specific operating
performed on the filtered property. The valid values for fields outlined in the tables below and are grouped by the
type of connection.
Every filter also defines one or more values that are supplied to the operator. See Search Criteria Operator Properties for more information on the valid values for each operator.
This section documents search criteria information for ActiveSync discovery connections. The discovery connections
must be one of the following types: "activesync-ldap"
, "activesync-office365"
, or "activesync-powershell"
.
The following table outlines the search criteria fields and the available operators for ActiveSync connections:
Field | Operators |
---|---|
last-sync-time | is-within-the-last is-earlier-than |
operating-system | contains does-not-contain |
user | is is-not contains does-not-contain starts-with |
This section documents search criteria information for AWS discovery connections. The discovery connections must be the type "aws"
.
The following table outlines the search criteria fields and the available operators for AWS connections:
Field | Operators |
---|---|
availability-zone | contains does-not-contain |
guest-os-family | contains does-not-contain |
instance-id | contains does-not-contain |
instance-name | is is-not contains does-not-contain starts-with |
instance-state | in not-in |
instance-type | in not-in |
ip-address | in-range not-in-range is is-not |
region | in not-in |
vpc-id | is is-not contains does-not-contain starts-with |
This section documents search criteria information for DHCP discovery connections. The discovery connections must be the type "dhcp"
.
The following table outlines the search criteria fields and the available operators for DHCP connections:
Field | Operators |
---|---|
host-name | is is-not contains does-not-contain starts-with |
ip-address | in-range not-in-range is is-not |
mac-address | is is-not contains does-not-contain starts-with |
This section documents search criteria information for Sonar discovery connections. The discovery connections must be the type "sonar"
.
The following table outlines the search criteria fields and the available operators for Sonar connections:
Field | Operators |
---|---|
search-domain | contains is |
ip-address | in-range is |
sonar-scan-date | is-within-the-last |
This section documents search criteria information for vSphere discovery connections. The discovery connections must be the type "vsphere"
.
The following table outlines the search criteria fields and the available operators for vSphere connections:
Field | Operators |
---|---|
cluster | is is-not contains does-not-contain starts-with |
data-center | is is-not |
discovered-time | is-on-or-before is-on-or-after is-between is-earlier-than is-within-the-last |
guest-os-family | contains does-not-contain |
host-name | is is-not contains does-not-contain starts-with |
ip-address | in-range not-in-range is is-not |
power-state | in not-in |
resource-pool-path | contains does-not-contain |
last-time-seen | is-on-or-before is-on-or-after is-between is-earlier-than is-within-the-last |
vm | is is-not contains does-not-contain starts-with |
The following fields have enumerated values:
Field | Acceptable Values |
---|---|
power-state | poweredOn poweredOff suspended |
This API follows Hypermedia as the Engine of Application State (HATEOAS) principals and is therefore hypermedia friendly.
Hyperlinks are returned in the links
property of any given resource and contain a fully-qualified hyperlink to
the corresponding resource. The format of the hypermedia link adheres to both the
{json:api} v1
"Link Object" and
JSON Hyper-Schema
"Link Description Object"
formats. For example:
"links": [{
"rel": "<relation>",
"href": "<href>"
...
}]
Where appropriate link objects may also contain additional properties than the rel
and href
properties, such as id
, type
, etc.
See the Root resources for the entry points into API discovery.
Returns a listing of the resources (endpoints) that are available to be invoked in this API.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": []
{}
"rel": "self"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Resources and operations for managing assets. Assets can be created under the Site Assets resource.
Returns all assets for which you have access.
The index of the page (zero-based) to retrieve.
The number of records per page to retrieve.
The criteria to sort the records by, in the format: property[,ASC|DESC]
. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "page": {},
"number": 6, "size": 10, "totalPages": 13, "totalResources": 123 "resources": []
{}
"addresses": [],
{}
"ip": "123.245.34.235", "mac": "12:34:56:78:90:AB" "assessedForPolicies": false, "assessedForVulnerabilities": true, "configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "files": [],
{}
"attributes": [],
{}
"name": "<name>", "value": "<value>" "name": "ADMIN$", "size": -1, "type": "directory" "history": [],
{}
"date": "2018-04-09T06:23:49Z", "description": "", "scanId": 12, "type": "SCAN", "user": "", "version": 8, "vulnerabilityExceptionId": "" "hostName": "corporate-workstation-1102DC.acme.com", "hostNames": [],
{}
"name": "corporate-workstation-1102DC.acme.com", "source": "DNS" "id": 282, "ids": [],
{}
"id": "c56b2c59-4e9b-4b89-85e2-13f8146eb071", "source": "WQL" "ip": "182.34.74.202", "links": [],
{}
"rel": "self" "mac": "AB:12:CD:34:EF:56", "os": "Microsoft Windows Server 2008 Enterprise Edition SP1", "osFingerprint": {},
"architecture": "x86", "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Windows Server 2008 Enterprise Edition SP1", "family": "Windows", "id": 35, "product": "Windows Server 2008 Enterprise Edition", "systemName": "Microsoft Windows", "type": "Workstation", "vendor": "Microsoft", "version": "SP1" "rawRiskScore": 31214.3, "riskScore": 37457.16, "services": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "family": "", "links": [],
{}
"rel": "self" "name": "CIFS Name Service", "port": 139, "product": "Samba", "protocol": "tcp", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vendor": "", "version": "3.5.11", "webApplications": []
{}
"id": 30712, "pages": [],
{}
"linkType": "html-ref", "path": "/docs/config/index.html", "response": 200 "root": "/", "virtualHost": "102.89.22.253" "software": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000" "type": "", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vulnerabilities": {}
"critical": 16, "exploits": 4, "malwareKits": 0, "moderate": 3, "severe": 76, "total": 95
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Creates or updates an asset with the specified details.
The identifier of the site.
The details of the asset being added or updated.
The operating system can be specified in one of three ways, with the order of precedence: "osFingerprint"
, "os"
, "cpe"
addresses null |
Address
All addresses discovered on the asset. |
|
|
configurations null |
Configuration
Configuration key-values pairs enumerated on the asset. |
|
|
cpe null |
string
The Common Platform Enumeration (CPE) of the operating system. This is the tertiary means of specifying the operating system fingerprint. Use |
|
|
databases null |
Database
The databases enumerated on the asset. |
|
|
date null |
string
Required
The date the data was collected on the asset. |
|
|
description null |
string
The description of the source or collection of information on the asset. This description will appear in the history of the asset for future auditing purposes. |
|
|
files null |
File
The files discovered with searching on the asset. |
|
|
hostName null |
HostName
The primary host name (local or FQDN) of the asset. |
|
|
hostNames null |
HostName
Additional host names for the asset. |
|
|
id null |
integer <int64>
The identifier of the asset. |
|
|
ids null |
UniqueId
Unique identifiers found on the asset, such as hardware or operating system identifiers. |
|
|
ip null |
string
The primary IPv4 or IPv6 address of the asset. |
|
|
links null |
Link
|
|
|
mac null |
string
The primary Media Access Control (MAC) address of the asset. The format is six groups of two hexadecimal digits separated by colons. |
|
|
os null |
string
Free-form textual description of the operating system of the asset, typically from a fingerprinting source. This input will be parsed to produce a full fingerprint. This is the secondary means of specifying the operating system. Use |
|
|
osFingerprint null |
OperatingSystem
The details of the operating system of the asset. |
|
|
services null |
Service
The services discovered on the asset. |
|
|
software null |
Software
The software discovered on the asset. |
|
|
type null |
string
The type of asset. |
|
|
userGroups null |
GroupAccount
The group accounts enumerated on the asset. |
|
|
users null |
UserAccount
The user accounts enumerated on the asset. |
|
|
vulnerabilities null |
AssetVulnerabilities
Summary information for vulnerabilities on the asset. |
|
200 OK
201 Created
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"addresses": [],
{}
"ip": "123.245.34.235", "mac": "12:34:56:78:90:AB" "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": "", "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "date": "", "description": "", "files": [],
{}
"attributes": [],
{}
"name": "<name>", "value": "<value>" "name": "ADMIN$", "size": -1, "type": "directory" "hostName": {},
"name": "corporate-workstation-1102DC.acme.com", "source": "DNS" "hostNames": [],
{}
"name": "corporate-workstation-1102DC.acme.com", "source": "DNS" "id": 282, "ids": [],
{}
"id": "c56b2c59-4e9b-4b89-85e2-13f8146eb071", "source": "WQL" "ip": "182.34.74.202", "links": [],
{}
"rel": "self" "mac": "AB:12:CD:34:EF:56", "os": "", "osFingerprint": {},
"architecture": "x86", "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Windows Server 2008 Enterprise Edition SP1", "family": "Windows", "id": 35, "product": "Windows Server 2008 Enterprise Edition", "systemName": "Microsoft Windows", "type": "Workstation", "vendor": "Microsoft", "version": "SP1" "services": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "family": "", "name": "CIFS Name Service", "port": 139, "product": "Samba", "protocol": "tcp", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vendor": "", "version": "3.5.11", "webApplications": []
{}
"id": 30712, "pages": [],
{}
"linkType": "html-ref", "path": "/docs/config/index.html", "response": 200 "root": "/", "virtualHost": "102.89.22.253" "software": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000" "type": "", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vulnerabilities": { }
200 OK
201 Created
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"id": "1", "links": []
{}
"rel": "self"
{}
"id": "3", "links": []
{}
"rel": "self"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "400"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns all assets for which you have access that match the given search criteria.
The index of the page (zero-based) to retrieve.
The number of records per page to retrieve.
The criteria to sort the records by, in the format: property[,ASC|DESC]
. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
param1
filters null |
SwaggerSearchCriteriaFilter
Filters used to match assets. See Search Criteria for more information on the structure and format. |
|
|
match null |
string
"any" "all"
Operator to determine how to match filters. |
|
200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"filters": [],
{}
"field": "", "lower": "", "operator": "", "upper": "", "value": "", "values": []
"string" "match": "all"
{ "match": "all", "filters": [ { "field": "service-name", "operator": "contains", "value": "ssh"} ] }
{ "match": "all", "filters": [ { "field": "risk-score", "operator": "is-greater-than", "value": 5000 }, { "field": "operating-system", "operator": "contains", "value": "windows" }, { "field": "service-name", "operator": "contains", "value": "ssh" } ] }
{ "match": "all", "filters": [ { "field": "operating-system", "operator": "contains", "value": "Microsoft Windows 10" } ] }
{ "match": "all", "filters": [ { "field": "owner-tag", "operator": "contains", "value": "Bob" }, { "field": "vulnerability-cvss-score", "operator": "is-greater-than", "value": 8 } ] }
{ "match": "all", "filters": [ { "field": "location-tag", "operator": "contains", "value": "Los Angeles Datacenter" }, { "field": "containers", "operator": "are", "value": "0" }, { "field": "service-name", "operator": "contains", "value": "ssh" } ] }
200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "page": {},
"number": 6, "size": 10, "totalPages": 13, "totalResources": 123 "resources": []
{}
"addresses": [],
{}
"ip": "123.245.34.235", "mac": "12:34:56:78:90:AB" "assessedForPolicies": false, "assessedForVulnerabilities": true, "configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "files": [],
{}
"attributes": [],
{}
"name": "<name>", "value": "<value>" "name": "ADMIN$", "size": -1, "type": "directory" "history": [],
{}
"date": "2018-04-09T06:23:49Z", "description": "", "scanId": 12, "type": "SCAN", "user": "", "version": 8, "vulnerabilityExceptionId": "" "hostName": "corporate-workstation-1102DC.acme.com", "hostNames": [],
{}
"name": "corporate-workstation-1102DC.acme.com", "source": "DNS" "id": 282, "ids": [],
{}
"id": "c56b2c59-4e9b-4b89-85e2-13f8146eb071", "source": "WQL" "ip": "182.34.74.202", "links": [],
{}
"rel": "self" "mac": "AB:12:CD:34:EF:56", "os": "Microsoft Windows Server 2008 Enterprise Edition SP1", "osFingerprint": {},
"architecture": "x86", "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Windows Server 2008 Enterprise Edition SP1", "family": "Windows", "id": 35, "product": "Windows Server 2008 Enterprise Edition", "systemName": "Microsoft Windows", "type": "Workstation", "vendor": "Microsoft", "version": "SP1" "rawRiskScore": 31214.3, "riskScore": 37457.16, "services": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "family": "", "links": [],
{}
"rel": "self" "name": "CIFS Name Service", "port": 139, "product": "Samba", "protocol": "tcp", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vendor": "", "version": "3.5.11", "webApplications": []
{}
"id": 30712, "pages": [],
{}
"linkType": "html-ref", "path": "/docs/config/index.html", "response": 200 "root": "/", "virtualHost": "102.89.22.253" "software": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000" "type": "", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vulnerabilities": {}
"critical": 16, "exploits": 4, "malwareKits": 0, "moderate": 3, "severe": 76, "total": 95
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "400"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the specified asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"addresses": [],
{}
"ip": "123.245.34.235", "mac": "12:34:56:78:90:AB" "assessedForPolicies": false, "assessedForVulnerabilities": true, "configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "files": [],
{}
"attributes": [],
{}
"name": "<name>", "value": "<value>" "name": "ADMIN$", "size": -1, "type": "directory" "history": [],
{}
"date": "2018-04-09T06:23:49Z", "description": "", "scanId": 12, "type": "SCAN", "user": "", "version": 8, "vulnerabilityExceptionId": "" "hostName": "corporate-workstation-1102DC.acme.com", "hostNames": [],
{}
"name": "corporate-workstation-1102DC.acme.com", "source": "DNS" "id": 282, "ids": [],
{}
"id": "c56b2c59-4e9b-4b89-85e2-13f8146eb071", "source": "WQL" "ip": "182.34.74.202", "links": [],
{}
"rel": "self" "mac": "AB:12:CD:34:EF:56", "os": "Microsoft Windows Server 2008 Enterprise Edition SP1", "osFingerprint": {},
"architecture": "x86", "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Windows Server 2008 Enterprise Edition SP1", "family": "Windows", "id": 35, "product": "Windows Server 2008 Enterprise Edition", "systemName": "Microsoft Windows", "type": "Workstation", "vendor": "Microsoft", "version": "SP1" "rawRiskScore": 31214.3, "riskScore": 37457.16, "services": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "family": "", "links": [],
{}
"rel": "self" "name": "CIFS Name Service", "port": 139, "product": "Samba", "protocol": "tcp", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vendor": "", "version": "3.5.11", "webApplications": []
{}
"id": 30712, "pages": [],
{}
"linkType": "html-ref", "path": "/docs/config/index.html", "response": 200 "root": "/", "virtualHost": "102.89.22.253" "software": [],
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000" "type": "", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vulnerabilities": {}
"critical": 16, "exploits": 4, "malwareKits": 0, "moderate": 3, "severe": 76, "total": 95
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Deletes the specified asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": []
{}
"rel": "self"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the databases enumerated on an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the files discovered on an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"attributes": [],
{}
"name": "<name>", "value": "<value>" "name": "ADMIN$", "size": -1, "type": "directory"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the services discovered on an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"port": 22, "protocol": "tcp", "rel": "Service" "resources": []
{}
"links": [],
{}
"rel": "self" "port": 22, "protocol": "tcp"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the service running a port and protocol on the asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "databases": [],
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL" "family": "", "links": [],
{}
"rel": "self" "name": "CIFS Name Service", "port": 139, "product": "Samba", "protocol": "tcp", "userGroups": [],
{}
"id": 972, "name": "Administrators" "users": [],
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith" "vendor": "", "version": "3.5.11", "webApplications": []
{}
"id": 30712, "pages": [],
{}
"linkType": "html-ref", "path": "/docs/config/index.html", "response": 200 "root": "/", "virtualHost": "102.89.22.253"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the configuration (properties) of a port and protocol on an asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"name": "<name>", "value": "<value>"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the databases running on a port and protocol on an asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"description": "Microsoft SQL Server", "id": 13, "name": "MSSQL"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the user groups enumerated on a port and protocol on an asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"id": 972, "name": "Administrators"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the users enumerated on a port and protocol on an asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the web applications running on a port and protocol on an asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
0
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns a web application running on a port and protocol on an asset.
The identifier of the asset.
The protocol of the service.
The port of the service.
The identifier of the web application.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"id": 30712, "pages": [],
{}
"linkType": "html-ref", "path": "/docs/config/index.html", "response": 200 "root": "/", "virtualHost": "102.89.22.253"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the software on an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns tags assigned to an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"color": "default", "created": "2017-10-07T23:50:01.205Z", "id": 6, "links": [],
{}
"rel": "self" "name": "Very High", "riskModifier": "2.0", "searchCriteria": {},
"filters": [],
{}
"field": "", "lower": "", "operator": "", "upper": "", "value": "", "values": []
"string" "match": "all" "source": "built-in", "sources": [],
{}
"id": 92, "links": [],
{}
"rel": "self" "source": "site" "type": "criticality"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Assigns the specified tag to the asset.
The identifier of the asset.
The identifier of the tag.
200 OK
400 Bad Request
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
400 Bad Request
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": []
{}
"rel": "self"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "400"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Removes the specified tag from the asset's tags.
The identifier of the asset.
The identifier of the tag.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": []
{}
"rel": "self"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns user groups enumerated on an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"id": 972, "name": "Administrators"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns users enumerated on an asset.
The identifier of the asset.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"fullName": "Smith, John", "id": 8952, "name": "john_smith"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns all operating systems discovered across all assets.
The index of the page (zero-based) to retrieve.
The number of records per page to retrieve.
The criteria to sort the records by, in the format: property[,ASC|DESC]
. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "page": {},
"number": 6, "size": 10, "totalPages": 13, "totalResources": 123 "resources": []
{}
"architecture": "x86", "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Windows Server 2008 Enterprise Edition SP1", "family": "Windows", "id": 35, "product": "Windows Server 2008 Enterprise Edition", "systemName": "Microsoft Windows", "type": "Workstation", "vendor": "Microsoft", "version": "SP1"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the details for an operating system.
The identifier of the operating system.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"architecture": "x86", "configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Windows Server 2008 Enterprise Edition SP1", "family": "Windows", "id": 35, "product": "Windows Server 2008 Enterprise Edition", "systemName": "Microsoft Windows", "type": "Workstation", "vendor": "Microsoft", "version": "SP1"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns all software enumerated on any asset.
The index of the page (zero-based) to retrieve.
The number of records per page to retrieve.
The criteria to sort the records by, in the format: property[,ASC|DESC]
. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "page": {},
"number": 6, "size": 10, "totalPages": 13, "totalResources": 123 "resources": []
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns the details for software.
The identifier of the software.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"configurations": [],
{}
"name": "<name>", "value": "<value>" "cpe": {},
"edition": "enterprise", "language": "", "other": "", "part": "o", "product": "windows_server_2008", "swEdition": "", "targetHW": "", "targetSW": "", "update": "sp1", "v2.2": "cpe:/o:microsoft:windows_server_2008:-:sp1:enterprise", "v2.3": "cpe:2.3:o:microsoft:windows_server_2008:-:sp1:enterprise:*:*:*:*:*", "vendor": "microsoft", "version": "-" "description": "Microsoft Outlook 2013 15.0.4867.1000", "family": "Office 2013", "id": 0, "product": "Outlook 2013", "type": "Productivity", "vendor": "Microsoft", "version": "15.0.4867.1000"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Resources for managing and viewing the mechanisms used to automatically discover assets.
Returns all discovery connections.
The index of the page (zero-based) to retrieve.
The number of records per page to retrieve.
The criteria to sort the records by, in the format: property[,ASC|DESC]
. The default sort order is ascending. Multiple sort criteria can be specified using multiple sort query parameters.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "page": {},
"number": 6, "size": 10, "totalPages": 13, "totalResources": 123 "resources": []
{}
"accessKeyId": "", "address": "", "arn": "", "awsSessionName": "", "connectionType": "", "eventSource": "", "exchangeServerHostname": "", "exchangeUser": "", "folderPath": "", "id": "", "ldapServer": "", "links": [],
{}
"rel": "self" "name": "Connection 1", "port": "", "protocol": "", "region": "", "scanEngineIsInsideAWS": false, "secretAccessKey": "", "status": "", "username": "", "winRMServer": ""
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns a discovery connection.
The identifier of the discovery connection.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"accessKeyId": "", "address": "", "arn": "", "awsSessionName": "", "connectionType": "", "eventSource": "", "exchangeServerHostname": "", "exchangeUser": "", "folderPath": "", "id": "", "ldapServer": "", "links": [],
{}
"rel": "self" "name": "Connection 1", "port": "", "protocol": "", "region": "", "scanEngineIsInsideAWS": false, "secretAccessKey": "", "status": "", "username": "", "winRMServer": ""
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Attempts to reconnect the discovery connection.
The identifier of the discovery connection.
200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "400"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Returns all sonar queries.
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
200 OK
401 Unauthorized
404 Not Found
500 Internal Server Error
503 Service Unavailable
{}
"links": [],
{}
"rel": "self" "resources": []
{}
"criteria": {},
"filters": []
{}
"days": "", "lower": "", "searchDomain": "acme.com", "type": "domain-contains", "upper": "" "id": 14, "links": [],
{}
"rel": "self" "name": "Assets in Domain"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "404"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"
Creates a sonar query.
param0
criteria null |
SonarCriteria
The search criteria used to search for assets from the Sonar API. |
|
|
links null |
Link
|
|
|
name null |
string
The name of the Sonar query. |
|
200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"criteria": {},
"filters": []
{}
"days": "", "lower": "", "searchDomain": "acme.com", "type": "domain-contains", "upper": "" "links": [],
{}
"rel": "self" "name": "Assets in Domain"
{ "criteria": { "filters": [ { "type": "ip-address-range", "lower": "192.168.1.1", "upper": "192.168.1.254" } ] }, "name": "Assets In IP Range" }
{ "criteria": { "filters": [ { "type": "domain-contains", "domain": "acme.com" }, { "type": "scan-date-within-the-last", "days": "30" } ] }, "name": "Recently Scanned ACME Assets" }
{ "criteria": { "filters": [ { "type": "ip-address-range", "lower": "192.168.1.1", "upper": "192.168.1.254" }, { "type": "scan-date-within-the-last", "days": "30" } ] }, "name": "Recently Scanned Assets in IP Range" }
200 OK
400 Bad Request
401 Unauthorized
500 Internal Server Error
503 Service Unavailable
{}
"id": 1, "links": []
{}
"rel": "self"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "400"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "401"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "500"
{}
"links": [],
{}
"rel": "self" "message": "An error has occurred.", "status": "503"