Introduction

Getting started

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 a developer guide for Outpost24's full stack security assessment platform REST API.

The REST API specification in OpenAPI Specification (OAS) 3.0 format is available on Outpost24's SaaS platform and the HIAB appliances.

To explore the API, scroll through the index on the left or paste the content of the OAS specification in the Swagger editor.

Base URL for all API requests

• Https://outscan.outpost24.com/opi/rest
• Https://your-appliance.outpost24.com/opi/rest

Response codes

Unsupported HTTP verbs will return 405 or 400.

Authentication

The REST API uses JWT tokens for granting access to the API's resources.

To authenticate, use this code:

Successful response:

There are 2 ways to generate a new token:

1. Login with username and password by sending a POST request to /auth/login

2. Call GET /auth/login with an existing, valid token

Token expiration time

To set custom expiration time of the JWT token:

The default validity period for the generated tokens is 10 minutes. It's possible to set a custom expiration time for the tokens by submitting the optional parameter validUntil.

Example request

To authenticate to the API resources, submit the generated JWT token in the Authorization header.

Access

This table presents a user role access matrix with the defined in the system user roles, API collections and actions.

Method	Collection	Description	admin	user	support	licensemanager	legal	pcioperator	swatservice	superswatservice	customersuccess	msspmanager
GET	/about	Retrieve the list of software versions		x 1)
GET	/accounts/{accountId}	Get an account		x 1)
DELETE	/accounts/{accountId}	Delete an account		x 1)
PATCH	/accounts/{accountId}	Partially update an account		x 1)
PUT	/accounts/{accountId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/accounts/{accountId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/accounts	Get a list of accounts		x 1)
POST	/accounts	Create an account		x 1)
HEAD	/accounts	Get header with count		x 1)
PUT	/accounts/{accountId}/tags	Modify linked set of tags		x 1)
GET	/agents/installers/download	Download an agent installer (Deprecated: 2024-5-21)		x 1)
POST	/agents/installers/download	Request for creating an agent installer		x 1)
GET	/agents/{agentUuid}/logs	Get agent logs		x 1)
GET	/agents/version	Retrieve the agent version		x 1)
GET	/agents/installers/configuration	Download agent installer configuration file		x 1)
GET	/agents/installers	Get agent installers		x 1)
GET	/appliances/{applianceId}	Get a appliance		x 1)
GET	/appliances	Get a list of appliances		x 1)
HEAD	/appliances	Get header with count		x 1)
DELETE	/asset-groups/{assetGroupId}/activities/{activityId}	Delete an activity
GET	/asset-groups/{assetGroupId}	Get an asset group		x 1)
DELETE	/asset-groups/{assetGroupId}	Delete an asset group		x 1)
PATCH	/asset-groups/{assetGroupId}	Partially update an asset group		x 1)
PUT	/asset-groups/{assetGroupId}/assets/{assetId}	Create a link to an asset		x 1)
DELETE	/asset-groups/{assetGroupId}/assets/{assetId}	Delete a link to an asset		x 1)
PUT	/asset-groups/{assetGroupId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/asset-groups/{assetGroupId}/tags/{tagId}	Delete an existing link to a tag		x 1)
GET	/asset-groups/{assetGroupId}/comments/{commentId}	Get a comment for an asset group		x 1)
DELETE	/asset-groups/{assetGroupId}/comments/{commentId}	Delete a comment for an asset group		x 1)
PATCH	/asset-groups/{assetGroupId}/comments/{commentId}	Partially update a comment for an asset group		x 1)
GET	/asset-groups/comments	Get comments		x 1)
POST	/asset-groups/comments	Add a comment to one or several asset groups		x 1)
DELETE	/asset-groups/comments	Delete one or several comments for one or several asset groups		x 1)
HEAD	/asset-groups/comments	Get header with count
GET	/asset-groups/activities	Get activities		x 1)
GET	/asset-groups/{assetGroupId}/activities	Get activities		x 1)
POST	/asset-groups/{assetGroupId}/activities	Add an activity for an AssetGroup
HEAD	/asset-groups/{assetGroupId}/activities	Get header with count		x 1)
GET	/asset-groups	Get a list of asset groups		x 1)
POST	/asset-groups	Create an asset group		x 1)
HEAD	/asset-groups	Get header with count		x 1)
GET	/asset-groups/{assetGroupId}/comments	Get the comments for an asset group		x 1)
POST	/asset-groups/{assetGroupId}/comments	Add a comment for an asset group		x 1)
GET	/asset-groups/{assetGroupId}/dynamic-tags	Get a list of tags for a dynamic group		x 1)
GET	/asset-groups/{assetGroupId}/subscriptions	Get subscriptions associated with the given asset group		x 1)
PUT	/asset-groups/{assetGroupId}/tags	Modify linked set of tags		x 1)
GET	/asset-identifiers/{assetIdentifierId}	Get an asset identifier		x 1)
DELETE	/asset-identifiers/{assetIdentifierId}	Delete an asset identifier		x 1)
PATCH	/asset-identifiers/{assetIdentifierId}	Partially update an asset identifier		x 1)
DELETE	/asset-identifiers/{assetIdentifierId}/links/{assetIdentifierLinkId}	Delete an asset identifier link		x 1)
GET	/asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}	Get the screenshot file for an asset identifier		x 1)
PUT	/asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}	Add screenshot to asset identifier		x 1)
DELETE	/asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}	Delete the screenshot file for an asset identifier		x 1)
PUT	/asset-identifiers/{assetIdentifierId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/asset-identifiers/{assetIdentifierId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/asset-identifiers	Get a list of asset identifiers		x 1)
POST	/asset-identifiers	Create an asset identifier		x 1)
HEAD	/asset-identifiers	Get header with count		x 1)
GET	/asset-identifiers/{assetIdentifierId}/screenshots	Get the screenshot list for an asset identifier		x 1)
GET	/asset-identifiers/{assetIdentifierId}/links	Get the links for an asset identifier		x 1)
POST	/asset-identifiers/{assetIdentifierId}/links	Create an asset identifier link		x 1)
GET	/assets/{assetId}	Get an asset		x 1)
DELETE	/assets/{assetId}	Delete an asset		x 1)
PATCH	/assets/{assetId}	Partially update an asset		x 1)
DELETE	/assets/{assetId}/links/{assetLinkId}	Delete an asset link		x 1)
PUT	/assets/{assetId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/assets/{assetId}/tags/{tagId}	Delete a link to a tag		x 1)
PUT	/assets/tags/{tagId}	Create one or several links to one a tag		x 1)
DELETE	/assets/tags/{tagId}	Delete one or several links to a tag		x 1)
GET	/assets	Get a list of assets		x 1)
POST	/assets	Create an asset		x 1)
DELETE	/assets	Delete one or several assets		x 1)
HEAD	/assets	Get header with count		x 1)
PATCH	/assets	Partially update one or several assets		x 1)
GET	/assets/{assetId}/links	Get the links for an asset		x 1)
POST	/assets/{assetId}/links	Create an asset link		x 1)
GET	/assets/{assetId}/subscriptions	Get subscriptions associated with the given asset		x 1)
POST	/assets/{assetId}/merge	Merge two or more assets into a single asset		x 1)
PUT	/assets/{assetId}/tags	Modify linked set of tags		x 1)
PUT	/assets/tags	Modify linked set of tags to one or several assets		x 1)
POST	/assets/refresh-tags	Refresh tags		x 1)
POST	/assets/{assetId}/split	Split an asset based on identifier subset		x 1)
GET	/audits/{auditId}	Get a audit by ID		x 1)
GET	/audits	Get a list of audits		x 1)
HEAD	/audits	Get header with count		x 1)
GET	/auth/login	Get a token		x 1)
POST	/auth/login	Log in with username and password		x 1)
POST	/auth/logout	Log out		x 1)
POST	/auth/send-2fa-sms	Send an sms containing the two-factor authentication code to user		x 1)
GET	/blueprints/download/{key}	Download a blueprint
POST	/certificate/renew	Renews certificate		x 1)
GET	/checks/{checkId}/comments/{commentId}	Get a comment for a check		x 1)
DELETE	/checks/{checkId}/comments/{commentId}	Delete a comment for a check		x 1)
GET	/checks/{checkId}	Get a check		x 1)
GET	/checks	Get a list of checks		x 1)
HEAD	/checks	Get header with count		x 1)
GET	/checks/{checkId}/comments	Get the comments for a check		x 1)
POST	/checks/{checkId}/comments	Add a comment for a check		x 1)
GET	/checks/{checkId}/exploits	Get the exploits for a check		x 1)
GET	/classifications/{classificationId}	Get a classification
GET	/classifications	Get a list of classifications
HEAD	/classifications	Get header with count
PUT	/compliance/findings/{findingId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/compliance/findings/{findingId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/compliance/findings/{findingId}	Get a compliance finding by ID		x 1)
GET	/compliance/findings	Get a list of compliance findings		x 1)
HEAD	/compliance/findings	Get header with count		x 1)
GET	/compliance/policies/{policyId}	Get a compliance policy		x 1)
GET	/compliance/policies	Get a list of compliance policies		x 1)
HEAD	/compliance/policies	Get header with count		x 1)
GET	/compliance/requirements/{requirementId}	Get a compliance requirement		x 1)
GET	/compliance/requirements	Get a list of requirements		x 1)
HEAD	/compliance/requirements	Get header with count		x 1)
POST	/compliance/findings/{findingId}/mark-exception	Mark compliance finding as exception		x 1)
POST	/compliance/findings/{findingId}/mark-false-positive	Mark compliance finding as false positive		x 1)
PUT	/compliance/findings/{findingId}/tags	Modify linked set of tags		x 1)
POST	/compliance/reports	Generate a compliance report		x 1)
POST	/compliance/findings/{findingId}/unmark-exception	Unmark finding as exception		x 1)
POST	/compliance/findings/{findingId}/unmark-false-positive	Unmark finding as false positive		x 1)
GET	/consumption-stats/{consumptionStatsId}	Get consumption stats by ID
GET	/consumption-stats	Get a list of consumption stats
HEAD	/consumption-stats	Get header with count
GET	/consumption-stats/{consumptionStatsId}/subscriptions	Get a list of subscriptions for consumption stats
GET	/credential-classes/{credentialClassId}	Get a credential class		x 1)
GET	/credential-classes	Get a list of credential classes		x 1)
HEAD	/credential-classes	Get header with count		x 1)
GET	/credentials/{credentialId}	Get a credential		x 1)
DELETE	/credentials/{credentialId}	Delete a credential		x 1)
PATCH	/credentials/{credentialId}	Partially update a credential		x 1)
POST	/credentials	Create a credential		x 1)
PUT	/customers/{customerId}/tags/{tagId}	Create a link to a tag
DELETE	/customers/{customerId}/tags/{tagId}	Delete a link to a tag
GET	/customers/{customerId}/consultancy	Get consultancy token
GET	/customers/me/consumption-stats/{consumptionStatsId}	Get consumption stats by ID for current customer		x 1)
GET	/customers/me/consumption-stats	Get consumption stats for current customer		x 1)
GET	/customers/{customerId}/consumption-stats	Get consumption stats for a customer
GET	/customers/me/consumption-stats/{consumptionStatsId}/subscriptions	Get a list of subscriptions for consumption stats for current customer		x 1)
GET	/customers/me	Get current customer		x 1)
GET	/customers/{customerId}	Get a customer
PATCH	/customers/{customerId}	Partially update a customer
GET	/customers	Get a list of customers
HEAD	/customers	Get header with count
GET	/customers/{customerId}/usage-stats	Get usage stats for a customer
POST	/customers/me/migrate	Migrate current customer		x 1)
POST	/customers/{customerId}/migrate	Migrate a customer
PUT	/customers/{customerId}/tags	Modify linked set of tags
POST	/customers/me/reset-migration	Reset migration for current customer		x 1)
POST	/customers/{customerId}/reset-migration	Reset migration for a customer
GET	/dashboards/{dashboardId}	Get a dashboard		x 1)
DELETE	/dashboards/{dashboardId}	Delete a dashboard		x 1)
PATCH	/dashboards/{dashboardId}	Partially update a dashboard		x 1)
PUT	/dashboards/{dashboardId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/dashboards/{dashboardId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/dashboards	Get a list of dashboards		x 1)
POST	/dashboards	Create a dashboard		x 1)
HEAD	/dashboards	Get header with count		x 1)
PUT	/dashboards/{dashboardId}/tags	Modify linked set of tags		x 1)
POST	/decrypt/file	Request the decryption of an uploaded file
POST	/decrypt/object	Request the decryption of a file from object storage
GET	/downloads/{key}	Get a download cache entry and generate a token for downloading the file, expires after 5 minutes		x 1)
DELETE	/downloads/{key}	Delete a download cache entry, and potentially associated data		x 1)
GET	/downloads/download/{token}	Download a file		x 1)
GET	/downloads	Get a list of download cache entries		x 1)
HEAD	/downloads	Get header with count		x 1)
GET	/downloads/{token}	Compatibility endpoint for file download (Deprecated: 2021-03-04)		x 1)
POST	/enroll/db-settings	Configure database settings		x 1)
DELETE	/enroll/db-settings	Delete database settings		x 1)
POST	/enroll/services	Enroll services		x 1)
GET	/events/subscriptions/{subscriptionId}	Get an event subscription		x 1)
DELETE	/events/subscriptions/{subscriptionId}	Delete an event subscription		x 1)
PATCH	/events/subscriptions/{subscriptionId}	Partially update an event subscription		x 1)
PUT	/events/subscriptions/{subscriptionId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/events/subscriptions/{subscriptionId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/events/subscriptions	Get a list of event subscriptions		x 1)
POST	/events/subscriptions	Create event subscription		x 1)
HEAD	/events/subscriptions	Get header with count		x 1)
GET	/events/subscriptions/template-variables/{trigger}	Get jinja variables relevant to an event		x 1)
PUT	/events/subscriptions/{subscriptionId}/tags	Modify linked set of tags		x 1)
GET	/exploits/{exploitId}	Get an exploit		x 1)
GET	/exploits	Get a list of exploits		x 1)
HEAD	/exploits	Get header with count		x 1)
GET	/finding-template-groups/{findingTemplateGroupId}	Get a finding template group
DELETE	/finding-template-groups/{findingTemplateGroupId}	Delete a finding template group
GET	/finding-template-groups	Get a list of finding template groups
POST	/finding-template-groups	Create a finding template group
HEAD	/finding-template-groups	Get header with count
PATCH	/finding-template-groups/{findingTemplateId}	Update a finding template
GET	/finding-templates/{findingTemplateId}	Get a finding template
DELETE	/finding-templates/{findingTemplateId}	Delete a finding template
PATCH	/finding-templates/{findingTemplateId}	Update a finding template
PUT	/finding-templates/{findingTemplateId}/tags/{tagId}	Create a link to a tag
DELETE	/finding-templates/{findingTemplateId}/tags/{tagId}	Delete a link to a tag
GET	/finding-templates	Get a list of finding templates
POST	/finding-templates	Create a finding template
HEAD	/finding-templates	Get header with count
PUT	/finding-templates/{findingTemplateId}/tags	Modify linked set of tags
GET	/findings/{findingId}/attachments/{attachmentId}	Get an attachment for a finding		x 1)
DELETE	/findings/{findingId}/attachments/{attachmentId}	Delete an attachment for a finding
GET	/findings/{findingId}/comments/{commentId}	Get a comment for a finding		x 1)
DELETE	/findings/{findingId}/comments/{commentId}	Delete a comment for a finding		x 1)
PATCH	/findings/{findingId}/comments/{commentId}	Partially update a comment for a finding		x 1)
GET	/findings/comments	Get comments
POST	/findings/comments	Add a comment to one or several findings		x 1)
DELETE	/findings/comments	Delete one or several comments for one or several findings		x 1)
HEAD	/findings/comments	Get header with count
GET	/findings/{findingId}	Get a finding by ID		x 1)
DELETE	/findings/{findingId}	Delete a finding
PATCH	/findings/{findingId}	Partially update a finding		x 1)
PUT	/findings/{findingId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/findings/{findingId}/tags/{tagId}	Delete a link to a tag		x 1)
PUT	/findings/tags/{tagId}	Create links to a tag		x 1)
DELETE	/findings/tags/{tagId}	Delete links to a tag		x 1)
GET	/findings	Get a list of findings		x 1)
POST	/findings	Create a finding
DELETE	/findings	Delete one or several findings
HEAD	/findings	Get header with count		x 1)
PATCH	/findings	Partially update one or several findings		x 1)
PUT	/findings/{findingId}/matches/{matchId}	Create a link to a match
DELETE	/findings/{findingId}/matches/{matchId}	Delete a link to a match
GET	/findings/{findingId}/attachments/{attachmentId}/download	Get the token for downloading an attachment for a finding		x 1)
POST	/findings/{findingId}/send	Send finding as email		x 1)
GET	/findings/{findingId}/attachments	Get the attachments for a finding		x 1)
POST	/findings/{findingId}/attachments	Add an attachment for a finding
GET	/findings/{findingId}/comments	Get the comments for a finding		x 1)
POST	/findings/{findingId}/comments	Add a comment for a finding		x 1)
GET	/findings/{findingId}/exploits	Get the exploits for a finding		x 1)
GET	/findings/delta	Get a list of deltas		x 1)
GET	/findings/delta-summary	Get a delta summary		x 1)
GET	/findings/solutions	Get a list of solutions		x 1)
POST	/findings/{findingId}/secure-code-warrior	Log the request to Secure Code Warrior		x 1)
POST	/findings/{findingId}/mark-false-positive	Mark finding as false positive		x 1)
POST	/findings/mark-false-positive	Mark one or several finding(s) as false positives		x 1)
POST	/findings/{findingId}/mark-fixed	Mark finding as fixed		x 1)
POST	/findings/mark-fixed	Mark one or several findings as fixed		x 1)
POST	/findings/{findingId}/mark-irreproducible	Mark finding as irreproducible		x 1)
POST	/findings/mark-irreproducible	Mark one or several findings as irreproducible		x 1)
PUT	/findings/{findingId}/tags	Modify linked set of tags		x 1)
PUT	/findings/tags	Modify linked set of tags to one or several findings		x 1)
POST	/findings/{findingId}/publish	Publish finding (set as present)
POST	/findings/{findingId}/reject	Set finding as rejected
POST	/findings/{findingId}/request-clarification	Request clarification for a finding		x 1)
POST	/findings/{findingId}/request-verification	Mark finding as pending verification		x 1)
POST	/findings/request-verification	Mark one or several findings as pending for verification		x 1)
POST	/findings/{findingId}/reset-status	Reset status of finding to 'PRESENT'		x 1)
POST	/findings/reset-status	Reset status on one or several findings to 'PRESENT		x 1)
POST	/findings/{findingId}/accept	Accept finding		x 1)
POST	/findings/accept	Accept one or several findings		x 1)
POST	/findings/{findingId}/quality-assure	Set finding as quality assured
POST	/findings/{findingId}/review	Set finding as reviewed and transition to be verified
POST	/findings/{findingId}/verify	Set finding as verified and transitioned to be quality assured
POST	/findings/{findingId}/unwatch	Unwatch a finding		x 1)
POST	/findings/unwatch	Unwatch one or several findings		x 1)
POST	/findings/{findingId}/watch	Watch a finding		x 1)
POST	/findings/watch	Watch one or several findings		x 1)
GET	/globals	Get global settings		x 1)
GET	/globals/timezones	Get a list of timezones		x 1)
GET	/integrations/authorization	Authorization		x 1)
GET	/integrations/{integrationId}/authorize	Authorize an integration based on OAuth 2.0		x 1)
GET	/integrations/{integrationId}	Get an integration		x 1)
DELETE	/integrations/{integrationId}	Delete an integration		x 1)
PATCH	/integrations/{integrationId}	Partially update an integration		x 1)
PUT	/integrations/{integrationId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/integrations/{integrationId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/integrations	Get a list of integrations		x 1)
POST	/integrations	Create an integration		x 1)
HEAD	/integrations	Get header with count		x 1)
PUT	/integrations/{integrationId}/tags	Modify linked set of tags		x 1)
POST	/integrations/verify	Verify the integration connectivity		x 1)
POST	/integrations/{integrationId}/verify	Verify the integration connectivity		x 1)
GET	/managed-report-groups/{managedReportGroupId}	Get a managed report group (Deprecated: 2019-12-11)		x 1)
GET	/managed-report-groups	Get a list of managed report groups (Deprecated: 2019-12-11)		x 1)
HEAD	/managed-report-groups	Get header with count (Deprecated: 2019-12-11)		x 1)
GET	/managed-reports/{managedReportId}	Get a managed report		x 1)
DELETE	/managed-reports/{managedReportId}	Delete a managed report		x 1)
PATCH	/managed-reports/{managedReportId}	Partially update a managed report		x 1)
PUT	/managed-reports/{managedReportId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/managed-reports/{managedReportId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/managed-reports/{managedReportId}/download	Get the token for downloading a managed report		x 1)
GET	/managed-reports	Get a list of managed reports		x 1)
POST	/managed-reports	Create a managed report		x 1)
HEAD	/managed-reports	Get header with count		x 1)
GET	/managed-reports/tags	Get a list of tags for managed reports		x 1)
PUT	/managed-reports/{managedReportId}/tags	Modify linked set of tags		x 1)
POST	/managed-reports/upload	Upload a managed report from HIAB		x 1)
GET	/matches/{matchId}	Get a match		x 1)
DELETE	/matches/{matchId}	Delete a match
PATCH	/matches/{matchId}	Partially update a match
GET	/matches	Get a list of matches		x 1)
POST	/matches	Create a match
HEAD	/matches	Get header with count		x 1)
GET	/notifications/{notificationId}	Get a notification		x 1)
GET	/notifications	Get a list of notifications		x 1)
HEAD	/notifications	Get header with count		x 1)
POST	/notifications/{notificationId}/mark-as-read	Mark a notification as read		x 1)
POST	/notifications/{notificationId}/mark-as-unread	Mark a notification as unread		x 1)
GET	/organizations/{organizationId}	Get an organization
GET	/organizations	Get a list of organizations
HEAD	/organizations	Get header with count
GET	/outscan/findings/{findingId}/exploits	Get the exploits for a finding		x 1)
GET	/outscan/findings/{findingId}	Get a finding by ID		x 1)
GET	/outscan/findings	Get a list of findings		x 1)
HEAD	/outscan/findings	Get header with count		x 1)
GET	/outscan/scan-logs/{scanLogId}/findings	Get a list of findings for a scan		x 1)
GET	/outscan/scan-logs/{scanLogId}	Get a scan log		x 1)
GET	/outscan/scan-logs	Get a list of scan logs		x 1)
HEAD	/outscan/scan-logs	Get header with count		x 1)
GET	/outscan/scans/{scanId}	Get a scan		x 1)
GET	/outscan/scans	Get a list of scans		x 1)
HEAD	/outscan/scans	Get header with count		x 1)
POST	/outscan/scans/{scanId}/stop	Stop a scan		x 1)
GET	/outscan/schedules/{scheduleId}	Get a schedule		x 1)
DELETE	/outscan/schedules/{scheduleId}	Delete a schedule		x 1)
PATCH	/outscan/schedules/{scheduleId}	Partially update a schedule		x 1)
GET	/outscan/schedules	Get a list of schedules		x 1)
POST	/outscan/schedules	Create a schedule		x 1)
HEAD	/outscan/schedules	Get header with count		x 1)
POST	/outscan/schedules/{scheduleId}/scan	Start scanning now		x 1)
GET	/outscan/targets/{targetId}	Get a target		x 1)
DELETE	/outscan/targets/{targetId}	Delete a target		x 1)
GET	/outscan/targets	Get a list of targets		x 1)
POST	/outscan/targets	Create new targets		x 1)
HEAD	/outscan/targets	Get header with count		x 1)
POST	/password-recovery	Request password recovery email for username		x 1)
GET	/product-information	Get a list of products		x 1)
HEAD	/product-information	Get header with count		x 1)
GET	/release-notes/notification-trigger	Get last release notes notification trigger timestamp
POST	/release-notes/trigger-notification	Trigger release notes notification and set trigger timestamp
GET	/report-schedules/{reportScheduleId}	Get a report schedule (Deprecated: 2019-12-11)		x 1)
DELETE	/report-schedules/{reportScheduleId}	Delete a report schedule (Deprecated: 2019-12-11)		x 1)
PATCH	/report-schedules/{reportScheduleId}	Partially update a report schedule (Deprecated: 2019-12-11)		x 1)
GET	/report-schedules	Get a list of report schedules (Deprecated: 2019-12-11)		x 1)
POST	/report-schedules	Create a new report schedule (Deprecated: 2019-12-11)		x 1)
HEAD	/report-schedules	Get header with count (Deprecated: 2019-12-11)		x 1)
POST	/report-schedules/{reportScheduleId}/send	Start scanning now (Deprecated: 2019-12-11)		x 1)
GET	/reports/{key}	Get a report cache entry and generate a token for downloading the report, expires after 5 minutes (Deprecated: 2021-02-25)		x 1)
DELETE	/reports/{key}	Delete a report (Deprecated: 2021-02-25)		x 1)
GET	/reports	Get a list of report cache entries (Deprecated: 2021-02-25)		x 1)
POST	/reports	Generate a report		x 1)
HEAD	/reports	Get header with count (Deprecated: 2021-02-25)		x 1)
GET	/resource-groups/{resourceGroupId}	Get a resource group		x 1)
DELETE	/resource-groups/{resourceGroupId}	Delete a resource group		x 1)
PATCH	/resource-groups/{resourceGroupId}	Partially update a resource group		x 1)
GET	/resource-groups	Get a list of resource groups		x 1)
POST	/resource-groups	Create a resource group		x 1)
HEAD	/resource-groups	Get header with count		x 1)
POST	/rule-engine	Run rule engine
GET	/scan-configuration-groups/{scanConfigurationGroupId}	Get scan configuration group		x 1)
DELETE	/scan-configuration-groups/{scanConfigurationGroupId}	Delete scan configuration group		x 1)
PATCH	/scan-configuration-groups/{scanConfigurationGroupId}	Partially update a scan configuration group		x 1)
GET	/scan-configuration-groups	Get a list of scan configuration groups		x 1)
POST	/scan-configuration-groups	Create a scan configuration group		x 1)
HEAD	/scan-configuration-groups	Get header with count		x 1)
PUT	/scan-configurations/{scanConfigurationId}/asset-identifiers/{assetIdentifierId}	Create a link to an asset identifier		x 1)
DELETE	/scan-configurations/{scanConfigurationId}/asset-identifiers/{assetIdentifierId}	Delete a link to an asset identifier		x 1)
PUT	/scan-configurations/{scanConfigurationId}/assets/{assetId}	Create a link to an asset		x 1)
DELETE	/scan-configurations/{scanConfigurationId}/assets/{assetId}	Delete a link to an asset		x 1)
GET	/scan-configurations/{scanConfigurationId}	Get a scan configuration		x 1)
DELETE	/scan-configurations/{scanConfigurationId}	Delete a scan configuration		x 1)
PATCH	/scan-configurations/{scanConfigurationId}	Partially update a scan configuration		x 1)
PUT	/scan-configurations/{scanConfigurationId}/schedules/{scheduleId}	Create a link to a schedule		x 1)
DELETE	/scan-configurations/{scanConfigurationId}/schedules/{scheduleId}	Delete a link to a schedule		x 1)
PUT	/scan-configurations/{scanConfigurationId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/scan-configurations/{scanConfigurationId}/tags/{tagId}	Delete a link to a tag		x 1)
PUT	/scan-configurations/tags/{tagId}	Create a tag link to one or several scan configurations		x 1)
DELETE	/scan-configurations/tags/{tagId}	Delete a tag link to one or several scan configurations		x 1)
GET	/scan-configurations	Get a list of scan configurations		x 1)
POST	/scan-configurations	Create a scan configuration		x 1)
DELETE	/scan-configurations	Delete one or several scan configurations		x 1)
HEAD	/scan-configurations	Get header with count		x 1)
PATCH	/scan-configurations	Partially update one or several scan configurations		x 1)
PUT	/scan-configurations/{scanConfigurationId}/tags	Modify linked set of tags		x 1)
PUT	/scan-configurations/tags	Modify linked set of tags to several scan configurations		x 1)
POST	/scan-configurations/{scanConfigurationId}/scan	Start a scan based on this configuration		x 1)
POST	/scan-configurations/test-setup-script	Test a setup LUA script		x 1)
POST	/scan-configurations/{scanConfigurationId}/test-setup-script	Test an application setup LUA script		x 1)
GET	/scan-policies/{scanPolicyId}	Get a scan policy		x 1)
DELETE	/scan-policies/{scanPolicyId}	Delete a scan policy		x 1)
PATCH	/scan-policies/{scanPolicyId}	Partially update an scan policy		x 1)
PUT	/scan-policies/{scanPolicyId}/accounts/{accountId}	Create a link to an account		x 1)
DELETE	/scan-policies/{scanPolicyId}/accounts/{accountId}	Delete a link to an account		x 1)
PUT	/scan-policies/{scanPolicyId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/scan-policies/{scanPolicyId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/scan-policies/default-settings	Get default scan policy settings		x 1)
GET	/scan-policies	Get a list of scan policies		x 1)
POST	/scan-policies	Create a scan policy		x 1)
HEAD	/scan-policies	Get header with count		x 1)
PUT	/scan-policies/{scanPolicyId}/tags	Modify linked set of tags		x 1)
PUT	/scan-policies/{scanPolicyId}/accounts	Modify linked set of account IDs		x 1)
GET	/scanners/{scannerId}	Get a scanner		x 1)
GET	/scanners	Get a list of scanners		x 1)
HEAD	/scanners	Get header with count		x 1)
GET	/scans/{scanId}/crawled-urls	Get the crawled URLs for a scan		x 1)
GET	/scans/{scanId}/discovery	Get the discovery results for a scan		x 1)
GET	/scans/{scanId}/issues	Get the issues for a scan		x 1)
GET	/scans/{scanId}/log	Get the log for a scan		x 1)
GET	/scans/{scanId}	Get a scan		x 1)
GET	/scans	Get a list of scans		x 1)
POST	/scans	Create a scan	x
HEAD	/scans	Get header with count		x 1)
GET	/scans/{scanId}/metadata	Get metadata for a scan
POST	/scans/{scanId}/blueprints	Request a blueprint		x 1)
POST	/scans/{scanId}/stop	Stop a scan		x 1)
GET	/scheduled-reports/{scheduledReportId}	Get a scheduled report		x 1)
DELETE	/scheduled-reports/{scheduledReportId}	Delete a scheduled report		x 1)
PATCH	/scheduled-reports/{scheduledReportId}	Partially update a scheduled report		x 1)
PUT	/scheduled-reports/{scheduledReportId}/schedules/{scheduleId}	Create a link to a schedule		x 1)
DELETE	/scheduled-reports/{scheduledReportId}/schedules/{scheduleId}	Delete a link to a schedule		x 1)
PUT	/scheduled-reports/{scheduledReportId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/scheduled-reports/{scheduledReportId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/scheduled-reports	Get a list of scheduled reports		x 1)
POST	/scheduled-reports	Create a scheduled report		x 1)
HEAD	/scheduled-reports	Get header with count		x 1)
PUT	/scheduled-reports/{scheduledReportId}/tags	Modify linked set of tags		x 1)
POST	/scheduled-reports/{scheduledReportId}/send	Send report		x 1)
GET	/schedules/{scheduleId}	Get a schedule		x 1)
DELETE	/schedules/{scheduleId}	Delete a schedule		x 1)
PATCH	/schedules/{scheduleId}	Partially update a schedule		x 1)
GET	/schedules	Get a list of schedules		x 1)
POST	/schedules	Create a schedule		x 1)
HEAD	/schedules	Get header with count		x 1)
POST	/scoping	Submit scoping information.		x 1)
POST	/sub-users/me/change-password	Change current sub-users password; if current user isn't a sub-user, redirect to /users/me/change-password		x 1)
GET	/sub-users/{subUserId}	Get a sub-user		x 1)
DELETE	/sub-users/{subUserId}	Delete a sub-user		x 1)
PATCH	/sub-users/{subUserId}	Partially update a sub-user		x 1)
PUT	/sub-users/{subUserId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/sub-users/{subUserId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/sub-users/me	Get current sub-user; if current user isn't a sub-user, redirect to /users/me		x 1)
PATCH	/sub-users/me	Partially update current sub-user; if current user isn't a sub-user, redirect to /users/me		x 1)
GET	/sub-users	Get a list of sub-users		x 1)
POST	/sub-users	Create a new sub-user		x 1)
HEAD	/sub-users	Get header with count		x 1)
PUT	/sub-users/{subUserId}/tags	Modify linked set of tags		x 1)
GET	/subscription-audits/{auditId}	Get a subscription audit	x
GET	/subscription-audits	Get a list of subscription audits	x
HEAD	/subscription-audits	Get header with count	x
GET	/subscriptions/{subscriptionUuid}	Get a subscription		x 1)
DELETE	/subscriptions/{subscriptionUuid}	Delete a subscription
PATCH	/subscriptions/{subscriptionUuid}	Partially update a subscription
GET	/subscriptions/templates/{subscriptionTemplateUuid}	Get a subscription template
DELETE	/subscriptions/templates/{subscriptionTemplateUuid}	Delete a subscription template
PATCH	/subscriptions/templates/{subscriptionTemplateUuid}	Partially update a subscription template
GET	/subscriptions/{subscriptionId}/asset-groups	Get asset groups associated with the subscription		x 1)
GET	/subscriptions	Get a list of subscriptions		x 1)
POST	/subscriptions	Create a subscription
HEAD	/subscriptions	Get header with count		x 1)
GET	/subscriptions/templates	Get a list of subscription templates
POST	/subscriptions/templates	Create a subscription template
HEAD	/subscriptions/templates	Get header with count
GET	/subscriptions/templates/{subscriptionTemplateUuid}/template-variables	Get variables for subscription templates
GET	/subscriptions/template-variables	Get variables for subscription templates
POST	/subscriptions/templates/preview	Preview a subscription template
POST	/subscriptions/reports	Generate a report
GET	/summaries/{summaryId}	Get a summary
DELETE	/summaries/{summaryId}	Delete a summary
PATCH	/summaries/{summaryId}	Partially update a summary
GET	/summaries	Get a list of summaries
POST	/summaries	Create a summary
HEAD	/summaries	Get header with count
POST	/summaries/{summaryId}/transition	Transition a summary status
GET	/tags/{tagId}	Get a tag by ID		x 1)
DELETE	/tags/{tagId}	Delete a tag		x 1)
PATCH	/tags/{tagId}	Partially update a tag		x 1)
GET	/tags	Get a list of tags		x 1)
POST	/tags	Create a tag		x 1)
HEAD	/tags	Get header with count		x 1)
GET	/tags/statistics/{statisticId}	Get tag statistics by ID		x 1)
GET	/tags/statistics	Get a list of tag statistics		x 1)
HEAD	/tags/statistics	Get header with count		x 1)
POST	/tags/transform	Transform tags		x 1)
POST	/terms/{termsId}/accept	Accept terms		x 1)
GET	/terms/{termsId}	Get terms		x 1)
DELETE	/terms/{termsId}	Delete terms
GET	/terms/acceptances	Get a list of terms acceptances		x 1)
GET	/terms	Get a list of terms		x 1)
POST	/terms	Create terms
HEAD	/terms	Get header with count		x 1)
GET	/terms-templates/{termsTemplateId}	Get a terms template
DELETE	/terms-templates/{termsTemplateId}	Delete a terms template
GET	/terms-templates	Get a list of terms templates
POST	/terms-templates	Create a terms template
HEAD	/terms-templates	Get header with count
GET	/usage-stats/cyr3con	Get cyr3con stats
GET	/usage-stats/{usageStatsId}	Get usage stats by ID
GET	/usage-stats	Get a list of usage stats
HEAD	/usage-stats	Get header with count
GET	/user-role-permissions/{userRolePermissionId}	Get a user role permission		x 1)
GET	/user-role-permissions	Get a list of user role permissions		x 1)
HEAD	/user-role-permissions	Get header with count		x 1)
GET	/user-roles/{userRoleId}	Get a user role		x 1)
DELETE	/user-roles/{userRoleId}	Delete a user role		x 1)
PATCH	/user-roles/{userRoleId}	Partially update a user role		x 1)
GET	/user-roles	Get a list of user roles		x 1)
POST	/user-roles	Create a user role		x 1)
HEAD	/user-roles	Get header with count		x 1)
POST	/users/me/change-password	Change current users password; if current user is a sub-user, redirect to /sub-users/me/change-password
PUT	/users/{userId}/tags/{tagId}	Create a link to a tag
DELETE	/users/{userId}/tags/{tagId}	Delete a link to a tag
GET	/users/me	Get current user; if current user is a sub-user, redirect to /sub-users/me		x 1)
PATCH	/users/me	Partially update current user; if current user is a sub-user, redirect to /sub-users/me		x 1)
GET	/users/{userId}	Get a user
PATCH	/users/{userId}	Partially update a user
GET	/users	Get a list of users
HEAD	/users	Get header with count
PUT	/users/{userId}/tags	Modify linked set of tags
GET	/view-template-groups/{viewTemplateGroupId}	Get view template group		x 1)
DELETE	/view-template-groups/{viewTemplateGroupId}	Delete view template group		x 1)
PATCH	/view-template-groups/{viewTemplateGroupId}	Partially update a view template group		x 1)
GET	/view-template-groups	Get a list of view template groups		x 1)
POST	/view-template-groups	Create a view template group		x 1)
HEAD	/view-template-groups	Get header with count		x 1)
GET	/view-templates	Get a list of view templates		x 1)
POST	/view-templates	Create a view template		x 1)
HEAD	/view-templates	Get header with count		x 1)
GET	/view-templates/{viewTemplateId}	Get view template by ID		x 1)
DELETE	/view-templates/{viewTemplateId}	Delete a view template		x 1)
PATCH	/view-templates/{viewTemplateId}	Partially update a view template		x 1)
PUT	/view-templates/{viewTemplateId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/view-templates/{viewTemplateId}/tags/{tagId}	Delete a link to a tag		x 1)
PUT	/view-templates/{viewTemplateId}/tags	Modify linked set of tags		x 1)
GET	/workflows/{workflowId}	Get a workflow		x 1)
DELETE	/workflows/{workflowId}	Delete a workflow		x 1)
PATCH	/workflows/{workflowId}	Partially update a workflow		x 1)
PUT	/workflows/{workflowId}/schedules/{scheduleId}	Create a link to a schedule		x 1)
DELETE	/workflows/{workflowId}/schedules/{scheduleId}	Delete a link to a schedule		x 1)
PUT	/workflows/{workflowId}/tags/{tagId}	Create a link to a tag		x 1)
DELETE	/workflows/{workflowId}/tags/{tagId}	Delete a link to a tag		x 1)
GET	/workflows	Get a list of workflows		x 1)
POST	/workflows	Create a workflow		x 1)
HEAD	/workflows	Get header with count		x 1)
PUT	/workflows/{workflowId}/tags	Modify linked set of tags		x 1)
POST	/workflows/{workflowId}/scan	Start scans based on this workflow		x 1)

¹⁾ Can operate on own entries only.#Example flows

Run an Appsec scan

1. Authenticate

All API requests in the code examples to the right require a valid JWT token. To learn how to create a token, see Authentication.

