# Scanners Configuration Service API

REST API for Scanners Configuration Service

- **Version:** 0.0.1
- **Category:** Platform
- **OpenAPI Spec:** [api.yaml](https://dev-portal.mulesoft.com/apis/agent-scanner-configuration-service/api.yaml)

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

## Operations (12)
### PUT /api/v1/organizations/{organizationId}/scanner-configurations/{scannerConfigurationId}

**Operation ID:** `updateScanConfiguration`
Update Scanner Configurations
Returns an updated scanner configuration

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerConfigurationId` | query | The scanner configuration ID. | required |

### DELETE /api/v1/organizations/{organizationId}/scanner-configurations/{scannerConfigurationId}

**Operation ID:** `deleteScannerConfiguration`
Delete Scanner Configuration by id
Starts an asynchronous workflow to delete the scanner configuration. Returns 200 OK when the deletion workflow is started successfully.

**Parameters:**
| `X-Delete-Agents` | query | Whether to also delete associated agents. | optional |
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerConfigurationId` | query | The scanner configuration ID. | required |

### GET /api/v1/organizations/{organizationId}/scanner-configurations

**Operation ID:** `getScanConfigurations`
Get Scanner Configurations of a specific organization
Returns a list of scanner configuration for a specific organization

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `page` | query | Zero-based page number for pagination. | optional |
| `size` | query | Number of items per page. | optional |

### POST /api/v1/organizations/{organizationId}/scanner-configurations

**Operation ID:** `createScanConfigurations`
Create Scanner Configurations
Returns the scanner configuration created

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |

### POST /api/v1/organizations/{organizationId}/scanner-configurations/{scannerConfigurationId}/execute

**Operation ID:** `executeWorkflowFromConfiguration`
Execute workflow from scanner configuration
Starts a scan workflow based on the specified scanner configuration ID

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerConfigurationId` | query | The scanner configuration ID. | required |

### POST /api/v1/organizations/{organizationId}/scanner-configurations/{scannerConfigurationId}/abort

**Operation ID:** `abortWorkflowFromConfiguration`
Abort workflow from scanner configuration
Cancels a running scan based on the specified scanner configuration ID

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerConfigurationId` | query | The scanner configuration ID. | required |

### POST /api/v1/organizations/{organizationId}/scanner-configurations/{scannerConfigurationId}/runs/{scanRunId}/publish

**Operation ID:** `publishAssetsAfterReview`
Publish services after manual review
Updates ignored status for staged services and signals the workflow to proceed with publication.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerConfigurationId` | query | The scanner configuration ID. | required |
| `scanRunId` | query | The scan run identifier. | required |

### POST /api/v1/organizations/{organizationId}/connectivity/{targetSystemType}/test

**Operation ID:** `testConnection`
Test connection
Tests connectivity to a target system type using provided connection parameters. Requires authentication.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `targetSystemType` | query | The target system type. | required |

### GET /api/v1/organizations/{organizationId}/scanner/{scannerId}/runs

**Operation ID:** `getScannerRunHistory`
Get scanner run history
Returns a paginated list of scanner runs for a specific scanner

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerId` | query | The scanner identifier (same as scanner configuration ID). | required |
| `page` | query | Zero-based page number for pagination. | optional |
| `size` | query | Number of items per page. | optional |

### GET /api/v1/organizations/{organizationId}/scanner/{scannerId}/runs/{scanRunId}/assets

**Operation ID:** `getStagingAssetsByScanRunId`
Get staging assets for a scan run
Returns a paginated list of staging assets for a specific scan run. Use size=0 to get all results without pagination.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |
| `scannerId` | query | The scanner identifier (same as scanner configuration ID). | required |
| `scanRunId` | query | The scan run identifier. | required |
| `page` | query | Zero-based page number for pagination. | optional |
| `size` | query | Page size (use 0 to get all results) | optional |

### GET /api/v1/organizations/{organizationId}/info

**Operation ID:** `getOrganizationInfo`
Get organization information
Returns organization information including total managed agents and capacity limit

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |

### GET /api/v1/organizations/{organizationId}/connectivity/target-systems

**Operation ID:** `getTargetSystems`
Get target systems
Returns a list of available target systems for connections. Requires authentication.

**Parameters:**
| `organizationId` | query | The organization ID to identify the target resource. | required |


## Related Skills
- [run-service-scan-and-view-results](https://dev-portal.mulesoft.com/skills/run-service-scan-and-view-results.md) — Executes a scanner and views discovered services (such as AI agents, MCP servers, and API metadata). Use when running a scan, checking scan status, viewing scan history, reviewing discovered services from external platforms, or importing services into Anypoint Exchange.
- [setup-service-scanner](https://dev-portal.mulesoft.com/skills/setup-service-scanner.md) — Creates a scanner configuration to discover services (such as AI agents, MCP servers, and API metadata) from external platforms like AWS Bedrock, Microsoft Copilot, or Google Vertex AI. Use when setting up scanner discovery, configuring a new scanner, connecting to cloud AI platforms, or importing discovered services into Anypoint Exchange.