Scanners Configuration Service API - Anypoint Platform APIs

Overview

Statistics

12 Operations

2 Skills

Platform Category

REST API for Scanners Configuration Service

Servers

https://anypoint.mulesoft.com/agent-scanner
https://{region}.anypoint.mulesoft.com/agent-scanner
https://{region}.platform.mulesoft.com/agent-scanner

Authentication & Security

bearerAuth http
Bearer token authentication. Login endpoint: https://anypoint.mulesoft.com/accounts/api/login
clientAuth oauth2
OAuth2 client credentials. Token endpoint: https://anypoint.mulesoft.com/accounts/api/v2/oauth2/token

Update Scan Configuration updateScanConfiguration

PUT

Try it out

Path Parameters

organizationId *

scannerConfigurationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Scanner Configuration

Returns an updated scanner configuration

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerConfigurationId *: string(uuid)

The scanner configuration ID.

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

Request Body *

json

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Response

Successfully updated Scanner Configurations

Scanner Configurations Minimum Required Fields are missing

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

If user is not authorized

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Scanner Configurations not found

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Internal server error

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Delete Scanner Configuration deleteScannerConfiguration

DELETE

Try it out

Path Parameters

organizationId *

scannerConfigurationId *

Header Parameters

X-Delete-Agents

Custom Query Parameters

Custom Headers

Scanner Configuration

Starts an asynchronous workflow to delete the scanner configuration. Returns 200 OK when the deletion workflow is started successfully.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerConfigurationId *: string(uuid)

The scanner configuration ID.

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

Header Parameters

X-Delete-Agents: boolean

Whether to also delete associated agents.

default: True

Response

Delete workflow started successfully

Examples