2. Create an Appsec scan configuration

3. Trigger a scan

4. Retrieve scanned asset identifiers

5. Retrieve findings for the IP

Errors

The API uses the following error codes:

Error Code	Meaning
400	Bad Request -- Your request is invalid.
401	Unauthorized -- Your API key is wrong.
403	Forbidden -- You don't have permission to perform this operation.
404	Not Found -- The specified resource could not be found.
405	Method Not Allowed -- You tried to access an object with an invalid method.
406	Not Acceptable -- You requested a format that isn't json.
500	Internal Server Error -- We had a problem with our server. Try again later.
503	Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Security

• HTTP Authentication, scheme: Bearer

About

Retrieve the list of software versions

GET /about

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[VersionInfo]	false	none	none
» software	string	false	none	none
» version	string	false	none	none

Enumerated Values

Property	Value
software	AGENT
software	RULES

Accounts

Get an account

GET /accounts/{accountId}

Parameters

Name	In	Type	Required	Description
accountId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Account

Delete an account

DELETE /accounts/{accountId}

Parameters

Name	In	Type	Required	Description
accountId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an account

PATCH /accounts/{accountId}

Body parameter

Parameters

Name	In	Type	Required	Description
accountId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Account	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /accounts/{accountId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
accountId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /accounts/{accountId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
accountId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of accounts

GET /accounts

Accounts lists all test accounts that are utilized in authenticated scans or used for the scoping and consist of zero or more credentials (see /credentials).

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Account]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» type	string	true	none	none
» name	string	true	none	The name of the entry.
» url	string	false	none	none
» role	string	false	none	none
» integrationId	integer(int32)	false	none	none
» credentials	[Credential]	false	none	none
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» accountId	integer(int32)	true	none	none
»» classId	integer(int32)	true	none	none
»» className	string	false	none	none
»» value	string	true	none	none
»» tags	[Tag]	false	read-only	[The tags]
»»» id	integer(int32)	false	read-only	The ID of the entry.
»»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»»» createdBy	string	false	read-only	The name of the user who created the entry.
»»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»»» key	string	true	none	none
»»» value	string	false	none	none
»»» inherited	boolean	false	read-only	none
»»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
» scanConfigurationIds	[integer]	false	none	none
» scanPolicyIds	[integer]	false	none	none
» tags	[Tag]	false	read-only	[The tags]

Enumerated Values

Property	Value
type	SMB
type	SSH
type	BASIC
type	WEB
type	AWS
type	AZURE
type	VSPHERE
type	GCP
type	DOCKER

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an account

POST /accounts

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Account	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /accounts

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /accounts/{accountId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
accountId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Agents

Download an agent installer (Deprecated: 2024-5-21)

GET /agents/installers/download

Parameters

Name	In	Type	Required	Description
platform	query	string	true	none
arch	query	string	true	none
pkg	query	string	true	none
customAttributes	query	string	false	none
tags	query	string	false	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Request for creating an agent installer

POST /agents/installers/download

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	AgentInstallerCreationRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get agent logs

GET /agents/{agentUuid}/logs

Parameters

Name	In	Type	Required	Description
agentUuid	path	string(uuid)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Response Headers

Status	Header	Type	Format	Description
default	Count	long		The number of total entries, without limit and offset

Retrieve the agent version

GET /agents/version

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Download agent installer configuration file

GET /agents/installers/configuration

Parameters

Name	In	Type	Required	Description
customAttributes	query	string	false	none
tags	query	string	false	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get agent installers

GET /agents/installers

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Appliances

Get a appliance

GET /appliances/{applianceId}

Parameters

Name	In	Type	Required	Description
applianceId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Appliance

Get a list of appliances

GET /appliances

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Appliance]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» customerName	string	false	read-only	none
» primary	boolean	false	read-only	none
» virtual	boolean	false	read-only	none
» revoked	string(date-time)	false	read-only	none
» mac	string	false	read-only	none
» updatedOnline	string(date-time)	false	read-only	none
» updatedOffline	string(date-time)	false	read-only	none
» versions	Appliance.ApplianceVersion	false	read-only	none
»» xmlapi	string	false	none	none
»» ui	string	false	none	none
»» scanner	string	false	none	none
»» rules	string	false	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /appliances

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Asset groups

Delete an activity

DELETE /asset-groups/{assetGroupId}/activities/{activityId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
activityId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get an asset group

GET /asset-groups/{assetGroupId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	AssetGroup

Delete an asset group

DELETE /asset-groups/{assetGroupId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an asset group

PATCH /asset-groups/{assetGroupId}

Body parameter

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	AssetGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to an asset

PUT /asset-groups/{assetGroupId}/assets/{assetId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
assetId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to an asset

DELETE /asset-groups/{assetGroupId}/assets/{assetId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
assetId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /asset-groups/{assetGroupId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete an existing link to a tag

DELETE /asset-groups/{assetGroupId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a comment for an asset group

GET /asset-groups/{assetGroupId}/comments/{commentId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Comment

Delete a comment for an asset group

DELETE /asset-groups/{assetGroupId}/comments/{commentId}

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a comment for an asset group

PATCH /asset-groups/{assetGroupId}/comments/{commentId}

Body parameter

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get comments

GET /asset-groups/comments

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Comment]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» comment	string	false	none	The content of the comment
» entityType	string	false	none	The type of object this comment is made for
» entityId	integer(int32)	false	none	The ID of the object this comment is made for
» supportStatus	string	false	none	Current support status of the comment
» authorIsStaff	boolean	false	read-only	Whether the comment is from Outpost24 or the customer
» deleted	string(date-time)	false	none	When the comment was deleted

Enumerated Values

Property	Value
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
supportStatus	NOT_APPLICABLE
supportStatus	WAITING
supportStatus	DONE
supportStatus	INTERNAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add a comment to one or several asset groups

POST /asset-groups/comments

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete one or several comments for one or several asset groups

DELETE /asset-groups/comments

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /asset-groups

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get activities

GET /asset-groups/{assetGroupId}/activities

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Activity]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» assetGroupId	integer(int32)	false	read-only	The id of the AssetGroup this activity is related to
» activityType	string	true	none	The type of this activity
» description	string	false	none	Description of the entry.

Enumerated Values

Property	Value
activityType	PENTEST_COMPLETED
activityType	ONBOARDING_COMPLETED
activityType	FALSE_POSITIVE_DISCARDED
activityType	NEW_VULNERABILITY_CHECK
activityType	EXECUTIVE_SUMMARY_UPDATED
activityType	VERIFICATION_REQUEST_COMPLETED

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add an activity for an AssetGroup

POST /asset-groups/{assetGroupId}/activities

Body parameter

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Activity	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of asset groups

GET /asset-groups

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[AssetGroup]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» type	string	false	none	The assetgroup's type
» parentId	integer(int32)	false	none	The ID of the parent entry.
» assetIds	[integer]	false	read-only	The component assets
» assetGroupIds	[integer]	false	read-only	The children asset groups
» summaryId	integer(int32)	false	read-only	The ID of the executive summary
» summary	string	false	read-only	The content of the executive summary
» summaryPublishedAt	string(date-time)	false	read-only	When the executive summary was published
» path	[integer]	false	read-only	The path of the asset group tree
» activeSubscriptionTypes	[string]	false	read-only	The assetgroup's active subscription types
» managed	boolean	false	read-only	Managed internally by (e.g SWAT API or GhostLab)
» dynamic	boolean	false	none	Indicates whether the asset group is automatically populated with assets based on the assigned tags
» labels	string	false	none	The labels of the asset group
» contactName	string	false	none	The customer's contact name with regards to this asset group
» contactDetails	string	false	none	The customer's contact details
» additionalDetails	string	false	none	Additional information about the asset group that may require attention
» commentPendingSince	string(date-time)	false	read-only	The date since comment is pending
» customerName	string	false	none	The customer name
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» includedDynamicTags	[Tag]	false	read-only	The included dynamic asset tags
» excludedDynamicTags	[Tag]	false	read-only	The excluded dynamic asset tags

Enumerated Values

Property	Value
type	WEB_APP
type	INSTANCE
type	API
type	INTERNAL
type	EXTERNAL
type	MOBILE
type	PHYSICAL
type	WIRELESS
type	PHISHING
type	RED
type	ASSUMED
type	DIGITAL
type	HARDWARE
type	PROJECT

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an asset group

POST /asset-groups

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	AssetGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the comments for an asset group

GET /asset-groups/{assetGroupId}/comments

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Comment]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» comment	string	false	none	The content of the comment
» entityType	string	false	none	The type of object this comment is made for
» entityId	integer(int32)	false	none	The ID of the object this comment is made for
» supportStatus	string	false	none	Current support status of the comment
» authorIsStaff	boolean	false	read-only	Whether the comment is from Outpost24 or the customer
» deleted	string(date-time)	false	none	When the comment was deleted

Enumerated Values

Property	Value
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
supportStatus	NOT_APPLICABLE
supportStatus	WAITING
supportStatus	DONE
supportStatus	INTERNAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add a comment for an asset group

POST /asset-groups/{assetGroupId}/comments

Body parameter

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of tags for a dynamic group

GET /asset-groups/{assetGroupId}/dynamic-tags

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
assetGroupId	path	integer(int32)	true	none
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Tag]	false	none	[The tags]
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» key	string	true	none	none
» value	string	false	none	none
» inherited	boolean	false	read-only	none
» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get subscriptions associated with the given asset group

GET /asset-groups/{assetGroupId}/subscriptions

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Subscription]	false	none	none
» uuid	string	false	none	The UUID of the entry.
» type	string	false	none	none
» associations	Subscription.Associations	false	none	none
»» assetGroups	[string]	false	none	none
» durationInDays	integer(int32)	false	none	none
» activeUntil	string(date-time)	false	none	none
» activatedAt	string(date-time)	false	none	none
» redeemableUntil	string(date-time)	false	none	none
» created	string(date-time)	false	none	The timestamp when the entry was created.
» createdBy	string	false	none	The name of the user who created the entry.
» updated	string(date-time)	false	none	The timestamp when the entry was updated.
» updatedBy	string	false	none	The name of the user who updated the entry.
» template	Subscription.Template	false	none	none
»» uuid	string	true	none	The UUID of the entry.
»» variables	string	false	none	none
»» template	string	false	none	none
»» name	string	false	none	The name of the entry.
» customer	Subscription.Customer	false	none	none
»» uuid	string	true	none	The UUID of the entry.
» limits	Subscription.Limits	false	none	none
»» netsecAssets	integer(int32)	false	none	The netsec assets
»» netsecScans	integer(int32)	false	none	The netsec scans
»» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
»» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
»» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
»» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
»» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
»» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
»» complianceAssets	integer(int32)	false	none	The compliance assets
»» complianceScans	integer(int32)	false	none	The compliance scans
»» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
»» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
»» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
»» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
»» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
»» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
»» pciAssets	integer(int32)	false	none	The pci assets
»» pciScans	integer(int32)	false	none	The pci scans
»» scaleAssets	integer(int32)	false	none	The scale assets
»» scaleScans	integer(int32)	false	none	The scale scans
»» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
»» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
»» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
»» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
»» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
»» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
»» cloudsecScans	integer(int32)	false	none	The cloudsec scans
»» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
»» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
»» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
»» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
»» networkAssets	integer(int32)	false	none	The network assets
»» networkScans	integer(int32)	false	none	The network scans
»» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
»» networkApplianceScans	integer(int32)	false	none	The network appliance scans
»» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
»» dockerImageAssets	integer(int32)	false	none	The docker image assets
»» dockerImageScans	integer(int32)	false	none	The docker image scans
»» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
»» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
»» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
»» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
»» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets
» isActive	boolean	false	none	none

Enumerated Values

Property	Value
type	DAST
type	SCALE
type	SCOUT
type	SNAPSHOT
type	ASSURE
type	DAST_EXPERT
type	VERIFY
type	SWAT
type	CLOUDSEC
type	NETSEC
type	CONSUMPTION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /asset-groups/{assetGroupId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
assetGroupId	path	integer(int32)	true	none
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Asset identifiers

Get an asset identifier

GET /asset-identifiers/{assetIdentifierId}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	AssetIdentifier

Delete an asset identifier

DELETE /asset-identifiers/{assetIdentifierId}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an asset identifier

PATCH /asset-identifiers/{assetIdentifierId}

Body parameter

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	AssetIdentifier	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete an asset identifier link

DELETE /asset-identifiers/{assetIdentifierId}/links/{assetIdentifierLinkId}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
assetIdentifierLinkId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the screenshot file for an asset identifier

GET /asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
screenshotFilename	path	string	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	string

Add screenshot to asset identifier

PUT /asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}

Body parameter

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
screenshotFilename	path	string	true	none
body	body	string(byte)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete the screenshot file for an asset identifier

DELETE /asset-identifiers/{assetIdentifierId}/screenshots/{screenshotFilename}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
screenshotFilename	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /asset-identifiers/{assetIdentifierId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /asset-identifiers/{assetIdentifierId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of asset identifiers

GET /asset-identifiers

Asset identifiers are the most atomic elements defining the scanned assets like IP or hostname and can be associated with each other via the "links" attribute. An asset identifier is created automatically whenever a new Appsec configuration is created. It can also be added manually.

Example:

When you add an Appsec configuration with "http://demo.outpost24.com:8080", the system automatically creates an asset identifier "demo.outpost24.com" of type "hostname". If this asset identifier already exists it will be deduplicated and associated with the newly created configuration. The identity of an asset identifier is a "name", "type" and "scannerId" so "demo.outpost24.com" with "scannerId": 0 will be treated as a different asset identifier than "demo.outpost24.com" with "scannerId": 3. When a scan runs, the system will resolve the hostname to an IP address and when the scan has finished, it will add it as an asset identifier of type "IP" and link to the previously created "demo.outpost24.com".

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[AssetIdentifier]	false	none	[The asset links]
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» presentableName	string	false	none	none
» type	string	true	none	none
» firstSeen	string(date-time)	false	none	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	none	Timestamp when the entry was seen last time.
» scannerId	integer(int32)	false	none	none
» scannerName	string	false	read-only	none
» ownership	integer(int32)	false	read-only	none
» customOwnership	integer(int32)	false	none	none
» firstScanId	integer(int32)	false	read-only	none
» lastScanId	integer(int32)	false	read-only	none
» source	[string]	true	none	none
» links	[integer]	false	read-only	none
» assetIds	[integer]	false	none	none
» assetNames	[string]	false	read-only	none
» accountIds	[integer]	false	none	none
» platform	string	false	none	none
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» properties	BaseProperties	false	none	The asset base properties
»» type	string	true	none	none

Enumerated Values

Property	Value
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an asset identifier

POST /asset-identifiers

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	AssetIdentifier	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /asset-identifiers

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get the screenshot list for an asset identifier

GET /asset-identifiers/{assetIdentifierId}/screenshots

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the links for an asset identifier

GET /asset-identifiers/{assetIdentifierId}/links

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[AssetIdentifierLink]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» assetIdentifierId	integer(int32)	true	none	The ID of the asset identifier associated with this entry
» firstSeen	string(date-time)	true	none	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	true	none	Timestamp when the entry was seen last time.
» type	string	true	none	none

Enumerated Values

Property	Value
type	RESOLVES_TO
type	LOADS_SCRIPTS_FROM
type	REFERS_IN_TLS_TO
type	DNS_CNAME
type	DNS_DNAME
type	DNS_MX
type	DNS_NS
type	DNS_PTR
type	DNS_SRV
type	DNS_A
type	DNS_AAAA
type	DNS_URI
type	CONTAINS
type	HTML_LINKS_TO
type	ARP

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an asset identifier link

POST /asset-identifiers/{assetIdentifierId}/links

Body parameter

Parameters

Name	In	Type	Required	Description
assetIdentifierId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	AssetIdentifierLink	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Assets

Get an asset

GET /assets/{assetId}

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Asset

Delete an asset

DELETE /assets/{assetId}

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an asset

PATCH /assets/{assetId}

Body parameter

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Asset	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete an asset link

DELETE /assets/{assetId}/links/{assetLinkId}

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
assetLinkId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /assets/{assetId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /assets/{assetId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create one or several links to one a tag

PUT /assets/tags/{tagId}

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete one or several links to a tag

DELETE /assets/tags/{tagId}

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of assets

GET /assets

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Asset]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» source	[string]	true	none	The asset sources
» platform	string	false	read-only	The asset platform
» assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
» assetIdentifierTypes	[string]	false	read-only	The asset identifier types (deprecated)
» activeSubscriptionTypes	[string]	false	read-only	The asset's active subscription types
» uuid	string	false	read-only	The UUID of the entry.
» firstScanId	integer(int32)	false	read-only	The id of the first scan performed on the asset
» lastScanId	integer(int32)	false	read-only	The id of last scan performed on the asset
» compliant	string	false	read-only	The asset compliance status
» cvssV2EnvironmentalVector	string	false	none	The CVSS V2 environmental vector
» cvssV3EnvironmentalVector	string	false	none	The CVSS V3 environmental vector
» customerName	string	false	none	The customer name
» enabled	boolean	false	none	Determines if the entry is enabled or not.
» active	boolean	false	read-only	Determines if the entry is active or not.
» dockerImageProperties	BaseProperties	false	none	The asset base properties
»» type	string	true	none	none
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» assetIdentifiers	[AssetIdentifier]	false	none	The asset links
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» name	string	true	none	The name of the entry.
»» presentableName	string	false	none	none
»» type	string	true	none	none
»» firstSeen	string(date-time)	false	none	Timestamp when the entry was seen for the first time.
»» lastSeen	string(date-time)	false	none	Timestamp when the entry was seen last time.
»» scannerId	integer(int32)	false	none	none
»» scannerName	string	false	read-only	none
»» ownership	integer(int32)	false	read-only	none
»» customOwnership	integer(int32)	false	none	none
»» firstScanId	integer(int32)	false	read-only	none
»» lastScanId	integer(int32)	false	read-only	none
»» source	[string]	true	none	none
»» links	[integer]	false	read-only	none
»» assetIds	[integer]	false	none	none
»» assetNames	[string]	false	read-only	none
»» accountIds	[integer]	false	none	none
»» platform	string	false	none	none
»» tags	[Tag]	false	read-only	[The tags]
»» properties	BaseProperties	false	none	The asset base properties
» assetGroups	[Asset.AssetGroup]	false	read-only	Information of all asset groups the asset is linked to
»» id	integer(int32)	false	none	The ID of the entry.
»» name	string	false	none	The name of the entry.

Enumerated Values

Property	Value
compliant	COMPLIANT
compliant	NOT_COMPLIANT
compliant	COMPLIANT_WITH_EXCEPTIONS
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an asset

POST /assets

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Asset	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete one or several assets

DELETE /assets

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /assets

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Partially update one or several assets

PATCH /assets

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	Asset	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the links for an asset

GET /assets/{assetId}/links

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[AssetLink]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» assetId	integer(int32)	false	none	none
» assetIdentifierId	integer(int32)	true	none	The ID of the asset identifier associated with this entry
» firstSeen	string(date-time)	true	none	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	true	none	Timestamp when the entry was seen last time.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an asset link

POST /assets/{assetId}/links

Body parameter

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	AssetLink	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get subscriptions associated with the given asset

GET /assets/{assetId}/subscriptions

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Subscription]	false	none	none
» uuid	string	false	none	The UUID of the entry.
» type	string	false	none	none
» associations	Subscription.Associations	false	none	none
»» assetGroups	[string]	false	none	none
» durationInDays	integer(int32)	false	none	none
» activeUntil	string(date-time)	false	none	none
» activatedAt	string(date-time)	false	none	none
» redeemableUntil	string(date-time)	false	none	none
» created	string(date-time)	false	none	The timestamp when the entry was created.
» createdBy	string	false	none	The name of the user who created the entry.
» updated	string(date-time)	false	none	The timestamp when the entry was updated.
» updatedBy	string	false	none	The name of the user who updated the entry.
» template	Subscription.Template	false	none	none
»» uuid	string	true	none	The UUID of the entry.
»» variables	string	false	none	none
»» template	string	false	none	none
»» name	string	false	none	The name of the entry.
» customer	Subscription.Customer	false	none	none
»» uuid	string	true	none	The UUID of the entry.
» limits	Subscription.Limits	false	none	none
»» netsecAssets	integer(int32)	false	none	The netsec assets
»» netsecScans	integer(int32)	false	none	The netsec scans
»» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
»» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
»» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
»» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
»» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
»» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
»» complianceAssets	integer(int32)	false	none	The compliance assets
»» complianceScans	integer(int32)	false	none	The compliance scans
»» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
»» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
»» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
»» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
»» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
»» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
»» pciAssets	integer(int32)	false	none	The pci assets
»» pciScans	integer(int32)	false	none	The pci scans
»» scaleAssets	integer(int32)	false	none	The scale assets
»» scaleScans	integer(int32)	false	none	The scale scans
»» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
»» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
»» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
»» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
»» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
»» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
»» cloudsecScans	integer(int32)	false	none	The cloudsec scans
»» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
»» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
»» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
»» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
»» networkAssets	integer(int32)	false	none	The network assets
»» networkScans	integer(int32)	false	none	The network scans
»» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
»» networkApplianceScans	integer(int32)	false	none	The network appliance scans
»» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
»» dockerImageAssets	integer(int32)	false	none	The docker image assets
»» dockerImageScans	integer(int32)	false	none	The docker image scans
»» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
»» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
»» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
»» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
»» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets
» isActive	boolean	false	none	none

Enumerated Values

Property	Value
type	DAST
type	SCALE
type	SCOUT
type	SNAPSHOT
type	ASSURE
type	DAST_EXPERT
type	VERIFY
type	SWAT
type	CLOUDSEC
type	NETSEC
type	CONSUMPTION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Merge two or more assets into a single asset

POST /assets/{assetId}/merge

Merges the selected asset records. This will reassign all identifiers to the target asset. Findings and other historical data associated with the merged records will be invalidated and removed; the target's historical data will remain unaltered.

Body parameter

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags

PUT /assets/{assetId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags to one or several assets

PUT /assets/tags

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Refresh tags

POST /assets/refresh-tags

Refresh tags should add all custom attributes as tags on the asset, except MAC attribute

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Split an asset based on identifier subset

POST /assets/{assetId}/split

Moves the selected identifiers into a new asset record. All findings will remain associated with the original asset.

Body parameter

Parameters

Name	In	Type	Required	Description
assetId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Audits

Get a audit by ID

GET /audits/{auditId}

Parameters

Name	In	Type	Required	Description
auditId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Audit

Get a list of audits

GET /audits

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Audit]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» objectName	string	false	read-only	none
» objectId	integer(int32)	false	read-only	none
» action	string	false	read-only	none
» updatedFields	object	false	read-only	none
»» additionalProperties	string	false	read-only	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /audits

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Auth

Get a token

GET /auth/login

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	string

Log in with username and password

POST /auth/login

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» username	body	string	true	none
» password	body	string	true	none
» code	body	string	false	none
» validUntil	body	string(date-time)	false	When the token should expire, has to be in the future and in the ISO 8601 instant format

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Log out

POST /auth/logout

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Send an sms containing the two-factor authentication code to user

POST /auth/send-2fa-sms

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	SendSmsRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Blueprints

Download a blueprint

GET /blueprints/download/{key}

Parameters

Name	In	Type	Required	Description
key	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Certificate

Renews certificate

POST /certificate/renew

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	CertificateCreationRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Checks

Get a comment for a check

GET /checks/{checkId}/comments/{commentId}

Parameters

Name	In	Type	Required	Description
checkId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Comment

Delete a comment for a check

DELETE /checks/{checkId}/comments/{commentId}

Parameters

Name	In	Type	Required	Description
checkId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a check

GET /checks/{checkId}

Parameters

Name	In	Type	Required	Description
checkId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Check

Get a list of checks

GET /checks

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Check]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» cve	string	false	read-only	The check CVE
» name	string	false	read-only	The name of the entry.
» nvdCvssV2Score	number(double)	false	read-only	The CVSS V2 score
» nvdCvssV3Score	number(double)	false	read-only	The CVSS V3 score
» nvdCvssV2Vector	string	false	read-only	The CVSS V2 vector
» cvssV3Severity	string	false	read-only	The CVSS V3 Severity
» hasExploits	boolean	false	read-only	Set to true when exploits are available
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» description	string	false	read-only	Description of the entry.
» cyrating	number(double)	false	read-only	none
» previousCyrating	number(double)	false	read-only	none
» cyratingDelta	number(double)	false	read-only	none
» cyratingUpdated	string(date-time)	false	read-only	none
» cyratingLastSeen	string(date-time)	false	read-only	none
» exploitProbability	number(double)	false	read-only	The exploit probability
» previousExploitProbability	number(double)	false	read-only	The previous exploit probability
» exploitProbabilityDelta	number(double)	false	read-only	The exploit probability delta
» softwareComponent	string	false	read-only	The software component
» owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
» solutionType	string	false	read-only	The solution type
» solution	string	false	read-only	The solution
» solutionProduct	string	false	read-only	The solution product
» solutionTitle	string	false	read-only	The solution title
» solutionUuid	string	false	read-only	The solution uuid
» bugTraq	[integer]	false	read-only	An array of Bugtraq reference IDs.
» nvdCvssV3Vector	string	false	read-only	The CVSS V3 vector
» farsight	Farsight	false	read-only	The farsight concists in additional information on risk such as likelihood, threat activity
»» risk	Farsight.Risk	false	none	none
»»» score	number(float)	false	none	none
»»» delta	number(float)	false	none	none
»» updated	string(date-time)	false	none	The timestamp when the entry was updated.
»» lastThreatActivity	string(date-time)	false	none	none
» classifications	Classification.Classifications	false	read-only	The classifications such as CAPEC, OWASP20XX
»» sans25	integer(int32)	false	none	SANS 25 classification of the entry.
»» capec	[integer]	false	none	CAPEC classification of the entry.
»» owasp2004	[integer]	false	none	An array of OWASP Top 10 2004 classifications of the entry.
»» owasp2007	[integer]	false	none	An array of OWASP Top 10 2007 classifications of the entry.
»» owasp2010	[integer]	false	none	An array of OWASP Top 10 2010 classifications of the entry.
»» owasp2013	[integer]	false	none	An array of OWASP Top 10 2013 classifications of the entry.
»» owasp2017	[integer]	false	none	An array of OWASP Top 10 2017 classifications of the entry.
»» owasp2021	[integer]	false	none	none

Enumerated Values

Property	Value
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /checks

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get the comments for a check

GET /checks/{checkId}/comments

Parameters

Name	In	Type	Required	Description
checkId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Comment]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» comment	string	false	none	The content of the comment
» entityType	string	false	none	The type of object this comment is made for
» entityId	integer(int32)	false	none	The ID of the object this comment is made for
» supportStatus	string	false	none	Current support status of the comment
» authorIsStaff	boolean	false	read-only	Whether the comment is from Outpost24 or the customer
» deleted	string(date-time)	false	none	When the comment was deleted

Enumerated Values

Property	Value
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
supportStatus	NOT_APPLICABLE
supportStatus	WAITING
supportStatus	DONE
supportStatus	INTERNAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add a comment for a check

POST /checks/{checkId}/comments

Body parameter

Parameters

Name	In	Type	Required	Description
checkId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the exploits for a check

GET /checks/{checkId}/exploits

Parameters

Name	In	Type	Required	Description
checkId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Exploit]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» source	string	false	read-only	none
» cve	string	false	read-only	none
» name	string	false	read-only	The name of the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» pack	string	false	read-only	none
» checkId	integer(int64)	false	read-only	none
» url	string	false	read-only	none

Enumerated Values

Property	Value
source	Unknown
source	Core Security
source	Immunity
source	Exploit Database
source	DSquare Security
source	Contagio
source	Metasploit
source	SAINT
source	Security Focus
source	Snort
source	Farsight

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Classifications

Get a classification

GET /classifications/{classificationId}

Parameters

Name	In	Type	Required	Description
classificationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Classification

Get a list of classifications

GET /classifications

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Classification]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» cwe	integer(int32)	false	read-only	CWE classification of the entry.
» name	string	false	read-only	The name of the entry.
» sans25	integer(int32)	false	read-only	SANS 25 classification of the entry.
» capec	[integer]	false	read-only	CAPEC classification of the entry.
» owasp2004	[integer]	false	read-only	An array of OWASP Top 10 2004 classifications of the entry.
» owasp2007	[integer]	false	read-only	An array of OWASP Top 10 2007 classifications of the entry.
» owasp2010	[integer]	false	read-only	An array of OWASP Top 10 2010 classifications of the entry.
» owasp2013	[integer]	false	read-only	An array of OWASP Top 10 2013 classifications of the entry.
» owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
» owasp2021	[integer]	false	read-only	none
» secureCodeWarrior	SecureCodeWarrior	false	read-only	The secure code warrior information on the vulnerability description and training
»» name	string	false	none	The name of the entry.
»» description	string	false	none	Description of the entry.
»» url	string	false	none	none
» classifications	Classification.Classifications	false	read-only	The classifications such as CAPEC, OWASP20XX
»» sans25	integer(int32)	false	none	SANS 25 classification of the entry.
»» capec	[integer]	false	none	CAPEC classification of the entry.
»» owasp2004	[integer]	false	none	An array of OWASP Top 10 2004 classifications of the entry.
»» owasp2007	[integer]	false	none	An array of OWASP Top 10 2007 classifications of the entry.
»» owasp2010	[integer]	false	none	An array of OWASP Top 10 2010 classifications of the entry.
»» owasp2013	[integer]	false	none	An array of OWASP Top 10 2013 classifications of the entry.
»» owasp2017	[integer]	false	none	An array of OWASP Top 10 2017 classifications of the entry.
»» owasp2021	[integer]	false	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /classifications

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Compliance

Create a link to a tag

PUT /compliance/findings/{findingId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /compliance/findings/{findingId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a compliance finding by ID

GET /compliance/findings/{findingId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ComplianceFinding

Get a list of compliance findings

GET /compliance/findings

Parameters

Name	In	Type	Required	Description
assetIdentifierId	query	string	false	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ComplianceFinding]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» requirementId	integer(int32)	true	none	Id of the requirement associated with the finding
» matchId	integer(int32)	true	none	Id of the matching entity
» assetId	integer(int32)	true	none	Id of the associated asset
» policyId	integer(int32)	false	read-only	Id of the associated policy
» policyName	string	false	read-only	Name of the associated policy
» audit	string	false	read-only	Audit information related to the finding
» description	string	false	read-only	Description of the entry.
» rationale	string	false	read-only	Rationale behind the finding
» scored	boolean	false	read-only	Indicates whether the finding is scored
» nameLong	string	false	read-only	Long name associated with the finding
» nameShort	string	false	read-only	Short name associated with the finding
» requirement	string	false	read-only	Requirement details associated with the finding
» solution	string	false	read-only	Solution to address the finding
» impacts	string	false	read-only	Impacts of the finding
» notes	string	false	read-only	Additional notes related to the finding
» references	string	false	read-only	References related to the finding
» controls	string	false	read-only	Controls in place to address the finding
» category	string	false	read-only	Category of compliance requirement
» source	[string]	false	read-only	Array of sources related to the finding
» firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
» firstScanId	integer(int32)	false	read-only	Id of the first scan associated with the finding
» lastScanId	integer(int32)	false	read-only	Id of the last scan associated with the finding
» compliant	string	false	read-only	Compliance status of the finding
» falsePositive	string(date-time)	false	read-only	Instant when the finding was marked as false positive
» falsePositiveComment	string	false	read-only	Comment related to marking the finding as false positive
» falsePositiveBy	string	false	read-only	User who marked the finding as false positive
» exception	string(date-time)	false	read-only	Instant when an exception was recorded for the finding
» exceptionComment	string	false	read-only	Comment related to the exception recorded for the finding
» exceptionUntil	string(date-time)	false	read-only	Instant until when the exception is valid
» exceptionBy	string	false	read-only	User who recorded the exception for the finding
» humanCheck	boolean	false	read-only	Indicates whether there is a human check for the finding
» firstFailed	string(date-time)	false	read-only	Instant when the finding first failed
» lastFailed	string(date-time)	false	read-only	Instant when the finding last failed
» assetName	string	false	read-only	Name of the asset associated with the finding
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
category	INFRASTRUCTURE
category	COMPUTE
category	NETWORK
category	STORAGE
category	DATABASE
category	BIG_DATA_AND_ANALYTICS
category	SECURITY_AND_IDENTITY
category	MONITORING_AND_LOGGING
category	NOT_DEFINED
compliant	COMPLIANT
compliant	NOT_COMPLIANT
compliant	COMPLIANT_WITH_EXCEPTIONS

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /compliance/requirements

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a compliance policy

GET /compliance/policies/{policyId}

Parameters

Name	In	Type	Required	Description
policyId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Policy

Get a list of compliance policies

GET /compliance/policies

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Policy]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	false	read-only	The name of the entry.
» description	string	false	read-only	Description of the entry.
» type	string	false	read-only	none
» checksum	string(byte)	false	read-only	none

Enumerated Values

Property	Value
type	AWS
type	GCP
type	AZURE

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a compliance requirement

GET /compliance/requirements/{requirementId}

Parameters

Name	In	Type	Required	Description
requirementId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Requirement

Get a list of requirements

GET /compliance/requirements

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Requirement]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» policyId	integer(int32)	false	read-only	none
» audit	string	false	read-only	none
» description	string	false	read-only	Description of the entry.
» rationale	string	false	read-only	none
» scored	boolean	false	read-only	none
» nameLong	string	false	read-only	none
» nameShort	string	false	read-only	none
» requirementId	string	false	read-only	none
» solution	string	false	read-only	none
» category	string	false	read-only	none
» notes	string	false	read-only	none
» references	string	false	read-only	none
» controls	string	false	read-only	none
» impacts	string	false	read-only	none

Enumerated Values

Property	Value
category	INFRASTRUCTURE
category	COMPUTE
category	NETWORK
category	STORAGE
category	DATABASE
category	BIG_DATA_AND_ANALYTICS
category	SECURITY_AND_IDENTITY
category	MONITORING_AND_LOGGING
category	NOT_DEFINED

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Mark compliance finding as exception

POST /compliance/findings/{findingId}/mark-exception

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	ComplianceFindingException	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark compliance finding as false positive

POST /compliance/findings/{findingId}/mark-false-positive

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	ComplianceFindingFalsePositive	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags

PUT /compliance/findings/{findingId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Generate a compliance report

POST /compliance/reports

Body parameter

Parameters

Name	In	Type	Required	Description
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ComplianceReport	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Unmark finding as exception

POST /compliance/findings/{findingId}/unmark-exception

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Unmark finding as false positive

POST /compliance/findings/{findingId}/unmark-false-positive

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Consumption stats

Get consumption stats by ID

GET /consumption-stats/{consumptionStatsId}

Parameters

Name	In	Type	Required	Description
consumptionStatsId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ConsumptionStats

Get a list of consumption stats

GET /consumption-stats

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ConsumptionStats]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» customerName	string	false	read-only	none
» organization	string	false	read-only	none
» salesAccountId	string	false	read-only	none
» periodStart	string(date-time)	false	none	The consumption period start date
» periodEnd	string(date-time)	false	none	The consumption period end date
» appliancePeriodEnd	string(date-time)	false	none	The appliance consumption period start date
» netsecAssets	integer(int32)	false	none	The netsec assets
» netsecScans	integer(int32)	false	none	The netsec scans
» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
» complianceAssets	integer(int32)	false	none	The compliance assets
» complianceScans	integer(int32)	false	none	The compliance scans
» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
» pciAssets	integer(int32)	false	none	The pci assets
» pciScans	integer(int32)	false	none	The pci scans
» scaleAssets	integer(int32)	false	none	The scale assets
» scaleScans	integer(int32)	false	none	The scale scans
» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
» cloudsecScans	integer(int32)	false	none	The cloudsec scans
» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
» networkAssets	integer(int32)	false	none	The network assets
» networkScans	integer(int32)	false	none	The network scans
» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
» networkApplianceScans	integer(int32)	false	none	The network appliance scans
» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
» dockerImageAssets	integer(int32)	false	none	The docker image assets
» dockerImageScans	integer(int32)	false	none	The docker image scans
» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /consumption-stats

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of subscriptions for consumption stats

GET /consumption-stats/{consumptionStatsId}/subscriptions

Parameters

Name	In	Type	Required	Description
consumptionStatsId	path	integer(int32)	true	none
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Subscription]	false	none	none
» uuid	string	false	none	The UUID of the entry.
» type	string	false	none	none
» associations	Subscription.Associations	false	none	none
»» assetGroups	[string]	false	none	none
» durationInDays	integer(int32)	false	none	none
» activeUntil	string(date-time)	false	none	none
» activatedAt	string(date-time)	false	none	none
» redeemableUntil	string(date-time)	false	none	none
» created	string(date-time)	false	none	The timestamp when the entry was created.
» createdBy	string	false	none	The name of the user who created the entry.
» updated	string(date-time)	false	none	The timestamp when the entry was updated.
» updatedBy	string	false	none	The name of the user who updated the entry.
» template	Subscription.Template	false	none	none
»» uuid	string	true	none	The UUID of the entry.
»» variables	string	false	none	none
»» template	string	false	none	none
»» name	string	false	none	The name of the entry.
» customer	Subscription.Customer	false	none	none
»» uuid	string	true	none	The UUID of the entry.
» limits	Subscription.Limits	false	none	none
»» netsecAssets	integer(int32)	false	none	The netsec assets
»» netsecScans	integer(int32)	false	none	The netsec scans
»» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
»» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
»» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
»» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
»» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
»» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
»» complianceAssets	integer(int32)	false	none	The compliance assets
»» complianceScans	integer(int32)	false	none	The compliance scans
»» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
»» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
»» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
»» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
»» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
»» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
»» pciAssets	integer(int32)	false	none	The pci assets
»» pciScans	integer(int32)	false	none	The pci scans
»» scaleAssets	integer(int32)	false	none	The scale assets
»» scaleScans	integer(int32)	false	none	The scale scans
»» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
»» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
»» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
»» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
»» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
»» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
»» cloudsecScans	integer(int32)	false	none	The cloudsec scans
»» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
»» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
»» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
»» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
»» networkAssets	integer(int32)	false	none	The network assets
»» networkScans	integer(int32)	false	none	The network scans
»» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
»» networkApplianceScans	integer(int32)	false	none	The network appliance scans
»» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
»» dockerImageAssets	integer(int32)	false	none	The docker image assets
»» dockerImageScans	integer(int32)	false	none	The docker image scans
»» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
»» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
»» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
»» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
»» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets
» isActive	boolean	false	none	none

Enumerated Values

Property	Value
type	DAST
type	SCALE
type	SCOUT
type	SNAPSHOT
type	ASSURE
type	DAST_EXPERT
type	VERIFY
type	SWAT
type	CLOUDSEC
type	NETSEC
type	CONSUMPTION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Credential classes

Get a credential class

GET /credential-classes/{credentialClassId}

Parameters

Name	In	Type	Required	Description
credentialClassId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	CredentialClass

Get a list of credential classes

GET /credential-classes

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[CredentialClass]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» name	string	false	read-only	The name of the entry.
» hidden	boolean	false	read-only	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /credential-classes

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Credentials

Get a credential

GET /credentials/{credentialId}

Credentials specify information like username, password, PIN, token, etc. that are required for the authentication. The class of each credential determines if it's retrieved in a clear-text format in the account output or not (see /credential-classes). For instance a credential classified as "password" will not be presented in clear-text in the default output of the account from the API and has to be explicitly requested from the API by sending a GET request to /credentials/{credentialId}?fields=value. Note, each attempt to retrieve a credential results in an entry being written to the audit log (see /audits).

Parameters

Name	In	Type	Required	Description
credentialId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Credential

Delete a credential

DELETE /credentials/{credentialId}

Parameters

Name	In	Type	Required	Description
credentialId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a credential

PATCH /credentials/{credentialId}

Body parameter

Parameters

Name	In	Type	Required	Description
credentialId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Credential	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a credential

POST /credentials

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Credential	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Customers

Create a link to a tag

PUT /customers/{customerId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /customers/{customerId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get consultancy token

GET /customers/{customerId}/consultancy

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	string

Get consumption stats by ID for current customer

GET /customers/me/consumption-stats/{consumptionStatsId}

Parameters

Name	In	Type	Required	Description
consumptionStatsId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ConsumptionStats

Get consumption stats for current customer

GET /customers/me/consumption-stats

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ConsumptionStats]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» customerName	string	false	read-only	none
» organization	string	false	read-only	none
» salesAccountId	string	false	read-only	none
» periodStart	string(date-time)	false	none	The consumption period start date
» periodEnd	string(date-time)	false	none	The consumption period end date
» appliancePeriodEnd	string(date-time)	false	none	The appliance consumption period start date
» netsecAssets	integer(int32)	false	none	The netsec assets
» netsecScans	integer(int32)	false	none	The netsec scans
» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
» complianceAssets	integer(int32)	false	none	The compliance assets
» complianceScans	integer(int32)	false	none	The compliance scans
» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
» pciAssets	integer(int32)	false	none	The pci assets
» pciScans	integer(int32)	false	none	The pci scans
» scaleAssets	integer(int32)	false	none	The scale assets
» scaleScans	integer(int32)	false	none	The scale scans
» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
» cloudsecScans	integer(int32)	false	none	The cloudsec scans
» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
» networkAssets	integer(int32)	false	none	The network assets
» networkScans	integer(int32)	false	none	The network scans
» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
» networkApplianceScans	integer(int32)	false	none	The network appliance scans
» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
» dockerImageAssets	integer(int32)	false	none	The docker image assets
» dockerImageScans	integer(int32)	false	none	The docker image scans
» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get consumption stats for a customer

GET /customers/{customerId}/consumption-stats

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ConsumptionStats]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» customerName	string	false	read-only	none
» organization	string	false	read-only	none
» salesAccountId	string	false	read-only	none
» periodStart	string(date-time)	false	none	The consumption period start date
» periodEnd	string(date-time)	false	none	The consumption period end date
» appliancePeriodEnd	string(date-time)	false	none	The appliance consumption period start date
» netsecAssets	integer(int32)	false	none	The netsec assets
» netsecScans	integer(int32)	false	none	The netsec scans
» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
» complianceAssets	integer(int32)	false	none	The compliance assets
» complianceScans	integer(int32)	false	none	The compliance scans
» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
» pciAssets	integer(int32)	false	none	The pci assets
» pciScans	integer(int32)	false	none	The pci scans
» scaleAssets	integer(int32)	false	none	The scale assets
» scaleScans	integer(int32)	false	none	The scale scans
» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
» cloudsecScans	integer(int32)	false	none	The cloudsec scans
» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
» networkAssets	integer(int32)	false	none	The network assets
» networkScans	integer(int32)	false	none	The network scans
» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
» networkApplianceScans	integer(int32)	false	none	The network appliance scans
» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
» dockerImageAssets	integer(int32)	false	none	The docker image assets
» dockerImageScans	integer(int32)	false	none	The docker image scans
» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of subscriptions for consumption stats for current customer

GET /customers/me/consumption-stats/{consumptionStatsId}/subscriptions

Parameters

Name	In	Type	Required	Description
consumptionStatsId	path	integer(int32)	true	none
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Subscription]	false	none	none
» uuid	string	false	none	The UUID of the entry.
» type	string	false	none	none
» associations	Subscription.Associations	false	none	none
»» assetGroups	[string]	false	none	none
» durationInDays	integer(int32)	false	none	none
» activeUntil	string(date-time)	false	none	none
» activatedAt	string(date-time)	false	none	none
» redeemableUntil	string(date-time)	false	none	none
» created	string(date-time)	false	none	The timestamp when the entry was created.
» createdBy	string	false	none	The name of the user who created the entry.
» updated	string(date-time)	false	none	The timestamp when the entry was updated.
» updatedBy	string	false	none	The name of the user who updated the entry.
» template	Subscription.Template	false	none	none
»» uuid	string	true	none	The UUID of the entry.
»» variables	string	false	none	none
»» template	string	false	none	none
»» name	string	false	none	The name of the entry.
» customer	Subscription.Customer	false	none	none
»» uuid	string	true	none	The UUID of the entry.
» limits	Subscription.Limits	false	none	none
»» netsecAssets	integer(int32)	false	none	The netsec assets
»» netsecScans	integer(int32)	false	none	The netsec scans
»» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
»» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
»» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
»» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
»» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
»» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
»» complianceAssets	integer(int32)	false	none	The compliance assets
»» complianceScans	integer(int32)	false	none	The compliance scans
»» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
»» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
»» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
»» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
»» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
»» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
»» pciAssets	integer(int32)	false	none	The pci assets
»» pciScans	integer(int32)	false	none	The pci scans
»» scaleAssets	integer(int32)	false	none	The scale assets
»» scaleScans	integer(int32)	false	none	The scale scans
»» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
»» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
»» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
»» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
»» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
»» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
»» cloudsecScans	integer(int32)	false	none	The cloudsec scans
»» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
»» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
»» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
»» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
»» networkAssets	integer(int32)	false	none	The network assets
»» networkScans	integer(int32)	false	none	The network scans
»» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
»» networkApplianceScans	integer(int32)	false	none	The network appliance scans
»» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
»» dockerImageAssets	integer(int32)	false	none	The docker image assets
»» dockerImageScans	integer(int32)	false	none	The docker image scans
»» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
»» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
»» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
»» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
»» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets
» isActive	boolean	false	none	none

