Scrape domains / Create

Creates new domain to scrape..

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/scrape_domains

Method: POST

Authorisation: Minimum role: ADMIN

Request Arguments
Name Type Source
inputDTO_scrape_domainBody

  Request body example

Response object

Response status: 200 (OK)

Response type: DTO_scrape_domain

Wrapper: DTO_response_wrap

Other response statuses: 400 (BadRequest), 403 (Forbidden)

  Response body example

DTO_scrape_domain
NameTypeReadOnlyDescription
created_byDTO_reference_userReadOnlyCreated by
last_updated_byDTO_reference_userReadOnlyLast updated by
idInt32ReadOnlyLeave empty on input
domain_nameStringDomain name
statusENUM scrape_domain_statusReadOnlyStatus
createdDateTimeReadOnlyCreated
scraped_countInt32ReadOnlyScraped count
last_updatedDateTimeReadOnlyLast updated
verifiedDateTime (nullable)ReadOnlyVerified
DTO_reference_user
NameTypeReadOnlyDescription
profile_picStringReadOnlyProfile pic
emailStringReadOnlyEmail
idInt32Id
labelObjectReadOnlyLabel
ENUM scrape_domain_status
ValueNameDescription
0UNKNOWNUNKNOWN
1PENDINGPENDING
2VERIFIEDVERIFIED