# Probely Developers API

> Probely Developers API on Apizie: 143 endpoints (Retrieve account information, Authenticate user, Replace token with a new one, Revoke a token, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:probely/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:probely`
- Category: Cloud
- Status: byok
- Source: https://probely.com
- Page: https://apizie.tech/api/cloud/probely
- OpenAPI: https://apizie.tech/api/cloud/probely/openapi.json

Probely is a Web Vulnerability Scanning suite for Agile Teams. It provides continuous scanning of your Web Applications and lets you efficiently manage the lifecycle of the vulnerabilities found, in a sleek and…

## Endpoints

### Retrieve account information
`GET https://apizie.tech/v1/cloud:probely/get-account` (byok)

### Authenticate user
`POST https://apizie.tech/v1/cloud:probely/post-auth-obtain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Replace token with a new one
`POST https://apizie.tech/v1/cloud:probely/post-auth-refresh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Revoke a token
`POST https://apizie.tech/v1/cloud:probely/post-auth-revoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Verify a token
`POST https://apizie.tech/v1/cloud:probely/post-auth-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve billing information
`GET https://apizie.tech/v1/cloud:probely/get-billing` (byok)

### Update billing information
`POST https://apizie.tech/v1/cloud:probely/put-billing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Partial update billing information
`POST https://apizie.tech/v1/cloud:probely/patch-billing` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Action that should be taken to enable the selected targets
`POST https://apizie.tech/v1/cloud:probely/post-billing-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Estimate costs of updating a subscription
`POST https://apizie.tech/v1/cloud:probely/post-billing-estimate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Update a subscription
`POST https://apizie.tech/v1/cloud:probely/post-billing-subscribe` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Check validity of password reset token
`POST https://apizie.tech/v1/cloud:probely/post-check` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Enterprise user authentication
`POST https://apizie.tech/v1/cloud:probely/post-enterprise-auth-obtain` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Enterprise token refresh
`POST https://apizie.tech/v1/cloud:probely/post-enterprise-auth-refresh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Enterprise token revokation
`POST https://apizie.tech/v1/cloud:probely/post-enterprise-auth-revoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Enterprise token verification
`POST https://apizie.tech/v1/cloud:probely/post-enterprise-auth-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List account events
`GET https://apizie.tech/v1/cloud:probely/get-events` (byok)

### Retrieve account event
`GET https://apizie.tech/v1/cloud:probely/get-events-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### List frameworks
`GET https://apizie.tech/v1/cloud:probely/get-frameworks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Retrieve framework
`GET https://apizie.tech/v1/cloud:probely/get-frameworks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### Integrations available and installed in the account
`GET https://apizie.tech/v1/cloud:probely/get-integrations` (byok)

### List Jira Projects
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-cloud-projects` (byok)

### Retrieve project issue types
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-cloud-projects-project-id-issue-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | yes | Jira Project Id |

### Retrieve issue priorities
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-cloud-projects-project-id-issue-types-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | yes | Jira Project Id |
| issue_type_id | string | yes | Jira issue type id |

### Retrieve issue statuses
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-cloud-projects-project-id-issue-types-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | yes | Jira Project Id |
| issue_type_id | string | yes | Jira issue type id |

### List Jira Projects
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-server-projects` (byok)

### Retrieve project issue types
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-server-projects-project-id-issue-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | yes | Jira Project Id |

### Retrieve issue priorities
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-server-projects-project-id-issue-types-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | yes | Jira Project Id |
| issue_type_id | string | yes | Jira issue type id |

### Retrieve issue statuses
`GET https://apizie.tech/v1/cloud:probely/get-integrations-jira-server-projects-project-id-issue-types-3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| project_id | string | yes | Jira Project Id |
| issue_type_id | string | yes | Jira issue type id |

### List API keys allowed to operate on account
`GET https://apizie.tech/v1/cloud:probely/get-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Create account API key
`POST https://apizie.tech/v1/cloud:probely/post-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve account API key
`GET https://apizie.tech/v1/cloud:probely/get-keys-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### Delete account API key
`POST https://apizie.tech/v1/cloud:probely/delete-keys-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### List labels
`GET https://apizie.tech/v1/cloud:probely/get-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Create label
`POST https://apizie.tech/v1/cloud:probely/post-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve framework
`GET https://apizie.tech/v1/cloud:probely/get-labels-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### Update label
`POST https://apizie.tech/v1/cloud:probely/put-labels-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Partial update
`POST https://apizie.tech/v1/cloud:probely/patch-labels-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Delete label
`POST https://apizie.tech/v1/cloud:probely/delete-labels-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### Subscription plans
`GET https://apizie.tech/v1/cloud:probely/get-plans` (byok)

### User data
`GET https://apizie.tech/v1/cloud:probely/get-profile` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Change user password
`POST https://apizie.tech/v1/cloud:probely/post-profile-change-password` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Send reset password email
`POST https://apizie.tech/v1/cloud:probely/post-reset` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Reset password after asking for a reset (with the token sent by email).
`POST https://apizie.tech/v1/cloud:probely/post-setpassword` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Available actions for the selected targets
`POST https://apizie.tech/v1/cloud:probely/post-target-actions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List targets
`GET https://apizie.tech/v1/cloud:probely/get-targets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Create target
`POST https://apizie.tech/v1/cloud:probely/post-targets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Activate targets
`POST https://apizie.tech/v1/cloud:probely/post-targets-activate` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Average fix time graph data (all targets)
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-average-fix-time` (byok)

### Targets with open vulnerabilities pie chart data
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-needs-attention-pie` (byok)

### Targets with open vulnerabilities
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-needs-attention-top` (byok)

### Risk trend graph data (all targets)
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-risk-trend` (byok)

### List scans for all targets
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-scans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |
| started | array | no | Filter by scan start dates |
| status | string | no | Filter by scan statuses |

### List scheduled scans for all targets expanding recurrence
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-scheduledscans-expanded` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| length | integer | no | Number of results to return per page |

### Severity trend graph data (all targets)
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-severity-trend` (byok)

### Top 5 vulnerabilities (all targets).
`GET https://apizie.tech/v1/cloud:probely/get-targets-all-top-vulns` (byok)

### Archive targets
`POST https://apizie.tech/v1/cloud:probely/post-targets-archive` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List archived targets
`POST https://apizie.tech/v1/cloud:probely/post-targets-archived` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve target
`GET https://apizie.tech/v1/cloud:probely/get-targets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### Update target
`POST https://apizie.tech/v1/cloud:probely/put-targets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |
| body | object | no | JSON request body |

### Partial update target
`POST https://apizie.tech/v1/cloud:probely/patch-targets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |
| body | object | no | JSON request body |

### Delete target
`POST https://apizie.tech/v1/cloud:probely/delete-targets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Object Id |

### List target's assets
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Create new asset
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-assets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Retrieve asset
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-assets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Update asset
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-assets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Partial update assets
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-assets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Delete asset
`POST https://apizie.tech/v1/cloud:probely/delete-targets-target-id-assets-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Verify asset ownership
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-assets-id-verify` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Average vulnerability trend graph data
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-average-fix-time` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### List target events
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Retrieve target event
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-events-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### List target findings
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-findings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| scan | array | no | Filter by scan ids |
| severity | string | no | Filter by finding severity |
| state | string | no | Filter by finding states |
| assignee | array | no | Filter by assignee ids |
| label | array | no | Filter by finding labels |
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Finding report
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-findings-bulk-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Bulk retest findings
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-findings-bulk-retest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Bulk update findings
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-findings-bulk-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Retrieve finding report PDF format
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-findings-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| token | string | yes | Token received from the finding report endpoint. |

### Retrieve finding
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-findings-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Update finding
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-findings-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Partial update finding
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-findings-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Retrieve Jira Cloud finding configuration
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-findings-id-integrations-jira-cloud` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Update Jira Cloud finding configuration
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-findings-id-integrations-jira-cloud` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Update Jira Cloud finding configuration
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-findings-id-integrations-jira-cloud` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Retrieve Jira Server finding configuration
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-findings-id-integrations-jira-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Update Jira Server finding configuration
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-findings-id-integrations-jira-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Update Jira Server finding configuration
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-findings-id-integrations-jira-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Finding activity log.
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-findings-id-log` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Retest finding
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-findings-id-retest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Integrations available and installed for the target
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-integrations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Retrieve Jira Cloud Target configuration
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-integrations-jira-cloud` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Update Jira Cloud target configuration
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-integrations-jira-cloud` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Update Jira Cloud target configuration
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-integrations-jira-cloud` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Retrieve Jira Server Target configuration
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-integrations-jira-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Update Jira Server target configuration
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-integrations-jira-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Update Jira Server target configuration
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-integrations-jira-server` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Retrieve slack integration data
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-integrations-slack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Update slack integration data
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-integrations-slack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Update slack integration data
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-integrations-slack` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### List target specific API keys
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Create target API key
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-keys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### Retrieve target API key
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-keys-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Delete target API key
`POST https://apizie.tech/v1/cloud:probely/delete-targets-target-id-keys-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Risk trend graph data
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-risk-trend` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Start a scan on the target
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-scan-now` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | no | JSON request body |

### List scans
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |
| started | array | no | Filter by scan start dates |
| status | string | no | Filter by scan statuses |

### Dates where scans have ocurred
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-dates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |

### Scan page
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-retrieve-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| length | integer | no | Number of results to return per page |
| date | string | yes | Date |

### Retrieve scan
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Cancel running scan
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-scans-id-cancel` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Scan endpoints file
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-id-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Scan report PDF, using the report type specified for the target
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-id-report` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Scan report PDF, using the default report type
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-id-report-default` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Scan report PDF, using the OWASP report type
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-id-report-owasp` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Scan report PDF, using the PCI report type
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scans-id-report-pci` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### List scheduled scans
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scheduledscans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| page | integer | no | Page number within the paginated result set |
| length | integer | no | Number of results to return per page |
| ordering | string | no | Which field to use when ordering the results, prefix with `-` to invert ordering. |
| search | string | no | Search term |

### Create new scheduled scan
`POST https://apizie.tech/v1/cloud:probely/post-targets-target-id-scheduledscans` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| body | object | yes | JSON request body |

### List scheduled scans expanding recurrence
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scheduledscans-expanded` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| length | integer | no | Number of results to return per page |

### Retrieve a scheduled scan
`GET https://apizie.tech/v1/cloud:probely/get-targets-target-id-scheduledscans-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |

### Update a scheduled scan
`POST https://apizie.tech/v1/cloud:probely/put-targets-target-id-scheduledscans-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

### Partial update
`POST https://apizie.tech/v1/cloud:probely/patch-targets-target-id-scheduledscans-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| target_id | string | yes | Target id |
| id | string | yes | Object Id |
| body | object | yes | JSON request body |

…and 23 more. See the OpenAPI spec.

## Example
```
curl "https://apizie.tech/v1/cloud:probely/get-account" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Probely Developers API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:probely/get-account with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Probely Developers API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Probely Developers itself also needs your own key from probely.com.

### Can AI agents use the Probely Developers API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:probely.

### What is the status of the Probely Developers API?
Needs your own provider key (bring your own key)