Probely Developers
  1. Targets
Probely Developers
  • Account
    • Retrieve account information
      GET
    • Retrieve billing information
      GET
    • Partial update billing information
      PATCH
    • Update billing information
      PUT
    • Action that should be taken to enable the selected targets
      POST
    • Estimate costs of updating a subscription
      POST
    • Update a subscription
      POST
    • Available actions for the selected targets
      POST
  • Login
    • Authenticate user
      POST
    • Replace token with a new one
      POST
    • Revoke a token
      POST
    • Verify a token
      POST
    • Enterprise user authentication
      POST
    • Enterprise token refresh
      POST
    • Enterprise token revokation
      POST
    • Enterprise token verification
      POST
  • Password Reset
    • Check validity of password reset token
      POST
    • Send reset password email
      POST
    • Reset password after asking for a reset (with the token sent by email).
      POST
  • Events
    • List account events
      GET
    • Retrieve account event
      GET
    • List target events
      GET
    • Retrieve target event
      GET
    • List target webhooks
      GET
    • Create new target webhook
      POST
    • Delete target webhook
      DELETE
    • Retrieve target webhook
      GET
    • Partial update target webhook
      PATCH
    • Update target webhook
      PUT
    • List account webhooks
      GET
    • Create new account webhook
      POST
    • Delete account webhook
      DELETE
    • Retrieve account webhook
      GET
    • Partial update account webhook
      PATCH
    • Update account webhook
      PUT
  • Frameworks
    • List frameworks
    • Retrieve framework
  • Integrations
    • Integrations available and installed in the account
    • Integrations available and installed for the target
  • Jira Cloud Integration
    • List Jira Projects
    • Retrieve project issue types
    • Retrieve issue priorities
    • Retrieve issue statuses
    • Retrieve Jira Cloud finding configuration
    • Update Jira Cloud finding configuration
    • Update Jira Cloud finding configuration
    • Retrieve Jira Cloud Target configuration
    • Update Jira Cloud target configuration
    • Update Jira Cloud target configuration
  • Jira Server Integration
    • List Jira Projects
    • Retrieve project issue types
    • Retrieve issue priorities
    • Retrieve issue statuses
    • Retrieve Jira Server finding configuration
    • Update Jira Server finding configuration
    • Update Jira Server finding configuration
    • Retrieve Jira Server Target configuration
    • Update Jira Server target configuration
    • Update Jira Server target configuration
  • API Keys
    • List API keys allowed to operate on account
    • Create account API key
    • Delete account API key
    • Retrieve account API key
    • List target specific API keys
    • Create target API key
    • Delete target API key
    • Retrieve target API key
  • Labels
    • List labels
    • Create label
    • Delete label
    • Retrieve framework
    • Partial update
    • Update label
  • Plan
    • Subscription plans
  • Users
    • User data
    • Change user password
    • List users
    • Create/Reactivate a user.
    • Deactivate a user
    • Retrieve user
    • Partial update user
    • Update user
  • Targets
    • List targets
      GET
    • Create target
      POST
    • Delete target
      DELETE
    • Retrieve target
      GET
    • Partial update target
      PATCH
    • Update target
      PUT
  • Archive
    • Activate targets
    • Archive targets
    • List archived targets
  • Statistics
    • Average fix time graph data (all targets)
    • Targets with open vulnerabilities pie chart data
    • Targets with open vulnerabilities
    • Risk trend graph data (all targets)
    • Severity trend graph data (all targets)
    • Top 5 vulnerabilities (all targets).
    • Average vulnerability trend graph data
    • Risk trend graph data
    • Severity trend graph data.
    • Top 5 vulnerabilities
  • Scans
    • List scans for all targets
    • Start a scan on the target
    • List scans
    • Dates where scans have ocurred
    • Scan page
    • Retrieve scan
    • Cancel running scan
    • Scan endpoints file
    • Scan report PDF, using the report type specified for the target
    • Scan report PDF, using the default report type
    • Scan report PDF, using the OWASP report type
    • Scan report PDF, using the PCI report type
  • Scheduled
    • List scheduled scans for all targets expanding recurrence
    • List scheduled scans
    • Create new scheduled scan
    • List scheduled scans expanding recurrence
    • Delete
    • Retrieve a scheduled scan
    • Partial update
    • Update a scheduled scan
  • Assets
    • List target's assets
    • Create new asset
    • Delete asset
    • Retrieve asset
    • Partial update assets
    • Update asset
    • Verify asset ownership
  • Findings
    • List target findings
    • Finding report
    • Bulk retest findings
    • Bulk update findings
    • Retrieve finding report PDF format
    • Retrieve finding
    • Partial update finding
    • Update finding
    • Finding activity log.
    • Retest finding
  • Slack Integration
    • Retrieve slack integration data
    • Update slack integration data
    • Update slack integration data
  • Site
    • Retrieve target's site
    • Partial update target's site
    • Update target's site
    • Verify site ownership
  • Vulnerabilities
    • List vulnerability definitions
    • Retrieve vulnerability definition
  1. Targets