Enumerated Values

Property	Value
type	DAST
type	SCALE
type	SCOUT
type	SNAPSHOT
type	ASSURE
type	DAST_EXPERT
type	VERIFY
type	SWAT
type	CLOUDSEC
type	NETSEC
type	CONSUMPTION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get current customer

GET /customers/me

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Customer

Get a customer

GET /customers/{customerId}

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Customer

Partially update a customer

PATCH /customers/{customerId}

Body parameter

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Customer	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of customers

GET /customers

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Customer]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	false	read-only	The name of the entry.
» country	string	false	read-only	Country associated with the entry.
» active	boolean	false	read-only	Determines if the entry is active or not.
» features	[string]	false	none	none
» awsExternalId	string	false	read-only	none
» uuid	string	false	read-only	The UUID of the entry.
» organization	string	false	read-only	none
» organizationUuid	string	false	read-only	none
» farsightProducts	[string]	false	read-only	none
» salesAccountId	string	false	read-only	none
» assetMigration	string(date-time)	false	none	none
» customerSuccessManagerEmail	string	false	read-only	The email to the customer success manager responsible for this customer
» accountManagerEmail	string	false	read-only	The email to the account manager responsible for this customer
» migrationStatus	string	false	read-only	The migration status
» state	string	false	read-only	none
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» migration	Customer.Migration	false	read-only	The migration status
»» queued	string(date-time)	false	none	none
»» started	string(date-time)	false	none	none
»» ended	string(date-time)	false	none	none
»» failed	boolean	false	none	none
»» targets	integer(int32)	false	none	none
»» migratedTargets	integer(int32)	false	none	none
»» targetGroups	integer(int32)	false	none	none
»» migratedTargetGroups	integer(int32)	false	none	none
»» reports	integer(int32)	false	none	none
»» migratedReports	integer(int32)	false	none	none
»» managedReports	integer(int32)	false	none	none
»» migratedManagedReports	integer(int32)	false	none	none

Enumerated Values

Property	Value
migrationStatus	RUNNING
migrationStatus	FINISHED
migrationStatus	FAILED

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /customers

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get usage stats for a customer

GET /customers/{customerId}/usage-stats

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[UsageStats]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» customerName	string	false	read-only	none
» organization	string	false	read-only	none
» salesAccountId	string	false	read-only	none
» statsUpdated	string(date-time)	false	none	none
» applianceStatsUpdated	string(date-time)	false	none	none
» scaleConfigurations	integer(int32)	false	none	none
» scoutConfigurations	integer(int32)	false	none	none
» cloudsecConfigurations	integer(int32)	false	none	none
» applianceScaleConfigurations	integer(int32)	false	none	none
» users	integer(int32)	false	none	none
» lastLogin	string(date-time)	false	none	none
» applianceUsers	integer(int32)	false	none	none
» applianceLastLogin	string(date-time)	false	none	none
» findingsCritical	integer(int32)	false	none	none
» findingsHigh	integer(int32)	false	none	none
» findingsMedium	integer(int32)	false	none	none
» findingsLow	integer(int32)	false	none	none
» findingsRecommendations	integer(int32)	false	none	none
» applianceFindingsCritical	integer(int32)	false	none	none
» applianceFindingsHigh	integer(int32)	false	none	none
» applianceFindingsMedium	integer(int32)	false	none	none
» applianceFindingsLow	integer(int32)	false	none	none
» applianceFindingsRecommendations	integer(int32)	false	none	none
» scans	integer(int32)	false	none	none
» lastScan	string(date-time)	false	none	none
» applianceScans	integer(int32)	false	none	none
» applianceLastScan	string(date-time)	false	none	none
» accountsAws	integer(int32)	false	none	none
» accountsGcp	integer(int32)	false	none	none
» accountsAzure	integer(int32)	false	none	none
» accountsVsphere	integer(int32)	false	none	none
» accountsBasic	integer(int32)	false	none	none
» accountsWeb	integer(int32)	false	none	none
» applianceAccountsAws	integer(int32)	false	none	none
» applianceAccountsGcp	integer(int32)	false	none	none
» applianceAccountsAzure	integer(int32)	false	none	none
» applianceAccountsVsphere	integer(int32)	false	none	none
» applianceAccountsBasic	integer(int32)	false	none	none
» applianceAccountsWeb	integer(int32)	false	none	none
» cyr3conAssets	integer(int32)	false	none	none
» cyr3conApplianceAssets	integer(int32)	false	none	none
» agents	integer(int32)	false	none	none
» agentsScanned	integer(int32)	false	none	none
» agentsOutdated	integer(int32)	false	none	none
» applianceAgents	integer(int32)	false	none	none
» applianceAgentsScanned	integer(int32)	false	none	none
» applianceAgentsOutdated	integer(int32)	false	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Migrate current customer

POST /customers/me/migrate

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Migrate a customer

POST /customers/{customerId}/migrate

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags

