Danbooru
Login Posts Comments Notes Artists Tags Pools Wiki Forum More ยป
Search Changes Help | Posts (0) History
  • Help
guro
scat
furry -rating:g

Recent Changes (all)

  • teru (astral party)
  • suzi (the sphere hunter)
  • the naked gun (series)
  • saryuu (iriomote)
  • selen tatsuki (3rd costume)
  • selen tatsuki (2nd costume)
  • selen tatsuki (4th costume)
  • watanabe akio
  • nurse witch komugi chan
  • houshou marine
  • amane kanata
  • tsunomaki watame
  • tokoyami towa
  • himemori luna
  • shiranui flare
  • usada pekora
  • shirogane noel
  • shishiro botan
  • mococo abyssgard (holonatsu paradise)
  • shiori novella (holonatsu paradise)
  • momosuzu nene
  • nerissa ravencroft (holonatsu paradise)
  • fuwawa abyssgard (holonatsu paradise)
  • koseki bijou (holonatsu paradise)
  • takanashi kiara (holonatsu paradise)

Options

  • Wiki History
  • Discussions
  • What Links Here

api:pools

Table of Contents
  • 01. Record field format
  • 02. Associated attributes
  • 03. Nomenclature
  • 04. Index
  • 05. Show
  • 06. Create
  • 07. Update
  • 08. Delete
  • 09. Undelete
  • 10. Revert
  • 11. See also
  • 12. External links

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

Record field format

NameTypeDetails
idinteger>0
namestring
descriptionstring
post_idsarrayintegers > 0
categorystring[series, collection]
is_deletedboolean
is_activebooleanunused
created_attimestamp
updated_attimestamp

Associated attributes

None.

Nomenclature

  • Plural form: "pools"
    • Used in the URL pathname
  • Singular form: "pool"
    • Used for write parameters (Help:API Write Requests)
  • Versions: API:Pool versions

Index

HTTP MethodGET
Base URL/pools.json
Typeread request
DescriptionThe default order is updated at descending.
Search attributes

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

  • Number syntax
    • id
    • created_at
    • updated_at
  • Text syntax
    • name
    • description
  • Array syntax
    • post_ids
  • Boolean syntax
    • is_deleted
Special search parameters
  • name_matches - Normalized case-insensitive wildcard searching on the name text field.
  • description_matches - Case-insensitive wildcard searching on the description text field.
  • post_tags_match - The pools's post's tags match the given terms. Meta-tags not supported.
  • category
    • series - Only series-type pools.
    • collection - Only collection-type pools.
  • order - Sets the order of the results.
    • name - Alphabetic order by name.
    • created_at - Orders by creation time.
    • post_count - Orders by post count.

Show

HTTP MethodGET
Base URL/pools/$id.json
Typeread request
Description$id is the pool ID.

Create

HTTP MethodPOST
Base URL/pools.json
Typewrite request
Create parameters
  • Required:
    • name
    • category - Can be: series, collection.
  • Optional
    • description
    • post_ids - Uses URL array parameter format.
    • post_ids_string - Space delimited list of post IDs.
    • is_deleted

Update

HTTP MethodPUT/PATCH
Base URL/pools/$id.json
Typewrite request
Description$id is the pool ID.
Update parameters

Accepts the same parameters as the create pool action. All parameters are optional.

Delete

HTTP MethodDELETE
Base URL/pools/$id.json
Typewrite request
Description$id is the pool ID.

Note: This action can also be accomplished using the update pool action by setting is_deleted to true.

Undelete

HTTP MethodPOST
Base URL/pools/$id/undelete.json
Typewrite request
Description$id is the pool ID.

Note: This action can also be accomplished using the update pool action by setting is_deleted to false.

Revert

HTTP MethodPUT
Base URL/pools/$id/revert.json
Typewrite request
Description$id is the pool ID.
Revert parameters
  • Required:
    • version_id - The pool version ID to revert to.

See also

  • Help:Common URL Parameters
  • Help:API

External links

Controllerhttps://github.com/danbooru/danbooru/blob/master/app/controllers/pools_controller.rb
Modelhttps://github.com/danbooru/danbooru/blob/master/app/models/pool.rb
Policyhttps://github.com/danbooru/danbooru/blob/master/app/policies/pool_policy.rb
Terms / Privacy / Upgrade / Contact /