api:post flags

Table of Contents

The following includes the details of how to interface with the post flag records through the API.

Record field format

NameTypeDetails
idinteger>0
post_idinteger>0
reasonstring
statusenumSee Status table for list of acceptable values.
is_resolvedboolean
creator_idinteger>0, limited to Moderator+ or the flag creator
created_attimestamp
updated_attimestamp
Status
ValueEnum
0pending
1succeeded
2rejected

Associated attributes

NameTypeNumberAvailabilityDetails
postpostsinglerequiredPost that the flag belongs to.

Nomenclature

  • Plural form: "post flags"
    • Used in the URL pathname
  • Singular form: "post flag"
  • Versions: none

Index

HTTP MethodGET or POST*
Base URL/post_flags.json
Typeread request
DescriptionThe default order is ID descending.
* Accepts POST under certain circumstances. See Help:API read requests.
Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

Special search parameters
  • reason_matches - Case-insensitive wildcard search on the reason field.
  • creator_id - Searches for flags by creator ID. Single ID only.
  • creator_name - Searches for flags by creator name. Single name only.
  • category_matches - Can be: normal, unapproved, rejected, deleted.
Search order

The search order can only be changed with the custom parameter.

Show

HTTP MethodGET or POST*
Base URL/post_flags/$id.json
Typeread request
Description$id is the post flag ID.
* Accepts POST under certain circumstances. See Help:API read requests.

Create

HTTP MethodPOST
Base URL/post_flags.json
Typewrite request
Description
Create parameters
  • Required:
    • post_id
    • reason

See also

Controllerhttps://github.com/danbooru/danbooru/blob/master/app/controllers/post_flags_controller.rb
Modelhttps://github.com/danbooru/danbooru/blob/master/app/models/post_flag.rb
Policyhttps://github.com/danbooru/danbooru/blob/master/app/policies/post_flag_policy.rb