Create Extra Host

POST 
/targets/:target_id/assets/

Request

Path Parameters

target_id stringrequired

Identifier of the target.

application/json

Body

required

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.

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 [

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.

]

headers

object[]

Custom headers to send.

Array [

name stringrequired

value stringrequired

]

cookies

object[]

Custom cookies to send.

Array [

name stringrequired

value stringrequired

]

include boolean

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.

host stringrequired

Possible values: Value must match regular expression ^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z\u00a1-\uffff0-9](?:[a-z\u00a1-\uffff0-9_-]{0,61}[a-z\u00a1-\uffff0-9])?(?:\.(?!-)[a-z\u00a1-\uffff0-9-]{1,63}(?<!-))*(\.(?!-)(?:[a-z\u00a1-\uffff-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?)?))(?::\d{2,5})?$

application/x-www-form-urlencoded

Body

required

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.

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 [

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.

]

headers

object[]

Custom headers to send.

Array [

name stringrequired

value stringrequired

]

cookies

object[]

Custom cookies to send.

Array [

name stringrequired

value stringrequired

]

include boolean

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.

host stringrequired

Possible values: Value must match regular expression ^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z\u00a1-\uffff0-9](?:[a-z\u00a1-\uffff0-9_-]{0,61}[a-z\u00a1-\uffff0-9])?(?:\.(?!-)[a-z\u00a1-\uffff0-9-]{1,63}(?<!-))*(\.(?!-)(?:[a-z\u00a1-\uffff-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?)?))(?::\d{2,5})?$

multipart/form-data

Body

required

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.

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 [

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.

]

headers

object[]

Custom headers to send.

Array [

name stringrequired

value stringrequired

]

cookies

object[]

Custom cookies to send.

Array [

name stringrequired

value stringrequired

]

include boolean

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.

host stringrequired

Possible values: Value must match regular expression ^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z\u00a1-\uffff0-9](?:[a-z\u00a1-\uffff0-9_-]{0,61}[a-z\u00a1-\uffff0-9])?(?:\.(?!-)[a-z\u00a1-\uffff0-9-]{1,63}(?<!-))*(\.(?!-)(?:[a-z\u00a1-\uffff-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?)?))(?::\d{2,5})?$

Responses

201

application/json

Schema

Schema

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.

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 uuidrequired

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

verification_last_error stringrequired

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

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.

headers

object[]

Custom headers to send.

Array [

name stringrequired

value stringrequired

]

cookies

object[]

Custom cookies to send.

Array [

name stringrequired

value stringrequired

]

include boolean

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.

host stringrequired

Possible values: Value must match regular expression ^(?:(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)(?:\.(?:0|25[0-5]|2[0-4][0-9]|1[0-9]?[0-9]?|[1-9][0-9]?)){3}|\[[0-9a-f:.]+\]|([a-z\u00a1-\uffff0-9](?:[a-z\u00a1-\uffff0-9_-]{0,61}[a-z\u00a1-\uffff0-9])?(?:\.(?!-)[a-z\u00a1-\uffff0-9-]{1,63}(?<!-))*(\.(?!-)(?:[a-z\u00a1-\uffff-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\.?)?))(?::\d{2,5})?$

Example (from schema)

{
  "id": "string",
  "name": "string",
  "desc": "string",
  "stack": [
    {
      "id": "string",
      "name": "string",
      "desc": "string"
    }
  ],
  "verified": true,
  "verification_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verification_date": "2024-07-29T15:51:28.071Z",
  "verification_method": "file",
  "verification_last_error": "string",
  "changed": "2024-07-29T15:51:28.071Z",
  "changed_by": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  },
  "headers": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "cookies": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "include": true,
  "host": "string"
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...