Table of Contents

• 1. Record field format
• 2. Associated attributes
• 3. Nomenclature
• 4. Actions
• 4.01 Index
• 4.02 Show
• 4.03 Delete
• 5. See also

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

Note: Only upload records created by oneself are visible, unless you are an Admin (Help:Users).

Record field format

Name	Type	Details
id	integer	>0
uploader_id	integer	>0
source	string
referer_url	string
media_asset_count	integer
status	string
error	string or null
created_at	timestamp
updated_at	timestamp

Associated attributes

Name	Type	Number	Availability	Details
uploader	user	single	required
upload_media_assets	upload media asset	multiple	required
media_assets	media asset	multiple	required
posts	post	multiple	optional

Nomenclature

• Plural form: "uploads"
• Used in the URL pathname
• Singular form: "upload"
• Used for write parameters (Help:API Write Requests)
• Versions: none

Actions

These are the various actions that can be done with upload records.

Index

HTTP Method	GET or POST [1]
Base URL	/uploads.json
Type	read request
Description	The default order is ID descending

Search attributes

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

• Number syntax
• id
• media_asset_count
• created_at
• updated_at
• Text syntax
• status
• source
• referer_url
• Post syntax
• post
• User syntax
• uploader
• Chaining syntax
• media_assets
• upload_media_assets

Special search parameters

• is_posted - Whether to show uploads that have a post or not (Help:Boolean syntax).

Show

HTTP Method	GET or POST [1]
Base URL	/uploads/$id.json
Type	read request
Description	$id is the upload ID

Create

HTTP Method	POST
Base URL	/uploads.json
Type	write request
Description

Create parameters

• Mandatory: One of these values must be present.
• source
• files (array file format)
• Optional:
• referer_url

See also

[1] See Help:API read requests for more information.

• Help:Number syntax
• Help:Text syntax
• Help:User syntax
• Help:Common URL Parameters
• Help:API

External links

Controller	https://github.com/danbooru/danbooru/blob/master/app/controllers/uploads_controller.rb
Model	https://github.com/danbooru/danbooru/blob/master/app/models/upload.rb
Policy	https://github.com/danbooru/danbooru/blob/master/app/policies/upload_policy.rb

View wiki