wallabag API documentation

_others

DELETE /api/annotations/{annotation}.{_format}

Removes an annotation.

PUT /api/annotations/{annotation}.{_format}

Updates an annotation.

GET /api/annotations/{entry}.{_format}

Retrieve annotations for an entry.

POST /api/annotations/{entry}.{_format}

Creates a new annotation.

GET /api/entries.{_format}

Retrieve all entries. It could be filtered by many options.

Documentation

Retrieve all entries. It could be filtered by many options.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|txt\|csv\|pdf\|epub\|mobi\|html

Parameters

Parameter	Type	Required?	Format	Description
archive	integer	false	1 or 0, all entries by default	filter by archived status.
starred	integer	false	1 or 0, all entries by default	filter by starred status.
sort	string	false	'created' or 'updated', default 'created'	sort entries by date.
order	string	false	'asc' or 'desc', default 'desc'	order of sort.
page	integer	false	default '1'	what page you want.
perPage	integer	false	default'30'	results per page.
tags	string	false	api,rest	a list of tags url encoded. Will returns entries that matches ALL tags.
since	integer	false	default '0'	The timestamp since when you want entries updated.

POST /api/entries.{_format}

Create an entry.

Documentation

Create an entry.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|txt\|csv\|pdf\|epub\|mobi\|html

Parameters

Parameter	Type	Required?	Format	Description
url	string	true	http://www.test.com/article.html	Url for the entry.
title	string	false		Optional, we'll get the title from the page.
tags	string	false	tag1,tag2,tag3	a comma-separated list of tags.
starred	integer	false	1 or 0	entry already starred
archive	integer	false	1 or 0	entry already archived

GET /api/entries/exists.{_format}

Check if an entry exist by url.

Documentation

Check if an entry exist by url.

Requirements

Name	Requirement	Type	Description
_format	xml\|json\|txt\|csv\|pdf\|epub\|mobi\|html

Parameters

Parameter	Type	Required?	Format	Description
url	string	true	An url	Url to check if it exists
urls	string	false	An array of urls (?urls[]=http...&urls[]=http...)	Urls (as an array) to check if it exists

DELETE /api/entries/{entry}.{_format}

Delete permanently an entry.

GET /api/entries/{entry}.{_format}

Retrieve a single entry.

PATCH /api/entries/{entry}.{_format}

Change several properties of an entry.

Documentation

Change several properties of an entry.

Requirements

Name	Requirement	Type	Description
entry	\w+	integer	The entry ID
_format	xml\|json\|txt\|csv\|pdf\|epub\|mobi\|html

Parameters

Parameter	Type	Required?	Format	Description
title	string	false
tags	string	false	tag1,tag2,tag3	a comma-separated list of tags.
archive	integer	false	1 or 0	archived the entry.
starred	integer	false	1 or 0	starred the entry.

GET /api/entries/{entry}/export.{_format}

Retrieve a single entry as a predefined format.

PATCH /api/entries/{entry}/reload.{_format}

Reload an entry.

GET /api/entries/{entry}/tags.{_format}

Retrieve all tags for an entry.

POST /api/entries/{entry}/tags.{_format}

Add one or more tags to an entry.

DELETE /api/entries/{entry}/tags/{tag}.{_format}

Permanently remove one tag for an entry.

DELETE /api/tag/label.{_format}

Permanently remove one tag from every entry.

GET /api/tags.{_format}

Retrieve all tags.

DELETE /api/tags/label.{_format}

Permanently remove some tags from every entry.

DELETE /api/tags/{tag}.{_format}

Permanently remove one tag from every entry.

GET /api/version.{_format}

Retrieve version number.

Documentation auto-generated on Mon, 18 Feb 19 18:13:06 +0100