documentation/content/en/entities/Admin_DomainBlock.md

2.6 KiB

title description menu aliases
Admin::DomainBlock Represents a domain limited from federating.
docs
parent
entities
/entities/admin-domainblock
/entities/Admin-DomainBlock
/entities/admin_domainblock
/entities/Admin_DomainBlock
/api/entities/admin-domainblock
/api/entities/Admin-DomainBlock
/api/entities/admin_domainblock
/api/entities/Admin_DomainBlock

{{< hint style="danger" >}} This page is under construction. {{< /hint >}}

Example

{
  "id": "1",
  "domain": "example.com",
  "created_at": "2022-11-16T08:15:34.238Z",
  "severity": "noop",
  "reject_media": false,
  "reject_reports": false,
  "private_comment": null,
  "public_comment": null,
  "obfuscate": false
}

Attributes

id

Description: The ID of the DomainBlock in the database.
Type: String (cast from an integer, but not guaranteed to be a number)
Version history:
4.0.0 - added

domain

Description: The domain that is not allowed to federate.
Type: String
Version history:
4.0.0 - added

created_at

Description: When the domain was blocked from federating.
Type: String (ISO 8601 Datetime)
Version history:
4.0.0 - added

severity

Description: The policy to be applied by this domain block.
Type: String (Enumerable oneOf)
silence = Account statuses from this domain will be hidden by default
suspend = All incoming data from this domain will be rejected
noop = Do nothing. Allows for rejecting media or reports
Version history:
4.0.0 - added

reject_media

Description: Whether to reject media attachments from this domain
Type: Boolean
Version history:
4.0.0 - added

reject_reports

Description: Whether to reject reports from this domain
Type: Boolean
Version history:
4.0.0 - added

private_comment

Description:
Type: {{}} String
Version history:
4.0.0 - added

public_comment

Description:
Type: {{}} String
Version history:
4.0.0 - added

obfuscate

Description: Whether to obfuscate public displays of this domain block
Type: Boolean
Version history:
4.0.0 - added

See also

{{< page-relref page="methods/admin/domain_blocks" caption="admin/domain_blocks API methods" >}}

{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/serializers/rest/admin/domain_blocks_serializer.rb" caption="app/serializers/rest/admin/domain_blocks_serializer.rb" >}}