BLblockaid-official
Label Management

Apply Label to Domain

Changed on

Apply a label to a domain. Domain labels are not chain-scoped — a domain label always applies globally, regardless of chain. Labels are unique per (identifier, label); re-applying the same label returns 409.

post/v0/platform/labels/domains/{domain}

Request

Path parameters

domainstring required

The domain name to label. Provide the bare hostname (e.g. evil.com or sub.evil.com) without scheme or path; matched case-insensitively.

Request body

labelstring required

The label to apply, by name (e.g. "Phishing"). Matched case-insensitively against the label catalog (GET /v0/platform/labels/types). Labels are unique per (identifier, label) — re-applying returns 409; an identifier may carry multiple distinct labels.

tagsstring[]

Optional tags to group labels by.

commentstring nullable

Optional free-text note explaining the label.

Response

Label applied

idstring uuid required

Unique ID of this label assignment.

identifierstring required

The labeled address, domain or token.

identifier_type'address' | 'domain' | 'token' required

The type of the labeled identifier.

chainstring nullable required

The chain this label applies to. null means the label applies to ALL chains (sticky); chain is always null for domains, which are not chain-scoped.

labelstring required

The applied label name.

result_type'Malicious' | 'Benign' required

Whether this label marks the entity as Malicious (block) or Benign (allow). Derived from the label.

tagsstring[] required

Tags grouping this label.

commentstring nullable

Free-text note explaining the label, if any.

created_bystring required

Who created the assignment (e.g. "API" or a user identifier).

updated_bystring required

Who last updated the assignment.

created_atstring date-time required

Creation timestamp (ISO 8601, UTC).

updated_atstring date-time required

Last-update timestamp (ISO 8601, UTC).

Changes