Partial Update to Domain

PATCH 
/domains/:id/

Request

Path Parameters

id stringrequired

application/json

Body

hostname string

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})?$

Domain name with an associated IP address or an IP address itself.
For example, "my.example.com", "example.com", or "37.139.17.48".
The maximum length is 256 characters.

basic_auth_username stringnullable

Username used for basic authentication.

basic_auth_password stringnullable

Password used for basic authentication.

port integernullable

Possible values: >= 1 and <= 65535

IP Port to send the requests to.
If not defined, uses the default ports for HTTPS and HTTP (if the verification method requires making HTTP requests).

discovery_enabled boolean

If true, the domain is available for use in Asset Discovery.
If false, the domain can only be used in targets.
This parameter is only applicable if you are entitled to use Asset Discovery. You can contact Probely support to enable the feature.
Learn more about Asset Discovery in the Overview of Asset Discovery.
Defaults to true.

application/x-www-form-urlencoded

Body

hostname string

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})?$

Domain name with an associated IP address or an IP address itself.
For example, "my.example.com", "example.com", or "37.139.17.48".
The maximum length is 256 characters.

basic_auth_username stringnullable

Username used for basic authentication.

basic_auth_password stringnullable

Password used for basic authentication.

port integernullable

Possible values: >= 1 and <= 65535

IP Port to send the requests to.
If not defined, uses the default ports for HTTPS and HTTP (if the verification method requires making HTTP requests).

discovery_enabled boolean

If true, the domain is available for use in Asset Discovery.
If false, the domain can only be used in targets.
This parameter is only applicable if you are entitled to use Asset Discovery. You can contact Probely support to enable the feature.
Learn more about Asset Discovery in the Overview of Asset Discovery.
Defaults to true.

multipart/form-data

Body

hostname string

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})?$

Domain name with an associated IP address or an IP address itself.
For example, "my.example.com", "example.com", or "37.139.17.48".
The maximum length is 256 characters.

basic_auth_username stringnullable

Username used for basic authentication.

basic_auth_password stringnullable

Password used for basic authentication.

port integernullable

Possible values: >= 1 and <= 65535

IP Port to send the requests to.
If not defined, uses the default ports for HTTPS and HTTP (if the verification method requires making HTTP requests).

discovery_enabled boolean

If true, the domain is available for use in Asset Discovery.
If false, the domain can only be used in targets.
This parameter is only applicable if you are entitled to use Asset Discovery. You can contact Probely support to enable the feature.
Learn more about Asset Discovery in the Overview of Asset Discovery.
Defaults to true.

Responses

200

application/json

Schema

Schema

hostname 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})?$

Domain name with an associated IP address or an IP address itself.
For example, "my.example.com", "example.com", or "37.139.17.48".
The maximum length is 256 characters.

id stringrequired

A unique Base58 value identifying this object.

verification_token uuidrequired

Token used to verify the domain.
Read-only.

verification_date date-timenullablerequired

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

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 stringnullablerequired

Error of the last verification of the domain.
Empty if no error occurred.

verified booleanrequired

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

basic_auth_username stringnullable

Username used for basic authentication.

basic_auth_password stringnullable

Password used for basic authentication.

port integernullable

Possible values: >= 1 and <= 65535

IP Port to send the requests to.
If not defined, uses the default ports for HTTPS and HTTP (if the verification method requires making HTTP requests).

discovery_enabled boolean

Default value: true

If true, the domain is available for use in Asset Discovery.
If false, the domain can only be used in targets.
This parameter is only applicable if you are entitled to use Asset Discovery. You can contact Probely support to enable the feature.
Learn more about Asset Discovery in the Overview of Asset Discovery.
Defaults to true.

source

object

required

id stringrequired

Possible values: <= 255 characters

Identifier of the source.

name stringrequired

Possible values: <= 256 characters

Name of the source.
The maximum length is 256 characters.

Example (from schema)

{
  "hostname": "string",
  "id": "string",
  "verification_token": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "verification_date": "2024-07-29T15:51:28.071Z",
  "verification_method": "file",
  "verification_last_error": "string",
  "verified": true,
  "basic_auth_username": "string",
  "basic_auth_password": "string",
  "port": 0,
  "discovery_enabled": true,
  "source": {
    "id": "string",
    "name": "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...