PUT /customers/{customerId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Reset migration for current customer

POST /customers/me/reset-migration

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Reset migration for a customer

POST /customers/{customerId}/reset-migration

Parameters

Name	In	Type	Required	Description
customerId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Dashboards

Get a dashboard

GET /dashboards/{dashboardId}

Parameters

Name	In	Type	Required	Description
dashboardId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Dashboard

Delete a dashboard

DELETE /dashboards/{dashboardId}

Parameters

Name	In	Type	Required	Description
dashboardId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a dashboard

PATCH /dashboards/{dashboardId}

Body parameter

Parameters

Name	In	Type	Required	Description
dashboardId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Dashboard	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /dashboards/{dashboardId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
dashboardId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /dashboards/{dashboardId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
dashboardId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of dashboards

GET /dashboards

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Dashboard]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» cards	[Dashboard.Card]	false	none	none
»» name	string	false	none	The name of the entry.
»» data	string	false	none	none
»» width	integer(int32)	false	none	none
»» height	integer(int32)	false	none	none
»» x	integer(int32)	false	none	none
»» y	integer(int32)	false	none	none
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a dashboard

POST /dashboards

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Dashboard	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /dashboards

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /dashboards/{dashboardId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
dashboardId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Decrypt

Request the decryption of an uploaded file

POST /decrypt/file

Body parameter

Parameters

Name	In	Type	Required	Description
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	object	false	none
» file	body	FormDataContentDisposition	true	none
»» type	body	string	false	none
»» parameters	body	object	false	none
»»» additionalProperties	body	string	false	none
»» fileName	body	string	false	none
»» creationDate	body	string(date-time)	false	none
»» modificationDate	body	string(date-time)	false	none
»» readDate	body	string(date-time)	false	none
»» size	body	integer(int64)	false	none
»» name	body	string	false	The name of the entry.
» data	body	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Request the decryption of a file from object storage

POST /decrypt/object

Body parameter

Parameters

Name	In	Type	Required	Description
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ObjectDecryptionRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Downloads

Get a download cache entry and generate a token for downloading the file, expires after 5 minutes

GET /downloads/{key}

Parameters

Name	In	Type	Required	Description
key	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a download cache entry, and potentially associated data

DELETE /downloads/{key}

Parameters

Name	In	Type	Required	Description
key	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Download a file

GET /downloads/download/{token}

Parameters

Name	In	Type	Required	Description
token	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of download cache entries

GET /downloads

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[DownloadCacheEntry]	false	none	none
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» name	string	false	read-only	The name of the entry.
» key	string	false	read-only	none
» status	string	false	read-only	none
» size	integer(int64)	false	read-only	none
» token	string	false	read-only	none
» tokenExpires	string(date-time)	false	read-only	none
» type	string	false	read-only	none

Enumerated Values

Property	Value
type	ATTACHMENT
type	REPORT
type	BLUEPRINT
type	INTERNAL_BLUEPRINT
type	MANAGED_REPORT
type	DECRYPTED_OBJECT
type	LOGS
type	AGENT_INSTALLER
type	UPDATE_PACKAGE

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /downloads

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Compatibility endpoint for file download (Deprecated: 2021-03-04)

GET /downloads/{token}

Parameters

Name	In	Type	Required	Description
token	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Enroll

Configure database settings

POST /enroll/db-settings

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	DatabaseSetting	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete database settings

DELETE /enroll/db-settings

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Enroll services

POST /enroll/services

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Events

Get an event subscription

GET /events/subscriptions/{subscriptionId}

Parameters

Name	In	Type	Required	Description
subscriptionId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	EventSubscription

Delete an event subscription

DELETE /events/subscriptions/{subscriptionId}

Parameters

Name	In	Type	Required	Description
subscriptionId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an event subscription

PATCH /events/subscriptions/{subscriptionId}

Body parameter

Parameters

Name	In	Type	Required	Description
subscriptionId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	EventSubscription	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /events/subscriptions/{subscriptionId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
subscriptionId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /events/subscriptions/{subscriptionId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
subscriptionId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of event subscriptions

GET /events/subscriptions

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[EventSubscription]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» trigger	string	true	none	none
» viewTemplateId	integer(int32)	false	none	none
» integrationId	integer(int32)	false	none	none
» integrationType	string	false	read-only	none
» enabled	boolean	false	none	Determines if the entry is enabled or not.
» settings	EventSubscription.Settings	false	none	none
»» timeBefore	integer(int32)	false	none	none
»» timeSince	integer(int32)	false	none	none
»» diskUsage	integer(int32)	false	none	none
»» metric	string	false	none	none
»» limit	integer(int32)	false	none	none
»» userId	integer(int32)	false	none	none
»» from	string	false	none	none
»» to	string	false	none	none
»» entityType	string	false	none	none
» contentConfiguration	BaseContentConfiguration	false	none	none
»» integrationType	string	true	none	none
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
trigger	SCHEDULE_CREATED
trigger	SCHEDULE_DELETED
trigger	SCHEDULE_MODIFIED
trigger	SCHEDULE_SCHEDULED
trigger	CONFIGURATION_CREATED
trigger	CONFIGURATION_DELETED
trigger	CONFIGURATION_MODIFIED
trigger	CONFIGURATION_STARTED
trigger	CONFIGURATION_DONE
trigger	SCAN_STARTED
trigger	SCAN_STOPPED
trigger	SCAN_DONE
trigger	ASSET_NOT_RECENTLY_SEEN
trigger	ASSET_SEEN
trigger	ASSET_CREATED
trigger	ASSET_DELETED
trigger	ASSET_MODIFIED
trigger	FINDING_SEEN
trigger	FINDING_CREATED
trigger	FINDING_MODIFIED
trigger	FINDING_STATUS_TRANSITIONED
trigger	FINDING_RISK_ACCEPTED_EXPIRATION
trigger	WATCHED_FINDING_UPDATED
trigger	USER_CREATED
trigger	USER_DELETED
trigger	USER_MODIFIED
trigger	USER_LOGIN_ATTEMPT
trigger	USER_PASSWORD_RESET
trigger	ROLE_CREATED
trigger	ROLE_DELETED
trigger	ROLE_MODIFIED
trigger	RESOURCE_GROUP_CREATED
trigger	RESOURCE_GROUP_DELETED
trigger	RESOURCE_GROUP_MODIFIED
trigger	NEW_RELEASE_NOTES
trigger	HIAB_SCANNER_MISSING
trigger	HIAB_UPDATE_DONE
trigger	HIAB_UPDATE_FAILED
trigger	HIAB_BACKUP_DONE
trigger	HIAB_BACKUP_FAILED
trigger	HIAB_MAINTENANCE_PLAN_DONE
trigger	HIAB_DISK_USAGE_HIGH
trigger	HIAB_REBOOTED
trigger	HIAB_REMOTE_SUPPORT
trigger	OUTSCAN_CONSULTANCY
trigger	CONSUMPTION_ABSOLUTE
trigger	CONSUMPTION_RELATIVE
trigger	WORKFLOW_CREATED
trigger	WORKFLOW_DELETED
trigger	WORKFLOW_MODIFIED
trigger	WORKFLOW_STARTED
trigger	WORKFLOW_DONE
trigger	COMPLIANCE_CREATED
trigger	COMPLIANCE_MODIFIED
trigger	COMPLIANCE_RISK_EXCEPTION
trigger	COMPLIANCE_RISK_EXCEPTION_EXPIRATION
trigger	COMMENT_CREATED
trigger	EXECUTIVE_SUMMARY_UPDATED
trigger	ACTIVITY_FEED_UPDATED
trigger	ASSET_GROUP_CREATED
trigger	ASSET_GROUP_DELETED
trigger	ASSET_GROUP_MODIFIED
integrationType	WEBHOOK
integrationType	EMAIL
integrationType	LOG
integrationType	SYSLOG
integrationType	SNMP
integrationType	NOTIFICATION
metric	NETSEC_ASSETS
metric	NETSEC_SCANS
metric	NETSEC_INTERNAL_ASSETS
metric	NETSEC_INTERNAL_SCANS
metric	NETSEC_APPLIANCE_ASSETS
metric	NETSEC_APPLIANCE_SCANS
metric	NETSEC_APPLIANCE_EXTERNAL_ASSETS
metric	NETSEC_APPLIANCE_EXTERNAL_SCANS
metric	COMPLIANCE_ASSETS
metric	COMPLIANCE_SCANS
metric	COMPLIANCE_INTERNAL_ASSETS
metric	COMPLIANCE_INTERNAL_SCANS
metric	COMPLIANCE_APPLIANCE_ASSETS
metric	COMPLIANCE_APPLIANCE_SCANS
metric	COMPLIANCE_APPLIANCE_EXTERNAL_ASSETS
metric	COMPLIANCE_APPLIANCE_EXTERNAL_SCANS
metric	PCI_ASSETS
metric	PCI_SCANS
metric	SCALE_ASSETS
metric	SCALE_SCANS
metric	SCALE_INTERNAL_ASSETS
metric	SCALE_APPLIANCE_ASSETS
metric	SCALE_APPLIANCE_SCANS
metric	SCALE_APPLIANCE_EXTERNAL_ASSETS
metric	SCALE_APPLIANCE_EXTERNAL_SCANS
metric	CLOUDSEC_ASSETS
metric	CLOUDSEC_SCANS
metric	NETWORK_DISCOVERY_SCANS
metric	NETWORK_DISCOVERY_APPLIANCE_SCANS
metric	CLOUD_DISCOVERY_SCANS
metric	CLOUD_DISCOVERY_APPLIANCE_SCANS
metric	NETWORK_ASSETS
metric	NETWORK_SCANS
metric	NETWORK_APPLIANCE_ASSETS
metric	NETWORK_APPLIANCE_SCANS
metric	DOCKER_IMAGE_DISCOVERY_SCANS
metric	DOCKER_IMAGE_ASSETS
metric	DOCKER_IMAGE_SCANS
metric	DOCKER_IMAGE_DISCOVERY_APPLIANCE_SCANS
metric	DOCKER_IMAGE_APPLIANCE_ASSETS
metric	DOCKER_IMAGE_APPLIANCE_SCANS
metric	OUTSCAN_NX_ASSETS
metric	OUTSCAN_NX_APPLIANCE_ASSETS
from	to review
from	to verify
from	to QA
from	to publish
from	rejected
from	present
from	accepted
from	false positive
from	pending verification
from	fixed
from	irreproducible
to	to review
to	to verify
to	to QA
to	to publish
to	rejected
to	present
to	accepted
to	false positive
to	pending verification
to	fixed
to	irreproducible
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
integrationType	WEBHOOK
integrationType	EMAIL
integrationType	LOG
integrationType	SYSLOG
integrationType	SNMP
integrationType	NOTIFICATION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create event subscription

POST /events/subscriptions

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	EventSubscription	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /events/subscriptions

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get jinja variables relevant to an event

GET /events/subscriptions/template-variables/{trigger}

Parameters

Name	In	Type	Required	Description
trigger	path	string	true	none

Enumerated Values

Parameter	Value
trigger	SCHEDULE_CREATED
trigger	SCHEDULE_DELETED
trigger	SCHEDULE_MODIFIED
trigger	SCHEDULE_SCHEDULED
trigger	CONFIGURATION_CREATED
trigger	CONFIGURATION_DELETED
trigger	CONFIGURATION_MODIFIED
trigger	CONFIGURATION_STARTED
trigger	CONFIGURATION_DONE
trigger	SCAN_STARTED
trigger	SCAN_STOPPED
trigger	SCAN_DONE
trigger	ASSET_NOT_RECENTLY_SEEN
trigger	ASSET_SEEN
trigger	ASSET_CREATED
trigger	ASSET_DELETED
trigger	ASSET_MODIFIED
trigger	FINDING_SEEN
trigger	FINDING_CREATED
trigger	FINDING_MODIFIED
trigger	FINDING_STATUS_TRANSITIONED
trigger	FINDING_RISK_ACCEPTED_EXPIRATION
trigger	WATCHED_FINDING_UPDATED
trigger	USER_CREATED
trigger	USER_DELETED
trigger	USER_MODIFIED
trigger	USER_LOGIN_ATTEMPT
trigger	USER_PASSWORD_RESET
trigger	ROLE_CREATED
trigger	ROLE_DELETED
trigger	ROLE_MODIFIED
trigger	RESOURCE_GROUP_CREATED
trigger	RESOURCE_GROUP_DELETED
trigger	RESOURCE_GROUP_MODIFIED
trigger	NEW_RELEASE_NOTES
trigger	HIAB_SCANNER_MISSING
trigger	HIAB_UPDATE_DONE
trigger	HIAB_UPDATE_FAILED
trigger	HIAB_BACKUP_DONE
trigger	HIAB_BACKUP_FAILED
trigger	HIAB_MAINTENANCE_PLAN_DONE
trigger	HIAB_DISK_USAGE_HIGH
trigger	HIAB_REBOOTED
trigger	HIAB_REMOTE_SUPPORT
trigger	OUTSCAN_CONSULTANCY
trigger	CONSUMPTION_ABSOLUTE
trigger	CONSUMPTION_RELATIVE
trigger	WORKFLOW_CREATED
trigger	WORKFLOW_DELETED
trigger	WORKFLOW_MODIFIED
trigger	WORKFLOW_STARTED
trigger	WORKFLOW_DONE
trigger	COMPLIANCE_CREATED
trigger	COMPLIANCE_MODIFIED
trigger	COMPLIANCE_RISK_EXCEPTION
trigger	COMPLIANCE_RISK_EXCEPTION_EXPIRATION
trigger	COMMENT_CREATED
trigger	EXECUTIVE_SUMMARY_UPDATED
trigger	ACTIVITY_FEED_UPDATED
trigger	ASSET_GROUP_CREATED
trigger	ASSET_GROUP_DELETED
trigger	ASSET_GROUP_MODIFIED

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[EventTemplateVariable]	false	none	none
» key	string	false	none	The event template variable name
» description	string	false	none	Description of the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /events/subscriptions/{subscriptionId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
subscriptionId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Exploits

Get an exploit

GET /exploits/{exploitId}

Parameters

Name	In	Type	Required	Description
exploitId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Exploit

Get a list of exploits

GET /exploits

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Exploit]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» source	string	false	read-only	none
» cve	string	false	read-only	none
» name	string	false	read-only	The name of the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» pack	string	false	read-only	none
» checkId	integer(int64)	false	read-only	none
» url	string	false	read-only	none

Enumerated Values

Property	Value
source	Unknown
source	Core Security
source	Immunity
source	Exploit Database
source	DSquare Security
source	Contagio
source	Metasploit
source	SAINT
source	Security Focus
source	Snort
source	Farsight

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /exploits

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Finding template groups

Get a finding template group

GET /finding-template-groups/{findingTemplateGroupId}

Parameters

Name	In	Type	Required	Description
findingTemplateGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	FindingTemplateGroup

Delete a finding template group

DELETE /finding-template-groups/{findingTemplateGroupId}

Parameters

Name	In	Type	Required	Description
findingTemplateGroupId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of finding template groups

GET /finding-template-groups

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[FindingTemplateGroup]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a finding template group

POST /finding-template-groups

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	FindingTemplateGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /finding-template-groups

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Update a finding template

PATCH /finding-template-groups/{findingTemplateId}

Body parameter

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	FindingTemplateGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Finding templates

Get a finding template

GET /finding-templates/{findingTemplateId}

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	FindingTemplate

Delete a finding template

DELETE /finding-templates/{findingTemplateId}

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Update a finding template

PATCH /finding-templates/{findingTemplateId}

Body parameter

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	FindingTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /finding-templates/{findingTemplateId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /finding-templates/{findingTemplateId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of finding templates

GET /finding-templates

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[FindingTemplate]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» uuid	string	false	none	The UUID of the entry.
» groupId	integer(int32)	false	none	none
» cvssV2Score	number(float)	false	read-only	The CVSS V2 score
» cvssV3Score	number(float)	false	read-only	The CVSS V3 score
» cvssV2Severity	string	false	read-only	The CVSS V2 severity
» cvssV3Severity	string	false	read-only	The CVSS V3 severity
» template	FindingTemplate.Template	true	none	The finding template attributes
»» name	string	true	none	The name of the entry.
»» description	string	false	none	Description of the entry.
»» remediation	string	false	none	none
»» impact	string	false	none	none
»» recreation	string	false	none	none
»» cwe	integer(int32)	false	none	CWE classification of the entry.
»» cvssV2Vector	string	false	none	none
»» cvssV3Vector	string	false	none	none
»» owaspMobile2024	integer(int32)	false	none	none
»» owaspApi2023	integer(int32)	false	none	none
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
cvssV2Severity	RECOMMENDATION
cvssV2Severity	LOW
cvssV2Severity	MEDIUM
cvssV2Severity	HIGH
cvssV2Severity	CRITICAL
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a finding template

POST /finding-templates

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	FindingTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /finding-templates

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /finding-templates/{findingTemplateId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
findingTemplateId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Findings

Get an attachment for a finding

GET /findings/{findingId}/attachments/{attachmentId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
attachmentId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Attachment

Delete an attachment for a finding

DELETE /findings/{findingId}/attachments/{attachmentId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
attachmentId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a comment for a finding

GET /findings/{findingId}/comments/{commentId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Comment

Delete a comment for a finding

DELETE /findings/{findingId}/comments/{commentId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a comment for a finding

PATCH /findings/{findingId}/comments/{commentId}

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
commentId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get comments

GET /findings/comments

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Comment]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» comment	string	false	none	The content of the comment
» entityType	string	false	none	The type of object this comment is made for
» entityId	integer(int32)	false	none	The ID of the object this comment is made for
» supportStatus	string	false	none	Current support status of the comment
» authorIsStaff	boolean	false	read-only	Whether the comment is from Outpost24 or the customer
» deleted	string(date-time)	false	none	When the comment was deleted

Enumerated Values

Property	Value
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
supportStatus	NOT_APPLICABLE
supportStatus	WAITING
supportStatus	DONE
supportStatus	INTERNAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add a comment to one or several findings

POST /findings/comments

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete one or several comments for one or several findings

DELETE /findings/comments

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /findings

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a finding by ID

GET /findings/{findingId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Finding

Delete a finding

DELETE /findings/{findingId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a finding

PATCH /findings/{findingId}

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Finding	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /findings/{findingId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /findings/{findingId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create links to a tag

PUT /findings/tags/{tagId}

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete links to a tag

DELETE /findings/tags/{tagId}

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of findings

GET /findings

Findings are vulnerabilities and recommendations that were detected during the scan and are deducted from matches (see /matches) based on checks (see /checks). Checks might involve multiple conditions to trigger a finding and therefore findings can be associated with multiple matches. Findings are associated with a service (see /services) connected to an asset identifier of type "IP". Any findings detected during the scan will be associated with a service connected to the IP that was resolved during the scan.

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Finding]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» checkId	integer(int32)	false	none	The check id associated with the finding
» findingTemplateId	integer(int32)	false	none	The finding template from which the finding was created
» cvssScore	number(float)	false	read-only	The CVSS score, take CVSS V3 if available, otherwise CVSS V2
» cvssSeverity	string	false	read-only	The CVSS severity, take CVSS V3 severity if available, otherwise CVSS V2
» cvssV2Score	number(float)	false	read-only	The CVSS V2 score
» cvssV2BaseScore	number(float)	false	read-only	The CVSS V2 base score
» cvssV2TemporalScore	number(float)	false	read-only	The CVSS V2 temporal score
» cvssV2EnvironmentalScore	number(float)	false	read-only	The CVSS V2 environmental score
» cvssV2Vector	string	false	read-only	The CVSS V2 vector
» cvssV2Severity	string	false	read-only	The CVSS V2 severity
» cvssV3Score	number(float)	false	read-only	The CVSS V3 score
» cvssV3BaseScore	number(float)	false	read-only	The CVSS V3 base score
» cvssV3TemporalScore	number(float)	false	read-only	The CVSS V3 temporal score
» cvssV3EnvironmentalScore	number(float)	false	read-only	The CVSS V3 environmental score
» cvssV3Vector	string	false	read-only	The CVSS V3 vector
» cvssV3Severity	string	false	read-only	The CVSS V3 severity
» falsePositive	string(date-time)	false	read-only	The date when marked as false positive
» falsePositiveComment	string	false	read-only	The false positive comment
» isAccepted	boolean	false	read-only	Set to true when the risk is accepted
» accepted	string(date-time)	false	read-only	The date when the finding was marked as accepted risk.
» acceptedComment	string	false	read-only	The accepted comment
» acceptedUntil	string(date-time)	false	read-only	The date when the risk acceptance will expire.
» fixed	string(date-time)	false	read-only	The date when the risk was fixed
» commentsCount	integer(int32)	false	read-only	The number of comments
» customName	string	false	none	The custom name
» customDescription	string	false	none	The custom description
» customCve	string	false	none	The custom CVE
» customCwe	integer(int32)	false	none	The custom CWE
» customBugTraq	string	false	none	The custom bug track
» customSolution	string	false	none	The custom solution
» customRecreation	string	false	none	The custom recreation
» customImpact	string	false	none	The custom impact
» customOwaspMobile2024	integer(int32)	false	none	Custom OWASP Mobile 2024 score
» customOwaspApi2023	integer(int32)	false	none	Custom OWASP API 2023 score
» solutionPatches	[string]	false	none	The solution patches
» customCvssV2Vector	string	false	none	The custom CVSS V2 vector
» customCvssV2Severity	string	false	none	The custom CVSS V2 severity
» customCvssV3Vector	string	false	none	The custom CVSS V3 vector
» customCvssV3Severity	string	false	none	The custom CVSS V3 severity
» source	[string]	false	read-only	The scan sources
» activeSubscriptionTypes	[string]	false	read-only	The finding's active subscription types
» name	string	false	read-only	The name of the entry.
» description	string	false	read-only	Description of the entry.
» cve	string	false	read-only	The finding CVE
» cwe	string	false	read-only	CWE classification of the entry.
» solutionType	string	false	read-only	The solution type
» solution	string	false	read-only	The solution
» solutionProduct	string	false	read-only	The solution product
» solutionTitle	string	false	read-only	The solution title
» solutionUuid	string	false	read-only	The solution uuid
» exploitAvailable	boolean	false	read-only	Set to true when exploits are available
» matchIds	[integer]	false	none	The match ids
» attachmentIds	[integer]	false	read-only	The attachments ids
» firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
» firstScanId	integer(int32)	false	read-only	The id of the first scan
» lastScanId	integer(int32)	false	read-only	The id of the last scan
» lastScanConfigurationId	integer(int32)	false	read-only	The id of the last scan configuration
» status	string	false	read-only	The finding status
» commentPendingSince	string(date-time)	false	read-only	The date since comment is pending
» reviewed	string(date-time)	false	read-only	The finding reviewed date
» reviewedBy	string	false	read-only	The username of the user that reviewed the finding
» reviewedById	integer(int32)	false	read-only	The user ID of the user that reviewed the finding
» verified	string(date-time)	false	read-only	The finding verified date
» verifiedBy	string	false	read-only	The username of the user that verified the finding
» verifiedById	integer(int32)	false	read-only	The user ID of the user that verified the finding
» qualityAssured	string(date-time)	false	read-only	The finding quality assured date
» qualityAssuredBy	string	false	read-only	The username of the user that quality assured the finding
» qualityAssuredById	integer(int32)	false	read-only	The user ID of the user that quality assured the finding
» published	string(date-time)	false	read-only	The finding published date
» publishedBy	string	false	read-only	The username of the user that published the finding
» publishedById	integer(int32)	false	read-only	The user ID of the user that published the finding
» rejected	string(date-time)	false	read-only	The finding rejected date
» rejectedBy	string	false	read-only	The username of the user that rejected the finding
» rejectedById	integer(int32)	false	read-only	The user ID of the user that rejected the finding
» recreation	string	false	read-only	The recreation
» alternativeRecreation	string	false	none	The alternate recreation
» impact	string	false	none	The impact
» sans25	integer(int32)	false	read-only	SANS 25 classification of the entry.
» owasp2004	[integer]	false	read-only	An array of OWASP Top 10 2004 classifications of the entry.
» owasp2007	[integer]	false	read-only	An array of OWASP Top 10 2007 classifications of the entry.
» owasp2010	[integer]	false	read-only	An array of OWASP Top 10 2010 classifications of the entry.
» owasp2013	[integer]	false	read-only	An array of OWASP Top 10 2013 classifications of the entry.
» owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
» owasp2021	[integer]	false	read-only	The OWASP 2021 scores
» owaspMobile2024	integer(int32)	false	none	The OWASP Mobile 2024 score
» owaspApi2023	integer(int32)	false	none	The OWASP API 2023 score
» capec	[integer]	false	read-only	CAPEC classification of the entry.
» assetId	integer(int32)	true	none	The asset id
» assetName	string	false	read-only	The asset name
» potential	boolean	false	none	The finding potential. Set to true when potential false positive
» softwareComponent	string	false	read-only	The software component
» cyrating	number(double)	false	read-only	The cyrating
» cyratingDelta	number(double)	false	read-only	The cyrating delta
» exploitProbability	number(double)	false	read-only	The exploit probability
» exploitProbabilityDelta	number(double)	false	read-only	The exploit probability delta
» cyratingUpdated	string(date-time)	false	read-only	The cyrating updated date
» cyratingLastSeen	string(date-time)	false	read-only	The cyrating last seen date
» seenLastScan	boolean	false	read-only	Set to true if finding was seen in last scan
» watching	boolean	false	read-only	Whether the current user is watching this finding
» age	integer(int32)	false	read-only	The finding's age in days since creation
» assetGroupIds	[integer]	false	none	The asset group ids
» sentTo	[string]	false	read-only	A list of e-mail addresses that this finding has been sent to
» renderedName	string	false	read-only	Finding name derived from finding template
» renderedDescription	string	false	read-only	Finding description derived from finding template
» renderedCwe	integer(int32)	false	read-only	Finding CWE derived from finding template
» renderedSolution	string	false	read-only	Solution derived from finding template
» renderedRecreation	string	false	read-only	Finding recreation derived from finding template
» renderedImpact	string	false	read-only	Finding impact derived from finding template
» renderedOwaspMobile2024	integer(int32)	false	none	Finding OWASP Mobile 2024 score derived from finding template
» renderedOwaspApi2023	integer(int32)	false	none	Finding OWASP API 2023 score derived from finding template
» customerName	string	false	none	The customer name
» enabled	boolean	false	read-only	Determines if the entry is enabled or not.
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» bugTraq	[integer]	false	read-only	An array of Bugtraq reference IDs.
» secureCodeWarrior	SecureCodeWarrior	false	read-only	The secure code warrior information on the vulnerability description and training
»» name	string	false	none	The name of the entry.
»» description	string	false	none	Description of the entry.
»» url	string	false	none	none
» farsight	Farsight	false	read-only	The farsight concists in additional information on risk such as likelihood, threat activity
»» risk	Farsight.Risk	false	none	none
»»» score	number(float)	false	none	none
»»» delta	number(float)	false	none	none
»» updated	string(date-time)	false	none	The timestamp when the entry was updated.
»» lastThreatActivity	string(date-time)	false	none	none
» matches	[BaseMatch]	false	read-only	The match list
»» type	string	true	none	none
»» service	Service	false	none	none
»»» name	string	true	none	The name of the entry.
»»» scheme	string	false	none	none
»»» port	integer(int32)	false	none	none
»»» protocol	string	true	none	none
»»» virtualHost	string	false	none	none
»» patternUuid	string	false	none	none
» classifications	Classification.Classifications	false	read-only	The classifications such as CAPEC, OWASP20XX
»» sans25	integer(int32)	false	none	SANS 25 classification of the entry.
»» capec	[integer]	false	none	CAPEC classification of the entry.
»» owasp2004	[integer]	false	none	An array of OWASP Top 10 2004 classifications of the entry.
»» owasp2007	[integer]	false	none	An array of OWASP Top 10 2007 classifications of the entry.
»» owasp2010	[integer]	false	none	An array of OWASP Top 10 2010 classifications of the entry.
»» owasp2013	[integer]	false	none	An array of OWASP Top 10 2013 classifications of the entry.
»» owasp2017	[integer]	false	none	An array of OWASP Top 10 2017 classifications of the entry.
»» owasp2021	[integer]	false	none	none
» ports	[Port]	false	read-only	Ports information on the vulnerability description
»» name	string	false	none	The name of the entry.
»» port	integer(int32)	false	none	none
»» protocol	string	false	none	none

Enumerated Values

Property	Value
cvssSeverity	RECOMMENDATION
cvssSeverity	LOW
cvssSeverity	MEDIUM
cvssSeverity	HIGH
cvssSeverity	CRITICAL
cvssV2Severity	RECOMMENDATION
cvssV2Severity	LOW
cvssV2Severity	MEDIUM
cvssV2Severity	HIGH
cvssV2Severity	CRITICAL
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
customCvssV2Severity	RECOMMENDATION
customCvssV2Severity	LOW
customCvssV2Severity	MEDIUM
customCvssV2Severity	HIGH
customCvssV2Severity	CRITICAL
customCvssV3Severity	RECOMMENDATION
customCvssV3Severity	LOW
customCvssV3Severity	MEDIUM
customCvssV3Severity	HIGH
customCvssV3Severity	CRITICAL
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE
status	to review
status	to verify
status	to QA
status	to publish
status	rejected
status	present
status	accepted
status	false positive
status	pending verification
status	fixed
status	irreproducible
type	WAS
type	GATHEREDINFORMATION
type	COMPONENT
type	COMPLIANCE
type	PAC
protocol	TCP
protocol	UDP
protocol	TCP
protocol	UDP

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a finding

POST /findings

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Finding	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete one or several findings

DELETE /findings

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update one or several findings

PATCH /findings

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	Finding	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a match

PUT /findings/{findingId}/matches/{matchId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
matchId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a match

DELETE /findings/{findingId}/matches/{matchId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
matchId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the token for downloading an attachment for a finding

GET /findings/{findingId}/attachments/{attachmentId}/download

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
attachmentId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Send finding as email

POST /findings/{findingId}/send

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	FindingExportAsEmail	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the attachments for a finding

GET /findings/{findingId}/attachments

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Attachment]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» findingId	integer(int32)	false	read-only	none
» type	string	false	read-only	none
» name	string	false	read-only	The name of the entry.

Enumerated Values

Property	Value
type	OTHER
type	IMAGE
type	TEXT
type	VIDEO
type	ARCHIVE

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add an attachment for a finding

POST /findings/{findingId}/attachments

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	object	false	none
» name	body	string	false	none
» type	body	string	false	none
» file	body	FormDataContentDisposition	false	none
»» type	body	string	false	none
»» parameters	body	object	false	none
»»» additionalProperties	body	string	false	none
»» fileName	body	string	false	none
»» creationDate	body	string(date-time)	false	none
»» modificationDate	body	string(date-time)	false	none
»» readDate	body	string(date-time)	false	none
»» size	body	integer(int64)	false	none
»» name	body	string	false	The name of the entry.

Enumerated Values

Parameter	Value
» type	OTHER
» type	IMAGE
» type	TEXT
» type	VIDEO
» type	ARCHIVE

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the comments for a finding

GET /findings/{findingId}/comments

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Comment]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» comment	string	false	none	The content of the comment
» entityType	string	false	none	The type of object this comment is made for
» entityId	integer(int32)	false	none	The ID of the object this comment is made for
» supportStatus	string	false	none	Current support status of the comment
» authorIsStaff	boolean	false	read-only	Whether the comment is from Outpost24 or the customer
» deleted	string(date-time)	false	none	When the comment was deleted

Enumerated Values

Property	Value
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
supportStatus	NOT_APPLICABLE
supportStatus	WAITING
supportStatus	DONE
supportStatus	INTERNAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Add a comment for a finding

POST /findings/{findingId}/comments

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Comment	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the exploits for a finding

GET /findings/{findingId}/exploits

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Exploit]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» source	string	false	read-only	none
» cve	string	false	read-only	none
» name	string	false	read-only	The name of the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» pack	string	false	read-only	none
» checkId	integer(int64)	false	read-only	none
» url	string	false	read-only	none

Enumerated Values

Property	Value
source	Unknown
source	Core Security
source	Immunity
source	Exploit Database
source	DSquare Security
source	Contagio
source	Metasploit
source	SAINT
source	Security Focus
source	Snort
source	Farsight

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of deltas

GET /findings/delta

Parameters

Name	In	Type	Required	Description
from	query	string(date-time)	false	none
to	query	string(date-time)	false	none
findingFilter	query	string	false	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[FindingDelta]	false	none	none
» firstSeen	integer(int32)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	integer(int32)	false	read-only	Timestamp when the entry was seen last time.
» unchanged	integer(int32)	false	read-only	none
» asset	Asset	false	read-only	none
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» name	string	true	none	The name of the entry.
»» source	[string]	true	none	The asset sources
»» platform	string	false	read-only	The asset platform
»» assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
»» assetIdentifierTypes	[string]	false	read-only	The asset identifier types (deprecated)
»» activeSubscriptionTypes	[string]	false	read-only	The asset's active subscription types
»» uuid	string	false	read-only	The UUID of the entry.
»» firstScanId	integer(int32)	false	read-only	The id of the first scan performed on the asset
»» lastScanId	integer(int32)	false	read-only	The id of last scan performed on the asset
»» compliant	string	false	read-only	The asset compliance status
»» cvssV2EnvironmentalVector	string	false	none	The CVSS V2 environmental vector
»» cvssV3EnvironmentalVector	string	false	none	The CVSS V3 environmental vector
»» customerName	string	false	none	The customer name
»» enabled	boolean	false	none	Determines if the entry is enabled or not.
»» active	boolean	false	read-only	Determines if the entry is active or not.
»» dockerImageProperties	BaseProperties	false	none	The asset base properties
»»» type	string	true	none	none
»» tags	[Tag]	false	read-only	The tags
»»» id	integer(int32)	false	read-only	The ID of the entry.
»»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»»» createdBy	string	false	read-only	The name of the user who created the entry.
»»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»»» key	string	true	none	none
»»» value	string	false	none	none
»»» inherited	boolean	false	read-only	none
»»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
»» assetIdentifiers	[AssetIdentifier]	false	none	The asset links
»»» id	integer(int32)	false	read-only	The ID of the entry.
»»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»»» createdBy	string	false	read-only	The name of the user who created the entry.
»»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»»» name	string	true	none	The name of the entry.
»»» presentableName	string	false	none	none
»»» type	string	true	none	none
»»» firstSeen	string(date-time)	false	none	Timestamp when the entry was seen for the first time.
»»» lastSeen	string(date-time)	false	none	Timestamp when the entry was seen last time.
»»» scannerId	integer(int32)	false	none	none
»»» scannerName	string	false	read-only	none
»»» ownership	integer(int32)	false	read-only	none
»»» customOwnership	integer(int32)	false	none	none
»»» firstScanId	integer(int32)	false	read-only	none
»»» lastScanId	integer(int32)	false	read-only	none
»»» source	[string]	true	none	none
»»» links	[integer]	false	read-only	none
»»» assetIds	[integer]	false	none	none
»»» assetNames	[string]	false	read-only	none
»»» accountIds	[integer]	false	none	none
»»» platform	string	false	none	none
»»» tags	[Tag]	false	read-only	[The tags]
»»» properties	BaseProperties	false	none	The asset base properties
»» assetGroups	[Asset.AssetGroup]	false	read-only	Information of all asset groups the asset is linked to
»»» id	integer(int32)	false	none	The ID of the entry.
»»» name	string	false	none	The name of the entry.

Enumerated Values

Property	Value
compliant	COMPLIANT
compliant	NOT_COMPLIANT
compliant	COMPLIANT_WITH_EXCEPTIONS
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a delta summary

GET /findings/delta-summary

Parameters

Name	In	Type	Required	Description
from	query	string(date-time)	false	none
to	query	string(date-time)	false	none
findingFilter	query	string	false	none
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	FindingDelta

Get a list of solutions

GET /findings/solutions

Parameters

Name	In	Type	Required	Description
assetIds	query	string	false	none
assetGroupIds	query	string	false	none
findingFilter	query	string	false	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[FindingSolution]	false	none	none
» solutionUuid	string	false	read-only	none
» solutionType	string	false	read-only	none
» solution	string	false	read-only	none
» solutionProduct	string	false	read-only	none
» solutionTitle	string	false	read-only	none
» riskCount	integer(int32)	false	read-only	none
» assetCount	integer(int32)	false	read-only	none
» severityCount	FindingSolution.SeverityCount	false	read-only	none
»» critical	integer(int32)	false	none	none
»» high	integer(int32)	false	none	none
»» medium	integer(int32)	false	none	none
»» low	integer(int32)	false	none	none
»» recommendation	integer(int32)	false	none	none

Enumerated Values

Property	Value
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Log the request to Secure Code Warrior

POST /findings/{findingId}/secure-code-warrior

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark finding as false positive

POST /findings/{findingId}/mark-false-positive

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	FindingFalsePositive	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark one or several finding(s) as false positives

POST /findings/mark-false-positive

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	FindingFalsePositive	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark finding as fixed

POST /findings/{findingId}/mark-fixed

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark one or several findings as fixed

POST /findings/mark-fixed

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark finding as irreproducible

POST /findings/{findingId}/mark-irreproducible

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark one or several findings as irreproducible

POST /findings/mark-irreproducible

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags

PUT /findings/{findingId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags to one or several findings

PUT /findings/tags

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Publish finding (set as present)

POST /findings/{findingId}/publish

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Set finding as rejected

POST /findings/{findingId}/reject

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Request clarification for a finding

POST /findings/{findingId}/request-clarification

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	FindingClarificationRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark finding as pending verification

POST /findings/{findingId}/request-verification

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	FindingVerificationRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark one or several findings as pending for verification

POST /findings/request-verification

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	FindingVerificationRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Reset status of finding to 'PRESENT'

POST /findings/{findingId}/reset-status

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Reset status on one or several findings to 'PRESENT

POST /findings/reset-status

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Accept finding

POST /findings/{findingId}/accept

Body parameter

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none
body	body	FindingAccept	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Accept one or several findings

POST /findings/accept

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	FindingAccept	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Set finding as quality assured

POST /findings/{findingId}/quality-assure

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Set finding as reviewed and transition to be verified

POST /findings/{findingId}/review

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Set finding as verified and transitioned to be quality assured

POST /findings/{findingId}/verify

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Unwatch a finding

POST /findings/{findingId}/unwatch

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Unwatch one or several findings

POST /findings/unwatch

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Watch a finding

POST /findings/{findingId}/watch

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Watch one or several findings

POST /findings/watch

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Globals

Get global settings

GET /globals

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Globals

Get a list of timezones

GET /globals/timezones

Parameters

Name	In	Type	Required	Description
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Timezone]	false	none	none
» name	string	true	none	The name of the entry.
» gmtOffset	number(double)	true	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Integrations

Authorization

GET /integrations/authorization

Parameters

Name	In	Type	Required	Description
code	query	string	true	none
error	query	string	false	none
error_description	query	string	false	none
state	query	string	false	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Authorize an integration based on OAuth 2.0

GET /integrations/{integrationId}/authorize

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get an integration

GET /integrations/{integrationId}

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Integration

Delete an integration

DELETE /integrations/{integrationId}

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an integration

PATCH /integrations/{integrationId}

Body parameter

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Integration	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /integrations/{integrationId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /integrations/{integrationId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of integrations

GET /integrations

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Integration]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» type	string	false	read-only	none
» verified	string(date-time)	false	read-only	none
» verifiedBy	string	false	read-only	none
» verifiedById	integer(int32)	false	read-only	none
» verifyStatus	boolean	false	read-only	none
» configuration	BaseIntegrationConfiguration	true	none	none
»» type	string	true	none	none
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
type	OBJECT_STORAGE
type	AGENT
type	ENCRYPTION_SERVICE
type	EMAIL
type	WEBHOOK
type	LOG
type	SYSLOG
type	SNMP
type	CYBERARK
type	DELINEA
type	NOTIFICATION
type	OBJECT_STORAGE
type	AGENT
type	ENCRYPTION_SERVICE
type	EMAIL
type	WEBHOOK
type	LOG
type	SYSLOG
type	SNMP
type	CYBERARK
type	DELINEA
type	NOTIFICATION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create an integration

POST /integrations

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Integration	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /integrations

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /integrations/{integrationId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Verify the integration connectivity

POST /integrations/{integrationId}/verify

Parameters

Name	In	Type	Required	Description
integrationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Managed report groups

Get a managed report group (Deprecated: 2019-12-11)

GET /managed-report-groups/{managedReportGroupId}

Parameters

Name	In	Type	Required	Description
managedReportGroupId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ManagedReportGroup

Get a list of managed report groups (Deprecated: 2019-12-11)

GET /managed-report-groups

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ManagedReportGroup]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» userId	integer(int64)	false	read-only	none
» name	string	true	none	The name of the entry.
» parentId	integer(int64)	false	none	The ID of the parent entry.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» count	integer(int64)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count (Deprecated: 2019-12-11)

HEAD /managed-report-groups

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Managed reports

Get a managed report

GET /managed-reports/{managedReportId}

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ManagedReport

Delete a managed report

DELETE /managed-reports/{managedReportId}

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a managed report

PATCH /managed-reports/{managedReportId}

Body parameter

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ManagedReport	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /managed-reports/{managedReportId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /managed-reports/{managedReportId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the token for downloading a managed report

GET /managed-reports/{managedReportId}/download

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of managed reports

GET /managed-reports

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ManagedReport]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» size	integer(int32)	false	read-only	none
» lastDownloaded	string(date-time)	false	read-only	none
» lastDownloadedBy	string	false	read-only	none
» uuid	string	false	read-only	The UUID of the entry.
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a managed report

POST /managed-reports

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» name	body	string	false	none
» file	body	FormDataContentDisposition	false	none
»» type	body	string	false	none
»» parameters	body	object	false	none
»»» additionalProperties	body	string	false	none
»» fileName	body	string	false	none
»» creationDate	body	string(date-time)	false	none
»» modificationDate	body	string(date-time)	false	none
»» readDate	body	string(date-time)	false	none
»» size	body	integer(int64)	false	none
»» name	body	string	false	The name of the entry.

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /managed-reports

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of tags for managed reports

GET /managed-reports/tags

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Tag]	false	none	[The tags]
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» key	string	true	none	none
» value	string	false	none	none
» inherited	boolean	false	read-only	none
» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /managed-reports/{managedReportId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
managedReportId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Upload a managed report from HIAB

POST /managed-reports/upload

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» key	body	string	false	none
» name	body	string	false	none
» tags	body	string	false	none
» file	body	FormDataContentDisposition	false	none
»» type	body	string	false	none
»» parameters	body	object	false	none
»»» additionalProperties	body	string	false	none
»» fileName	body	string	false	none
»» creationDate	body	string(date-time)	false	none
»» modificationDate	body	string(date-time)	false	none
»» readDate	body	string(date-time)	false	none
»» size	body	integer(int64)	false	none
»» name	body	string	false	The name of the entry.

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Matches

Get a match

GET /matches/{matchId}

Parameters

Name	In	Type	Required	Description
matchId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Match

Delete a match

DELETE /matches/{matchId}

Parameters

Name	In	Type	Required	Description
matchId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a match

PATCH /matches/{matchId}

Body parameter

Parameters

Name	In	Type	Required	Description
matchId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Match	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of matches

GET /matches

Matches are the most atomic elements composing findings. A match is an output from the scanner describing a state that has been detected on the scanned asset.

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Match]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» assetId	integer(int32)	true	none	none
» type	string	true	none	none
» firstSeen	string(date-time)	true	none	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	true	none	Timestamp when the entry was seen last time.
» firstScanId	integer(int32)	false	read-only	none
» lastScanId	integer(int32)	false	read-only	none
» findingIds	[integer]	false	read-only	none
» source	[string]	true	none	none
» subscriptionType	string	false	none	none
» match	BaseMatch	false	read-only	The match list
»» type	string	true	none	none
»» service	Service	false	none	none
»»» name	string	true	none	The name of the entry.
»»» scheme	string	false	none	none
»»» port	integer(int32)	false	none	none
»»» protocol	string	true	none	none
»»» virtualHost	string	false	none	none
»» patternUuid	string	false	none	none
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
type	WAS
type	GATHEREDINFORMATION
type	COMPONENT
type	COMPLIANCE
type	PAC
subscriptionType	DAST
subscriptionType	SCALE
subscriptionType	SCOUT
subscriptionType	SNAPSHOT
subscriptionType	ASSURE
subscriptionType	DAST_EXPERT
subscriptionType	VERIFY
subscriptionType	SWAT
subscriptionType	CLOUDSEC
subscriptionType	NETSEC
subscriptionType	CONSUMPTION
type	WAS
type	GATHEREDINFORMATION
type	COMPONENT
type	COMPLIANCE
type	PAC
protocol	TCP
protocol	UDP

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a match

POST /matches

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Match	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /matches

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Notifications

Get a notification

GET /notifications/{notificationId}

Parameters

Name	In	Type	Required	Description
notificationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Notification

Get a list of notifications

GET /notifications

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Notification]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» userId	integer(int64)	false	none	none
» subUserId	integer(int64)	false	none	none
» eventSubscriptionId	integer(int32)	false	none	none
» read	string(date-time)	false	none	none
» content	Notification.Content	false	none	none
»» subject	string	true	none	none
»» message	string	false	none	none
»» trigger	string	true	none	none
»» entityType	string	false	none	none
»» entityId	integer(int32)	false	none	none
»» subEntityType	string	false	none	none
»» subEntityId	integer(int32)	false	none	none

Enumerated Values

Property	Value
trigger	SCHEDULE_CREATED
trigger	SCHEDULE_DELETED
trigger	SCHEDULE_MODIFIED
trigger	SCHEDULE_SCHEDULED
trigger	CONFIGURATION_CREATED
trigger	CONFIGURATION_DELETED
trigger	CONFIGURATION_MODIFIED
trigger	CONFIGURATION_STARTED
trigger	CONFIGURATION_DONE
trigger	SCAN_STARTED
trigger	SCAN_STOPPED
trigger	SCAN_DONE
trigger	ASSET_NOT_RECENTLY_SEEN
trigger	ASSET_SEEN
trigger	ASSET_CREATED
trigger	ASSET_DELETED
trigger	ASSET_MODIFIED
trigger	FINDING_SEEN
trigger	FINDING_CREATED
trigger	FINDING_MODIFIED
trigger	FINDING_STATUS_TRANSITIONED
trigger	FINDING_RISK_ACCEPTED_EXPIRATION
trigger	WATCHED_FINDING_UPDATED
trigger	USER_CREATED
trigger	USER_DELETED
trigger	USER_MODIFIED
trigger	USER_LOGIN_ATTEMPT
trigger	USER_PASSWORD_RESET
trigger	ROLE_CREATED
trigger	ROLE_DELETED
trigger	ROLE_MODIFIED
trigger	RESOURCE_GROUP_CREATED
trigger	RESOURCE_GROUP_DELETED
trigger	RESOURCE_GROUP_MODIFIED
trigger	NEW_RELEASE_NOTES
trigger	HIAB_SCANNER_MISSING
trigger	HIAB_UPDATE_DONE
trigger	HIAB_UPDATE_FAILED
trigger	HIAB_BACKUP_DONE
trigger	HIAB_BACKUP_FAILED
trigger	HIAB_MAINTENANCE_PLAN_DONE
trigger	HIAB_DISK_USAGE_HIGH
trigger	HIAB_REBOOTED
trigger	HIAB_REMOTE_SUPPORT
trigger	OUTSCAN_CONSULTANCY
trigger	CONSUMPTION_ABSOLUTE
trigger	CONSUMPTION_RELATIVE
trigger	WORKFLOW_CREATED
trigger	WORKFLOW_DELETED
trigger	WORKFLOW_MODIFIED
trigger	WORKFLOW_STARTED
trigger	WORKFLOW_DONE
trigger	COMPLIANCE_CREATED
trigger	COMPLIANCE_MODIFIED
trigger	COMPLIANCE_RISK_EXCEPTION
trigger	COMPLIANCE_RISK_EXCEPTION_EXPIRATION
trigger	COMMENT_CREATED
trigger	EXECUTIVE_SUMMARY_UPDATED
trigger	ACTIVITY_FEED_UPDATED
trigger	ASSET_GROUP_CREATED
trigger	ASSET_GROUP_DELETED
trigger	ASSET_GROUP_MODIFIED
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
subEntityType	COMMENT
subEntityType	ATTACHMENT
subEntityType	ACTIVITY

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /notifications

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Mark a notification as read

POST /notifications/{notificationId}/mark-as-read

Parameters

Name	In	Type	Required	Description
notificationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Mark a notification as unread

POST /notifications/{notificationId}/mark-as-unread

Parameters

Name	In	Type	Required	Description
notificationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Organizations

Get an organization

GET /organizations/{organizationId}

Parameters

Name	In	Type	Required	Description
organizationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Organization

Get a list of organizations

GET /organizations

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Organization]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» uuid	string	false	read-only	The UUID of the entry.
» name	string	false	read-only	The name of the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /organizations

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Outscan findings

Get the exploits for a finding

GET /outscan/findings/{findingId}/exploits

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int64)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Exploit]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» source	string	false	read-only	none
» cve	string	false	read-only	none
» name	string	false	read-only	The name of the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» pack	string	false	read-only	none
» checkId	integer(int64)	false	read-only	none
» url	string	false	read-only	none

Enumerated Values

Property	Value
source	Unknown
source	Core Security
source	Immunity
source	Exploit Database
source	DSquare Security
source	Contagio
source	Metasploit
source	SAINT
source	Security Focus
source	Snort
source	Farsight

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a finding by ID

GET /outscan/findings/{findingId}

Parameters

Name	In	Type	Required	Description
findingId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	OutscanFinding

Get a list of findings

GET /outscan/findings

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[OutscanFinding]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» scanJobId	integer(int64)	false	read-only	none
» scanLogId	integer(int64)	false	read-only	none
» scheduleId	integer(int64)	false	read-only	none
» templateId	integer(int64)	false	read-only	none
» cvssScore	number(double)	false	read-only	none
» cvssV3Score	number(double)	false	read-only	none
» cvssV3Severity	string	false	read-only	none
» cvssV3Vector	string	false	read-only	none
» firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
» reportDate	string(date-time)	false	read-only	none
» targetId	integer(int64)	false	read-only	none
» target	string	false	read-only	none
» hostname	string	false	read-only	none
» port	integer(int64)	false	read-only	none
» protocol	integer(int64)	false	read-only	none
» name	string	false	read-only	The name of the entry.
» source	[string]	false	read-only	none
» cve	string	false	read-only	none
» vulnId	integer(int64)	false	read-only	none
» isNew	boolean	false	read-only	none
» previouslyDetected	boolean	false	read-only	none
» type	string	false	read-only	none
» isPotentialFalsePositive	boolean	false	read-only	none
» productName	string	false	read-only	none
» productUrl	string	false	read-only	none
» solutionProduct	string	false	read-only	none
» checkCreated	string(date-time)	false	read-only	none
» hasExploits	boolean	false	read-only	none
» solution	string	false	read-only	none
» businessCriticality	string	false	read-only	none
» assetBusinessCriticality	string	false	read-only	none
» solutionTitle	string	false	read-only	none
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» cyrating	number(double)	false	read-only	none
» cyratingDelta	number(double)	false	read-only	none
» cyratingUpdated	string(date-time)	false	read-only	none
» cyratingLastSeen	string(date-time)	false	read-only	none
» exploitProbability	number(double)	false	read-only	none
» exploitProbabilityDelta	number(double)	false	read-only	none
» assetExposed	boolean	false	read-only	none
» owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
» isAccepted	boolean	false	read-only	none
» patchInformation	string	false	read-only	none
» cvssVector	string	false	none	none
» virtualHost	string	false	none	none
» platform	string	false	none	none
» bugTraq	[integer]	false	none	An array of Bugtraq reference IDs.
» serviceName	string	false	none	none
» riskLevel	string	false	none	none
» solutionType	string	false	none	none
» age	integer(int32)	false	none	none
» data	string	false	none	none
» description	string	false	read-only	Description of the entry.
» farsight	Farsight	false	read-only	The farsight concists in additional information on risk such as likelihood, threat activity
»» risk	Farsight.Risk	false	none	none
»»» score	number(float)	false	none	none
»»» delta	number(float)	false	none	none
»» updated	string(date-time)	false	none	The timestamp when the entry was updated.
»» lastThreatActivity	string(date-time)	false	none	none
» acceptExpires	string(date-time)	false	read-only	none
» acceptedBy	string	false	read-only	The name of the user who accepted the risk.
» acceptDate	string(date-time)	false	read-only	none
» acceptComment	string	false	read-only	none

Enumerated Values

Property	Value
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
businessCriticality	LOW
businessCriticality	MEDIUM
businessCriticality	HIGH
businessCriticality	CRITICAL
assetBusinessCriticality	LOW
assetBusinessCriticality	MEDIUM
assetBusinessCriticality	HIGH
assetBusinessCriticality	CRITICAL
riskLevel	Initial
riskLevel	Recommendation
riskLevel	Low
riskLevel	Medium
riskLevel	High
riskLevel	Critical
solutionType	Unspecified
solutionType	Unknown
solutionType	Reconfigure
solutionType	Workaround
solutionType	InProgress
solutionType	Contact
solutionType	Update
solutionType	Patch
solutionType	Unack
solutionType	NoSol
solutionType	Account
solutionType	Disable
solutionType	Filter
solutionType	Malware

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /outscan/findings

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Outscan scan logs

Get a list of findings for a scan

GET /outscan/scan-logs/{scanLogId}/findings

Parameters

Name	In	Type	Required	Description
scanLogId	path	integer(int64)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[OutscanFinding]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» scanJobId	integer(int64)	false	read-only	none
» scanLogId	integer(int64)	false	read-only	none
» scheduleId	integer(int64)	false	read-only	none
» templateId	integer(int64)	false	read-only	none
» cvssScore	number(double)	false	read-only	none
» cvssV3Score	number(double)	false	read-only	none
» cvssV3Severity	string	false	read-only	none
» cvssV3Vector	string	false	read-only	none
» firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
» reportDate	string(date-time)	false	read-only	none
» targetId	integer(int64)	false	read-only	none
» target	string	false	read-only	none
» hostname	string	false	read-only	none
» port	integer(int64)	false	read-only	none
» protocol	integer(int64)	false	read-only	none
» name	string	false	read-only	The name of the entry.
» source	[string]	false	read-only	none
» cve	string	false	read-only	none
» vulnId	integer(int64)	false	read-only	none
» isNew	boolean	false	read-only	none
» previouslyDetected	boolean	false	read-only	none
» type	string	false	read-only	none
» isPotentialFalsePositive	boolean	false	read-only	none
» productName	string	false	read-only	none
» productUrl	string	false	read-only	none
» solutionProduct	string	false	read-only	none
» checkCreated	string(date-time)	false	read-only	none
» hasExploits	boolean	false	read-only	none
» solution	string	false	read-only	none
» businessCriticality	string	false	read-only	none
» assetBusinessCriticality	string	false	read-only	none
» solutionTitle	string	false	read-only	none
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» cyrating	number(double)	false	read-only	none
» cyratingDelta	number(double)	false	read-only	none
» cyratingUpdated	string(date-time)	false	read-only	none
» cyratingLastSeen	string(date-time)	false	read-only	none
» exploitProbability	number(double)	false	read-only	none
» exploitProbabilityDelta	number(double)	false	read-only	none
» assetExposed	boolean	false	read-only	none
» owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
» isAccepted	boolean	false	read-only	none
» patchInformation	string	false	read-only	none
» cvssVector	string	false	none	none
» virtualHost	string	false	none	none
» platform	string	false	none	none
» bugTraq	[integer]	false	none	An array of Bugtraq reference IDs.
» serviceName	string	false	none	none
» riskLevel	string	false	none	none
» solutionType	string	false	none	none
» age	integer(int32)	false	none	none
» data	string	false	none	none
» description	string	false	read-only	Description of the entry.
» farsight	Farsight	false	read-only	The farsight concists in additional information on risk such as likelihood, threat activity
»» risk	Farsight.Risk	false	none	none
»»» score	number(float)	false	none	none
»»» delta	number(float)	false	none	none
»» updated	string(date-time)	false	none	The timestamp when the entry was updated.
»» lastThreatActivity	string(date-time)	false	none	none
» acceptExpires	string(date-time)	false	read-only	none
» acceptedBy	string	false	read-only	The name of the user who accepted the risk.
» acceptDate	string(date-time)	false	read-only	none
» acceptComment	string	false	read-only	none

Enumerated Values

Property	Value
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
businessCriticality	LOW
businessCriticality	MEDIUM
businessCriticality	HIGH
businessCriticality	CRITICAL
assetBusinessCriticality	LOW
assetBusinessCriticality	MEDIUM
assetBusinessCriticality	HIGH
assetBusinessCriticality	CRITICAL
riskLevel	Initial
riskLevel	Recommendation
riskLevel	Low
riskLevel	Medium
riskLevel	High
riskLevel	Critical
solutionType	Unspecified
solutionType	Unknown
solutionType	Reconfigure
solutionType	Workaround
solutionType	InProgress
solutionType	Contact
solutionType	Update
solutionType	Patch
solutionType	Unack
solutionType	NoSol
solutionType	Account
solutionType	Disable
solutionType	Filter
solutionType	Malware

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a scan log

GET /outscan/scan-logs/{scanLogId}

Parameters

Name	In	Type	Required	Description
scanLogId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	OutscanScanLog

Get a list of scan logs

GET /outscan/scan-logs

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[OutscanScanLog]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» startDate	string(date-time)	false	read-only	none
» endDate	string(date-time)	false	read-only	none
» target	string	false	read-only	none
» targetId	integer(int64)	false	read-only	none
» schedule	string	false	read-only	none
» scheduleId	integer(int64)	false	read-only	none
» scanJobId	integer(int64)	false	read-only	none
» status	string	false	none	none

Enumerated Values

Property	Value
status	Invalid
status	Ok
status	Forced
status	Timeout
status	Stopped
status	StoppedByUser
status	Large
status	KilledLarge
status	Failed

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /outscan/scan-logs

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Outscan scans

Get a scan

GET /outscan/scans/{scanId}

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	OutscanScan

Get a list of scans

GET /outscan/scans

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[OutscanScan]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» target	string	false	read-only	none
» targetId	integer(int64)	false	read-only	none
» scheduleId	integer(int64)	false	read-only	none
» status	string	false	read-only	none
» scanStarted	string(date-time)	false	read-only	none
» scanJobId	integer(int64)	false	read-only	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /outscan/scans

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Stop a scan

POST /outscan/scans/{scanId}/stop

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int64)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Outscan schedules

Get a schedule

GET /outscan/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	OutscanSchedule

Delete a schedule

DELETE /outscan/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int64)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a schedule

PATCH /outscan/schedules/{scheduleId}

Body parameter

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	OutscanSchedule	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of schedules

GET /outscan/schedules

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[OutscanSchedule]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» nextScanDate	string(date-time)	false	none	none
» template	integer(int64)	false	none	none
» name	string	true	none	The name of the entry.
» targetList	string	true	none	none
» recurrence	string	false	none	none

Enumerated Values

Property	Value
recurrence	Now
recurrence	Once
recurrence	Weekly
recurrence	Monthly
recurrence	Bimonthly
recurrence	Quarterly
recurrence	Fortnightly
recurrence	Daily

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a schedule

POST /outscan/schedules

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	OutscanSchedule	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /outscan/schedules

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Start scanning now

POST /outscan/schedules/{scheduleId}/scan

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int64)	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	integer

Outscan targets

Get a target

GET /outscan/targets/{targetId}

Parameters

Name	In	Type	Required	Description
targetId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	OutscanTarget

Delete a target

DELETE /outscan/targets/{targetId}

Parameters

Name	In	Type	Required	Description
targetId	path	integer(int64)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of targets

GET /outscan/targets

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[OutscanTarget]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» ip	string	false	read-only	none
» hostname	string	false	read-only	none
» businessCriticality	string	false	read-only	none
» exposed	boolean	false	read-only	none
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
» source	[string]	false	read-only	none

Enumerated Values

Property	Value
businessCriticality	LOW
businessCriticality	MEDIUM
businessCriticality	HIGH
businessCriticality	CRITICAL

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create new targets

POST /outscan/targets

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /outscan/targets

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Password recovery

Request password recovery email for username

POST /password-recovery

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	PasswordRecoveryRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Product information

Get a list of products

GET /product-information

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ProductInformation]	false	none	none
» product	string	false	read-only	none
» name	string	false	read-only	The name of the entry.
» url	string	false	read-only	none
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /product-information

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Release notes

Get last release notes notification trigger timestamp

GET /release-notes/notification-trigger

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	string

Trigger release notes notification and set trigger timestamp

POST /release-notes/trigger-notification

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	string

Report schedules

Get a report schedule (Deprecated: 2019-12-11)

GET /report-schedules/{reportScheduleId}

Parameters

Name	In	Type	Required	Description
reportScheduleId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ReportSchedule

Delete a report schedule (Deprecated: 2019-12-11)

DELETE /report-schedules/{reportScheduleId}

Parameters

Name	In	Type	Required	Description
reportScheduleId	path	integer(int64)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a report schedule (Deprecated: 2019-12-11)

PATCH /report-schedules/{reportScheduleId}

Body parameter

Parameters

Name	In	Type	Required	Description
reportScheduleId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ReportSchedule	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of report schedules (Deprecated: 2019-12-11)

GET /report-schedules

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ReportSchedule]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» userId	integer(int64)	false	read-only	none
» subUserId	integer(int64)	false	read-only	none
» frequency	integer(int32)	false	none	none
» nextDate	string(date-time)	false	none	none
» latestDate	string(date-time)	false	read-only	none
» lastDate	string(date-time)	false	none	none
» dayWeekMonth	integer(int32)	false	none	none
» name	string	true	none	The name of the entry.
» reportType	integer(int32)	false	none	none
» format	integer(int32)	false	none	none
» zip	boolean	false	none	none
» recipient	[integer]	false	none	none
» recipientEmail	string	false	none	none
» encryptionKey	string	true	none	none
» managedReportTitle	string	false	none	none
» managedReportGroup	integer(int64)	false	none	none
» managedReportToken	string	false	none	none
» scanType	integer(int32)	false	none	none
» recipientType	integer(int32)	false	none	none
» reportPassword	string	false	none	none
» reportLevel	integer(int32)	false	none	none
» customSubject	string	false	none	none
» customText	string	false	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a new report schedule (Deprecated: 2019-12-11)

POST /report-schedules

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ReportSchedule	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count (Deprecated: 2019-12-11)

HEAD /report-schedules

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Start scanning now (Deprecated: 2019-12-11)

POST /report-schedules/{reportScheduleId}/send

Parameters

Name	In	Type	Required	Description
reportScheduleId	path	integer(int64)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Reports

Get a report cache entry and generate a token for downloading the report, expires after 5 minutes (Deprecated: 2021-02-25)

GET /reports/{key}

Parameters

Name	In	Type	Required	Description
key	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a report (Deprecated: 2021-02-25)

DELETE /reports/{key}

Parameters

Name	In	Type	Required	Description
key	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of report cache entries (Deprecated: 2021-02-25)

GET /reports

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ReportCacheEntry]	false	none	none
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» key	string	false	read-only	none
» status	string	false	read-only	none
» size	integer(int64)	false	read-only	none
» token	string	false	read-only	none
» tokenExpires	string(date-time)	false	read-only	none
» name	string	false	read-only	The name of the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Generate a report

POST /reports

Body parameter

Parameters

Name	In	Type	Required	Description
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Report	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count (Deprecated: 2021-02-25)

HEAD /reports

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Resource groups

Get a resource group

GET /resource-groups/{resourceGroupId}

Parameters

Name	In	Type	Required	Description
resourceGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ResourceGroup

Delete a resource group

DELETE /resource-groups/{resourceGroupId}

Parameters

Name	In	Type	Required	Description
resourceGroupId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a resource group

PATCH /resource-groups/{resourceGroupId}

Body parameter

Parameters

Name	In	Type	Required	Description
resourceGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ResourceGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of resource groups

GET /resource-groups

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ResourceGroup]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» system	boolean	false	read-only	Set to true when resource group is system resource group
» resources	[Resource]	false	none	The resource group resources
»» type	string	false	none	The resource type
»» tagIds	[integer]	false	none	The resource tag ids

Enumerated Values

Property	Value
type	SCANCONFIGURATION
type	ACCOUNT
type	SCHEDULEDREPORT
type	MANAGEDREPORT
type	DASHBOARD
type	INTEGRATION
type	ASSETGROUP
type	ASSET
type	APPSTAK
type	VIEWTEMPLATE
type	EVENTSUBSCRIPTION
type	SCANPOLICY
type	FINDINGTEMPLATE

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a resource group

POST /resource-groups

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ResourceGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /resource-groups

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Rule engine

Run rule engine

POST /rule-engine

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
body	body	PatternMatch	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Finding]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» checkId	integer(int32)	false	none	The check id associated with the finding
» findingTemplateId	integer(int32)	false	none	The finding template from which the finding was created
» cvssScore	number(float)	false	read-only	The CVSS score, take CVSS V3 if available, otherwise CVSS V2
» cvssSeverity	string	false	read-only	The CVSS severity, take CVSS V3 severity if available, otherwise CVSS V2
» cvssV2Score	number(float)	false	read-only	The CVSS V2 score
» cvssV2BaseScore	number(float)	false	read-only	The CVSS V2 base score
» cvssV2TemporalScore	number(float)	false	read-only	The CVSS V2 temporal score
» cvssV2EnvironmentalScore	number(float)	false	read-only	The CVSS V2 environmental score
» cvssV2Vector	string	false	read-only	The CVSS V2 vector
» cvssV2Severity	string	false	read-only	The CVSS V2 severity
» cvssV3Score	number(float)	false	read-only	The CVSS V3 score
» cvssV3BaseScore	number(float)	false	read-only	The CVSS V3 base score
» cvssV3TemporalScore	number(float)	false	read-only	The CVSS V3 temporal score
» cvssV3EnvironmentalScore	number(float)	false	read-only	The CVSS V3 environmental score
» cvssV3Vector	string	false	read-only	The CVSS V3 vector
» cvssV3Severity	string	false	read-only	The CVSS V3 severity
» falsePositive	string(date-time)	false	read-only	The date when marked as false positive
» falsePositiveComment	string	false	read-only	The false positive comment
» isAccepted	boolean	false	read-only	Set to true when the risk is accepted
» accepted	string(date-time)	false	read-only	The date when the finding was marked as accepted risk.
» acceptedComment	string	false	read-only	The accepted comment
» acceptedUntil	string(date-time)	false	read-only	The date when the risk acceptance will expire.
» fixed	string(date-time)	false	read-only	The date when the risk was fixed
» commentsCount	integer(int32)	false	read-only	The number of comments
» customName	string	false	none	The custom name
» customDescription	string	false	none	The custom description
» customCve	string	false	none	The custom CVE
» customCwe	integer(int32)	false	none	The custom CWE
» customBugTraq	string	false	none	The custom bug track
» customSolution	string	false	none	The custom solution
» customRecreation	string	false	none	The custom recreation
» customImpact	string	false	none	The custom impact
» customOwaspMobile2024	integer(int32)	false	none	Custom OWASP Mobile 2024 score
» customOwaspApi2023	integer(int32)	false	none	Custom OWASP API 2023 score
» solutionPatches	[string]	false	none	The solution patches
» customCvssV2Vector	string	false	none	The custom CVSS V2 vector
» customCvssV2Severity	string	false	none	The custom CVSS V2 severity
» customCvssV3Vector	string	false	none	The custom CVSS V3 vector
» customCvssV3Severity	string	false	none	The custom CVSS V3 severity
» source	[string]	false	read-only	The scan sources
» activeSubscriptionTypes	[string]	false	read-only	The finding's active subscription types
» name	string	false	read-only	The name of the entry.
» description	string	false	read-only	Description of the entry.
» cve	string	false	read-only	The finding CVE
» cwe	string	false	read-only	CWE classification of the entry.
» solutionType	string	false	read-only	The solution type
» solution	string	false	read-only	The solution
» solutionProduct	string	false	read-only	The solution product
» solutionTitle	string	false	read-only	The solution title
» solutionUuid	string	false	read-only	The solution uuid
» exploitAvailable	boolean	false	read-only	Set to true when exploits are available
» matchIds	[integer]	false	none	The match ids
» attachmentIds	[integer]	false	read-only	The attachments ids
» firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
» lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
» firstScanId	integer(int32)	false	read-only	The id of the first scan
» lastScanId	integer(int32)	false	read-only	The id of the last scan
» lastScanConfigurationId	integer(int32)	false	read-only	The id of the last scan configuration
» status	string	false	read-only	The finding status
» commentPendingSince	string(date-time)	false	read-only	The date since comment is pending
» reviewed	string(date-time)	false	read-only	The finding reviewed date
» reviewedBy	string	false	read-only	The username of the user that reviewed the finding
» reviewedById	integer(int32)	false	read-only	The user ID of the user that reviewed the finding
» verified	string(date-time)	false	read-only	The finding verified date
» verifiedBy	string	false	read-only	The username of the user that verified the finding
» verifiedById	integer(int32)	false	read-only	The user ID of the user that verified the finding
» qualityAssured	string(date-time)	false	read-only	The finding quality assured date
» qualityAssuredBy	string	false	read-only	The username of the user that quality assured the finding
» qualityAssuredById	integer(int32)	false	read-only	The user ID of the user that quality assured the finding
» published	string(date-time)	false	read-only	The finding published date
» publishedBy	string	false	read-only	The username of the user that published the finding
» publishedById	integer(int32)	false	read-only	The user ID of the user that published the finding
» rejected	string(date-time)	false	read-only	The finding rejected date
» rejectedBy	string	false	read-only	The username of the user that rejected the finding
» rejectedById	integer(int32)	false	read-only	The user ID of the user that rejected the finding
» recreation	string	false	read-only	The recreation
» alternativeRecreation	string	false	none	The alternate recreation
» impact	string	false	none	The impact
» sans25	integer(int32)	false	read-only	SANS 25 classification of the entry.
» owasp2004	[integer]	false	read-only	An array of OWASP Top 10 2004 classifications of the entry.
» owasp2007	[integer]	false	read-only	An array of OWASP Top 10 2007 classifications of the entry.
» owasp2010	[integer]	false	read-only	An array of OWASP Top 10 2010 classifications of the entry.
» owasp2013	[integer]	false	read-only	An array of OWASP Top 10 2013 classifications of the entry.
» owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
» owasp2021	[integer]	false	read-only	The OWASP 2021 scores
» owaspMobile2024	integer(int32)	false	none	The OWASP Mobile 2024 score
» owaspApi2023	integer(int32)	false	none	The OWASP API 2023 score
» capec	[integer]	false	read-only	CAPEC classification of the entry.
» assetId	integer(int32)	true	none	The asset id
» assetName	string	false	read-only	The asset name
» potential	boolean	false	none	The finding potential. Set to true when potential false positive
» softwareComponent	string	false	read-only	The software component
» cyrating	number(double)	false	read-only	The cyrating
» cyratingDelta	number(double)	false	read-only	The cyrating delta
» exploitProbability	number(double)	false	read-only	The exploit probability
» exploitProbabilityDelta	number(double)	false	read-only	The exploit probability delta
» cyratingUpdated	string(date-time)	false	read-only	The cyrating updated date
» cyratingLastSeen	string(date-time)	false	read-only	The cyrating last seen date
» seenLastScan	boolean	false	read-only	Set to true if finding was seen in last scan
» watching	boolean	false	read-only	Whether the current user is watching this finding
» age	integer(int32)	false	read-only	The finding's age in days since creation
» assetGroupIds	[integer]	false	none	The asset group ids
» sentTo	[string]	false	read-only	A list of e-mail addresses that this finding has been sent to
» renderedName	string	false	read-only	Finding name derived from finding template
» renderedDescription	string	false	read-only	Finding description derived from finding template
» renderedCwe	integer(int32)	false	read-only	Finding CWE derived from finding template
» renderedSolution	string	false	read-only	Solution derived from finding template
» renderedRecreation	string	false	read-only	Finding recreation derived from finding template
» renderedImpact	string	false	read-only	Finding impact derived from finding template
» renderedOwaspMobile2024	integer(int32)	false	none	Finding OWASP Mobile 2024 score derived from finding template
» renderedOwaspApi2023	integer(int32)	false	none	Finding OWASP API 2023 score derived from finding template
» customerName	string	false	none	The customer name
» enabled	boolean	false	read-only	Determines if the entry is enabled or not.
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» bugTraq	[integer]	false	read-only	An array of Bugtraq reference IDs.
» secureCodeWarrior	SecureCodeWarrior	false	read-only	The secure code warrior information on the vulnerability description and training
»» name	string	false	none	The name of the entry.
»» description	string	false	none	Description of the entry.
»» url	string	false	none	none
» farsight	Farsight	false	read-only	The farsight concists in additional information on risk such as likelihood, threat activity
»» risk	Farsight.Risk	false	none	none
»»» score	number(float)	false	none	none
»»» delta	number(float)	false	none	none
»» updated	string(date-time)	false	none	The timestamp when the entry was updated.
»» lastThreatActivity	string(date-time)	false	none	none
» matches	[BaseMatch]	false	read-only	The match list
»» type	string	true	none	none
»» service	Service	false	none	none
»»» name	string	true	none	The name of the entry.
»»» scheme	string	false	none	none
»»» port	integer(int32)	false	none	none
»»» protocol	string	true	none	none
»»» virtualHost	string	false	none	none
»» patternUuid	string	false	none	none
» classifications	Classification.Classifications	false	read-only	The classifications such as CAPEC, OWASP20XX
»» sans25	integer(int32)	false	none	SANS 25 classification of the entry.
»» capec	[integer]	false	none	CAPEC classification of the entry.
»» owasp2004	[integer]	false	none	An array of OWASP Top 10 2004 classifications of the entry.
»» owasp2007	[integer]	false	none	An array of OWASP Top 10 2007 classifications of the entry.
»» owasp2010	[integer]	false	none	An array of OWASP Top 10 2010 classifications of the entry.
»» owasp2013	[integer]	false	none	An array of OWASP Top 10 2013 classifications of the entry.
»» owasp2017	[integer]	false	none	An array of OWASP Top 10 2017 classifications of the entry.
»» owasp2021	[integer]	false	none	none
» ports	[Port]	false	read-only	Ports information on the vulnerability description
»» name	string	false	none	The name of the entry.
»» port	integer(int32)	false	none	none
»» protocol	string	false	none	none

Enumerated Values

Property	Value
cvssSeverity	RECOMMENDATION
cvssSeverity	LOW
cvssSeverity	MEDIUM
cvssSeverity	HIGH
cvssSeverity	CRITICAL
cvssV2Severity	RECOMMENDATION
cvssV2Severity	LOW
cvssV2Severity	MEDIUM
cvssV2Severity	HIGH
cvssV2Severity	CRITICAL
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
customCvssV2Severity	RECOMMENDATION
customCvssV2Severity	LOW
customCvssV2Severity	MEDIUM
customCvssV2Severity	HIGH
customCvssV2Severity	CRITICAL
customCvssV3Severity	RECOMMENDATION
customCvssV3Severity	LOW
customCvssV3Severity	MEDIUM
customCvssV3Severity	HIGH
customCvssV3Severity	CRITICAL
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE
status	to review
status	to verify
status	to QA
status	to publish
status	rejected
status	present
status	accepted
status	false positive
status	pending verification
status	fixed
status	irreproducible
type	WAS
type	GATHEREDINFORMATION
type	COMPONENT
type	COMPLIANCE
type	PAC
protocol	TCP
protocol	UDP
protocol	TCP
protocol	UDP

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Scan configuration groups

Get scan configuration group

GET /scan-configuration-groups/{scanConfigurationGroupId}

Parameters

Name	In	Type	Required	Description
scanConfigurationGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScanConfigurationGroup

Delete scan configuration group

DELETE /scan-configuration-groups/{scanConfigurationGroupId}

Parameters

Name	In	Type	Required	Description
scanConfigurationGroupId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a scan configuration group

PATCH /scan-configuration-groups/{scanConfigurationGroupId}

Body parameter

Parameters

Name	In	Type	Required	Description
scanConfigurationGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanConfigurationGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of scan configuration groups

GET /scan-configuration-groups

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ScanConfigurationGroup]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» count	integer(int64)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a scan configuration group

POST /scan-configuration-groups

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanConfigurationGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /scan-configuration-groups

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Scan configurations

Create a link to an asset identifier

PUT /scan-configurations/{scanConfigurationId}/asset-identifiers/{assetIdentifierId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
assetIdentifierId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to an asset identifier

DELETE /scan-configurations/{scanConfigurationId}/asset-identifiers/{assetIdentifierId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
assetIdentifierId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to an asset

PUT /scan-configurations/{scanConfigurationId}/assets/{assetId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
assetId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to an asset

DELETE /scan-configurations/{scanConfigurationId}/assets/{assetId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
assetId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a scan configuration

GET /scan-configurations/{scanConfigurationId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScanConfiguration

Delete a scan configuration

DELETE /scan-configurations/{scanConfigurationId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a scan configuration

PATCH /scan-configurations/{scanConfigurationId}

Body parameter

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanConfiguration	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a schedule

PUT /scan-configurations/{scanConfigurationId}/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a schedule

DELETE /scan-configurations/{scanConfigurationId}/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /scan-configurations/{scanConfigurationId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /scan-configurations/{scanConfigurationId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a tag link to one or several scan configurations

PUT /scan-configurations/tags/{tagId}

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a tag link to one or several scan configurations

DELETE /scan-configurations/tags/{tagId}

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of scan configurations

GET /scan-configurations

Scan configurations define settings that should apply to the scan.

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ScanConfiguration]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» template	string	false	read-only	The scan template
» groupId	integer(int32)	false	none	The scan group id
» scheduleIds	[integer]	false	read-only	The schedule ids associated with this scan configuration
» assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
» assetIds	[integer]	false	none	The asset IDs associated with this scan configuration
» workflowId	integer(int32)	false	none	The workflow ID associated with this scan configuration
» enabled	boolean	false	none	Determines if the entry is enabled or not.
» scannerId	integer(int32)	false	none	The scanner id
» nextOccurrence	string(date-time)	false	read-only	The scan next occurrence date
» lastScan	string(date-time)	false	read-only	Last time a scan was performed using this configuration
» configuration	BaseScanConfigurationTemplate	true	none	The scan configuration
»» template	string	true	none	none
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
template	SCOUT
template	SCALE
template	SWAT
template	CLOUDSEC
template	NETWORK_SCAN
template	DOCKER_SCAN
template	DOCKER_DISCOVERY
template	NETWORK_DISCOVERY
template	CLOUD_DISCOVERY
template	AGENT_SCAN
template	WORKFLOW
template	SCOUT
template	SCALE
template	SWAT
template	CLOUDSEC
template	NETWORK_SCAN
template	DOCKER_SCAN
template	DOCKER_DISCOVERY
template	NETWORK_DISCOVERY
template	CLOUD_DISCOVERY
template	AGENT_SCAN
template	WORKFLOW

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a scan configuration

POST /scan-configurations

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanConfiguration	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete one or several scan configurations

DELETE /scan-configurations

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /scan-configurations

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Partially update one or several scan configurations

PATCH /scan-configurations

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	ScanConfiguration	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags

PUT /scan-configurations/{scanConfigurationId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags to several scan configurations

PUT /scan-configurations/tags

Body parameter

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Start a scan based on this configuration

POST /scan-configurations/{scanConfigurationId}/scan

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Test a setup LUA script

POST /scan-configurations/test-setup-script

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	TestSetupScript	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Test an application setup LUA script

POST /scan-configurations/{scanConfigurationId}/test-setup-script

Body parameter

Parameters

Name	In	Type	Required	Description
scanConfigurationId	path	integer(int32)	true	none
body	body	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Scan policies

Get a scan policy

GET /scan-policies/{scanPolicyId}

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScanPolicy

Delete a scan policy

DELETE /scan-policies/{scanPolicyId}

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update an scan policy

PATCH /scan-policies/{scanPolicyId}

Body parameter

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanPolicy	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to an account

PUT /scan-policies/{scanPolicyId}/accounts/{accountId}

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
accountId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to an account

DELETE /scan-policies/{scanPolicyId}/accounts/{accountId}

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
accountId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /scan-policies/{scanPolicyId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /scan-policies/{scanPolicyId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get default scan policy settings

GET /scan-policies/default-settings

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScanPolicySettings

Get a list of scan policies

GET /scan-policies

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ScanPolicy]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» system	boolean	false	read-only	none
» accountIds	[integer]	false	none	none
» settings	ScanPolicySettings	false	none	none
»» safeOnly	boolean	false	none	none
»» tryDefaultCredentials	boolean	false	none	none
»» ignoreFallbackKernels	boolean	false	none	none
»» useDiscoveredCredentials	boolean	false	none	none
»» virtualHostsIp	boolean	false	none	none
»» virtualHostsHostName	boolean	false	none	none
»» virtualHostsReverseDns	boolean	false	none	none
»» speed	string	false	none	none
»» portsTcp	string	false	none	none
»» portsUdp	string	false	none	none
»» netstatCheck	string	false	none	none
»» regularPortScanFallback	boolean	false	none	none
»» authenticatedScanSshPort	integer(int32)	false	none	none
»» trustedCasPem	string	false	none	none
»» useCustomCredentials	boolean	false	none	none
»» enableRemoteRegistry	boolean	false	none	none
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a scan policy

POST /scan-policies

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanPolicy	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /scan-policies

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /scan-policies/{scanPolicyId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of account IDs

PUT /scan-policies/{scanPolicyId}/accounts

Body parameter

Parameters

Name	In	Type	Required	Description
scanPolicyId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Scanners

Get a scanner

GET /scanners/{scannerId}

Parameters

Name	In	Type	Required	Description
scannerId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Scanner

Get a list of scanners

GET /scanners

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Scanner]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» userId	integer(int64)	false	read-only	none
» name	string	true	none	The name of the entry.
» ipaddress	string	true	none	none
» mode	integer(int32)	false	none	none
» approved	boolean	false	none	none
» inactive	boolean	false	none	none
» useProxy	boolean	false	none	none
» polling	boolean	false	read-only	none
» serverStatus	string	false	read-only	none
» lastConnection	string(date-time)	false	read-only	none
» lastUpdate	string(date-time)	false	read-only	none
» version	string	false	read-only	none
» uiVersion	string	false	read-only	none
» scannerVersion	string	false	read-only	none
» appsecScaleScanner	boolean	false	read-only	none
» groupId	integer(int64)	false	none	none
» groupName	string	false	none	none
» isOutpost	boolean	false	read-only	none
» isAwsScanner	boolean	false	read-only	none
» scanningDisabled	boolean	false	read-only	none
» isGroup	boolean	false	none	none
» performUpdate	boolean	false	read-only	none
» hwAddr	string	false	read-only	none
» hmacKey	string	false	read-only	none
» rulesVersion	string(date-time)	false	read-only	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /scanners

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Scans

Get the crawled URLs for a scan

GET /scans/{scanId}/crawled-urls

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the discovery results for a scan

GET /scans/{scanId}/discovery

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get the issues for a scan

GET /scans/{scanId}/issues

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get the log for a scan

GET /scans/{scanId}/log

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a scan

GET /scans/{scanId}

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScanLog

Get a list of scans

GET /scans

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ScanLog]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» jobId	string	false	none	The id of the scan job
» status	string	true	none	The scan status
» statusDetails	string	false	none	The scan status details
» source	string	true	none	The scan source
» scanConfigurationId	integer(int32)	false	none	The id of the scan configuration
» scanConfigurationName	string	false	read-only	The name of the scan configuration
» workflowId	integer(int32)	false	none	The id of the workflow
» workflowName	string	false	read-only	The name of the workflow
» started	string(date-time)	false	none	The scan started date
» ended	string(date-time)	false	none	The scan ended date
» expectedStart	string(date-time)	false	read-only	The scan expected start date
» expectedEnd	string(date-time)	false	read-only	The scan expected end date
» blueprintAvailable	boolean	false	read-only	Set to true when scan blueprint is available
» assetIdentifierId	integer(int32)	false	none	The ID of the asset identifier associated with this entry
» assetIdentifierType	string	false	read-only	The type of asset on which the scan is performed
» assetIdentifierName	string	false	read-only	The name of asset on which the scan is performed
» assetId	integer(int32)	false	none	The id of asset on which the scan is performed
» assetName	string	false	read-only	The name of asset on which the scan is performed
» latestRuleDate	string(date-time)	false	none	The latest rule date taken into account to perform the scan
» scanless	boolean	false	none	Set to true when scan is scanless (eg only detection performed)
» parentId	integer(int32)	false	none	The ID of the parent entry.
» scheduleId	integer(int32)	false	none	The schedule id when scan triggered by a schedule.
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
status	QUEUED
status	PENDING
status	STARTING
status	RUNNING
status	STOPPING
status	STOPPED
status	REPORTING
status	FINISHED
status	ISSUES
status	FAILED
source	SCOUT
source	SCALE
source	SWAT
source	CLOUDSEC
source	NETWORK_SCAN
source	DOCKER_SCAN
source	DOCKER_DISCOVERY
source	NETWORK_DISCOVERY
source	CLOUD_DISCOVERY
source	AGENT_SCAN
source	WORKFLOW
assetIdentifierType	IP
assetIdentifierType	HOSTNAME
assetIdentifierType	AWS_ACCOUNT_ID
assetIdentifierType	AWS_INSTANCE_ID
assetIdentifierType	AWS_REGION
assetIdentifierType	MAC
assetIdentifierType	NETBIOS
assetIdentifierType	GCP_PROJECT_ID
assetIdentifierType	MAZ_TENANT_ID
assetIdentifierType	MAZ_SUBSCRIPTION
assetIdentifierType	MAZ_RESOURCE_GROUP
assetIdentifierType	MAZ_RESOURCE
assetIdentifierType	DOCKER_REGISTRY
assetIdentifierType	DOCKER_IMAGE
assetIdentifierType	SEED_PATH
assetIdentifierType	AGENT
assetIdentifierType	SERIAL_MACHINE_ID
assetIdentifierType	SERIAL_PRODUCT_ID
assetIdentifierType	SERIAL_DISK_ID

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a scan

POST /scans

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScanLog	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /scans

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get metadata for a scan

GET /scans/{scanId}/metadata

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScanLogMetadata

Request a blueprint

POST /scans/{scanId}/blueprints

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Stop a scan

POST /scans/{scanId}/stop

Parameters

Name	In	Type	Required	Description
scanId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Scheduled reports

Get a scheduled report

GET /scheduled-reports/{scheduledReportId}

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ScheduledReport

Delete a scheduled report

DELETE /scheduled-reports/{scheduledReportId}

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a scheduled report

PATCH /scheduled-reports/{scheduledReportId}

Body parameter

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScheduledReport	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a schedule

PUT /scheduled-reports/{scheduledReportId}/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a schedule

DELETE /scheduled-reports/{scheduledReportId}/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /scheduled-reports/{scheduledReportId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /scheduled-reports/{scheduledReportId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of scheduled reports

GET /scheduled-reports

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ScheduledReport]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» enabled	boolean	false	none	Determines if the entry is enabled or not.
» lastSent	string(date-time)	false	read-only	none
» scheduleIds	[integer]	false	read-only	none
» nextOccurrence	string(date-time)	false	read-only	none
» workflowId	integer(int32)	false	none	The workflow ID associated with this report
» deliveryMethod	DeliveryMethod	true	none	none
»» email	DeliveryMethod.Email	false	none	none
»»» userIds	[integer]	false	none	none
»»» recipients	DeliveryMethod.Recipients	false	none	none
»»»» addresses	[string]	false	none	none
»»»» pgpKey	string	false	none	none
»» managedReport	DeliveryMethod.ManagedReport	false	none	none
»»» name	string	false	none	The name of the entry.
»»» tags	string	false	none	none
» scope	ScheduledReport.Scope	true	none	none
»» assetIds	[integer]	false	none	none
»» assetGroupIds	[integer]	false	none	none
»» tagIds	[integer]	false	none	none
» report	ScheduledReport.Report	true	none	none
»» formats	[string]	true	none	none
»» type	string	true	none	none
»» viewTemplateId	integer(int32)	false	none	none
»» viewTemplateName	string	false	none	none
»» level	string	false	none	none
»» product	string	false	none	none
»» password	string	false	none	none
»» executiveSummary	boolean	false	none	none
»» zip	boolean	false	none	none
»» timeFrame	string	false	none	none
»» startDate	string(date-time)	false	none	none
»» endDate	string(date-time)	false	none	none
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
type	Technical
type	Trend
type	GroupVulnerability
type	Delta
type	Pci
type	WasDiscovery
type	Discovery
type	SolutionTaskReport
type	SolutionTargetReport
type	GroupTrending
type	GroupDelta
type	Compliance
type	Consumption
level	Detailed
level	Management
level	Summary
product	Normal
product	Pci
product	Was
product	SWAT
product	Compliance
product	Appsec Scale
product	APPSEC
product	CLOUDSEC
timeFrame	LAST_DAY
timeFrame	LAST_WEEK
timeFrame	LAST_MONTH
timeFrame	LAST_QUARTER
timeFrame	LAST_YEAR
timeFrame	CUSTOM
timeFrame	ALL_TIME

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a scheduled report

POST /scheduled-reports

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ScheduledReport	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /scheduled-reports

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /scheduled-reports/{scheduledReportId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Send report

POST /scheduled-reports/{scheduledReportId}/send

Parameters

Name	In	Type	Required	Description
scheduledReportId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Schedules

Get a schedule

GET /schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Schedule

Delete a schedule

DELETE /schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a schedule

PATCH /schedules/{scheduleId}

Body parameter

Parameters

Name	In	Type	Required	Description
scheduleId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Schedule	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of schedules

GET /schedules

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Schedule]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» enabled	boolean	false	none	Determines if the entry is enabled or not.
» frequency	string	true	none	The schedule frequency
» interval	integer(int32)	true	none	The schedule interval
» weekdays	[string]	false	none	The schedule weekdays set what weekdays have been selected for recurrence
» days	[integer]	false	none	The schedule days set what days have been selected for recurrence
» nthDays	[integer]	false	none	The schedule nthDays set what ordinal days have been selected for recurrence
» weeks	[integer]	false	none	The schedule weeks set what weeks have been selected for recurrence
» months	[string]	false	none	The schedule months set what months have been selected for recurrence
» remainingOccurrences	integer(int32)	false	none	The schedule remaining occurrences
» scanConfigurationIds	[integer]	false	read-only	The scan configuration IDs associated with this schedule
» workflowIds	[integer]	false	read-only	The workflow IDs associated with this schedule
» scheduledReportIds	[integer]	false	read-only	The report IDs associated with this schedule
» timezone	string	false	none	The schedule time zone
» scanWindowDuration	integer(int32)	false	none	The schedule scan window duration.
» startsFrom	string(date-time)	true	none	The schedule starts from date
» until	string(date-time)	false	none	The schedule until date
» nextOccurrence	string(date-time)	false	read-only	The schedule next occurrence date
» blockedTimeSlots	Schedule.BlockedTimeSlots	false	none	The schedule blocked time slots
»» monday	[integer]	false	none	none
»» tuesday	[integer]	false	none	none
»» wednesday	[integer]	false	none	none
»» thursday	[integer]	false	none	none
»» friday	[integer]	false	none	none
»» saturday	[integer]	false	none	none
»» sunday	[integer]	false	none	none

Enumerated Values

Property	Value
frequency	NONE
frequency	ONCE
frequency	HOURLY
frequency	DAILY
frequency	WEEKLY
frequency	MONTHLY
frequency	YEARLY

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a schedule

POST /schedules

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Schedule	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /schedules

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Scoping

Submit scoping information.

POST /scoping

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	ScopingInformation	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Sub users

Change current sub-users password; if current user isn't a sub-user, redirect to /users/me/change-password

POST /sub-users/me/change-password

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ChangePasswordRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a sub-user

GET /sub-users/{subUserId}

Parameters

Name	In	Type	Required	Description
subUserId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	SubUser

Delete a sub-user

DELETE /sub-users/{subUserId}

Parameters

Name	In	Type	Required	Description
subUserId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a sub-user

PATCH /sub-users/{subUserId}

Body parameter

Parameters

Name	In	Type	Required	Description
subUserId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	SubUser	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /sub-users/{subUserId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
subUserId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /sub-users/{subUserId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
subUserId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get current sub-user; if current user isn't a sub-user, redirect to /users/me

GET /sub-users/me

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update current sub-user; if current user isn't a sub-user, redirect to /users/me

PATCH /sub-users/me

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	SubUser	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of sub-users

GET /sub-users

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[SubUser]	false	none	none
» timezone	string	false	none	The user time zone
» portalPreferences	string	false	none	The user portal preferences
» customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
» id	integer(int64)	false	read-only	The ID of the entry.
» subUser	boolean	false	read-only	none
» username	string	true	none	none
» firstName	string	true	none	none
» lastName	string	true	none	none
» email	string	true	none	none
» emailEncryptionKey	string	false	none	none
» countryCode	string	false	none	none
» stateCode	string	false	none	none
» parentId	integer(int64)	false	read-only	The ID of the parent entry.
» mobilePhone	string	false	none	none
» lastLogonIp	string	false	read-only	none
» lastLogonDate	string(date-time)	false	read-only	none
» logons	integer(int64)	false	read-only	none
» language	string	false	none	none
» twoFactorCode	string	false	none	none
» subParentId	integer(int64)	false	none	none
» superUser	boolean	false	none	none
» snapshotSubscriptions	integer(int64)	false	read-only	none
» snapshotSubscriptionsRemaining	integer(int64)	false	read-only	none
» swatSubscriptions	integer(int64)	false	read-only	none
» swatSubscriptionsRemaining	integer(int64)	false	read-only	none
» userRoleIds	[integer]	false	none	none
» resourceGroupIds	[integer]	false	none	none
» userRolePermissions	[string]	false	read-only	none
» allowedCustomerTagIds	[integer]	false	none	none
» roles	string	false	read-only	The user's roles
» pgpPublicKey	string	false	none	This user's PGP public key
» twoFactorType	string	false	none	The sub-user's two-factor authentication type
» tags	[Tag]	false	read-only	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» allowedCustomerTags	[Tag]	false	read-only	The allowed customer tags
» twoFactorSecret	string	false	none	The sub-user's two-factor secret

Enumerated Values

Property	Value
twoFactorType	ANY
twoFactorType	NONE
twoFactorType	SMS
twoFactorType	TOTP

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a new sub-user

POST /sub-users

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	SubUser	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /sub-users

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /sub-users/{subUserId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
subUserId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Subscription audits

Get a subscription audit

GET /subscription-audits/{auditId}

Parameters

Name	In	Type	Required	Description
auditId	path	integer(int64)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	SubscriptionAudit

Get a list of subscription audits

GET /subscription-audits

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[SubscriptionAudit]	false	none	none
» id	integer(int64)	false	read-only	The ID of the entry.
» action	string	false	read-only	none
» time	string(date-time)	false	read-only	none
» ip	string	false	read-only	none
» comment	string	false	read-only	none
» username	string	false	read-only	none
» customerName	string	false	read-only	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /subscription-audits

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Subscriptions

Get a subscription

GET /subscriptions/{subscriptionUuid}

Parameters

Name	In	Type	Required	Description
subscriptionUuid	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Subscription

Delete a subscription

DELETE /subscriptions/{subscriptionUuid}

Parameters

Name	In	Type	Required	Description
subscriptionUuid	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a subscription

PATCH /subscriptions/{subscriptionUuid}

Body parameter

Parameters

Name	In	Type	Required	Description
subscriptionUuid	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Subscription	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a subscription template

GET /subscriptions/templates/{subscriptionTemplateUuid}

Parameters

Name	In	Type	Required	Description
subscriptionTemplateUuid	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	SubscriptionTemplate

Delete a subscription template

DELETE /subscriptions/templates/{subscriptionTemplateUuid}

Parameters

Name	In	Type	Required	Description
subscriptionTemplateUuid	path	string	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a subscription template

PATCH /subscriptions/templates/{subscriptionTemplateUuid}

Body parameter

Parameters

Name	In	Type	Required	Description
subscriptionTemplateUuid	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	SubscriptionTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get asset groups associated with the subscription

GET /subscriptions/{subscriptionId}/asset-groups

Parameters

Name	In	Type	Required	Description
subscriptionId	path	string	true	none
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[AssetGroup]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» type	string	false	none	The assetgroup's type
» parentId	integer(int32)	false	none	The ID of the parent entry.
» assetIds	[integer]	false	read-only	The component assets
» assetGroupIds	[integer]	false	read-only	The children asset groups
» summaryId	integer(int32)	false	read-only	The ID of the executive summary
» summary	string	false	read-only	The content of the executive summary
» summaryPublishedAt	string(date-time)	false	read-only	When the executive summary was published
» path	[integer]	false	read-only	The path of the asset group tree
» activeSubscriptionTypes	[string]	false	read-only	The assetgroup's active subscription types
» managed	boolean	false	read-only	Managed internally by (e.g SWAT API or GhostLab)
» dynamic	boolean	false	none	Indicates whether the asset group is automatically populated with assets based on the assigned tags
» labels	string	false	none	The labels of the asset group
» contactName	string	false	none	The customer's contact name with regards to this asset group
» contactDetails	string	false	none	The customer's contact details
» additionalDetails	string	false	none	Additional information about the asset group that may require attention
» commentPendingSince	string(date-time)	false	read-only	The date since comment is pending
» customerName	string	false	none	The customer name
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» includedDynamicTags	[Tag]	false	read-only	The included dynamic asset tags
» excludedDynamicTags	[Tag]	false	read-only	The excluded dynamic asset tags

Enumerated Values

Property	Value
type	WEB_APP
type	INSTANCE
type	API
type	INTERNAL
type	EXTERNAL
type	MOBILE
type	PHYSICAL
type	WIRELESS
type	PHISHING
type	RED
type	ASSUMED
type	DIGITAL
type	HARDWARE
type	PROJECT

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of subscriptions

GET /subscriptions

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Subscription]	false	none	none
» uuid	string	false	none	The UUID of the entry.
» type	string	false	none	none
» associations	Subscription.Associations	false	none	none
»» assetGroups	[string]	false	none	none
» durationInDays	integer(int32)	false	none	none
» activeUntil	string(date-time)	false	none	none
» activatedAt	string(date-time)	false	none	none
» redeemableUntil	string(date-time)	false	none	none
» created	string(date-time)	false	none	The timestamp when the entry was created.
» createdBy	string	false	none	The name of the user who created the entry.
» updated	string(date-time)	false	none	The timestamp when the entry was updated.
» updatedBy	string	false	none	The name of the user who updated the entry.
» template	Subscription.Template	false	none	none
»» uuid	string	true	none	The UUID of the entry.
»» variables	string	false	none	none
»» template	string	false	none	none
»» name	string	false	none	The name of the entry.
» customer	Subscription.Customer	false	none	none
»» uuid	string	true	none	The UUID of the entry.
» limits	Subscription.Limits	false	none	none
»» netsecAssets	integer(int32)	false	none	The netsec assets
»» netsecScans	integer(int32)	false	none	The netsec scans
»» netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
»» netsecInternalScans	integer(int32)	false	none	The netsec internal scans
»» netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
»» netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
»» netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
»» netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
»» complianceAssets	integer(int32)	false	none	The compliance assets
»» complianceScans	integer(int32)	false	none	The compliance scans
»» complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
»» complianceInternalScans	integer(int32)	false	none	The compliance internal scans
»» complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
»» complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
»» complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
»» complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
»» pciAssets	integer(int32)	false	none	The pci assets
»» pciScans	integer(int32)	false	none	The pci scans
»» scaleAssets	integer(int32)	false	none	The scale assets
»» scaleScans	integer(int32)	false	none	The scale scans
»» scaleInternalAssets	integer(int32)	false	none	The scale internal assets
»» scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
»» scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
»» scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
»» scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
»» cloudsecAssets	integer(int32)	false	none	The cloudsec assets
»» cloudsecScans	integer(int32)	false	none	The cloudsec scans
»» networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
»» networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
»» cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
»» cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
»» networkAssets	integer(int32)	false	none	The network assets
»» networkScans	integer(int32)	false	none	The network scans
»» networkApplianceAssets	integer(int32)	false	none	The network appliance assets
»» networkApplianceScans	integer(int32)	false	none	The network appliance scans
»» dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
»» dockerImageAssets	integer(int32)	false	none	The docker image assets
»» dockerImageScans	integer(int32)	false	none	The docker image scans
»» dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
»» dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
»» dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
»» outscanNXAssets	integer(int32)	false	none	The outscan NX assets
»» outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets
» isActive	boolean	false	none	none

Enumerated Values

Property	Value
type	DAST
type	SCALE
type	SCOUT
type	SNAPSHOT
type	ASSURE
type	DAST_EXPERT
type	VERIFY
type	SWAT
type	CLOUDSEC
type	NETSEC
type	CONSUMPTION

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a subscription

POST /subscriptions

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Subscription	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /subscriptions/templates

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of subscription templates

GET /subscriptions/templates

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[SubscriptionTemplate]	false	none	none
» uuid	string	false	none	The UUID of the entry.
» name	string	true	none	The name of the entry.
» organization	SubscriptionTemplate.Organization	true	none	none
»» uuid	string	true	none	The UUID of the entry.
» variables	string	false	none	none
» template	string	true	none	none
» created	string(date-time)	false	none	The timestamp when the entry was created.
» createdBy	string	false	none	The name of the user who created the entry.
» updated	string(date-time)	false	none	The timestamp when the entry was updated.
» updatedBy	string	false	none	The name of the user who updated the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a subscription template

POST /subscriptions/templates

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	SubscriptionTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get variables for subscription templates

GET /subscriptions/template-variables

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[SubscriptionTemplateVariable]	false	none	none
» key	string	false	none	The subscription template variable name
» description	string	false	none	Description of the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Preview a subscription template

POST /subscriptions/templates/preview

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	SubscriptionTemplatePreviewRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Generate a report

POST /subscriptions/reports

Body parameter

Parameters

Name	In	Type	Required	Description
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	SubscriptionReport	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Summaries

Get a summary

GET /summaries/{summaryId}

Parameters

Name	In	Type	Required	Description
summaryId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Summary

Delete a summary

DELETE /summaries/{summaryId}

Parameters

Name	In	Type	Required	Description
summaryId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a summary

PATCH /summaries/{summaryId}

Body parameter

Parameters

Name	In	Type	Required	Description
summaryId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Summary	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of summaries

GET /summaries

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Summary]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» content	string	false	none	none
» assetGroupId	integer(int32)	true	none	none
» swatScheduleId	integer(int64)	false	none	none
» reviewed	string(date-time)	false	none	none
» reviewedBy	string	false	none	none
» reviewedById	integer(int32)	false	none	none
» qualityAssured	string(date-time)	false	none	none
» qualityAssuredBy	string	false	none	none
» qualityAssuredById	integer(int32)	false	none	none
» published	string(date-time)	false	none	none
» publishedBy	string	false	none	none
» publishedById	integer(int32)	false	none	none
» rejected	string(date-time)	false	none	none
» rejectedBy	string	false	none	none
» rejectedById	integer(int32)	false	none	none
» status	string	false	none	none

Enumerated Values

Property	Value
status	PENDING_REVIEW
status	PENDING_QA
status	PENDING_PUBLICATION
status	PUBLISHED
status	REJECTED

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a summary

POST /summaries

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Summary	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /summaries

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Transition a summary status

POST /summaries/{summaryId}/transition

Body parameter

Parameters

Name	In	Type	Required	Description
summaryId	path	integer(int32)	true	none
body	body	SummaryTransitionRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Tags

Get a tag by ID

GET /tags/{tagId}

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Tag

Delete a tag

DELETE /tags/{tagId}

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a tag

PATCH /tags/{tagId}

Body parameter

Parameters

Name	In	Type	Required	Description
tagId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Tag	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of tags

GET /tags

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Tag]	false	none	[The tags]
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» key	string	true	none	none
» value	string	false	none	none
» inherited	boolean	false	read-only	none
» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a tag

POST /tags

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Tag	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /tags/statistics

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get tag statistics by ID

GET /tags/statistics/{statisticId}

Parameters

Name	In	Type	Required	Description
statisticId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	TagStatistic

Get a list of tag statistics

GET /tags/statistics

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[TagStatistic]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» key	string	false	read-only	none
» value	string	false	read-only	none
» statistics	TagStatistic.Statistics	false	read-only	none
»» accounts	integer(int32)	false	none	none
»» assetGroups	integer(int32)	false	none	none
»» assets	integer(int32)	false	none	none
»» assetIdentifiers	integer(int32)	false	none	none
»» eventSubscriptions	integer(int32)	false	none	none
»» managedReports	integer(int32)	false	none	none
»» scheduledReports	integer(int32)	false	none	none
»» complianceFindings	integer(int32)	false	none	none
»» findings	integer(int32)	false	none	none
»» scanConfigurations	integer(int32)	false	none	none
»» workflows	integer(int32)	false	none	none
»» dashboards	integer(int32)	false	none	none
»» integrations	integer(int32)	false	none	none
»» scanPolicies	integer(int32)	false	none	none
»» viewTemplates	integer(int32)	false	none	none
»» users	integer(int32)	false	none	none
»» scanConfigurationSettings	integer(int32)	false	none	none
»» scheduledReportSettings	integer(int32)	false	none	none
»» resourceGroupSettings	integer(int32)	false	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Transform tags

POST /tags/transform

Body parameter

Parameters

Name	In	Type	Required	Description
body	body	TagsTransformation	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Terms

Accept terms

POST /terms/{termsId}/accept

Parameters

Name	In	Type	Required	Description
termsId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get terms

GET /terms/{termsId}

Parameters

Name	In	Type	Required	Description
termsId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Terms

Delete terms

DELETE /terms/{termsId}

Parameters

Name	In	Type	Required	Description
termsId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of terms acceptances

GET /terms/acceptances

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[TermsAcceptance]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» termsId	integer(int32)	true	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get a list of terms

GET /terms

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Terms]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» mainUserMustAccept	boolean	true	none	none
» allUsersMustAccept	boolean	true	none	none
» termsTemplateId	integer(int32)	true	none	none
» termsTemplateName	string	false	read-only	none
» termsTemplateContent	string	false	read-only	none
» customerName	string	false	read-only	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create terms

POST /terms

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Terms	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /terms

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Terms templates

Get a terms template

GET /terms-templates/{termsTemplateId}

Parameters

Name	In	Type	Required	Description
termsTemplateId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	TermsTemplate

Delete a terms template

DELETE /terms-templates/{termsTemplateId}

Parameters

Name	In	Type	Required	Description
termsTemplateId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of terms templates

GET /terms-templates

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[TermsTemplate]	false	none	none
» name	string	true	none	The name of the entry.
» content	string	true	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a terms template

POST /terms-templates

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	TermsTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /terms-templates

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Usage stats

Get cyr3con stats

GET /usage-stats/cyr3con

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get usage stats by ID

GET /usage-stats/{usageStatsId}

Parameters

Name	In	Type	Required	Description
usageStatsId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	UsageStats

Get a list of usage stats

GET /usage-stats

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[UsageStats]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» customerName	string	false	read-only	none
» organization	string	false	read-only	none
» salesAccountId	string	false	read-only	none
» statsUpdated	string(date-time)	false	none	none
» applianceStatsUpdated	string(date-time)	false	none	none
» scaleConfigurations	integer(int32)	false	none	none
» scoutConfigurations	integer(int32)	false	none	none
» cloudsecConfigurations	integer(int32)	false	none	none
» applianceScaleConfigurations	integer(int32)	false	none	none
» users	integer(int32)	false	none	none
» lastLogin	string(date-time)	false	none	none
» applianceUsers	integer(int32)	false	none	none
» applianceLastLogin	string(date-time)	false	none	none
» findingsCritical	integer(int32)	false	none	none
» findingsHigh	integer(int32)	false	none	none
» findingsMedium	integer(int32)	false	none	none
» findingsLow	integer(int32)	false	none	none
» findingsRecommendations	integer(int32)	false	none	none
» applianceFindingsCritical	integer(int32)	false	none	none
» applianceFindingsHigh	integer(int32)	false	none	none
» applianceFindingsMedium	integer(int32)	false	none	none
» applianceFindingsLow	integer(int32)	false	none	none
» applianceFindingsRecommendations	integer(int32)	false	none	none
» scans	integer(int32)	false	none	none
» lastScan	string(date-time)	false	none	none
» applianceScans	integer(int32)	false	none	none
» applianceLastScan	string(date-time)	false	none	none
» accountsAws	integer(int32)	false	none	none
» accountsGcp	integer(int32)	false	none	none
» accountsAzure	integer(int32)	false	none	none
» accountsVsphere	integer(int32)	false	none	none
» accountsBasic	integer(int32)	false	none	none
» accountsWeb	integer(int32)	false	none	none
» applianceAccountsAws	integer(int32)	false	none	none
» applianceAccountsGcp	integer(int32)	false	none	none
» applianceAccountsAzure	integer(int32)	false	none	none
» applianceAccountsVsphere	integer(int32)	false	none	none
» applianceAccountsBasic	integer(int32)	false	none	none
» applianceAccountsWeb	integer(int32)	false	none	none
» cyr3conAssets	integer(int32)	false	none	none
» cyr3conApplianceAssets	integer(int32)	false	none	none
» agents	integer(int32)	false	none	none
» agentsScanned	integer(int32)	false	none	none
» agentsOutdated	integer(int32)	false	none	none
» applianceAgents	integer(int32)	false	none	none
» applianceAgentsScanned	integer(int32)	false	none	none
» applianceAgentsOutdated	integer(int32)	false	none	none

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /usage-stats

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

User role permissions

Get a user role permission

GET /user-role-permissions/{userRolePermissionId}

Parameters

Name	In	Type	Required	Description
userRolePermissionId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	UserRolePermission

Get a list of user role permissions

GET /user-role-permissions

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[UserRolePermission]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» name	string	false	read-only	The name of the entry.

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /user-role-permissions

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

User roles

Get a user role

GET /user-roles/{userRoleId}

Parameters

Name	In	Type	Required	Description
userRoleId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	UserRole

Delete a user role

DELETE /user-roles/{userRoleId}

Parameters

Name	In	Type	Required	Description
userRoleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a user role

PATCH /user-roles/{userRoleId}

Body parameter

Parameters

Name	In	Type	Required	Description
userRoleId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	UserRole	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of user roles

GET /user-roles

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[UserRole]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» system	boolean	false	read-only	Set to true when system role
» permissionIds	[integer]	false	none	The user role permission ids

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a user role

POST /user-roles

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	UserRole	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /user-roles

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Users

Change current users password; if current user is a sub-user, redirect to /sub-users/me/change-password

POST /users/me/change-password

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ChangePasswordRequest	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /users/{userId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
userId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /users/{userId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
userId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get current user; if current user is a sub-user, redirect to /sub-users/me

GET /users/me

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update current user; if current user is a sub-user, redirect to /sub-users/me

PATCH /users/me

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	User	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a user

GET /users/{userId}

Parameters

Name	In	Type	Required	Description
userId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	User

Partially update a user

PATCH /users/{userId}

Body parameter

Parameters

Name	In	Type	Required	Description
userId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	User	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of users

GET /users

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[User]	false	none	none
» timezone	string	false	none	The user time zone
» portalPreferences	string	false	none	The user portal preferences
» customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
» id	integer(int64)	false	read-only	The ID of the entry.
» company	string	false	read-only	The user company name
» firstName	string	true	none	The user first name
» lastName	string	true	none	The user last name
» email	string	true	none	The user email address
» username	string	true	none	The user name
» emailEncryptionKey	string	false	none	The user public key for email encryption
» sshPublicKey	string	false	none	The user ssh public key
» mobilePhone	string	false	none	The user mobile phone number
» countryCode	string	false	none	The user country code
» stateCode	string	false	none	The user state code
» lastLogonIp	string	false	read-only	The user last logon ip address
» lastLogonDate	string(date-time)	false	read-only	The user last logon date
» logons	integer(int64)	false	read-only	The user logon numbers
» language	string	false	none	The user language
» remoteSupport	boolean	false	read-only	The user remote support status
» twoFactorCode	string	false	none	none
» roles	string	false	read-only	The user's roles
» snapshotSubscriptions	integer(int64)	false	none	The snapshot subscriptions
» snapshotSubscriptionsRemaining	integer(int64)	false	none	The remaining snapshot subscriptions
» swatSubscriptions	integer(int64)	false	none	The SWAT subscriptions
» swatSubscriptionsRemaining	integer(int64)	false	none	The remaining SWAT subscriptions
» customerSuccessManagerEmail	string	false	none	The email to the customer success manager responsible for this customer
» accountManagerEmail	string	false	none	The email to the account manager responsible for this customer
» pgpPublicKey	string	false	none	This user's PGP public key
» twoFactorType	string	false	none	The user's two-factor authentication type
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» twoFactorSecret	string	false	none	The user's two-factor secret

Enumerated Values

Property	Value
twoFactorType	ANY
twoFactorType	NONE
twoFactorType	SMS
twoFactorType	TOTP

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get header with count

HEAD /users

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /users/{userId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
userId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

View template groups

Get view template group

GET /view-template-groups/{viewTemplateGroupId}

Parameters

Name	In	Type	Required	Description
viewTemplateGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ViewTemplateGroup

Delete view template group

DELETE /view-template-groups/{viewTemplateGroupId}

Parameters

Name	In	Type	Required	Description
viewTemplateGroupId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a view template group

PATCH /view-template-groups/{viewTemplateGroupId}

Body parameter

Parameters

Name	In	Type	Required	Description
viewTemplateGroupId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ViewTemplateGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of view template groups

GET /view-template-groups

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ViewTemplateGroup]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» parentId	integer(int32)	false	none	The ID of the parent entry.
» type	string	true	none	none

Enumerated Values

Property	Value
type	ASSET_GROUPS
type	ASSETS
type	SCAN_CONFIGURATIONS
type	SCHEDULES
type	SCANS
type	FINDINGS
type	REPORTS
type	USERS
type	ACCOUNTS
type	AUDITS
type	SCHEDULED_REPORTS
type	MANAGED_REPORTS
type	INTEGRATIONS
type	COMPLIANCE
type	TAGS
type	VIEW_TEMPLATES
type	SCAN_POLICIES
type	AGENTS
type	CONSUMPTION
type	WORKFLOWS
type	CHECKS
type	FINDING_TEMPLATES
type	MATCHES

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a view template group

POST /view-template-groups

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ViewTemplateGroup	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /view-template-groups

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

View templates

Get a list of view templates

GET /view-templates

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[ViewTemplate]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» type	string	true	none	none
» sorting	string	false	none	none
» fields	string	false	none	none
» columnsWidth	string	false	none	none
» system	boolean	false	read-only	none
» isDefault	boolean	false	none	none
» groupId	integer(int32)	false	none	The view template group id
» filters	[ViewTemplate.Filter]	false	none	none
»» field	string	true	none	none
»» comparison	string	true	none	none
»» value	string	true	none	none
» tags	[Tag]	false	none	[The tags]
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

Enumerated Values

Property	Value
type	ASSET_GROUPS
type	ASSETS
type	SCAN_CONFIGURATIONS
type	SCHEDULES
type	SCANS
type	FINDINGS
type	REPORTS
type	USERS
type	ACCOUNTS
type	AUDITS
type	SCHEDULED_REPORTS
type	MANAGED_REPORTS
type	INTEGRATIONS
type	COMPLIANCE
type	TAGS
type	VIEW_TEMPLATES
type	SCAN_POLICIES
type	AGENTS
type	CONSUMPTION
type	WORKFLOWS
type	CHECKS
type	FINDING_TEMPLATES
type	MATCHES

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a view template

POST /view-templates

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ViewTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /view-templates

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Get view template by ID

GET /view-templates/{viewTemplateId}

Parameters

Name	In	Type	Required	Description
viewTemplateId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	ViewTemplate

Delete a view template

DELETE /view-templates/{viewTemplateId}

Parameters

Name	In	Type	Required	Description
viewTemplateId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a view template

PATCH /view-templates/{viewTemplateId}

Body parameter

Parameters

Name	In	Type	Required	Description
viewTemplateId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	ViewTemplate	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /view-templates/{viewTemplateId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
viewTemplateId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /view-templates/{viewTemplateId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
viewTemplateId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Modify linked set of tags

PUT /view-templates/{viewTemplateId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
viewTemplateId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Workflows

Get a workflow

GET /workflows/{workflowId}

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Workflow

Delete a workflow

DELETE /workflows/{workflowId}

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Partially update a workflow

PATCH /workflows/{workflowId}

Body parameter

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Workflow	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a schedule

PUT /workflows/{workflowId}/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a schedule

DELETE /workflows/{workflowId}/schedules/{scheduleId}

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
scheduleId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Create a link to a tag

PUT /workflows/{workflowId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Delete a link to a tag

DELETE /workflows/{workflowId}/tags/{tagId}

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
tagId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get a list of workflows

GET /workflows

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Maximum number of entries to return
offset	query	integer(int32)	false	Zero-based offset from first entry in list
sort	query	string	false	Comma-separated list of fields to sort on, ascending by default, dash prefix inverts order
fields	query	string	false	A comma-separated string of fields to request
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

The above code returns response like this:

default Response

Responses

Status	Meaning	Description	Schema
default	Default	default response	Inline

Response Schema

Status Code default

Name	Type	Required	Restrictions	Description
anonymous	[Workflow]	false	none	none
» id	integer(int32)	false	read-only	The ID of the entry.
» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
» created	string(date-time)	false	read-only	The timestamp when the entry was created.
» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
» createdBy	string	false	read-only	The name of the user who created the entry.
» updatedBy	string	false	read-only	The name of the user who updated the entry.
» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
» name	string	true	none	The name of the entry.
» enabled	boolean	false	none	Determines if the entry is enabled or not.
» nextOccurrence	string(date-time)	false	read-only	The scan next occurrence date
» lastScan	string(date-time)	false	read-only	Last time a scan was performed using this workflow
» scheduleIds	[integer]	false	read-only	The schedule ids associated with this workflow
» scannerId	integer(int32)	false	none	The scanner id
» tags	[Tag]	false	read-only	The tags
»» id	integer(int32)	false	read-only	The ID of the entry.
»» customerId	integer(int32)	false	none	The ID of the customer owning the entry.
»» created	string(date-time)	false	read-only	The timestamp when the entry was created.
»» updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
»» createdBy	string	false	read-only	The name of the user who created the entry.
»» updatedBy	string	false	read-only	The name of the user who updated the entry.
»» createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
»» updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
»» key	string	true	none	none
»» value	string	false	none	none
»» inherited	boolean	false	read-only	none
»» count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.
» configurations	[Workflow.Configuration]	true	none	The workflow configurations
»» id	integer(int32)	true	none	The ID of the entry.
»» type	string	true	none	none

Enumerated Values

Property	Value
type	SCAN_CONFIGURATION
type	SCHEDULED_REPORT

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Create a workflow

POST /workflows

Body parameter

Parameters

Name	In	Type	Required	Description
fields	query	string	false	A comma-separated string of fields to request
return-result	query	boolean	false	"true" to return the object(s) created/modified in e.g. a POST or PATCH
body	body	Workflow	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Get header with count

HEAD /workflows

Parameters

Name	In	Type	Required	Description
filter	query	string	false	JSON array with filters; [{"field":"<name>","value":"<string/number/boolean>","comparison":"<eq/ne/gt/lt/any/all/none/today/null>"}]

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Headers

Status	Header	Type	Format	Description
default	Count	integer		The number of total entries, without limit and offset

Modify linked set of tags

PUT /workflows/{workflowId}/tags

Body parameter

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none
body	body	array	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Start scans based on this workflow

POST /workflows/{workflowId}/scan

Parameters

Name	In	Type	Required	Description
workflowId	path	integer(int32)	true	none

The above code returns response like this:

Responses

Status	Meaning	Description	Schema
default	Default	default response	None

Response Schema

Schemas

VersionInfo

Properties

Name	Type	Required	Restrictions	Description
software	string	false	none	none
version	string	false	none	none

Enumerated Values

Property	Value
software	AGENT
software	RULES

Account

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
type	string	true	none	none
name	string	true	none	The name of the entry.
url	string	false	none	none
role	string	false	none	none
integrationId	integer(int32)	false	none	none
credentials	[Credential]	false	none	none
assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
scanConfigurationIds	[integer]	false	none	none
scanPolicyIds	[integer]	false	none	none
tags	[Tag]	false	read-only	[The tags]

Enumerated Values

Property	Value
type	SMB
type	SSH
type	BASIC
type	WEB
type	AWS
type	AZURE
type	VSPHERE
type	GCP
type	DOCKER

Credential

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
accountId	integer(int32)	true	none	none
classId	integer(int32)	true	none	none
className	string	false	none	none
value	string	true	none	none
tags	[Tag]	false	read-only	[The tags]

Tag

The tags

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
key	string	true	none	none
value	string	false	none	none
inherited	boolean	false	read-only	none
count	integer(int32)	false	read-only	The total number of entries associated with this entry and its child entries.

AgentInstallerCreationRequest

Properties

Name	Type	Required	Restrictions	Description
platform	string	true	none	none
arch	string	true	none	none
pkg	string	true	none	none
customAttributes	string	false	none	none
tags	[Tag]	false	none	[The tags]
expires	string	false	none	none
allowedUses	integer(int64)	false	none	none

Appliance

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
customerName	string	false	read-only	none
primary	boolean	false	read-only	none
virtual	boolean	false	read-only	none
revoked	string(date-time)	false	read-only	none
mac	string	false	read-only	none
updatedOnline	string(date-time)	false	read-only	none
updatedOffline	string(date-time)	false	read-only	none
versions	Appliance.ApplianceVersion	false	none	none

Appliance.ApplianceVersion

Properties

Name	Type	Required	Restrictions	Description
xmlapi	string	false	none	none
ui	string	false	none	none
scanner	string	false	none	none
rules	string	false	none	none

Activity

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
assetGroupId	integer(int32)	false	read-only	The id of the AssetGroup this activity is related to
activityType	string	true	none	The type of this activity
description	string	false	none	Description of the entry.

Enumerated Values

Property	Value
activityType	PENTEST_COMPLETED
activityType	ONBOARDING_COMPLETED
activityType	FALSE_POSITIVE_DISCARDED
activityType	NEW_VULNERABILITY_CHECK
activityType	EXECUTIVE_SUMMARY_UPDATED
activityType	VERIFICATION_REQUEST_COMPLETED

AssetGroup

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
type	string	false	none	The assetgroup's type
parentId	integer(int32)	false	none	The ID of the parent entry.
assetIds	[integer]	false	read-only	The component assets
assetGroupIds	[integer]	false	read-only	The children asset groups
summaryId	integer(int32)	false	read-only	The ID of the executive summary
summary	string	false	read-only	The content of the executive summary
summaryPublishedAt	string(date-time)	false	read-only	When the executive summary was published
path	[integer]	false	read-only	The path of the asset group tree
activeSubscriptionTypes	[string]	false	read-only	The assetgroup's active subscription types
managed	boolean	false	read-only	Managed internally by (e.g SWAT API or GhostLab)
dynamic	boolean	false	none	Indicates whether the asset group is automatically populated with assets based on the assigned tags
labels	string	false	none	The labels of the asset group
contactName	string	false	none	The customer's contact name with regards to this asset group
contactDetails	string	false	none	The customer's contact details
additionalDetails	string	false	none	Additional information about the asset group that may require attention
commentPendingSince	string(date-time)	false	read-only	The date since comment is pending
customerName	string	false	none	The customer name
tags	[Tag]	false	read-only	The tags
includedDynamicTags	[Tag]	false	read-only	The included dynamic asset tags
excludedDynamicTags	[Tag]	false	read-only	The excluded dynamic asset tags

Enumerated Values

Property	Value
type	WEB_APP
type	INSTANCE
type	API
type	INTERNAL
type	EXTERNAL
type	MOBILE
type	PHYSICAL
type	WIRELESS
type	PHISHING
type	RED
type	ASSUMED
type	DIGITAL
type	HARDWARE
type	PROJECT

Comment

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
parentId	integer(int32)	false	none	The ID of the parent entry.
comment	string	false	none	The content of the comment
entityType	string	false	none	The type of object this comment is made for
entityId	integer(int32)	false	none	The ID of the object this comment is made for
supportStatus	string	false	none	Current support status of the comment
authorIsStaff	boolean	false	read-only	Whether the comment is from Outpost24 or the customer
deleted	string(date-time)	false	none	When the comment was deleted

Enumerated Values

Property	Value
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
supportStatus	NOT_APPLICABLE
supportStatus	WAITING
supportStatus	DONE
supportStatus	INTERNAL

Subscription

Properties

Name	Type	Required	Restrictions	Description
uuid	string	false	none	The UUID of the entry.
type	string	false	none	none
associations	Subscription.Associations	false	none	none
durationInDays	integer(int32)	false	none	none
activeUntil	string(date-time)	false	none	none
activatedAt	string(date-time)	false	none	none
redeemableUntil	string(date-time)	false	none	none
created	string(date-time)	false	none	The timestamp when the entry was created.
createdBy	string	false	none	The name of the user who created the entry.
updated	string(date-time)	false	none	The timestamp when the entry was updated.
updatedBy	string	false	none	The name of the user who updated the entry.
template	Subscription.Template	false	none	none
customer	Subscription.Customer	false	none	none
limits	Subscription.Limits	false	none	none
isActive	boolean	false	none	none

Enumerated Values

Property	Value
type	DAST
type	SCALE
type	SCOUT
type	SNAPSHOT
type	ASSURE
type	DAST_EXPERT
type	VERIFY
type	SWAT
type	CLOUDSEC
type	NETSEC
type	CONSUMPTION

Subscription.Associations

Properties

Name	Type	Required	Restrictions	Description
assetGroups	[string]	false	none	none

Subscription.Customer

Properties

Name	Type	Required	Restrictions	Description
uuid	string	true	none	The UUID of the entry.

Subscription.Limits

Properties

Name	Type	Required	Restrictions	Description
netsecAssets	integer(int32)	false	none	The netsec assets
netsecScans	integer(int32)	false	none	The netsec scans
netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
netsecInternalScans	integer(int32)	false	none	The netsec internal scans
netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
complianceAssets	integer(int32)	false	none	The compliance assets
complianceScans	integer(int32)	false	none	The compliance scans
complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
complianceInternalScans	integer(int32)	false	none	The compliance internal scans
complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
pciAssets	integer(int32)	false	none	The pci assets
pciScans	integer(int32)	false	none	The pci scans
scaleAssets	integer(int32)	false	none	The scale assets
scaleScans	integer(int32)	false	none	The scale scans
scaleInternalAssets	integer(int32)	false	none	The scale internal assets
scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
cloudsecAssets	integer(int32)	false	none	The cloudsec assets
cloudsecScans	integer(int32)	false	none	The cloudsec scans
networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
networkAssets	integer(int32)	false	none	The network assets
networkScans	integer(int32)	false	none	The network scans
networkApplianceAssets	integer(int32)	false	none	The network appliance assets
networkApplianceScans	integer(int32)	false	none	The network appliance scans
dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
dockerImageAssets	integer(int32)	false	none	The docker image assets
dockerImageScans	integer(int32)	false	none	The docker image scans
dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
outscanNXAssets	integer(int32)	false	none	The outscan NX assets
outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets

Subscription.Template

Properties

Name	Type	Required	Restrictions	Description
uuid	string	true	none	The UUID of the entry.
variables	string	false	none	none
template	string	false	none	none
name	string	false	none	The name of the entry.

AgentMatch

Properties

Name	Type	Required	Restrictions	Description
data	IdentifierData	false	none	none
type	string	false	none	none

AssetIdentifier

The asset links

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
presentableName	string	false	none	none
type	string	true	none	none
firstSeen	string(date-time)	false	none	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	false	none	Timestamp when the entry was seen last time.
scannerId	integer(int32)	false	none	none
scannerName	string	false	read-only	none
ownership	integer(int32)	false	read-only	none
customOwnership	integer(int32)	false	none	none
firstScanId	integer(int32)	false	read-only	none
lastScanId	integer(int32)	false	read-only	none
source	[string]	true	none	none
links	[integer]	false	read-only	none
assetIds	[integer]	false	none	none
assetNames	[string]	false	read-only	none
accountIds	[integer]	false	none	none
platform	string	false	none	none
tags	[Tag]	false	read-only	[The tags]
properties	BaseProperties	false	none	The asset base properties

Enumerated Values

Property	Value
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

AssetIdentifier.AgentProperties

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseProperties	false	none	The asset base properties

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» uuid	string	false	none	none
» version	string	false	none	none
» lastSynchronized	string(date-time)	false	none	none
» customAttributes	object	false	none	none
»» additionalProperties	string	false	none	none
» tags	[Tag]	false	none	[The tags]
» retired	string(date-time)	false	none	none
» matches	[AgentMatch]	false	none	none

AssetIdentifier.DockerImageProperties

The docker image properties

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseProperties	false	none	The asset base properties

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» os	string	false	none	none
» tag	string	false	none	none
» size	integer(int64)	false	none	none
» architecture	string	false	none	none

BaseProperties

The asset base properties

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none

Enumerated Values

Property	Value
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

From

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
identifier	string	false	none	none
relation	string	false	none	none

Enumerated Values

Property	Value
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

IdentifierData

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
identifier	string	false	none	none
from	From	false	none	none

Enumerated Values

Property	Value
type	IP
type	HOSTNAME
type	AWS_ACCOUNT_ID
type	AWS_INSTANCE_ID
type	AWS_REGION
type	MAC
type	NETBIOS
type	GCP_PROJECT_ID
type	MAZ_TENANT_ID
type	MAZ_SUBSCRIPTION
type	MAZ_RESOURCE_GROUP
type	MAZ_RESOURCE
type	DOCKER_REGISTRY
type	DOCKER_IMAGE
type	SEED_PATH
type	AGENT
type	SERIAL_MACHINE_ID
type	SERIAL_PRODUCT_ID
type	SERIAL_DISK_ID

AssetIdentifierLink

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
assetIdentifierId	integer(int32)	true	none	The ID of the asset identifier associated with this entry
firstSeen	string(date-time)	true	none	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	true	none	Timestamp when the entry was seen last time.
type	string	true	none	none

Enumerated Values

Property	Value
type	RESOLVES_TO
type	LOADS_SCRIPTS_FROM
type	REFERS_IN_TLS_TO
type	DNS_CNAME
type	DNS_DNAME
type	DNS_MX
type	DNS_NS
type	DNS_PTR
type	DNS_SRV
type	DNS_A
type	DNS_AAAA
type	DNS_URI
type	CONTAINS
type	HTML_LINKS_TO
type	ARP

Asset

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
source	[string]	true	none	The asset sources
platform	string	false	read-only	The asset platform
assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
assetIdentifierTypes	[string]	false	read-only	The asset identifier types (deprecated)
activeSubscriptionTypes	[string]	false	read-only	The asset's active subscription types
uuid	string	false	read-only	The UUID of the entry.
firstScanId	integer(int32)	false	read-only	The id of the first scan performed on the asset
lastScanId	integer(int32)	false	read-only	The id of last scan performed on the asset
compliant	string	false	read-only	The asset compliance status
cvssV2EnvironmentalVector	string	false	none	The CVSS V2 environmental vector
cvssV3EnvironmentalVector	string	false	none	The CVSS V3 environmental vector
customerName	string	false	none	The customer name
enabled	boolean	false	none	Determines if the entry is enabled or not.
active	boolean	false	read-only	Determines if the entry is active or not.
dockerImageProperties	BaseProperties	false	none	The asset base properties
tags	[Tag]	false	read-only	The tags
assetIdentifiers	[AssetIdentifier]	false	none	The asset links
assetGroups	[Asset.AssetGroup]	false	read-only	Information of all asset groups the asset is linked to

Enumerated Values

Property	Value
compliant	COMPLIANT
compliant	NOT_COMPLIANT
compliant	COMPLIANT_WITH_EXCEPTIONS

Asset.AssetGroup

Information of all asset groups the asset is linked to

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	The ID of the entry.
name	string	false	none	The name of the entry.

AssetLink

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
assetId	integer(int32)	false	none	none
assetIdentifierId	integer(int32)	true	none	The ID of the asset identifier associated with this entry
firstSeen	string(date-time)	true	none	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	true	none	Timestamp when the entry was seen last time.

Audit

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
objectName	string	false	read-only	none
objectId	integer(int32)	false	read-only	none
action	string	false	read-only	none
updatedFields	object	false	read-only	none
» additionalProperties	string	false	read-only	none

SendSmsRequest

Properties

Name	Type	Required	Restrictions	Description
phoneNumber	string	true	none	none

CertificateCreationRequest

Properties

Name	Type	Required	Restrictions	Description
certificateSigningRequest	string	false	none	none
scannerId	integer(int64)	false	none	none
key	string	false	none	none
service	string	false	none	none

Enumerated Values

Property	Value
service	OUTPOST24_GLOBAL
service	OUTSCAN
service	OPERATOR
service	OUTSCAN_FRONTEND
service	OUTSCAN_ADMIN
service	OUTSCAN_BACKEND
service	OUTSCAN_ATTACKER
service	OUTSCAN_REMOTE_SUPPORT
service	HIAB_SCHEDULER
service	HIAB_SCANNER
service	REPORT_SERVICE
service	EVENT_SERVICE
service	MESOTHELAE_JOBS
service	MESOTHELAE_TASKS
service	LIBELLUM
service	TEDDY_SALAD
service	AGENT
service	MESOS_AGENT
service	SWAT_API
service	SWAT_WORKER
service	SUPPORT

Check

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
cve	string	false	read-only	The check CVE
name	string	false	read-only	The name of the entry.
nvdCvssV2Score	number(double)	false	read-only	The CVSS V2 score
nvdCvssV3Score	number(double)	false	read-only	The CVSS V3 score
nvdCvssV2Vector	string	false	read-only	The CVSS V2 vector
cvssV3Severity	string	false	read-only	The CVSS V3 Severity
hasExploits	boolean	false	read-only	Set to true when exploits are available
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
description	string	false	read-only	Description of the entry.
cyrating	number(double)	false	read-only	none
previousCyrating	number(double)	false	read-only	none
cyratingDelta	number(double)	false	read-only	none
cyratingUpdated	string(date-time)	false	read-only	none
cyratingLastSeen	string(date-time)	false	read-only	none
exploitProbability	number(double)	false	read-only	The exploit probability
previousExploitProbability	number(double)	false	read-only	The previous exploit probability
exploitProbabilityDelta	number(double)	false	read-only	The exploit probability delta
softwareComponent	string	false	read-only	The software component
owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
solutionType	string	false	read-only	The solution type
solution	string	false	read-only	The solution
solutionProduct	string	false	read-only	The solution product
solutionTitle	string	false	read-only	The solution title
solutionUuid	string	false	read-only	The solution uuid
bugTraq	[integer]	false	read-only	An array of Bugtraq reference IDs.
nvdCvssV3Vector	string	false	read-only	The CVSS V3 vector
farsight	Farsight	false	none	The farsight concists in additional information on risk such as likelihood, threat activity
classifications	Classification.Classifications	false	none	The classifications such as CAPEC, OWASP20XX

Enumerated Values

Property	Value
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE

Classification.Classifications

The classifications such as CAPEC, OWASP20XX

Properties

Name	Type	Required	Restrictions	Description
sans25	integer(int32)	false	none	SANS 25 classification of the entry.
capec	[integer]	false	none	CAPEC classification of the entry.
owasp2004	[integer]	false	none	An array of OWASP Top 10 2004 classifications of the entry.
owasp2007	[integer]	false	none	An array of OWASP Top 10 2007 classifications of the entry.
owasp2010	[integer]	false	none	An array of OWASP Top 10 2010 classifications of the entry.
owasp2013	[integer]	false	none	An array of OWASP Top 10 2013 classifications of the entry.
owasp2017	[integer]	false	none	An array of OWASP Top 10 2017 classifications of the entry.
owasp2021	[integer]	false	none	none

Farsight

The farsight concists in additional information on risk such as likelihood, threat activity

Properties

Name	Type	Required	Restrictions	Description
risk	Farsight.Risk	false	none	none
updated	string(date-time)	false	none	The timestamp when the entry was updated.
lastThreatActivity	string(date-time)	false	none	none

Farsight.Risk

Properties

Name	Type	Required	Restrictions	Description
score	number(float)	false	none	none
delta	number(float)	false	none	none

Exploit

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
source	string	false	read-only	none
cve	string	false	read-only	none
name	string	false	read-only	The name of the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
pack	string	false	read-only	none
checkId	integer(int64)	false	read-only	none
url	string	false	read-only	none

Enumerated Values

Property	Value
source	Unknown
source	Core Security
source	Immunity
source	Exploit Database
source	DSquare Security
source	Contagio
source	Metasploit
source	SAINT
source	Security Focus
source	Snort
source	Farsight

Classification

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
cwe	integer(int32)	false	read-only	CWE classification of the entry.
name	string	false	read-only	The name of the entry.
sans25	integer(int32)	false	read-only	SANS 25 classification of the entry.
capec	[integer]	false	read-only	CAPEC classification of the entry.
owasp2004	[integer]	false	read-only	An array of OWASP Top 10 2004 classifications of the entry.
owasp2007	[integer]	false	read-only	An array of OWASP Top 10 2007 classifications of the entry.
owasp2010	[integer]	false	read-only	An array of OWASP Top 10 2010 classifications of the entry.
owasp2013	[integer]	false	read-only	An array of OWASP Top 10 2013 classifications of the entry.
owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
owasp2021	[integer]	false	read-only	none
secureCodeWarrior	SecureCodeWarrior	false	none	The secure code warrior information on the vulnerability description and training
classifications	Classification.Classifications	false	none	The classifications such as CAPEC, OWASP20XX

SecureCodeWarrior

The secure code warrior information on the vulnerability description and training

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the entry.
description	string	false	none	Description of the entry.
url	string	false	none	none

ComplianceFinding

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
requirementId	integer(int32)	true	none	Id of the requirement associated with the finding
matchId	integer(int32)	true	none	Id of the matching entity
assetId	integer(int32)	true	none	Id of the associated asset
policyId	integer(int32)	false	read-only	Id of the associated policy
policyName	string	false	read-only	Name of the associated policy
audit	string	false	read-only	Audit information related to the finding
description	string	false	read-only	Description of the entry.
rationale	string	false	read-only	Rationale behind the finding
scored	boolean	false	read-only	Indicates whether the finding is scored
nameLong	string	false	read-only	Long name associated with the finding
nameShort	string	false	read-only	Short name associated with the finding
requirement	string	false	read-only	Requirement details associated with the finding
solution	string	false	read-only	Solution to address the finding
impacts	string	false	read-only	Impacts of the finding
notes	string	false	read-only	Additional notes related to the finding
references	string	false	read-only	References related to the finding
controls	string	false	read-only	Controls in place to address the finding
category	string	false	read-only	Category of compliance requirement
source	[string]	false	read-only	Array of sources related to the finding
firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
firstScanId	integer(int32)	false	read-only	Id of the first scan associated with the finding
lastScanId	integer(int32)	false	read-only	Id of the last scan associated with the finding
compliant	string	false	read-only	Compliance status of the finding
falsePositive	string(date-time)	false	read-only	Instant when the finding was marked as false positive
falsePositiveComment	string	false	read-only	Comment related to marking the finding as false positive
falsePositiveBy	string	false	read-only	User who marked the finding as false positive
exception	string(date-time)	false	read-only	Instant when an exception was recorded for the finding
exceptionComment	string	false	read-only	Comment related to the exception recorded for the finding
exceptionUntil	string(date-time)	false	read-only	Instant until when the exception is valid
exceptionBy	string	false	read-only	User who recorded the exception for the finding
humanCheck	boolean	false	read-only	Indicates whether there is a human check for the finding
firstFailed	string(date-time)	false	read-only	Instant when the finding first failed
lastFailed	string(date-time)	false	read-only	Instant when the finding last failed
assetName	string	false	read-only	Name of the asset associated with the finding
tags	[Tag]	false	read-only	The tags

Enumerated Values

Property	Value
category	INFRASTRUCTURE
category	COMPUTE
category	NETWORK
category	STORAGE
category	DATABASE
category	BIG_DATA_AND_ANALYTICS
category	SECURITY_AND_IDENTITY
category	MONITORING_AND_LOGGING
category	NOT_DEFINED
compliant	COMPLIANT
compliant	NOT_COMPLIANT
compliant	COMPLIANT_WITH_EXCEPTIONS

Policy

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	false	read-only	The name of the entry.
description	string	false	read-only	Description of the entry.
type	string	false	read-only	none
checksum	string(byte)	false	read-only	none

Enumerated Values

Property	Value
type	AWS
type	GCP
type	AZURE

Requirement

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
policyId	integer(int32)	false	read-only	none
audit	string	false	read-only	none
description	string	false	read-only	Description of the entry.
rationale	string	false	read-only	none
scored	boolean	false	read-only	none
nameLong	string	false	read-only	none
nameShort	string	false	read-only	none
requirementId	string	false	read-only	none
solution	string	false	read-only	none
category	string	false	read-only	none
notes	string	false	read-only	none
references	string	false	read-only	none
controls	string	false	read-only	none
impacts	string	false	read-only	none

Enumerated Values

Property	Value
category	INFRASTRUCTURE
category	COMPUTE
category	NETWORK
category	STORAGE
category	DATABASE
category	BIG_DATA_AND_ANALYTICS
category	SECURITY_AND_IDENTITY
category	MONITORING_AND_LOGGING
category	NOT_DEFINED

ComplianceFindingException

Properties

Name	Type	Required	Restrictions	Description
exceptionUntil	string(date-time)	true	none	none
exceptionComment	string	false	none	none

ComplianceFindingFalsePositive

Properties

Name	Type	Required	Restrictions	Description
falsePositiveComment	string	true	none	none

ComplianceReport

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
format	string	true	none	none
password	string	false	none	none
zip	boolean	false	none	none
level	string	false	none	none
assetIds	[integer]	false	none	none
assetGroupIds	[integer]	false	none	none
tagIds	[integer]	false	none	none
filter	string	false	none	none
viewTemplateId	integer(int32)	false	none	none
deliveryMethod	DeliveryMethod	false	none	none

Enumerated Values

Property	Value
format	PDF
format	EXCEL
format	XML
format	SWATDEMO
level	Detailed
level	Management
level	Summary

DeliveryMethod

Properties

Name	Type	Required	Restrictions	Description
email	DeliveryMethod.Email	false	none	none
managedReport	DeliveryMethod.ManagedReport	false	none	none

DeliveryMethod.Email

Properties

Name	Type	Required	Restrictions	Description
userIds	[integer]	false	none	none
recipients	DeliveryMethod.Recipients	false	none	none

DeliveryMethod.ManagedReport

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the entry.
tags	string	false	none	none

DeliveryMethod.Recipients

Properties

Name	Type	Required	Restrictions	Description
addresses	[string]	false	none	none
pgpKey	string	false	none	none

ConsumptionStats

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
customerName	string	false	read-only	none
organization	string	false	read-only	none
salesAccountId	string	false	read-only	none
periodStart	string(date-time)	false	none	The consumption period start date
periodEnd	string(date-time)	false	none	The consumption period end date
appliancePeriodEnd	string(date-time)	false	none	The appliance consumption period start date
netsecAssets	integer(int32)	false	none	The netsec assets
netsecScans	integer(int32)	false	none	The netsec scans
netsecInternalAssets	integer(int32)	false	none	The netsec internal assets
netsecInternalScans	integer(int32)	false	none	The netsec internal scans
netsecApplianceAssets	integer(int32)	false	none	The netsec appliance assets
netsecApplianceScans	integer(int32)	false	none	The netsec appliance scans
netsecApplianceExternalAssets	integer(int32)	false	none	The netsec appliance external assets
netsecApplianceExternalScans	integer(int32)	false	none	The netsec appliance external scans
complianceAssets	integer(int32)	false	none	The compliance assets
complianceScans	integer(int32)	false	none	The compliance scans
complianceInternalAssets	integer(int32)	false	none	The compliance internal assets
complianceInternalScans	integer(int32)	false	none	The compliance internal scans
complianceApplianceAssets	integer(int32)	false	none	The compliance appliance assets
complianceApplianceScans	integer(int32)	false	none	The compliance appliance scans
complianceApplianceExternalAssets	integer(int32)	false	none	The compliance appliance external assets
complianceApplianceExternalScans	integer(int32)	false	none	The compliance appliance external scans
pciAssets	integer(int32)	false	none	The pci assets
pciScans	integer(int32)	false	none	The pci scans
scaleAssets	integer(int32)	false	none	The scale assets
scaleScans	integer(int32)	false	none	The scale scans
scaleInternalAssets	integer(int32)	false	none	The scale internal assets
scaleApplianceAssets	integer(int32)	false	none	The scale appliance assets
scaleApplianceScans	integer(int32)	false	none	The scale appliance scans
scaleApplianceExternalScans	integer(int32)	false	none	The scale appliance external scans
scaleApplianceExternalAssets	integer(int32)	false	none	The scale appliance external assets
cloudsecAssets	integer(int32)	false	none	The cloudsec assets
cloudsecScans	integer(int32)	false	none	The cloudsec scans
networkDiscoveryScans	integer(int32)	false	none	The network discovery scans
networkDiscoveryApplianceScans	integer(int32)	false	none	The network discovery appliance scans
cloudDiscoveryScans	integer(int32)	false	none	The cloud discovery scans
cloudDiscoveryApplianceScans	integer(int32)	false	none	The cloud discovery appliance scans
networkAssets	integer(int32)	false	none	The network assets
networkScans	integer(int32)	false	none	The network scans
networkApplianceAssets	integer(int32)	false	none	The network appliance assets
networkApplianceScans	integer(int32)	false	none	The network appliance scans
dockerImageDiscoveryScans	integer(int32)	false	none	The docker image discovery scans
dockerImageAssets	integer(int32)	false	none	The docker image assets
dockerImageScans	integer(int32)	false	none	The docker image scans
dockerImageDiscoveryApplianceScans	integer(int32)	false	none	The docker image discovery appliance scans
dockerImageApplianceAssets	integer(int32)	false	none	The docker image appliance assets
dockerImageApplianceScans	integer(int32)	false	none	The docker image appliance scans
outscanNXAssets	integer(int32)	false	none	The outscan NX assets
outscanNXApplianceAssets	integer(int32)	false	none	The outscan NX appliance assets

CredentialClass

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
name	string	false	read-only	The name of the entry.
hidden	boolean	false	read-only	none

Customer

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	false	read-only	The name of the entry.
country	string	false	read-only	Country associated with the entry.
active	boolean	false	read-only	Determines if the entry is active or not.
features	[string]	false	none	none
awsExternalId	string	false	read-only	none
uuid	string	false	read-only	The UUID of the entry.
organization	string	false	read-only	none
organizationUuid	string	false	read-only	none
farsightProducts	[string]	false	read-only	none
salesAccountId	string	false	read-only	none
assetMigration	string(date-time)	false	none	none
customerSuccessManagerEmail	string	false	read-only	The email to the customer success manager responsible for this customer
accountManagerEmail	string	false	read-only	The email to the account manager responsible for this customer
migrationStatus	string	false	read-only	The migration status
state	string	false	read-only	none
tags	[Tag]	false	read-only	The tags
migration	Customer.Migration	false	none	The migration status

Enumerated Values

Property	Value
migrationStatus	RUNNING
migrationStatus	FINISHED
migrationStatus	FAILED

Customer.Migration

The migration status

Properties

Name	Type	Required	Restrictions	Description
queued	string(date-time)	false	none	none
started	string(date-time)	false	none	none
ended	string(date-time)	false	none	none
failed	boolean	false	none	none
targets	integer(int32)	false	none	none
migratedTargets	integer(int32)	false	none	none
targetGroups	integer(int32)	false	none	none
migratedTargetGroups	integer(int32)	false	none	none
reports	integer(int32)	false	none	none
migratedReports	integer(int32)	false	none	none
managedReports	integer(int32)	false	none	none
migratedManagedReports	integer(int32)	false	none	none

UsageStats

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
customerName	string	false	read-only	none
organization	string	false	read-only	none
salesAccountId	string	false	read-only	none
statsUpdated	string(date-time)	false	none	none
applianceStatsUpdated	string(date-time)	false	none	none
scaleConfigurations	integer(int32)	false	none	none
scoutConfigurations	integer(int32)	false	none	none
cloudsecConfigurations	integer(int32)	false	none	none
applianceScaleConfigurations	integer(int32)	false	none	none
users	integer(int32)	false	none	none
lastLogin	string(date-time)	false	none	none
applianceUsers	integer(int32)	false	none	none
applianceLastLogin	string(date-time)	false	none	none
findingsCritical	integer(int32)	false	none	none
findingsHigh	integer(int32)	false	none	none
findingsMedium	integer(int32)	false	none	none
findingsLow	integer(int32)	false	none	none
findingsRecommendations	integer(int32)	false	none	none
applianceFindingsCritical	integer(int32)	false	none	none
applianceFindingsHigh	integer(int32)	false	none	none
applianceFindingsMedium	integer(int32)	false	none	none
applianceFindingsLow	integer(int32)	false	none	none
applianceFindingsRecommendations	integer(int32)	false	none	none
scans	integer(int32)	false	none	none
lastScan	string(date-time)	false	none	none
applianceScans	integer(int32)	false	none	none
applianceLastScan	string(date-time)	false	none	none
accountsAws	integer(int32)	false	none	none
accountsGcp	integer(int32)	false	none	none
accountsAzure	integer(int32)	false	none	none
accountsVsphere	integer(int32)	false	none	none
accountsBasic	integer(int32)	false	none	none
accountsWeb	integer(int32)	false	none	none
applianceAccountsAws	integer(int32)	false	none	none
applianceAccountsGcp	integer(int32)	false	none	none
applianceAccountsAzure	integer(int32)	false	none	none
applianceAccountsVsphere	integer(int32)	false	none	none
applianceAccountsBasic	integer(int32)	false	none	none
applianceAccountsWeb	integer(int32)	false	none	none
cyr3conAssets	integer(int32)	false	none	none
cyr3conApplianceAssets	integer(int32)	false	none	none
agents	integer(int32)	false	none	none
agentsScanned	integer(int32)	false	none	none
agentsOutdated	integer(int32)	false	none	none
applianceAgents	integer(int32)	false	none	none
applianceAgentsScanned	integer(int32)	false	none	none
applianceAgentsOutdated	integer(int32)	false	none	none

Dashboard

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
cards	[Dashboard.Card]	false	none	none
tags	[Tag]	false	read-only	[The tags]

Dashboard.Card

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the entry.
data	string	false	none	none
width	integer(int32)	false	none	none
height	integer(int32)	false	none	none
x	integer(int32)	false	none	none
y	integer(int32)	false	none	none

FormDataContentDisposition

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	none
parameters	object	false	none	none
» additionalProperties	string	false	none	none
fileName	string	false	none	none
creationDate	string(date-time)	false	none	none
modificationDate	string(date-time)	false	none	none
readDate	string(date-time)	false	none	none
size	integer(int64)	false	none	none
name	string	false	none	The name of the entry.

ObjectDecryptionRequest

Properties

Name	Type	Required	Restrictions	Description
bucket	string	true	none	none
key	string	true	none	none
unsigned	boolean	false	none	none
auditComment	string	true	none	none

DownloadCacheEntry

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	read-only	The timestamp when the entry was created.
name	string	false	read-only	The name of the entry.
key	string	false	read-only	none
status	string	false	read-only	none
size	integer(int64)	false	read-only	none
token	string	false	read-only	none
tokenExpires	string(date-time)	false	read-only	none
type	string	false	read-only	none

Enumerated Values

Property	Value
type	ATTACHMENT
type	REPORT
type	BLUEPRINT
type	INTERNAL_BLUEPRINT
type	MANAGED_REPORT
type	DECRYPTED_OBJECT
type	LOGS
type	AGENT_INSTALLER
type	UPDATE_PACKAGE

DatabaseSetting

Properties

Name	Type	Required	Restrictions	Description
host	string	true	none	none
port	integer(int32)	false	none	none
password	string	false	none	none
ssl	boolean	false	none	none
certificate	string	false	none	none

BaseContentConfiguration

Properties

Name	Type	Required	Restrictions	Description
integrationType	string	true	none	none

Enumerated Values

Property	Value
integrationType	WEBHOOK
integrationType	EMAIL
integrationType	LOG
integrationType	SYSLOG
integrationType	SNMP
integrationType	NOTIFICATION

EmailContentConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContentConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» subject	string	false	none	none
» userList	[integer]	false	none	none
» userEmailAddresses	[string]	false	none	none
» content	string	false	none	none
» htmlContent	string	false	none	none

EventSubscription

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
trigger	string	true	none	none
viewTemplateId	integer(int32)	false	none	none
integrationId	integer(int32)	false	none	none
integrationType	string	false	read-only	none
enabled	boolean	false	none	Determines if the entry is enabled or not.
settings	EventSubscription.Settings	false	none	none
contentConfiguration	BaseContentConfiguration	false	none	none
tags	[Tag]	false	read-only	The tags

Enumerated Values

Property	Value
trigger	SCHEDULE_CREATED
trigger	SCHEDULE_DELETED
trigger	SCHEDULE_MODIFIED
trigger	SCHEDULE_SCHEDULED
trigger	CONFIGURATION_CREATED
trigger	CONFIGURATION_DELETED
trigger	CONFIGURATION_MODIFIED
trigger	CONFIGURATION_STARTED
trigger	CONFIGURATION_DONE
trigger	SCAN_STARTED
trigger	SCAN_STOPPED
trigger	SCAN_DONE
trigger	ASSET_NOT_RECENTLY_SEEN
trigger	ASSET_SEEN
trigger	ASSET_CREATED
trigger	ASSET_DELETED
trigger	ASSET_MODIFIED
trigger	FINDING_SEEN
trigger	FINDING_CREATED
trigger	FINDING_MODIFIED
trigger	FINDING_STATUS_TRANSITIONED
trigger	FINDING_RISK_ACCEPTED_EXPIRATION
trigger	WATCHED_FINDING_UPDATED
trigger	USER_CREATED
trigger	USER_DELETED
trigger	USER_MODIFIED
trigger	USER_LOGIN_ATTEMPT
trigger	USER_PASSWORD_RESET
trigger	ROLE_CREATED
trigger	ROLE_DELETED
trigger	ROLE_MODIFIED
trigger	RESOURCE_GROUP_CREATED
trigger	RESOURCE_GROUP_DELETED
trigger	RESOURCE_GROUP_MODIFIED
trigger	NEW_RELEASE_NOTES
trigger	HIAB_SCANNER_MISSING
trigger	HIAB_UPDATE_DONE
trigger	HIAB_UPDATE_FAILED
trigger	HIAB_BACKUP_DONE
trigger	HIAB_BACKUP_FAILED
trigger	HIAB_MAINTENANCE_PLAN_DONE
trigger	HIAB_DISK_USAGE_HIGH
trigger	HIAB_REBOOTED
trigger	HIAB_REMOTE_SUPPORT
trigger	OUTSCAN_CONSULTANCY
trigger	CONSUMPTION_ABSOLUTE
trigger	CONSUMPTION_RELATIVE
trigger	WORKFLOW_CREATED
trigger	WORKFLOW_DELETED
trigger	WORKFLOW_MODIFIED
trigger	WORKFLOW_STARTED
trigger	WORKFLOW_DONE
trigger	COMPLIANCE_CREATED
trigger	COMPLIANCE_MODIFIED
trigger	COMPLIANCE_RISK_EXCEPTION
trigger	COMPLIANCE_RISK_EXCEPTION_EXPIRATION
trigger	COMMENT_CREATED
trigger	EXECUTIVE_SUMMARY_UPDATED
trigger	ACTIVITY_FEED_UPDATED
trigger	ASSET_GROUP_CREATED
trigger	ASSET_GROUP_DELETED
trigger	ASSET_GROUP_MODIFIED
integrationType	WEBHOOK
integrationType	EMAIL
integrationType	LOG
integrationType	SYSLOG
integrationType	SNMP
integrationType	NOTIFICATION

EventSubscription.Settings

Properties

Name	Type	Required	Restrictions	Description
timeBefore	integer(int32)	false	none	none
timeSince	integer(int32)	false	none	none
diskUsage	integer(int32)	false	none	none
metric	string	false	none	none
limit	integer(int32)	false	none	none
userId	integer(int32)	false	none	none
from	string	false	none	none
to	string	false	none	none
entityType	string	false	none	none

Enumerated Values

Property	Value
metric	NETSEC_ASSETS
metric	NETSEC_SCANS
metric	NETSEC_INTERNAL_ASSETS
metric	NETSEC_INTERNAL_SCANS
metric	NETSEC_APPLIANCE_ASSETS
metric	NETSEC_APPLIANCE_SCANS
metric	NETSEC_APPLIANCE_EXTERNAL_ASSETS
metric	NETSEC_APPLIANCE_EXTERNAL_SCANS
metric	COMPLIANCE_ASSETS
metric	COMPLIANCE_SCANS
metric	COMPLIANCE_INTERNAL_ASSETS
metric	COMPLIANCE_INTERNAL_SCANS
metric	COMPLIANCE_APPLIANCE_ASSETS
metric	COMPLIANCE_APPLIANCE_SCANS
metric	COMPLIANCE_APPLIANCE_EXTERNAL_ASSETS
metric	COMPLIANCE_APPLIANCE_EXTERNAL_SCANS
metric	PCI_ASSETS
metric	PCI_SCANS
metric	SCALE_ASSETS
metric	SCALE_SCANS
metric	SCALE_INTERNAL_ASSETS
metric	SCALE_APPLIANCE_ASSETS
metric	SCALE_APPLIANCE_SCANS
metric	SCALE_APPLIANCE_EXTERNAL_ASSETS
metric	SCALE_APPLIANCE_EXTERNAL_SCANS
metric	CLOUDSEC_ASSETS
metric	CLOUDSEC_SCANS
metric	NETWORK_DISCOVERY_SCANS
metric	NETWORK_DISCOVERY_APPLIANCE_SCANS
metric	CLOUD_DISCOVERY_SCANS
metric	CLOUD_DISCOVERY_APPLIANCE_SCANS
metric	NETWORK_ASSETS
metric	NETWORK_SCANS
metric	NETWORK_APPLIANCE_ASSETS
metric	NETWORK_APPLIANCE_SCANS
metric	DOCKER_IMAGE_DISCOVERY_SCANS
metric	DOCKER_IMAGE_ASSETS
metric	DOCKER_IMAGE_SCANS
metric	DOCKER_IMAGE_DISCOVERY_APPLIANCE_SCANS
metric	DOCKER_IMAGE_APPLIANCE_ASSETS
metric	DOCKER_IMAGE_APPLIANCE_SCANS
metric	OUTSCAN_NX_ASSETS
metric	OUTSCAN_NX_APPLIANCE_ASSETS
from	to review
from	to verify
from	to QA
from	to publish
from	rejected
from	present
from	accepted
from	false positive
from	pending verification
from	fixed
from	irreproducible
to	to review
to	to verify
to	to QA
to	to publish
to	rejected
to	present
to	accepted
to	false positive
to	pending verification
to	fixed
to	irreproducible
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK

LogContentConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContentConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» content	string	false	none	none

NotificationContentConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContentConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» userId	integer(int32)	false	none	none
» subject	string	false	none	none
» message	string	false	none	none

SnmpContentConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContentConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» objectId	string	false	none	none
» content	string	false	none	none
» maxRetries	integer(int32)	false	none	none
» retryInterval	integer(int32)	false	none	none

SyslogContentConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContentConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» format	string	false	none	none
» applicationName	string	false	none	none
» processId	string	false	none	none
» messageId	string	false	none	none
» tag	string	false	none	none
» facility	integer(int32)	false	none	none
» severity	integer(int32)	false	none	none
» structuredData	string	false	none	none
» content	string	false	none	none
» maxRetries	integer(int32)	false	none	none
» retryInterval	integer(int32)	false	none	none

Enumerated Values

Property	Value
format	RFC5424
format	RFC3164
format	LEGACY

WebhookContentConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseContentConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» content	string	false	none	none
» maxRetries	integer(int32)	false	none	none
» retryInterval	integer(int32)	false	none	none
» httpMethod	string	false	none	none
» httpHeaders	string	false	none	none

EventTemplateVariable

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	The event template variable name
description	string	false	none	Description of the entry.

FindingTemplateGroup

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
parentId	integer(int32)	false	none	The ID of the parent entry.

FindingTemplate

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
uuid	string	false	none	The UUID of the entry.
groupId	integer(int32)	false	none	none
cvssV2Score	number(float)	false	read-only	The CVSS V2 score
cvssV3Score	number(float)	false	read-only	The CVSS V3 score
cvssV2Severity	string	false	read-only	The CVSS V2 severity
cvssV3Severity	string	false	read-only	The CVSS V3 severity
template	FindingTemplate.Template	true	none	The finding template attributes
tags	[Tag]	false	read-only	The tags

Enumerated Values

Property	Value
cvssV2Severity	RECOMMENDATION
cvssV2Severity	LOW
cvssV2Severity	MEDIUM
cvssV2Severity	HIGH
cvssV2Severity	CRITICAL
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL

FindingTemplate.Template

The finding template attributes

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
description	string	false	none	Description of the entry.
remediation	string	false	none	none
impact	string	false	none	none
recreation	string	false	none	none
cwe	integer(int32)	false	none	CWE classification of the entry.
cvssV2Vector	string	false	none	none
cvssV3Vector	string	false	none	none
owaspMobile2024	integer(int32)	false	none	none
owaspApi2023	integer(int32)	false	none	none

FindingExportAsEmail

Properties

Name	Type	Required	Restrictions	Description
emailAddresses	[string]	true	none	none
comment	string	false	none	none

Attachment

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
findingId	integer(int32)	false	read-only	none
type	string	false	read-only	none
name	string	false	read-only	The name of the entry.

Enumerated Values

Property	Value
type	OTHER
type	IMAGE
type	TEXT
type	VIDEO
type	ARCHIVE

AppCheckMatch

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseMatch	false	none	The match list

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» checkId	integer(int32)	false	none	none
» vulnerabilityId	string	false	none	none
» gatheredInformation	string	false	none	none

BaseMatch

The match list

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none
service	Service	false	none	none
patternUuid	string	false	none	none

Enumerated Values

Property	Value
type	WAS
type	GATHEREDINFORMATION
type	COMPONENT
type	COMPLIANCE
type	PAC

ComplianceMatch

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseMatch	false	none	The match list

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» requirementId	integer(int32)	false	none	none
» compliant	boolean	false	none	none
» message	string	false	none	none
» error	string	false	none	none
» humanCheck	boolean	false	none	none
» faultyItems	[array]	false	none	none
» checkedAssets	[array]	false	none	none

ComponentMatch

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseMatch	false	none	The match list

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» name	string	false	none	none
» presentableName	string	false	none	none
» version	string	false	none	none

Finding

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
checkId	integer(int32)	false	none	The check id associated with the finding
findingTemplateId	integer(int32)	false	none	The finding template from which the finding was created
cvssScore	number(float)	false	read-only	The CVSS score, take CVSS V3 if available, otherwise CVSS V2
cvssSeverity	string	false	read-only	The CVSS severity, take CVSS V3 severity if available, otherwise CVSS V2
cvssV2Score	number(float)	false	read-only	The CVSS V2 score
cvssV2BaseScore	number(float)	false	read-only	The CVSS V2 base score
cvssV2TemporalScore	number(float)	false	read-only	The CVSS V2 temporal score
cvssV2EnvironmentalScore	number(float)	false	read-only	The CVSS V2 environmental score
cvssV2Vector	string	false	read-only	The CVSS V2 vector
cvssV2Severity	string	false	read-only	The CVSS V2 severity
cvssV3Score	number(float)	false	read-only	The CVSS V3 score
cvssV3BaseScore	number(float)	false	read-only	The CVSS V3 base score
cvssV3TemporalScore	number(float)	false	read-only	The CVSS V3 temporal score
cvssV3EnvironmentalScore	number(float)	false	read-only	The CVSS V3 environmental score
cvssV3Vector	string	false	read-only	The CVSS V3 vector
cvssV3Severity	string	false	read-only	The CVSS V3 severity
falsePositive	string(date-time)	false	read-only	The date when marked as false positive
falsePositiveComment	string	false	read-only	The false positive comment
isAccepted	boolean	false	read-only	Set to true when the risk is accepted
accepted	string(date-time)	false	read-only	The date when the finding was marked as accepted risk.
acceptedComment	string	false	read-only	The accepted comment
acceptedUntil	string(date-time)	false	read-only	The date when the risk acceptance will expire.
fixed	string(date-time)	false	read-only	The date when the risk was fixed
commentsCount	integer(int32)	false	read-only	The number of comments
customName	string	false	none	The custom name
customDescription	string	false	none	The custom description
customCve	string	false	none	The custom CVE
customCwe	integer(int32)	false	none	The custom CWE
customBugTraq	string	false	none	The custom bug track
customSolution	string	false	none	The custom solution
customRecreation	string	false	none	The custom recreation
customImpact	string	false	none	The custom impact
customOwaspMobile2024	integer(int32)	false	none	Custom OWASP Mobile 2024 score
customOwaspApi2023	integer(int32)	false	none	Custom OWASP API 2023 score
solutionPatches	[string]	false	none	The solution patches
customCvssV2Vector	string	false	none	The custom CVSS V2 vector
customCvssV2Severity	string	false	none	The custom CVSS V2 severity
customCvssV3Vector	string	false	none	The custom CVSS V3 vector
customCvssV3Severity	string	false	none	The custom CVSS V3 severity
source	[string]	false	read-only	The scan sources
activeSubscriptionTypes	[string]	false	read-only	The finding's active subscription types
name	string	false	read-only	The name of the entry.
description	string	false	read-only	Description of the entry.
cve	string	false	read-only	The finding CVE
cwe	string	false	read-only	CWE classification of the entry.
solutionType	string	false	read-only	The solution type
solution	string	false	read-only	The solution
solutionProduct	string	false	read-only	The solution product
solutionTitle	string	false	read-only	The solution title
solutionUuid	string	false	read-only	The solution uuid
exploitAvailable	boolean	false	read-only	Set to true when exploits are available
matchIds	[integer]	false	none	The match ids
attachmentIds	[integer]	false	read-only	The attachments ids
firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
firstScanId	integer(int32)	false	read-only	The id of the first scan
lastScanId	integer(int32)	false	read-only	The id of the last scan
lastScanConfigurationId	integer(int32)	false	read-only	The id of the last scan configuration
status	string	false	read-only	The finding status
commentPendingSince	string(date-time)	false	read-only	The date since comment is pending
reviewed	string(date-time)	false	read-only	The finding reviewed date
reviewedBy	string	false	read-only	The username of the user that reviewed the finding
reviewedById	integer(int32)	false	read-only	The user ID of the user that reviewed the finding
verified	string(date-time)	false	read-only	The finding verified date
verifiedBy	string	false	read-only	The username of the user that verified the finding
verifiedById	integer(int32)	false	read-only	The user ID of the user that verified the finding
qualityAssured	string(date-time)	false	read-only	The finding quality assured date
qualityAssuredBy	string	false	read-only	The username of the user that quality assured the finding
qualityAssuredById	integer(int32)	false	read-only	The user ID of the user that quality assured the finding
published	string(date-time)	false	read-only	The finding published date
publishedBy	string	false	read-only	The username of the user that published the finding
publishedById	integer(int32)	false	read-only	The user ID of the user that published the finding
rejected	string(date-time)	false	read-only	The finding rejected date
rejectedBy	string	false	read-only	The username of the user that rejected the finding
rejectedById	integer(int32)	false	read-only	The user ID of the user that rejected the finding
recreation	string	false	read-only	The recreation
alternativeRecreation	string	false	none	The alternate recreation
impact	string	false	none	The impact
sans25	integer(int32)	false	read-only	SANS 25 classification of the entry.
owasp2004	[integer]	false	read-only	An array of OWASP Top 10 2004 classifications of the entry.
owasp2007	[integer]	false	read-only	An array of OWASP Top 10 2007 classifications of the entry.
owasp2010	[integer]	false	read-only	An array of OWASP Top 10 2010 classifications of the entry.
owasp2013	[integer]	false	read-only	An array of OWASP Top 10 2013 classifications of the entry.
owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
owasp2021	[integer]	false	read-only	The OWASP 2021 scores
owaspMobile2024	integer(int32)	false	none	The OWASP Mobile 2024 score
owaspApi2023	integer(int32)	false	none	The OWASP API 2023 score
capec	[integer]	false	read-only	CAPEC classification of the entry.
assetId	integer(int32)	true	none	The asset id
assetName	string	false	read-only	The asset name
potential	boolean	false	none	The finding potential. Set to true when potential false positive
softwareComponent	string	false	read-only	The software component
cyrating	number(double)	false	read-only	The cyrating
cyratingDelta	number(double)	false	read-only	The cyrating delta
exploitProbability	number(double)	false	read-only	The exploit probability
exploitProbabilityDelta	number(double)	false	read-only	The exploit probability delta
cyratingUpdated	string(date-time)	false	read-only	The cyrating updated date
cyratingLastSeen	string(date-time)	false	read-only	The cyrating last seen date
seenLastScan	boolean	false	read-only	Set to true if finding was seen in last scan
watching	boolean	false	read-only	Whether the current user is watching this finding
age	integer(int32)	false	read-only	The finding's age in days since creation
assetGroupIds	[integer]	false	none	The asset group ids
sentTo	[string]	false	read-only	A list of e-mail addresses that this finding has been sent to
renderedName	string	false	read-only	Finding name derived from finding template
renderedDescription	string	false	read-only	Finding description derived from finding template
renderedCwe	integer(int32)	false	read-only	Finding CWE derived from finding template
renderedSolution	string	false	read-only	Solution derived from finding template
renderedRecreation	string	false	read-only	Finding recreation derived from finding template
renderedImpact	string	false	read-only	Finding impact derived from finding template
renderedOwaspMobile2024	integer(int32)	false	none	Finding OWASP Mobile 2024 score derived from finding template
renderedOwaspApi2023	integer(int32)	false	none	Finding OWASP API 2023 score derived from finding template
customerName	string	false	none	The customer name
enabled	boolean	false	read-only	Determines if the entry is enabled or not.
tags	[Tag]	false	read-only	The tags
bugTraq	[integer]	false	read-only	An array of Bugtraq reference IDs.
secureCodeWarrior	SecureCodeWarrior	false	none	The secure code warrior information on the vulnerability description and training
farsight	Farsight	false	none	The farsight concists in additional information on risk such as likelihood, threat activity
matches	[BaseMatch]	false	read-only	The match list
classifications	Classification.Classifications	false	none	The classifications such as CAPEC, OWASP20XX
ports	[Port]	false	read-only	Ports information on the vulnerability description

Enumerated Values

Property	Value
cvssSeverity	RECOMMENDATION
cvssSeverity	LOW
cvssSeverity	MEDIUM
cvssSeverity	HIGH
cvssSeverity	CRITICAL
cvssV2Severity	RECOMMENDATION
cvssV2Severity	LOW
cvssV2Severity	MEDIUM
cvssV2Severity	HIGH
cvssV2Severity	CRITICAL
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
customCvssV2Severity	RECOMMENDATION
customCvssV2Severity	LOW
customCvssV2Severity	MEDIUM
customCvssV2Severity	HIGH
customCvssV2Severity	CRITICAL
customCvssV3Severity	RECOMMENDATION
customCvssV3Severity	LOW
customCvssV3Severity	MEDIUM
customCvssV3Severity	HIGH
customCvssV3Severity	CRITICAL
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE
status	to review
status	to verify
status	to QA
status	to publish
status	rejected
status	present
status	accepted
status	false positive
status	pending verification
status	fixed
status	irreproducible

GatheredInformationMatch

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseMatch	false	none	The match list

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» checkId	integer(int32)	false	none	none
» gatheredInformation	string	false	none	none

Port

Ports information on the vulnerability description

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	The name of the entry.
port	integer(int32)	false	none	none
protocol	string	false	none	none

Enumerated Values

Property	Value
protocol	TCP
protocol	UDP

Service

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
scheme	string	false	none	none
port	integer(int32)	false	none	none
protocol	string	true	none	none
virtualHost	string	false	none	none

Enumerated Values

Property	Value
protocol	TCP
protocol	UDP

WasMatch

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseMatch	false	none	The match list

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» checkId	integer(int32)	false	none	none
» url	string	false	none	none
» method	string	false	none	none
» body	string	false	none	none
» auxData	[string]	false	none	none
» context	string	false	none	none
» contextStart	integer(int32)	false	none	none
» contextLength	integer(int32)	false	none	none

FindingDelta

Properties

Name	Type	Required	Restrictions	Description
firstSeen	integer(int32)	false	read-only	Timestamp when the entry was seen for the first time.
lastSeen	integer(int32)	false	read-only	Timestamp when the entry was seen last time.
unchanged	integer(int32)	false	read-only	none
asset	Asset	false	none	none

FindingSolution

Properties

Name	Type	Required	Restrictions	Description
solutionUuid	string	false	read-only	none
solutionType	string	false	read-only	none
solution	string	false	read-only	none
solutionProduct	string	false	read-only	none
solutionTitle	string	false	read-only	none
riskCount	integer(int32)	false	read-only	none
assetCount	integer(int32)	false	read-only	none
severityCount	FindingSolution.SeverityCount	false	none	none

Enumerated Values

Property	Value
solutionType	NOT_CLASSIFIED
solutionType	UNKNOWN
solutionType	RECONFIGURE
solutionType	WORKAROUND
solutionType	SOLUTION_IN_PROGRESS
solutionType	CONTACT_VENDOR
solutionType	UPDATE
solutionType	PATCH
solutionType	NOT_ACKNOWLEDGED
solutionType	NO_SOLUTION
solutionType	CONFIGURE_ACCOUNT
solutionType	DISABLE
solutionType	FILTER
solutionType	MALWARE

FindingSolution.SeverityCount

Properties

Name	Type	Required	Restrictions	Description
critical	integer(int32)	false	none	none
high	integer(int32)	false	none	none
medium	integer(int32)	false	none	none
low	integer(int32)	false	none	none
recommendation	integer(int32)	false	none	none

FindingFalsePositive

Properties

Name	Type	Required	Restrictions	Description
falsePositiveComment	string	true	none	none
sendInfo	boolean	false	none	none
clarificationRequestComment	string	false	none	none
sendBlueprint	boolean	false	none	none

FindingClarificationRequest

Properties

Name	Type	Required	Restrictions	Description
clarificationRequestComment	string	false	none	none

FindingVerificationRequest

Properties

Name	Type	Required	Restrictions	Description
verificationRequestComment	string	true	none	none

FindingAccept

Properties

Name	Type	Required	Restrictions	Description
acceptedUntil	string(date-time)	true	none	The date when the risk acceptance will expire.
acceptedComment	string	false	none	none

Globals

Properties

Name	Type	Required	Restrictions	Description
awsAccountId	string	false	read-only	none
appliance	boolean	false	read-only	none
awsAccessKeyAllowRemote	boolean	false	read-only	none

Timezone

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
gmtOffset	number(double)	true	none	none

AgentIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» agentServerUrl	string	false	none	none

BaseAuthenticationConfiguration

Properties

Name	Type	Required	Restrictions	Description
authenticationType	string	true	none	none

Enumerated Values

Property	Value
authenticationType	BASIC_AUTHENTICATION
authenticationType	OAUTH2_AUTHENTICATION

BaseIntegrationConfiguration

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none

Enumerated Values

Property	Value
type	OBJECT_STORAGE
type	AGENT
type	ENCRYPTION_SERVICE
type	EMAIL
type	WEBHOOK
type	LOG
type	SYSLOG
type	SNMP
type	CYBERARK
type	DELINEA
type	NOTIFICATION

BasicAuthenticationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseAuthenticationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» username	string	false	none	none
» password	string	false	none	none

CyberArkIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» url	string	false	none	none
» applicationId	string	false	none	none
» certificate	string	false	none	none
» defaultFolder	string	false	none	none
» defaultSafe	string	false	none	none

DelineaIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» url	string	false	none	none
» username	string	false	none	none
» password	string	false	none	none
» certificate	string	false	none	none

EncryptionServiceIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» encryptionServiceUrl	string	false	none	none

Integration

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
type	string	false	read-only	none
verified	string(date-time)	false	read-only	none
verifiedBy	string	false	read-only	none
verifiedById	integer(int32)	false	read-only	none
verifyStatus	boolean	false	read-only	none
configuration	BaseIntegrationConfiguration	true	none	none
tags	[Tag]	false	read-only	[The tags]

Enumerated Values

Property	Value
type	OBJECT_STORAGE
type	AGENT
type	ENCRYPTION_SERVICE
type	EMAIL
type	WEBHOOK
type	LOG
type	SYSLOG
type	SNMP
type	CYBERARK
type	DELINEA
type	NOTIFICATION

OauthV2AuthenticationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseAuthenticationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» requiredOauthSetting	OauthV2AuthenticationConfiguration.RequiredOauthSetting	false	none	none
» optionalOauthSetting	OauthV2AuthenticationConfiguration.OptionalOauthSetting	false	none	none
» accessToken	string	false	none	none
» accessTokenCreated	string(date-time)	false	none	none
» accessTokenExpiresIn	string(date-time)	false	none	none
» refreshToken	string	false	none	none
» authorized	boolean	false	none	none
» errorMessage	string	false	none	none

OauthV2AuthenticationConfiguration.OptionalOauthSetting

Properties

Name	Type	Required	Restrictions	Description
audience	string	false	none	none
scope	[string]	false	none	none

OauthV2AuthenticationConfiguration.RequiredOauthSetting

Properties

Name	Type	Required	Restrictions	Description
oauthApiType	string	true	none	none
authorizeUrl	string	true	none	none
tokenUrl	string	true	none	none
clientId	string	true	none	none
clientSecret	string	true	none	none

Enumerated Values

Property	Value
oauthApiType	JSON
oauthApiType	FORM_URL_ENCODED

ObjectStorageIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» s3Uri	string	false	none	none
» s3AccessKey	string	false	none	none
» s3SecretKey	string	false	none	none
» s3Certificate	string	false	none	none

SnmpIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» host	string	false	none	none
» port	integer(int32)	false	none	none
» version	integer(int32)	false	none	none
» community	string	false	none	none
» username	string	false	none	none
» authPassword	string	false	none	none
» privPassword	string	false	none	none
» engineId	string	false	none	none
» prefix	string	false	none	none

SyslogIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» host	string	false	none	none
» format	string	false	none	none
» facility	integer(int32)	false	none	none
» severity	integer(int32)	false	none	none
» port	integer(int32)	false	none	none
» transportType	string	false	none	none
» prefix	string	false	none	none
» certificate	string	false	none	none
» audit	boolean	false	none	none
» tls	boolean	false	none	none
» arcsight	boolean	false	none	none

Enumerated Values

Property	Value
format	RFC5424
format	RFC3164
format	LEGACY
transportType	TCP
transportType	UDP

WebhookIntegrationConfiguration

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseIntegrationConfiguration	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» webhookUrl	string	false	none	none
» contentSample	string	false	none	none
» serverCertificate	string	false	none	none
» httpMethod	string	false	none	none
» httpHeaders	string	false	none	none
» authenticationConfiguration	BaseAuthenticationConfiguration	false	none	none

ManagedReportGroup

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
userId	integer(int64)	false	read-only	none
name	string	true	none	The name of the entry.
parentId	integer(int64)	false	none	The ID of the parent entry.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
count	integer(int64)	false	read-only	The total number of entries associated with this entry and its child entries.

ManagedReport

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
size	integer(int32)	false	read-only	none
lastDownloaded	string(date-time)	false	read-only	none
lastDownloadedBy	string	false	read-only	none
uuid	string	false	read-only	The UUID of the entry.
tags	[Tag]	false	read-only	[The tags]

Match

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
assetId	integer(int32)	true	none	none
type	string	true	none	none
firstSeen	string(date-time)	true	none	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	true	none	Timestamp when the entry was seen last time.
firstScanId	integer(int32)	false	read-only	none
lastScanId	integer(int32)	false	read-only	none
findingIds	[integer]	false	read-only	none
source	[string]	true	none	none
subscriptionType	string	false	none	none
match	BaseMatch	false	none	The match list
tags	[Tag]	false	read-only	[The tags]

Enumerated Values

Property	Value
type	WAS
type	GATHEREDINFORMATION
type	COMPONENT
type	COMPLIANCE
type	PAC
subscriptionType	DAST
subscriptionType	SCALE
subscriptionType	SCOUT
subscriptionType	SNAPSHOT
subscriptionType	ASSURE
subscriptionType	DAST_EXPERT
subscriptionType	VERIFY
subscriptionType	SWAT
subscriptionType	CLOUDSEC
subscriptionType	NETSEC
subscriptionType	CONSUMPTION

Notification

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
userId	integer(int64)	false	none	none
subUserId	integer(int64)	false	none	none
eventSubscriptionId	integer(int32)	false	none	none
read	string(date-time)	false	none	none
content	Notification.Content	false	none	none

Notification.Content

Properties

Name	Type	Required	Restrictions	Description
subject	string	true	none	none
message	string	false	none	none
trigger	string	true	none	none
entityType	string	false	none	none
entityId	integer(int32)	false	none	none
subEntityType	string	false	none	none
subEntityId	integer(int32)	false	none	none

Enumerated Values

Property	Value
trigger	SCHEDULE_CREATED
trigger	SCHEDULE_DELETED
trigger	SCHEDULE_MODIFIED
trigger	SCHEDULE_SCHEDULED
trigger	CONFIGURATION_CREATED
trigger	CONFIGURATION_DELETED
trigger	CONFIGURATION_MODIFIED
trigger	CONFIGURATION_STARTED
trigger	CONFIGURATION_DONE
trigger	SCAN_STARTED
trigger	SCAN_STOPPED
trigger	SCAN_DONE
trigger	ASSET_NOT_RECENTLY_SEEN
trigger	ASSET_SEEN
trigger	ASSET_CREATED
trigger	ASSET_DELETED
trigger	ASSET_MODIFIED
trigger	FINDING_SEEN
trigger	FINDING_CREATED
trigger	FINDING_MODIFIED
trigger	FINDING_STATUS_TRANSITIONED
trigger	FINDING_RISK_ACCEPTED_EXPIRATION
trigger	WATCHED_FINDING_UPDATED
trigger	USER_CREATED
trigger	USER_DELETED
trigger	USER_MODIFIED
trigger	USER_LOGIN_ATTEMPT
trigger	USER_PASSWORD_RESET
trigger	ROLE_CREATED
trigger	ROLE_DELETED
trigger	ROLE_MODIFIED
trigger	RESOURCE_GROUP_CREATED
trigger	RESOURCE_GROUP_DELETED
trigger	RESOURCE_GROUP_MODIFIED
trigger	NEW_RELEASE_NOTES
trigger	HIAB_SCANNER_MISSING
trigger	HIAB_UPDATE_DONE
trigger	HIAB_UPDATE_FAILED
trigger	HIAB_BACKUP_DONE
trigger	HIAB_BACKUP_FAILED
trigger	HIAB_MAINTENANCE_PLAN_DONE
trigger	HIAB_DISK_USAGE_HIGH
trigger	HIAB_REBOOTED
trigger	HIAB_REMOTE_SUPPORT
trigger	OUTSCAN_CONSULTANCY
trigger	CONSUMPTION_ABSOLUTE
trigger	CONSUMPTION_RELATIVE
trigger	WORKFLOW_CREATED
trigger	WORKFLOW_DELETED
trigger	WORKFLOW_MODIFIED
trigger	WORKFLOW_STARTED
trigger	WORKFLOW_DONE
trigger	COMPLIANCE_CREATED
trigger	COMPLIANCE_MODIFIED
trigger	COMPLIANCE_RISK_EXCEPTION
trigger	COMPLIANCE_RISK_EXCEPTION_EXPIRATION
trigger	COMMENT_CREATED
trigger	EXECUTIVE_SUMMARY_UPDATED
trigger	ACTIVITY_FEED_UPDATED
trigger	ASSET_GROUP_CREATED
trigger	ASSET_GROUP_DELETED
trigger	ASSET_GROUP_MODIFIED
entityType	FINDING
entityType	ASSET_GROUP
entityType	ASSET
entityType	SCAN_CONFIGURATION
entityType	SCHEDULE
entityType	SCAN
entityType	USER
entityType	ROLE
entityType	RESOURCE_GROUP
entityType	COMPLIANCE
entityType	WORKFLOW
entityType	CHECK
subEntityType	COMMENT
subEntityType	ATTACHMENT
subEntityType	ACTIVITY

Organization

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
uuid	string	false	read-only	The UUID of the entry.
name	string	false	read-only	The name of the entry.

OutscanFinding

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
scanJobId	integer(int64)	false	read-only	none
scanLogId	integer(int64)	false	read-only	none
scheduleId	integer(int64)	false	read-only	none
templateId	integer(int64)	false	read-only	none
cvssScore	number(double)	false	read-only	none
cvssV3Score	number(double)	false	read-only	none
cvssV3Severity	string	false	read-only	none
cvssV3Vector	string	false	read-only	none
firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
reportDate	string(date-time)	false	read-only	none
targetId	integer(int64)	false	read-only	none
target	string	false	read-only	none
hostname	string	false	read-only	none
port	integer(int64)	false	read-only	none
protocol	integer(int64)	false	read-only	none
name	string	false	read-only	The name of the entry.
source	[string]	false	read-only	none
cve	string	false	read-only	none
vulnId	integer(int64)	false	read-only	none
isNew	boolean	false	read-only	none
previouslyDetected	boolean	false	read-only	none
type	string	false	read-only	none
isPotentialFalsePositive	boolean	false	read-only	none
productName	string	false	read-only	none
productUrl	string	false	read-only	none
solutionProduct	string	false	read-only	none
checkCreated	string(date-time)	false	read-only	none
hasExploits	boolean	false	read-only	none
solution	string	false	read-only	none
businessCriticality	string	false	read-only	none
assetBusinessCriticality	string	false	read-only	none
solutionTitle	string	false	read-only	none
created	string(date-time)	false	read-only	The timestamp when the entry was created.
cyrating	number(double)	false	read-only	none
cyratingDelta	number(double)	false	read-only	none
cyratingUpdated	string(date-time)	false	read-only	none
cyratingLastSeen	string(date-time)	false	read-only	none
exploitProbability	number(double)	false	read-only	none
exploitProbabilityDelta	number(double)	false	read-only	none
assetExposed	boolean	false	read-only	none
owasp2017	[integer]	false	read-only	An array of OWASP Top 10 2017 classifications of the entry.
isAccepted	boolean	false	read-only	none
patchInformation	string	false	read-only	none
cvssVector	string	false	none	none
virtualHost	string	false	none	none
platform	string	false	none	none
bugTraq	[integer]	false	none	An array of Bugtraq reference IDs.
serviceName	string	false	none	none
riskLevel	string	false	none	none
solutionType	string	false	none	none
age	integer(int32)	false	none	none
data	string	false	none	none
description	string	false	read-only	Description of the entry.
farsight	Farsight	false	none	The farsight concists in additional information on risk such as likelihood, threat activity
acceptExpires	string(date-time)	false	read-only	none
acceptedBy	string	false	read-only	The name of the user who accepted the risk.
acceptDate	string(date-time)	false	read-only	none
acceptComment	string	false	read-only	none

Enumerated Values

Property	Value
cvssV3Severity	RECOMMENDATION
cvssV3Severity	LOW
cvssV3Severity	MEDIUM
cvssV3Severity	HIGH
cvssV3Severity	CRITICAL
businessCriticality	LOW
businessCriticality	MEDIUM
businessCriticality	HIGH
businessCriticality	CRITICAL
assetBusinessCriticality	LOW
assetBusinessCriticality	MEDIUM
assetBusinessCriticality	HIGH
assetBusinessCriticality	CRITICAL
riskLevel	Initial
riskLevel	Recommendation
riskLevel	Low
riskLevel	Medium
riskLevel	High
riskLevel	Critical
solutionType	Unspecified
solutionType	Unknown
solutionType	Reconfigure
solutionType	Workaround
solutionType	InProgress
solutionType	Contact
solutionType	Update
solutionType	Patch
solutionType	Unack
solutionType	NoSol
solutionType	Account
solutionType	Disable
solutionType	Filter
solutionType	Malware

OutscanScanLog

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
startDate	string(date-time)	false	read-only	none
endDate	string(date-time)	false	read-only	none
target	string	false	read-only	none
targetId	integer(int64)	false	read-only	none
schedule	string	false	read-only	none
scheduleId	integer(int64)	false	read-only	none
scanJobId	integer(int64)	false	read-only	none
status	string	false	none	none

Enumerated Values

Property	Value
status	Invalid
status	Ok
status	Forced
status	Timeout
status	Stopped
status	StoppedByUser
status	Large
status	KilledLarge
status	Failed

OutscanScan

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
target	string	false	read-only	none
targetId	integer(int64)	false	read-only	none
scheduleId	integer(int64)	false	read-only	none
status	string	false	read-only	none
scanStarted	string(date-time)	false	read-only	none
scanJobId	integer(int64)	false	read-only	none

OutscanSchedule

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
nextScanDate	string(date-time)	false	none	none
template	integer(int64)	false	none	none
name	string	true	none	The name of the entry.
targetList	string	true	none	none
recurrence	string	false	none	none

Enumerated Values

Property	Value
recurrence	Now
recurrence	Once
recurrence	Weekly
recurrence	Monthly
recurrence	Bimonthly
recurrence	Quarterly
recurrence	Fortnightly
recurrence	Daily

OutscanTarget

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
ip	string	false	read-only	none
hostname	string	false	read-only	none
businessCriticality	string	false	read-only	none
exposed	boolean	false	read-only	none
created	string(date-time)	false	read-only	The timestamp when the entry was created.
firstSeen	string(date-time)	false	read-only	Timestamp when the entry was seen for the first time.
lastSeen	string(date-time)	false	read-only	Timestamp when the entry was seen last time.
source	[string]	false	read-only	none

Enumerated Values

Property	Value
businessCriticality	LOW
businessCriticality	MEDIUM
businessCriticality	HIGH
businessCriticality	CRITICAL

PasswordRecoveryRequest

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	none

ProductInformation

Properties

Name	Type	Required	Restrictions	Description
product	string	false	read-only	none
name	string	false	read-only	The name of the entry.
url	string	false	read-only	none
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.

ReportSchedule

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
userId	integer(int64)	false	read-only	none
subUserId	integer(int64)	false	read-only	none
frequency	integer(int32)	false	none	none
nextDate	string(date-time)	false	none	none
latestDate	string(date-time)	false	read-only	none
lastDate	string(date-time)	false	none	none
dayWeekMonth	integer(int32)	false	none	none
name	string	true	none	The name of the entry.
reportType	integer(int32)	false	none	none
format	integer(int32)	false	none	none
zip	boolean	false	none	none
recipient	[integer]	false	none	none
recipientEmail	string	false	none	none
encryptionKey	string	true	none	none
managedReportTitle	string	false	none	none
managedReportGroup	integer(int64)	false	none	none
managedReportToken	string	false	none	none
scanType	integer(int32)	false	none	none
recipientType	integer(int32)	false	none	none
reportPassword	string	false	none	none
reportLevel	integer(int32)	false	none	none
customSubject	string	false	none	none
customText	string	false	none	none

ReportCacheEntry

Properties

Name	Type	Required	Restrictions	Description
created	string(date-time)	false	read-only	The timestamp when the entry was created.
key	string	false	read-only	none
status	string	false	read-only	none
size	integer(int64)	false	read-only	none
token	string	false	read-only	none
tokenExpires	string(date-time)	false	read-only	none
name	string	false	read-only	The name of the entry.

Report

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
executiveSummary	boolean	false	none	none
format	string	true	none	none
password	string	false	none	none
zip	boolean	false	none	none
type	string	true	none	none
level	string	false	none	none
product	string	false	none	none
viewTemplateId	integer(int32)	false	none	none
assetIds	[integer]	false	none	none
assetGroupIds	[integer]	false	none	none
findingIds	[integer]	false	none	none
assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
serviceIds	[integer]	false	none	none
tagIds	[integer]	false	none	none
startDate	string(date-time)	false	none	none
endDate	string(date-time)	false	none	none
filters	string	false	none	none
deliveryMethod	DeliveryMethod	false	none	none

Enumerated Values

Property	Value
format	PDF
format	EXCEL
format	XML
format	SWATDEMO
type	Technical
type	Trend
type	GroupVulnerability
type	Delta
type	Pci
type	WasDiscovery
type	Discovery
type	SolutionTaskReport
type	SolutionTargetReport
type	GroupTrending
type	GroupDelta
type	Compliance
type	Consumption
level	Detailed
level	Management
level	Summary
product	Normal
product	Pci
product	Was
product	SWAT
product	Compliance
product	Appsec Scale
product	APPSEC
product	CLOUDSEC

Resource

The resource group resources

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	The resource type
tagIds	[integer]	false	none	The resource tag ids

Enumerated Values

Property	Value
type	SCANCONFIGURATION
type	ACCOUNT
type	SCHEDULEDREPORT
type	MANAGEDREPORT
type	DASHBOARD
type	INTEGRATION
type	ASSETGROUP
type	ASSET
type	APPSTAK
type	VIEWTEMPLATE
type	EVENTSUBSCRIPTION
type	SCANPOLICY
type	FINDINGTEMPLATE

ResourceGroup

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
system	boolean	false	read-only	Set to true when resource group is system resource group
resources	[Resource]	false	none	The resource group resources

PatternMatch

Properties

Name	Type	Required	Restrictions	Description
request	PatternMatch.Request	false	none	none
match	PatternMatch.Match	true	none	none

PatternMatch.Match

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
version	string	false	none	none
context	string	false	none	none
patternUuid	string	false	none	none

PatternMatch.Request

Properties

Name	Type	Required	Restrictions	Description
method	string	false	none	none
url	string	false	none	none

ScanConfigurationGroup

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
parentId	integer(int32)	false	none	The ID of the parent entry.
count	integer(int64)	false	read-only	The total number of entries associated with this entry and its child entries.

AgentScanConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» assetTagIds	[integer]	false	none	none
» scanRecurrence	integer(int32)	false	none	none

BaseCloudConfigurationTemplate

Properties

Name	Type	Required	Restrictions	Description
cloudDiscoveryType	string	false	none	none

Enumerated Values

Property	Value
cloudDiscoveryType	AWS
cloudDiscoveryType	AZURE

BaseScanConfigurationTemplate

The scan configuration

Properties

Name	Type	Required	Restrictions	Description
template	string	true	none	none

Enumerated Values

Property	Value
template	SCOUT
template	SCALE
template	SWAT
template	CLOUDSEC
template	NETWORK_SCAN
template	DOCKER_SCAN
template	DOCKER_DISCOVERY
template	NETWORK_DISCOVERY
template	CLOUD_DISCOVERY
template	AGENT_SCAN
template	WORKFLOW

CloudDiscoveryAwsConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseCloudConfigurationTemplate	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» regions	string	false	none	none

CloudDiscoveryAzureConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseCloudConfigurationTemplate	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» subscriptions	string	false	none	none

CloudDiscoveryConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» timeout	integer(int32)	false	none	none
» accountId	integer(int32)	false	none	none
» updateAssets	boolean	false	none	none
» importExternalTags	boolean	false	none	none
» externalTagKeys	[string]	false	none	none
» addTagIds	[integer]	false	none	none
» replaceTagIds	[integer]	false	none	none
» cloudConfiguration	BaseCloudConfigurationTemplate	false	none	none

CloudsecScanConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» accountId	integer(int32)	false	none	none
» policyId	integer(int32)	false	none	none
» regions	string	false	none	none

DockerDiscoveryScanConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» accountId	integer(int32)	false	none	none

DockerScanConfigurationTemplate

Properties

None

NetworkDiscoveryConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» timeout	integer(int32)	false	none	none
» targetList	string	false	none	none
» ignoreTargetList	string	false	none	none
» protocols	[string]	false	none	none
» tcpPorts	string	false	none	none
» reportFilters	string	false	none	none
» updateAssets	boolean	false	none	none
» addTagIds	[integer]	false	none	none
» replaceTagIds	[integer]	false	none	none

NetworkScanConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» scanPolicyId	integer(int32)	false	none	none
» overrideScanPolicyId	integer(int32)	false	none	none
» assetTagIds	[integer]	false	none	none
» timeout	integer(int32)	false	none	none
» scanless	boolean	false	none	none

ScaleScanConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» nseconds	integer(int32)	false	none	none
» fuzzing	boolean	false	none	none
» sequential	boolean	false	none	none
» seeds	[string]	false	none	none
» clientCertificateAuth	ScaleScanConfigurationTemplate.ClientCertificate	false	none	none
» abortPattern	string	false	none	none
» mustMatch	[ScaleScanConfigurationTemplate.RequestFilter]	false	none	none
» cannotMatch	[ScaleScanConfigurationTemplate.RequestFilter]	false	none	none
» allowedDomains	[ScaleScanConfigurationTemplate.AllowedDomain]	false	none	none
» addrBlacklist	[string]	false	none	none
» setupProc	string	false	none	none
» setupProcVariables	object	false	none	none
»» additionalProperties	string	false	none	none
» basicAuth	[ScaleScanConfigurationTemplate.BasicAuthCredentials]	false	none	none
» hostMap	[ScaleScanConfigurationTemplate.HostMap]	false	none	none
» userAgent	string	false	none	none
» maxIvs	integer(int32)	false	none	none
» sideScript	string	false	none	none
» infrastructureScan	boolean	false	none	none
» spaCrawling	boolean	false	none	none

ScaleScanConfigurationTemplate.AllowedDomain

Properties

Name	Type	Required	Restrictions	Description
domain	string	true	none	none
allow-subdomains	boolean	false	none	none

ScaleScanConfigurationTemplate.BasicAuthCredentials

Properties

Name	Type	Required	Restrictions	Description
user	string	true	none	none
password	string	true	none	none
url-prefix	string	false	none	none

ScaleScanConfigurationTemplate.ClientCertificate

Properties

Name	Type	Required	Restrictions	Description
client-certificate	string	false	none	none
private-key	string	false	none	none
passphrase	string	false	none	none

ScaleScanConfigurationTemplate.HostMap

Properties

Name	Type	Required	Restrictions	Description
from	string	true	none	none
to	[string]	true	none	none

ScaleScanConfigurationTemplate.RequestFilter

Properties

Name	Type	Required	Restrictions	Description
method	string	false	none	none
url	string	false	none	none
body	string	false	none	none
body-type	string	false	none	none

ScanConfiguration

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
template	string	false	read-only	The scan template
groupId	integer(int32)	false	none	The scan group id
scheduleIds	[integer]	false	read-only	The schedule ids associated with this scan configuration
assetIdentifierIds	[integer]	false	none	An array of asset identifier IDs associated with this entry
assetIds	[integer]	false	none	The asset IDs associated with this scan configuration
workflowId	integer(int32)	false	none	The workflow ID associated with this scan configuration
enabled	boolean	false	none	Determines if the entry is enabled or not.
scannerId	integer(int32)	false	none	The scanner id
nextOccurrence	string(date-time)	false	read-only	The scan next occurrence date
lastScan	string(date-time)	false	read-only	Last time a scan was performed using this configuration
configuration	BaseScanConfigurationTemplate	true	none	The scan configuration
tags	[Tag]	false	read-only	The tags

Enumerated Values

Property	Value
template	SCOUT
template	SCALE
template	SWAT
template	CLOUDSEC
template	NETWORK_SCAN
template	DOCKER_SCAN
template	DOCKER_DISCOVERY
template	NETWORK_DISCOVERY
template	CLOUD_DISCOVERY
template	AGENT_SCAN
template	WORKFLOW

SwatScanConfigurationTemplate

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	BaseScanConfigurationTemplate	false	none	The scan configuration

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» seedUrls	[string]	false	none	none
» stopAfterSeconds	integer(int32)	false	none	none
» crawlScope	SwatScanConfigurationTemplate.Scope	false	none	none
» httpScope	SwatScanConfigurationTemplate.Scope	false	none	none
» nFetchers	integer(int32)	false	none	none
» cookiesTxt	string	false	none	none
» httpBodyLimit	integer(int32)	false	none	none
» httpBlockedMimeBodies	[string]	false	none	none
» depthLimit	integer(int32)	false	none	none
» abortPattern	string	false	none	none

SwatScanConfigurationTemplate.AllowedDomain

Properties

Name	Type	Required	Restrictions	Description
domain	string	false	none	none
allow-subdomains	boolean	false	none	none

SwatScanConfigurationTemplate.CountedRequestPattern

Properties

Name	Type	Required	Restrictions	Description
pattern	SwatScanConfigurationTemplate.RequestPattern	false	none	none
limit	integer(int32)	false	none	none

SwatScanConfigurationTemplate.RequestPattern

Properties

Name	Type	Required	Restrictions	Description
method	string	false	none	none
url	string	false	none	none
body	string	false	none	none
body-type	string	false	none	none

SwatScanConfigurationTemplate.Scope

Properties

Name	Type	Required	Restrictions	Description
must-match	[SwatScanConfigurationTemplate.RequestPattern]	false	none	none
cannot-match	[SwatScanConfigurationTemplate.RequestPattern]	false	none	none
allowed-domains	[SwatScanConfigurationTemplate.AllowedDomain]	false	none	none
n-matches	[SwatScanConfigurationTemplate.CountedRequestPattern]	false	none	none

TestSetupScript

Properties

Name	Type	Required	Restrictions	Description
script	string	false	none	none
blacklist	[string]	false	none	none
hostmap	[ScaleScanConfigurationTemplate.HostMap]	false	none	none

ScanPolicySettings

Properties

Name	Type	Required	Restrictions	Description
safeOnly	boolean	false	none	none
tryDefaultCredentials	boolean	false	none	none
ignoreFallbackKernels	boolean	false	none	none
useDiscoveredCredentials	boolean	false	none	none
virtualHostsIp	boolean	false	none	none
virtualHostsHostName	boolean	false	none	none
virtualHostsReverseDns	boolean	false	none	none
speed	string	false	none	none
portsTcp	string	false	none	none
portsUdp	string	false	none	none
netstatCheck	string	false	none	none
regularPortScanFallback	boolean	false	none	none
authenticatedScanSshPort	integer(int32)	false	none	none
trustedCasPem	string	false	none	none
useCustomCredentials	boolean	false	none	none
enableRemoteRegistry	boolean	false	none	none

ScanPolicy

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
system	boolean	false	read-only	none
accountIds	[integer]	false	none	none
settings	ScanPolicySettings	false	none	none
tags	[Tag]	false	read-only	[The tags]

Scanner

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
userId	integer(int64)	false	read-only	none
name	string	true	none	The name of the entry.
ipaddress	string	true	none	none
mode	integer(int32)	false	none	none
approved	boolean	false	none	none
inactive	boolean	false	none	none
useProxy	boolean	false	none	none
polling	boolean	false	read-only	none
serverStatus	string	false	read-only	none
lastConnection	string(date-time)	false	read-only	none
lastUpdate	string(date-time)	false	read-only	none
version	string	false	read-only	none
uiVersion	string	false	read-only	none
scannerVersion	string	false	read-only	none
appsecScaleScanner	boolean	false	read-only	none
groupId	integer(int64)	false	none	none
groupName	string	false	none	none
isOutpost	boolean	false	read-only	none
isAwsScanner	boolean	false	read-only	none
scanningDisabled	boolean	false	read-only	none
isGroup	boolean	false	none	none
performUpdate	boolean	false	read-only	none
hwAddr	string	false	read-only	none
hmacKey	string	false	read-only	none
rulesVersion	string(date-time)	false	read-only	none

ScanLog

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
jobId	string	false	none	The id of the scan job
status	string	true	none	The scan status
statusDetails	string	false	none	The scan status details
source	string	true	none	The scan source
scanConfigurationId	integer(int32)	false	none	The id of the scan configuration
scanConfigurationName	string	false	read-only	The name of the scan configuration
workflowId	integer(int32)	false	none	The id of the workflow
workflowName	string	false	read-only	The name of the workflow
started	string(date-time)	false	none	The scan started date
ended	string(date-time)	false	none	The scan ended date
expectedStart	string(date-time)	false	read-only	The scan expected start date
expectedEnd	string(date-time)	false	read-only	The scan expected end date
blueprintAvailable	boolean	false	read-only	Set to true when scan blueprint is available
assetIdentifierId	integer(int32)	false	none	The ID of the asset identifier associated with this entry
assetIdentifierType	string	false	read-only	The type of asset on which the scan is performed
assetIdentifierName	string	false	read-only	The name of asset on which the scan is performed
assetId	integer(int32)	false	none	The id of asset on which the scan is performed
assetName	string	false	read-only	The name of asset on which the scan is performed
latestRuleDate	string(date-time)	false	none	The latest rule date taken into account to perform the scan
scanless	boolean	false	none	Set to true when scan is scanless (eg only detection performed)
parentId	integer(int32)	false	none	The ID of the parent entry.
scheduleId	integer(int32)	false	none	The schedule id when scan triggered by a schedule.
tags	[Tag]	false	read-only	The tags

Enumerated Values

Property	Value
status	QUEUED
status	PENDING
status	STARTING
status	RUNNING
status	STOPPING
status	STOPPED
status	REPORTING
status	FINISHED
status	ISSUES
status	FAILED
source	SCOUT
source	SCALE
source	SWAT
source	CLOUDSEC
source	NETWORK_SCAN
source	DOCKER_SCAN
source	DOCKER_DISCOVERY
source	NETWORK_DISCOVERY
source	CLOUD_DISCOVERY
source	AGENT_SCAN
source	WORKFLOW
assetIdentifierType	IP
assetIdentifierType	HOSTNAME
assetIdentifierType	AWS_ACCOUNT_ID
assetIdentifierType	AWS_INSTANCE_ID
assetIdentifierType	AWS_REGION
assetIdentifierType	MAC
assetIdentifierType	NETBIOS
assetIdentifierType	GCP_PROJECT_ID
assetIdentifierType	MAZ_TENANT_ID
assetIdentifierType	MAZ_SUBSCRIPTION
assetIdentifierType	MAZ_RESOURCE_GROUP
assetIdentifierType	MAZ_RESOURCE
assetIdentifierType	DOCKER_REGISTRY
assetIdentifierType	DOCKER_IMAGE
assetIdentifierType	SEED_PATH
assetIdentifierType	AGENT
assetIdentifierType	SERIAL_MACHINE_ID
assetIdentifierType	SERIAL_PRODUCT_ID
assetIdentifierType	SERIAL_DISK_ID

ScanLogMetadata

Properties

Name	Type	Required	Restrictions	Description
schema	string	false	read-only	none
attacker	string	false	read-only	none

ScheduledReport

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
enabled	boolean	false	none	Determines if the entry is enabled or not.
lastSent	string(date-time)	false	read-only	none
scheduleIds	[integer]	false	read-only	none
nextOccurrence	string(date-time)	false	read-only	none
workflowId	integer(int32)	false	none	The workflow ID associated with this report
deliveryMethod	DeliveryMethod	true	none	none
scope	ScheduledReport.Scope	true	none	none
report	ScheduledReport.Report	true	none	none
tags	[Tag]	false	read-only	[The tags]

ScheduledReport.Report

Properties

Name	Type	Required	Restrictions	Description
formats	[string]	true	none	none
type	string	true	none	none
viewTemplateId	integer(int32)	false	none	none
viewTemplateName	string	false	none	none
level	string	false	none	none
product	string	false	none	none
password	string	false	none	none
executiveSummary	boolean	false	none	none
zip	boolean	false	none	none
timeFrame	string	false	none	none
startDate	string(date-time)	false	none	none
endDate	string(date-time)	false	none	none

Enumerated Values

Property	Value
type	Technical
type	Trend
type	GroupVulnerability
type	Delta
type	Pci
type	WasDiscovery
type	Discovery
type	SolutionTaskReport
type	SolutionTargetReport
type	GroupTrending
type	GroupDelta
type	Compliance
type	Consumption
level	Detailed
level	Management
level	Summary
product	Normal
product	Pci
product	Was
product	SWAT
product	Compliance
product	Appsec Scale
product	APPSEC
product	CLOUDSEC
timeFrame	LAST_DAY
timeFrame	LAST_WEEK
timeFrame	LAST_MONTH
timeFrame	LAST_QUARTER
timeFrame	LAST_YEAR
timeFrame	CUSTOM
timeFrame	ALL_TIME

ScheduledReport.Scope

Properties

Name	Type	Required	Restrictions	Description
assetIds	[integer]	false	none	none
assetGroupIds	[integer]	false	none	none
tagIds	[integer]	false	none	none

Schedule

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
enabled	boolean	false	none	Determines if the entry is enabled or not.
frequency	string	true	none	The schedule frequency
interval	integer(int32)	true	none	The schedule interval
weekdays	[string]	false	none	The schedule weekdays set what weekdays have been selected for recurrence
days	[integer]	false	none	The schedule days set what days have been selected for recurrence
nthDays	[integer]	false	none	The schedule nthDays set what ordinal days have been selected for recurrence
weeks	[integer]	false	none	The schedule weeks set what weeks have been selected for recurrence
months	[string]	false	none	The schedule months set what months have been selected for recurrence
remainingOccurrences	integer(int32)	false	none	The schedule remaining occurrences
scanConfigurationIds	[integer]	false	read-only	The scan configuration IDs associated with this schedule
workflowIds	[integer]	false	read-only	The workflow IDs associated with this schedule
scheduledReportIds	[integer]	false	read-only	The report IDs associated with this schedule
timezone	string	false	none	The schedule time zone
scanWindowDuration	integer(int32)	false	none	The schedule scan window duration.
startsFrom	string(date-time)	true	none	The schedule starts from date
until	string(date-time)	false	none	The schedule until date
nextOccurrence	string(date-time)	false	read-only	The schedule next occurrence date
blockedTimeSlots	Schedule.BlockedTimeSlots	false	none	The schedule blocked time slots

Enumerated Values

Property	Value
frequency	NONE
frequency	ONCE
frequency	HOURLY
frequency	DAILY
frequency	WEEKLY
frequency	MONTHLY
frequency	YEARLY

Schedule.BlockedTimeSlots

The schedule blocked time slots

Properties

Name	Type	Required	Restrictions	Description
monday	[integer]	false	none	none
tuesday	[integer]	false	none	none
wednesday	[integer]	false	none	none
thursday	[integer]	false	none	none
friday	[integer]	false	none	none
saturday	[integer]	false	none	none
sunday	[integer]	false	none	none

ScopingInformation

Properties

Name	Type	Required	Restrictions	Description
targetSolution	string	true	none	none
targetStartDate	string(date-time)	true	none	none
assetIdentifierIds	[integer]	true	none	An array of asset identifier IDs associated with this entry
adminUrls	[string]	false	none	none
outOfScopeUrls	[string]	false	none	none
knownSensitiveFunctionality	string	false	none	none
rolesAndCredentials	string	false	none	none
componentsAndTechnologies	string	false	none	none
focusAreas	string	false	none	none

Enumerated Values

Property	Value
targetSolution	Appsec SWAT
targetSolution	Appsec Snapshot
targetSolution	Appsec Assure

ChangePasswordRequest

Properties

Name	Type	Required	Restrictions	Description
password	string	true	none	none
oldPassword	string	true	none	none

SubUser

Properties

Name	Type	Required	Restrictions	Description
timezone	string	false	none	The user time zone
portalPreferences	string	false	none	The user portal preferences
customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
id	integer(int64)	false	read-only	The ID of the entry.
subUser	boolean	false	read-only	none
username	string	true	none	none
firstName	string	true	none	none
lastName	string	true	none	none
email	string	true	none	none
emailEncryptionKey	string	false	none	none
countryCode	string	false	none	none
stateCode	string	false	none	none
parentId	integer(int64)	false	read-only	The ID of the parent entry.
mobilePhone	string	false	none	none
lastLogonIp	string	false	read-only	none
lastLogonDate	string(date-time)	false	read-only	none
logons	integer(int64)	false	read-only	none
language	string	false	none	none
twoFactorCode	string	false	none	none
subParentId	integer(int64)	false	none	none
superUser	boolean	false	none	none
snapshotSubscriptions	integer(int64)	false	read-only	none
snapshotSubscriptionsRemaining	integer(int64)	false	read-only	none
swatSubscriptions	integer(int64)	false	read-only	none
swatSubscriptionsRemaining	integer(int64)	false	read-only	none
userRoleIds	[integer]	false	none	none
resourceGroupIds	[integer]	false	none	none
userRolePermissions	[string]	false	read-only	none
allowedCustomerTagIds	[integer]	false	none	none
roles	string	false	read-only	The user's roles
pgpPublicKey	string	false	none	This user's PGP public key
twoFactorType	string	false	none	The sub-user's two-factor authentication type
tags	[Tag]	false	read-only	[The tags]
allowedCustomerTags	[Tag]	false	read-only	The allowed customer tags
twoFactorSecret	string	false	none	The sub-user's two-factor secret

Enumerated Values

Property	Value
twoFactorType	ANY
twoFactorType	NONE
twoFactorType	SMS
twoFactorType	TOTP

SubscriptionAudit

Properties

Name	Type	Required	Restrictions	Description
id	integer(int64)	false	read-only	The ID of the entry.
action	string	false	read-only	none
time	string(date-time)	false	read-only	none
ip	string	false	read-only	none
comment	string	false	read-only	none
username	string	false	read-only	none
customerName	string	false	read-only	none

SubscriptionTemplate

Properties

Name	Type	Required	Restrictions	Description
uuid	string	false	none	The UUID of the entry.
name	string	true	none	The name of the entry.
organization	SubscriptionTemplate.Organization	true	none	none
variables	string	false	none	none
template	string	true	none	none
created	string(date-time)	false	none	The timestamp when the entry was created.
createdBy	string	false	none	The name of the user who created the entry.
updated	string(date-time)	false	none	The timestamp when the entry was updated.
updatedBy	string	false	none	The name of the user who updated the entry.

SubscriptionTemplate.Organization

Properties

Name	Type	Required	Restrictions	Description
uuid	string	true	none	The UUID of the entry.

SubscriptionTemplateVariable

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	The subscription template variable name
description	string	false	none	Description of the entry.

SubscriptionTemplatePreviewRequest

Properties

Name	Type	Required	Restrictions	Description
variables	string	false	none	none
template	string	true	none	none

SubscriptionReport

Properties

Name	Type	Required	Restrictions	Description
customerIds	[integer]	true	none	none
startDate	string(date-time)	true	none	none
endDate	string(date-time)	true	none	none

Summary

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
content	string	false	none	none
assetGroupId	integer(int32)	true	none	none
swatScheduleId	integer(int64)	false	none	none
reviewed	string(date-time)	false	none	none
reviewedBy	string	false	none	none
reviewedById	integer(int32)	false	none	none
qualityAssured	string(date-time)	false	none	none
qualityAssuredBy	string	false	none	none
qualityAssuredById	integer(int32)	false	none	none
published	string(date-time)	false	none	none
publishedBy	string	false	none	none
publishedById	integer(int32)	false	none	none
rejected	string(date-time)	false	none	none
rejectedBy	string	false	none	none
rejectedById	integer(int32)	false	none	none
status	string	false	none	none

Enumerated Values

Property	Value
status	PENDING_REVIEW
status	PENDING_QA
status	PENDING_PUBLICATION
status	PUBLISHED
status	REJECTED

SummaryTransitionRequest

Properties

Name	Type	Required	Restrictions	Description
transitionTo	string	true	none	none
transitionBy	string	false	none	none
transitionById	integer(int32)	false	none	none

Enumerated Values

Property	Value
transitionTo	PENDING_REVIEW
transitionTo	PENDING_QA
transitionTo	PENDING_PUBLICATION
transitionTo	PUBLISHED
transitionTo	REJECTED

TagStatistic

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
key	string	false	read-only	none
value	string	false	read-only	none
statistics	TagStatistic.Statistics	false	none	none

TagStatistic.Statistics

Properties

Name	Type	Required	Restrictions	Description
accounts	integer(int32)	false	none	none
assetGroups	integer(int32)	false	none	none
assets	integer(int32)	false	none	none
assetIdentifiers	integer(int32)	false	none	none
eventSubscriptions	integer(int32)	false	none	none
managedReports	integer(int32)	false	none	none
scheduledReports	integer(int32)	false	none	none
complianceFindings	integer(int32)	false	none	none
findings	integer(int32)	false	none	none
scanConfigurations	integer(int32)	false	none	none
workflows	integer(int32)	false	none	none
dashboards	integer(int32)	false	none	none
integrations	integer(int32)	false	none	none
scanPolicies	integer(int32)	false	none	none
viewTemplates	integer(int32)	false	none	none
users	integer(int32)	false	none	none
scanConfigurationSettings	integer(int32)	false	none	none
scheduledReportSettings	integer(int32)	false	none	none
resourceGroupSettings	integer(int32)	false	none	none

TagsTransformation

Properties

Name	Type	Required	Restrictions	Description
objects	TagsTransformation.Objects	false	none	none
from	TagsTransformation.ToFrom	false	none	none
to	TagsTransformation.ToFrom	false	none	none

TagsTransformation.Objects

Properties

Name	Type	Required	Restrictions	Description
accounts	boolean	false	none	none
assetGroups	boolean	false	none	none
assets	boolean	false	none	none
assetIdentifiers	boolean	false	none	none
eventSubscriptions	boolean	false	none	none
managedReports	boolean	false	none	none
scheduledReports	boolean	false	none	none
complianceFindings	boolean	false	none	none
findings	boolean	false	none	none
scanConfigurations	boolean	false	none	none
dashboards	boolean	false	none	none
integrations	boolean	false	none	none
scanPolicies	boolean	false	none	none
viewTemplates	boolean	false	none	none
users	boolean	false	none	none
scanConfigurationSettings	boolean	false	none	none
scheduledReportSettings	boolean	false	none	none
resourceGroupSettings	boolean	false	none	none
workflows	boolean	false	none	none

TagsTransformation.ToFrom

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
allKeys	boolean	false	none	none
value	string	false	none	none
allValues	boolean	false	none	none

Terms

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
mainUserMustAccept	boolean	true	none	none
allUsersMustAccept	boolean	true	none	none
termsTemplateId	integer(int32)	true	none	none
termsTemplateName	string	false	read-only	none
termsTemplateContent	string	false	read-only	none
customerName	string	false	read-only	none

TermsAcceptance

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
termsId	integer(int32)	true	none	none

TermsTemplate

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the entry.
content	string	true	none	none
id	integer(int32)	false	read-only	The ID of the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.

UserRolePermission

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
name	string	false	read-only	The name of the entry.

UserRole

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
system	boolean	false	read-only	Set to true when system role
permissionIds	[integer]	false	none	The user role permission ids

User

Properties

Name	Type	Required	Restrictions	Description
timezone	string	false	none	The user time zone
portalPreferences	string	false	none	The user portal preferences
customerId	integer(int32)	false	read-only	The ID of the customer owning the entry.
id	integer(int64)	false	read-only	The ID of the entry.
company	string	false	read-only	The user company name
firstName	string	true	none	The user first name
lastName	string	true	none	The user last name
email	string	true	none	The user email address
username	string	true	none	The user name
emailEncryptionKey	string	false	none	The user public key for email encryption
sshPublicKey	string	false	none	The user ssh public key
mobilePhone	string	false	none	The user mobile phone number
countryCode	string	false	none	The user country code
stateCode	string	false	none	The user state code
lastLogonIp	string	false	read-only	The user last logon ip address
lastLogonDate	string(date-time)	false	read-only	The user last logon date
logons	integer(int64)	false	read-only	The user logon numbers
language	string	false	none	The user language
remoteSupport	boolean	false	read-only	The user remote support status
twoFactorCode	string	false	none	none
roles	string	false	read-only	The user's roles
snapshotSubscriptions	integer(int64)	false	none	The snapshot subscriptions
snapshotSubscriptionsRemaining	integer(int64)	false	none	The remaining snapshot subscriptions
swatSubscriptions	integer(int64)	false	none	The SWAT subscriptions
swatSubscriptionsRemaining	integer(int64)	false	none	The remaining SWAT subscriptions
customerSuccessManagerEmail	string	false	none	The email to the customer success manager responsible for this customer
accountManagerEmail	string	false	none	The email to the account manager responsible for this customer
pgpPublicKey	string	false	none	This user's PGP public key
twoFactorType	string	false	none	The user's two-factor authentication type
tags	[Tag]	false	read-only	The tags
twoFactorSecret	string	false	none	The user's two-factor secret

Enumerated Values

Property	Value
twoFactorType	ANY
twoFactorType	NONE
twoFactorType	SMS
twoFactorType	TOTP

ViewTemplateGroup

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
parentId	integer(int32)	false	none	The ID of the parent entry.
type	string	true	none	none

Enumerated Values

Property	Value
type	ASSET_GROUPS
type	ASSETS
type	SCAN_CONFIGURATIONS
type	SCHEDULES
type	SCANS
type	FINDINGS
type	REPORTS
type	USERS
type	ACCOUNTS
type	AUDITS
type	SCHEDULED_REPORTS
type	MANAGED_REPORTS
type	INTEGRATIONS
type	COMPLIANCE
type	TAGS
type	VIEW_TEMPLATES
type	SCAN_POLICIES
type	AGENTS
type	CONSUMPTION
type	WORKFLOWS
type	CHECKS
type	FINDING_TEMPLATES
type	MATCHES

ViewTemplate

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
type	string	true	none	none
sorting	string	false	none	none
fields	string	false	none	none
columnsWidth	string	false	none	none
system	boolean	false	read-only	none
isDefault	boolean	false	none	none
groupId	integer(int32)	false	none	The view template group id
filters	[ViewTemplate.Filter]	false	none	none
tags	[Tag]	false	none	[The tags]

Enumerated Values

Property	Value
type	ASSET_GROUPS
type	ASSETS
type	SCAN_CONFIGURATIONS
type	SCHEDULES
type	SCANS
type	FINDINGS
type	REPORTS
type	USERS
type	ACCOUNTS
type	AUDITS
type	SCHEDULED_REPORTS
type	MANAGED_REPORTS
type	INTEGRATIONS
type	COMPLIANCE
type	TAGS
type	VIEW_TEMPLATES
type	SCAN_POLICIES
type	AGENTS
type	CONSUMPTION
type	WORKFLOWS
type	CHECKS
type	FINDING_TEMPLATES
type	MATCHES

ViewTemplate.Filter

Properties

Name	Type	Required	Restrictions	Description
field	string	true	none	none
comparison	string	true	none	none
value	string	true	none	none

Workflow

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	read-only	The ID of the entry.
customerId	integer(int32)	false	none	The ID of the customer owning the entry.
created	string(date-time)	false	read-only	The timestamp when the entry was created.
updated	string(date-time)	false	read-only	The timestamp when the entry was updated.
createdBy	string	false	read-only	The name of the user who created the entry.
updatedBy	string	false	read-only	The name of the user who updated the entry.
createdById	integer(int32)	false	read-only	The ID of the user who created the entry.
updatedById	integer(int32)	false	read-only	The ID of the user who updated the entry.
name	string	true	none	The name of the entry.
enabled	boolean	false	none	Determines if the entry is enabled or not.
nextOccurrence	string(date-time)	false	read-only	The scan next occurrence date
lastScan	string(date-time)	false	read-only	Last time a scan was performed using this workflow
scheduleIds	[integer]	false	read-only	The schedule ids associated with this workflow
scannerId	integer(int32)	false	none	The scanner id
tags	[Tag]	false	read-only	The tags
configurations	[Workflow.Configuration]	true	none	The workflow configurations

Workflow.Configuration

The workflow configurations

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	true	none	The ID of the entry.
type	string	true	none	none

Enumerated Values

Property	Value
type	SCAN_CONFIGURATION
type	SCHEDULED_REPORT