probely_create_api_target_from_openapi
Create an API target by providing an OpenAPI/Swagger schema via URL or JSON. Set allow_duplicate to enable multiple targets for the same URL with different configurations.
Instructions
Create an API target from an OpenAPI/Swagger schema. Provide either openapi_schema_url or openapi_schemajson. When the user provides openapi_schema_url, do not fetch the openapi_schemajson from that url.
Set allow_duplicate=True to create a target even if another target with the same URL already exists. This is useful when you want multiple targets for the same URL with different configurations (e.g., different auth methods, different test scenarios).
If target creation fails because the target is unreachable or the domain cannot be resolved, ask the user whether to retry with skip_reachability_check=True.
IMPORTANT: The response contains a top-level id (the target ID) and a nested
site.id (the site ID). Always use the top-level id as the targetId
parameter for all subsequent tool calls (update_target, start_scan, etc.).
Do NOT use the nested site.id field for target operations.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| target_url | Yes | ||
| openapi_schema_url | No | ||
| openapi_schemajson | No | ||
| desc | No | ||
| labels | No | ||
| allow_duplicate | No | ||
| skip_reachability_check | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||