PRprobely
Extra Hosts

Create Extra Host

Changed on
post/targets/{target_id}/assets/

Request

  • Base URL
    https://api.probely.com
  • URL
    https://api.probely.com/targets/{target_id}/assets/
  • Auth
    API key in header Authorization

Path parameters

target_idstring required

Identifier of the target.

Query parameters

include'target'

Extra fields to include in response:

  • target - Add target to response under target key
skip_reachability_checkstring

If false or not defined, makes a request to the target to try reach it and raises an error if it fails.
If true, skips this validation.

Request body

idstring required

A unique Base58 value identifying this object.

namestring

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

descstring nullable

Description of the target.

verifiedboolean required

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

verification_tokenstring uuid required

Token used to verify the domain. Read-only.

verification_datestring date-time required

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'file' | 'back_office' | 'existing_domain' | 'dns_txt' | 'dns' | 'dns_cname' | 'meta_tag' | 'whitelist' | 'email' | 'aws_route53' | 'cloudflare' | 'waved' | 'akamai' required

Method used in the verification of the domain: (Read-only)

  • 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.

  • akamai - Automatically verifies a domain if the host name exists as an AkamaiHost.

verification_last_errorstring required

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

changedstring date-time required

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

includeboolean

If true, the extra host is in the scope of the scan.
If false, the extra host is not in the scope of the scan.
Defaults to true.

hoststring required

Response

idstring required

A unique Base58 value identifying this object.

namestring

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

descstring nullable

Description of the target.

verifiedboolean required

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

verification_tokenstring uuid required

Token used to verify the domain. Read-only.

verification_datestring date-time required

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'file' | 'back_office' | 'existing_domain' | 'dns_txt' | 'dns' | 'dns_cname' | 'meta_tag' | 'whitelist' | 'email' | 'aws_route53' | 'cloudflare' | 'waved' | 'akamai' required

Method used in the verification of the domain: (Read-only)

  • 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.

  • akamai - Automatically verifies a domain if the host name exists as an AkamaiHost.

verification_last_errorstring required

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

changedstring date-time required

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

includeboolean

If true, the extra host is in the scope of the scan.
If false, the extra host is not in the scope of the scan.
Defaults to true.

hoststring required

Changes

  • 0e9b5b5da4d0Revision changes
    • warning

      added the new akamai enum value to the response property for the response status

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new optional request property // (media type: application/json)

    • info

      added the new optional request property // (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property // (media type: multipart/form-data)

    • info

      added the new akamai enum value to the request property (media type: application/json)

    • info

      added the new akamai enum value to the request property (media type: application/x-www-form-urlencoded)

    • info

      added the new akamai enum value to the request property (media type: multipart/form-data)

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 76a7d9557921Revision changes
    • info

      added the new optional query request parameter include

    • info

      added the new optional query request parameter skip_reachability_check