> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# probely/security-scan

Use Probely to scan your web application for security vulnerabilities.
Full orb source code: https://github.com/Probely/probely-orb


## Commands

### scan

Start the scan on a target (website) using Probely.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | env_var_name | PROBELY_API_KEY | The Probely API key to use, defined in the PROBELY_API_KEY environment variable.
 |
| `api_url` | string | https://api.probely.com | The URL of Probely's API |
| `target_id` | string |  | The id of the target (website) to scan. |

## Jobs

### scan

Start a scan on a target (website) using Probely.

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | env_var_name | PROBELY_API_KEY | The Probely API key to use, defined in the PROBELY_API_KEY environment variable.
 |
| `target_id` | string |  | The id of the target (website) to scan. |

## Executors

### alpine

## Examples

### scan

Start the scan on a target (website) using Probely.

```yaml
orbs:
  probely: probely/security-scan@x.y.z
version: 2.1
workflows:
  example-workflow:
    jobs:
      - probely/scan:
          target_id: probely_target_id
```