*/*

{}

Scanner Configuration ID is invalid

If user is not authorized

Scanner Configuration not found

Failed to start delete workflow

Get Scan Configurations getScanConfigurations

GET

Try it out

Path Parameters

organizationId *

Query Parameters

page

size

Custom Query Parameters

Custom Headers

Scanner Configuration

Returns a list of scanner configuration for a specific organization

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Query Parameters

page: integer(int32)

Zero-based page number for pagination.

default: 0

size: integer(int32)

Number of items per page.

default: 10000

Response

Successfully retrieved Scanner Configurations

If user is not authorized

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Scanner Configurations not found

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Internal server error

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Create Scan Configurations createScanConfigurations

POST

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Request Body application/json

Scanner Configuration

Returns the scanner configuration created

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Request Body *

json

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Response

Successfully created Scanner Configurations

Scanner Configurations Minimum Required Fields are missing

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

If user is not authorized

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Internal server error

name *: string

minLength: 1

id: string(uuid)

schedule *: string

minLength: 1

description: string

parameters: string

state: string

runPolicy *: string

minLength: 1

lastRunAt: string(date-time)

lastSuccessfulRunAt: string(date-time)

lastRunStatus: string

nextRunAt: string(date-time)

lastSuccessfulRunSummary: string

updatedAt: string(date-time)

rootOrgId: string(uuid)

createdAt: string(date-time)

orgId: string(uuid)

lastRunStatusDetail: string

connection: object

authParameters: string

id: string(uuid)

authScheme: string

targetSystemId *: string

minLength: 1, pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

statusMessage: string

environment: string

orgId: string

pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

status: string

name: string

lastTestedAt: string(date-time)

type: string

ownerId: string(uuid)

emails: string

notificationEnabled: boolean

scannerConfigurationFromDTO: object

Represents a scanner configuration for scanning operations

id: string(uuid)

Unique identifier of the scanner configuration

name: string

Name of the scanner configuration

schedule: string

Schedule for running the scanner

parameters: string

Custom parameters for thescanner configuration

runPolicy: string

Run policy for the scanner configuration

state: string

Current status of the scanner configuration

lastRunAt: string(date-time)

Date when the scanner was last executed

lastRunStatus: string

Status of the scanner last run

lastSuccessfulRunAt: string(date-time)

Date when the scanner was last successfully executed

nextRunAt: string(date-time)

Date when the scanner is scheduled to run next

lastSuccessfulRunSummary: string

Summary of the scanner last successful run

description: string

Scanner Configuration description

createdAt: string(date-time)

Scanner creation date

updatedAt: string(date-time)

Scanner updated date

orgId: string(uuid)

Organization Id

lastRunStatusDetail: string

Scanner Configuration last Run status detail

rootOrgId: string(uuid)

Root Organization ID

ownerId: string(uuid)

Owner identifier - the user who owns and initiated this scanning activity

emails: string

Email addresses to notify

connection: object

Represents the connection needed to run a scan

notificationEnabled: boolean

emailsList: array

deleted: boolean

Execute Workflow From Configuration executeWorkflowFromConfiguration

POST

Try it out

Path Parameters

organizationId *

scannerConfigurationId *

Custom Query Parameters

Custom Headers

Scanner Configuration

Starts a scan workflow based on the specified scanner configuration ID

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerConfigurationId *: string(uuid)

The scanner configuration ID.

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

Response

Workflow started successfully

Invalid configuration or parameters

If user is not authorized

Scanner configuration not found

Workflow already running for this scanner configuration

Internal server error

Scan workflows not enabled

Abort Workflow From Configuration abortWorkflowFromConfiguration

POST

Try it out

Path Parameters

organizationId *

scannerConfigurationId *

Custom Query Parameters

Custom Headers

Scanner Configuration

Cancels a running scan based on the specified scanner configuration ID

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerConfigurationId *: string(uuid)

The scanner configuration ID.

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

Response

Workflow aborted successfully

Invalid configuration or parameters

If user is not authorized

Scanner configuration not found

Internal server error

Scan workflows not enabled

Publish Assets After Review publishAssetsAfterReview

POST

Try it out

Path Parameters

organizationId *

scannerConfigurationId *

scanRunId *

Custom Query Parameters

Custom Headers

Request Body application/json

Scanner Configuration

Updates ignored status for staged services and signals the workflow to proceed with publication.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerConfigurationId *: string(uuid)

The scanner configuration ID.

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

scanRunId *: string(uuid)

The scan run identifier.

Related Operations:

agent-scanner-configuration-service#getScannerRunHistory.$.content[*].id

Request Body *

json

content *: array

Response

Successfully updated services and triggered publication

Bad request - invalid request body or parameters

Scan run not found

Conflict - scan run is outdated or already in a final state

Internal server error

Test Connection testConnection

POST

Try it out

Path Parameters

organizationId *

targetSystemType *

Custom Query Parameters

Custom Headers

Request Body application/json

Connectivity

Tests connectivity to a target system type using provided connection parameters. Requires authentication.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

targetSystemType *: string

The target system type.

Related Operations:

agent-scanner-configuration-service#getTargetSystems.$[*].type

Request Body *

json

Response

Connection successful

Bad request

Unauthorized - Invalid credentials

Target dependency failure (including converted target 5xx errors)

Internal server error

Get Scanner Run History getScannerRunHistory

GET

Try it out

Path Parameters

organizationId *

scannerId *

Query Parameters

page

size

Custom Query Parameters

Custom Headers

Scanner Runs

Returns a paginated list of scanner runs for a specific scanner

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerId *: string(uuid)

The scanner identifier (same as scanner configuration ID).

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

Query Parameters

page: integer(int32)

Zero-based page number for pagination.

default: 0

size: integer(int32)

Number of items per page.

default: 20

Response

json

Successfully retrieved scanner runs

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Examples

application/json

{ "totalElements": 1, "totalPages": 1, "first": true, "last": true, "size": 20, "number": 0, "content": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "status": "COMPLETED", "summary": "{\"scanned\": 10, \"found\": 5}" } ], "numberOfElements": 1, "empty": false }

Bad request - invalid scannerId parameter

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Internal server error

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Get Staging Assets By Scan Run Id getStagingAssetsByScanRunId

GET

Try it out

Path Parameters

organizationId *

scannerId *

scanRunId *

Query Parameters

page

size

Custom Query Parameters

Custom Headers

Scanner Runs

Returns a paginated list of staging assets for a specific scan run. Use size=0 to get all results without pagination.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

scannerId *: string(uuid)

The scanner identifier (same as scanner configuration ID).

Related Operations:

agent-scanner-configuration-service#getScanConfigurations.$.content[*].id

scanRunId *: string(uuid)

The scan run identifier.

Related Operations:

agent-scanner-configuration-service#getScannerRunHistory.$.content[*].id

Query Parameters

page: integer(int32)

Zero-based page number for pagination.

default: 0

size: integer(int32)

Page size (use 0 to get all results)

default: 20

Response

json

Successfully retrieved staging assets

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Examples

application/json

{ "totalElements": 1, "totalPages": 1, "first": true, "last": true, "size": 20, "number": 0, "content": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "My Agent", "status": "NEW" } ], "numberOfElements": 1, "empty": false }

Bad request - invalid scanRunId parameter

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Internal server error

totalElements: integer(int64)

totalPages: integer(int32)

first: boolean

last: boolean

size: integer(int32)

content: array

number: integer(int32)

sort: object

numberOfElements: integer(int32)

pageable: object

empty: boolean

Get Organization Info getOrganizationInfo

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Organization

Returns organization information including total managed agents and capacity limit

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successfully retrieved organization information

totalManagedAgents: integer(int64)

capacityAgentsLimit: integer(int64)

Examples

application/json

{ "totalManagedAgents": 150, "capacityAgentsLimit": 10000 }

If user is not authorized

totalManagedAgents: integer(int64)

capacityAgentsLimit: integer(int64)

Organization not found or not registered in the system

totalManagedAgents: integer(int64)

capacityAgentsLimit: integer(int64)

Internal server error

totalManagedAgents: integer(int64)

capacityAgentsLimit: integer(int64)

Get Target Systems getTargetSystems

GET

Try it out

Path Parameters

organizationId *

Custom Query Parameters

Custom Headers

Connectivity

Returns a list of available target systems for connections. Requires authentication.

Path Parameters

organizationId *: string

The organization ID to identify the target resource.

Related Operations:

access-management#listMe.$.user.organization.id access-management#getOrganizations.$.id access-management#getOrganizations.['$.id', '$.subOrganizationIds[*]']

Response

json

Successfully retrieved target systems

id: string(uuid)

Unique identifier of the target system

name: string

Name of the target system

description: string

Description of the target system

type: string

Scanner type of the target system

provider: string

Cloud provider

platform: string

Platform within the provider

assetType: string

Type of asset scanned

authSchemeFormFields: array

Auth Scheme Form Fields

Examples

application/json

{ "id": "550e8400-e29b-41d4-a716-446655440000", "name": "AWS Bedrock", "description": "Amazon Bedrock AI service", "type": "bedrock", "provider": "aws", "platform": "bedrock_agents", "assetType": "agent" }

Internal server error

items: array

Array items

id: string(uuid)

Unique identifier of the target system

name: string

Name of the target system

description: string

Description of the target system

type: string

Scanner type of the target system

provider: string

Cloud provider

platform: string

Platform within the provider

assetType: string

Type of asset scanned

authSchemeFormFields: array

Auth Scheme Form Fields