1
0
mirror of https://github.com/mastodon/documentation synced 2025-04-11 22:56:17 +02:00
documentation/content/en/entities/Admin_DomainBlock.md
trwnh ffbe66a389
Update content for 4.0, part 2 (#1060)
* fix relrefs around trends and related entities

* revert moving caption-links to middle of page

* hide empty menu in table of contents

* clarify edit notifs are only for boosted statuses

* following/followers no longer need auth

* fix typo

* specify cooldown period for account Move

* use the correct cooldown

* add missing parameters to accounts/id/statuses

* link to account_statuses_filter.rb

* fix typo (#1072)

* fix typo (#1073)

* fix link to http sig spec (#1067)

* simply HTTP request examples in api methods docs

* add missing client_secret to oauth/token (#1062)

* Add any, all, none to hashtag timeline

* minor formatting changes

* Update signature requirements and advice

* fix public key -> private key

* clarify use of RSA with SHA256

* Add note about saving your profile after adding rel-me link

* v2 filters api

* comment out params that shouldn't be used in v2 filter api

* admin trends

* remove old todo

* canonical email blocks + scheduled statuses

* remove under-construction warnings from finished pages

* verify api method params with source code

* fix typo (#1088)

* fix broken caption-links (#1100)

* fix formatting of entities (#1094)

* Remove keybase section from user guide (#1093)

* fix typos (#1092)

* Verify limits are accurate (#1086)

* add mention of iframe limitation (#1084)

* Add CORS header to WEB_DOMAIN example (#1083)

* Fix typo (#1081)

* pin http sigs spec at draft 8

* Revert "pin http sigs spec at draft 8"

This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20.

* add case sensitivity warning to 4.0 roles

* Add url length note to bio (#1087)

* remove follow scope from examples (#1103)

* clarify usage of update_credentials to update profile fields

* add noindex to Account entitity

* remove required hint from technically not required property
2022-12-14 22:55:30 +01:00

2.5 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

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" >}}