Create target

POST
/targets/

Request

Body Params application/json

Examples

Responses

🟢201OK
application/json
Body

🟠400400
🟠401401
🟠403403
🔴500500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.probely.com/targets/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "connected_target": "string",
    "environment": "testing",
    "labels": [
        "string"
    ],
    "name": "Object name",
    "report_type": "default",
    "scan_profile": "normal",
    "site": {
        "basic_auth": {
            "password": "dolphins",
            "username": "probely"
        },
        "cookies": [
            {
                "name": "cookie_1",
                "value": "cookie_value"
            }
        ],
        "desc": "Object description",
        "form_login": [
            {
                "name": "username",
                "value": "probely"
            }
        ],
        "form_login_check_pattern": "",
        "form_login_url": "https://app.probely.com/",
        "has_basic_auth": true,
        "has_form_login": true,
        "headers": [
            {
                "name": "X-Custom-Header",
                "value": "XXXXX"
            }
        ],
        "name": "Object name",
        "url": "https://app.probely.com",
        "whitelist": [
            "/private/path/"
        ]
    },
    "type": "single"
}'
Response Response Example
201 - Example 1
{
    "allowed_scan_profiles": [
        {
            "id": "normal",
            "name": "string"
        }
    ],
    "assets": [
        {
            "changed": "2018-01-31T16:32:17.238553Z",
            "changed_by": {
                "email": "example@probely.com",
                "id": "jMXUw-BE_2vd",
                "name": "Henrique Cimento"
            },
            "cookies": [
                {
                    "name": "cookie_1",
                    "value": "cookie_value"
                }
            ],
            "desc": "Object description",
            "headers": [
                {
                    "name": "X-Custom-Header",
                    "value": "XXXXX"
                }
            ],
            "host": "string",
            "id": "jMXUw-BE_2vd",
            "include": true,
            "name": "Object name",
            "stack": [
                "nginx"
            ],
            "verification_date": "2018-01-31T16:32:52.226652Z",
            "verification_last_error": "string",
            "verification_method": "dns",
            "verification_token": "a38351cb-ede8-4dc8-9366-80d3a7042d9a",
            "verified": false
        }
    ],
    "changed": "2018-01-31T16:32:17.238553Z",
    "changed_by": {
        "email": "example@probely.com",
        "id": "jMXUw-BE_2vd",
        "name": "Henrique Cimento"
    },
    "connected_target": "string",
    "enabled": true,
    "environment": "testing",
    "id": "jMXUw-BE_2vd",
    "labels": [
        "string"
    ],
    "name": "Object name",
    "report_type": "default",
    "scan_profile": "normal",
    "site": {
        "basic_auth": {
            "password": "dolphins",
            "username": "probely"
        },
        "changed": "2018-01-31T16:32:17.238553Z",
        "changed_by": {
            "email": "example@probely.com",
            "id": "jMXUw-BE_2vd",
            "name": "Henrique Cimento"
        },
        "cookies": [
            {
                "name": "cookie_1",
                "value": "cookie_value"
            }
        ],
        "desc": "Object description",
        "form_login": [
            {
                "name": "username",
                "value": "probely"
            }
        ],
        "form_login_check_pattern": "",
        "form_login_url": "https://app.probely.com/",
        "has_basic_auth": true,
        "has_form_login": true,
        "headers": [
            {
                "name": "X-Custom-Header",
                "value": "XXXXX"
            }
        ],
        "host": "app.probely.com",
        "id": "jMXUw-BE_2vd",
        "name": "Object name",
        "stack": [
            "nginx"
        ],
        "url": "https://app.probely.com",
        "verification_date": "2018-01-31T16:32:52.226652Z",
        "verification_last_error": "string",
        "verification_method": "dns",
        "verification_token": "a38351cb-ede8-4dc8-9366-80d3a7042d9a",
        "verified": false,
        "whitelist": [
            "/private/path/"
        ]
    },
    "type": "single"
}
Modified at 2022-09-11 19:40:30
Previous
List targets
Next
Delete target
Built with