Skip to main content

List Credits Usage

GET 
/account/credits/usage/

Request​

Query Parameters

    end_dt date-time
    length integer

    Number of results to return per page.

    operation string[]

    Possible values: [earned, expired, purchased, used]

    • purchased - PURCHASED
    • expired - EXPIRED
    • used - USED
    • earned - EARNED
    ordering string

    Which field to use when ordering the results.

    page integer

    A page number within the paginated result set.

    scope__name string
    search string

    A search term.

    start_dt date-time
    target string[]

    A unique Base58 value identifying this object.

    target__label string[]

    Name of the label.
    The maximum length is 255 characters.

Responses​

Schema

    count integer

    Total number of results.

    page_total integer

    Total number of pages.

    page integer

    Number of the current page.
    The first page is 1.
    Defaults to 1 if no specific page is requested.

    length integer

    Number of results returned per page.

    results

    object[]

  • Array [

    • timestamp date-timerequired

    Date and time of the credits usage, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

    description stringnullable

    Possible values: <= 150 characters

    amount int64

    Possible values: <= 4294967295

    Number of credits used.

    balance integer

    Possible values: >= -2147483648 and <= 2147483647

    Number of credits available after the usage.

    on_hold integer

    Possible values: >= -2147483648 and <= 2147483647

    Number of credits used and on hold on running scans.

    full_balance integerrequired

    Accrued number of credits: balance + on_hold.

    scan

    object

    required

    Scan where the credits were used.

    id stringrequired

    A unique Base58 value identifying this object.

    status stringrequired

    Possible values: [canceled, canceling, completed, completed_with_errors, failed, paused, pausing, queued, resuming, started, under_review, finishing_up]

    Status of the scan:

    • canceled - Canceled
    • canceling - Canceling
    • completed - Completed
    • completed_with_errors - Completed with errors - DEPRECATED
    • failed - Failed
    • paused - Paused
    • pausing - Pausing
    • queued - Queued
    • resuming - Resuming
    • started - Started
    • under_review - Under Review
    • finishing_up - Finishing up
    started date-timenullablerequired

    Date and time of when the scan started.

    completed date-timenullablerequired

    Date and time of when the scan was completed.

    scan_profile stringrequired

    Identifier of the scan profile.

    lows integernullablerequired

    Number of vulnerability findings with low severity.

    mediums integernullablerequired

    Number of vulnerability findings with medium severity.

    highs integernullablerequired

    Number of vulnerability findings with high severity.

    created date-timerequired

    target

    object

    required

    Target where the credits were used.

    id stringrequired
    name stringdeprecated

    Possible values: <= 255 characters

    Name of the target.
    The maximum length is 255 characters.

    site

    object

    Core settings of the target.
    Includes basic target information (like the name, description, and URL) and scanning information (like the authentication and navigation sequences).

    id stringrequired

    A unique Base58 value identifying this object.

    name string

    Possible values: <= 255 characters

    Name of the target or extra host.
    The maximum length is 255 characters.

    desc stringnullable

    Description of the target.

    url urirequired

    URL of the target.

    host stringrequired

    Hostname of the target.

    has_form_login boolean

    If true, the target authentication is done through a login form.
    Read more about how to set up target authentication (login form).
    Defaults to false.

    form_login_url uri

    URL of the login form of the target.

    form_login_check_pattern string

    Possible values: <= 255 characters

    Pattern to check a successful login.
    The maximum length is 255 characters.

    form_login

    object[]

    Field and value pairs to fill the login form.

  • Array [

    • name stringrequired
    value stringrequired

  • ]

    • logout_detection_enabled boolean

    If true, detects any undesired logouts that may occur during scans to log back in.
    Requires check_session_url and logout_detectors to be defined.
    Defaults to false.

    has_sequence_login boolean

    If true, the target authentication is done through a recorded login sequence.
    Read more about how to set up target authentication (login sequence).
    Defaults to false.

    has_sequence_navigation booleanrequired
    has_basic_auth boolean

    If true, the target authentication is done through username and password credentials.
    Defaults to false.

    basic_auth

    object

    Username and password credentials for the basic auth.

    username stringrequired

    Possible values: <= 255 characters

    password stringrequired

    Possible values: <= 255 characters

    headers

    object[]

    Custom headers to send.

  • Array [

    • name stringrequired
    value stringrequired

  • ]

    • cookies

    object[]

    Custom cookies to send.

  • Array [

    • name stringrequired
    value stringrequired

  • ]

    • whitelist

    object

    Additional paths to crawl and scan. For example, "archive/search?query=probely". Only relative paths are allowed. The blacklist takes precedence over the whitelist.

    property name* any

    Additional paths to crawl and scan. For example, "archive/search?query=probely". Only relative paths are allowed. The blacklist takes precedence over the whitelist.

    blacklist

    object

    URLs to avoid scanning. For example, "https://example.com/pic-delete.php*" or "*.archive.example.com". URLs need to be absolute and wildcards (*) are allowed. The blacklist takes precedence over the whitelist.

    property name* any

    URLs to avoid scanning. For example, "https://example.com/pic-delete.php*" or "*.archive.example.com". URLs need to be absolute and wildcards (*) are allowed. The blacklist takes precedence over the whitelist.

    changed date-timerequired

    Date and time of the last change, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

    changed_by

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    Possible values: <= 254 characters

    Email of the user.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

    auth_enabled boolean

    If true, the target has authentication.
    Defaults to false.

    logout_condition string

    Possible values: [any, all]

    Type of combination of the logout conditions:

    • any - Is logged out if any condition is verified.
    • all - Is logged out only if all condition are verified.
    check_session_url string

    URL to check session.

    has_otp boolean

    If true, the target has two-factor authentication (2FA).
    Read more about how to set up target two-factor authentication (2FA).
    Defaults to false.

    otp_secret string

    The seed/secret obtained when the QR code is displayed to be scanned by the third-party authenticator (TPA) app installed on the phone (e.g., Google Authenticator, 1Password, Authy, Microsoft Authenticator, etc.).
    Read more about how to set up target two-factor authentication (2FA).

    otp_algorithm string

    Possible values: [SHA1, SHA256, SHA512]

    Default value: SHA1

    Secure hash algorithm (SHA) to generate the one-time password (OTP):
    (Defaults to SHA1)

    • SHA1 - Sha1
    • SHA256 - Sha256
    • SHA512 - Sha512
    otp_digits integer

    Possible values: >= -2147483648 and <= 2147483647, [6, 7, 8]

    Default value: 6

    Number of digits of the one-time password (OTP):
    (Defaults to 6)

    • 6 - Six
    • 7 - Seven
    • 8 - Eight
    otp_field string

    CSS selector of the HTML element in the page to enter the one-time password (OTP).
    For example, a text input field. Read more about how to obtain a CSS selector.
    Defaults to "".

    otp_submit string

    CSS selector of the HTML element in the page to submit the one-time password (OTP). For example, a button.
    Read more about how to obtain a CSS selector.
    Defaults to "".

    otp_login_sequence_totp_value string

    Possible values: >= 6 characters and <= 8 characters

    One-time password (OTP) obtained at the time when the login sequence was recorded, i.e., the time-based one-time password (TOTP).
    Defaults to "".

    otp_type string
    otp_url stringrequired

    stack

    object[]

    Technologies identified in the target during scans.
    The scanning engine uses them to fine-tune vulnerability tests and improve the explanation of how to fix vulnerabilities.

  • Array [

    • id stringrequired

    A unique Base58 value identifying this object.

    name Framework Name (string)required

    Possible values: <= 255 characters

    Name of the technology.
    For example, "PHP, "SQLite", "Python", "Apache", or "Wordpress".
    The maximum lenght is 255 characters.

    desc Framework Description (string)nullablerequired

    Description of the technology.
    Defaults to "".

  • ]

    • verified booleanrequired

    If true, the domain is verified. Read-only.

    verification_token stringrequired

    Token used to verify the domain. Read-only.

    verification_date date-timerequired

    Date and time of the verification of the domain, in ISO 8601 UTC format. For example, "2023-08-09T13:27:43.8208302". Read-only.

    verification_method stringrequired

    Possible values: [file, back_office, existing_domain, dns_txt, dns, dns_cname, meta_tag, whitelist, email, aws_route53, cloudflare, waved]

    Method used in the domain verification:

    • file - Verifies the domain against a text file in the root directory of the website. Learn more in this article.

    • back_office - Automatically set if manually verified in the back-office. Read-only.

    • existing_domain - Automatically set if the upper-level domain is verified. For example, "my.example.com" is automatically verified if "example.com" is verified. Read-only.

    • dns_txt - Verifies the domain against a TXT record in the Domain Name System (DNS). Learn more in this article.

    • dns - Same as dns_txt.

    • dns_cname - Verifies the domain against a CNAME record in the Domain Name System (DNS). Learn more in this article.

    • meta_tag - Verifies the domain against a meta tag in the index page of the website. Learn more in this article.

    • whitelist - Automatically verifies if the domain is in the whitelist

    • email - Automatically verifies a domain if the user's email is in the same domain as the target

    • aws_route53 - Automatically verifies a domain if the hostname exists as an AWS Route53 Zone.

    • cloudflare - Automatically verifies a domain if the host name exists and is verified as a CloudflareZone.

    • waved - Automatically verifies a domain if there is a waver agreement.

    verification_last_error stringrequired

    Error of the last verification of the domain. Read-only.

    api_scan_settings

    object

    required

    Scanning settings if the target is an API.

    api_schema_type string

    Possible values: [openapi, postman]

    Type of schema that defines the API:

    • openapi - OpenAPI schema.
    • postman - Postman collection.
    api_schema_url stringnullable
    api_schema_file stringnullable

    custom_api_parameters

    object[]

  • Array [

    • name stringrequired
    value stringrequired

  • ]

    • media_type string

    Possible values: [application/json, application/x-www-form-urlencoded]

    Format of the payload:

    • application/json - The payload is in JSON format in the request body.
    • application/x-www-form-urlencoded - The payload is encoded in the request URL.
    api_login_url string

    Possible values: <= 2048 characters

    URL to make the authentication request to the API.
    The maximum length is 2048 characters.

    api_login_payload string

    Possible values: <= 4096 characters

    Payload to send in the authentication request.
    The maximum length is 4096 characters.

    api_login_enabled boolean
    api_login_token_field string

    Possible values: <= 256 characters

    Field containing the authentication token in the response to the authentication request.
    The maximum length is 256 characters.

    token_prefix string

    Possible values: <= 16 characters

    Prefix to add to the authentication token.
    For example, "Bearer" or "JWT".
    The maximum length is 16 characters.

    token_parameter_name string

    Possible values: <= 256 characters

    Parameter name to send the authentication token.
    For example, "Authorization".
    The maximum length is 256 characters.

    token_parameter_location string

    Possible values: [cookie, header]

    Where to send the parameter name with the authentication token and the prefix:

    • cookie - Cookie
    • header - Header
    type string

    Type of target.
    Possible values are "single" for a web application and "api" for an API.
    Defaults to "single".

    desc stringnullabledeprecated

    Description of the target.
    Defaults to "".

    labels

    object[]

  • Array [

    • id stringrequired

    A unique Base58 value identifying this object.

    name stringrequired

    Possible values: <= 255 characters

    Name of the label.
    The maximum length is 255 characters.

    color string

    Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

    Color of the label, in RGB hexadecimal format prefixed with "#".
    For example, "#00FF00" for green.

    changed_by

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    Possible values: <= 254 characters

    Email of the user.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

    changed date-timerequired

    Date and time of the last change, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

  • ]

    • has_assets booleanrequired
    report_fileformat string

    Possible values: [pdf, docx]

    Report format for the target:
    (Defaults to pdf)

    • pdf - PDF file format.
    • docx - DOCX file format.

    scanning_agent

    object

    nullable

    Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in to_internal_value.

    This is for the drf-spectacular documentation generation.

    id string
    name stringrequired

    Possible values: <= 255 characters

    installer_generated booleanrequired
    online booleanrequired
    fallback booleanrequired
    rx_bytes integerrequired
    tx_bytes integerrequired
    latest_handshake integerrequired

    teams

    object[]

    required

  • Array [

    • id string

    A unique Base58 value identifying this object.

    name stringrequired

  • ]

    • blackout_period

    object

    required

    Time window during which scans are temporarily interrupted.

    begin timerequired

    Time of when the blackout period starts, in ISO 8601 UTC format.
    For example, "13:27".

    cease timerequired

    Time of when the blackout period ceases, in ISO 8601 UTC format.
    For example, "13:27".

    weekdays integer[]required
    enabled boolean

    If true, the blackout period is enabled.

    timezone string

    Possible values: <= 64 characters

    changed date-timerequired

    Date and time of the last change, in ISO 8601 UTC format.
    For example, "2023-08-09T13:27:43.8208302".

    changed_by

    object

    required

    User who last made changes.

    id stringrequired

    A unique Base58 value identifying this object.

    email email

    Possible values: <= 254 characters

    Email of the user.

    name stringrequired

    Possible values: <= 60 characters

    Name of the user.

  • ]

Loading...