linkding

https://linkding.link/
Admin
linkding is a self-hosted bookmark manager designed to be minimal, fast, and easy to set up,...
Tokens:25,343
Snippets:207
Trust Score:7.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start linkding with Docker Compose

Source: https://linkding.link/installation

Starts a linkding installation using Docker Compose. Requires a downloaded docker-compose.yml and .env file.

```bash
docker-compose up -d
```

--------------------------------

### Get user profile - example response

Source: https://linkding.link/api

Example JSON response for user profile, showing all preference fields.

```json
{
  "theme": "auto",
  "bookmark_date_display": "relative",
  "bookmark_link_target": "_blank",
  "web_archive_integration": "enabled",
  "tag_search": "lax",
  "enable_sharing": true,
  "enable_public_sharing": true,
  "enable_favicons": false,
  "display_url": false,
  "permanent_notes": false,
  "search_preferences": {
    "sort": "title_asc",
    "shared": "off",
    "unread": "off"
  }
}
```

--------------------------------

### Upload bookmark asset - example response

Source: https://linkding.link/api

Example JSON response for a successful asset upload.

```json
{
  "id": 3,
  "bookmark": 1,
  "asset_type": "upload",
  "date_created": "2023-10-01T12:10:00Z",
  "content_type": "application/pdf",
  "display_name": "example.pdf",
  "status": "complete"
}
```

--------------------------------

### Create bundle - example payload

Source: https://linkding.link/api

Example JSON payload for creating a bundle.

```json
{
  "name": "My Bundle",
  "search": "search terms",
  "any_tags": "tag1 tag2",
  "all_tags": "required-tag",
  "excluded_tags": "excluded-tag",
  "order": 5
}
```

--------------------------------

### List bookmark assets - example response

Source: https://linkding.link/api

Example JSON response for listing bookmark assets, showing two assets with their metadata.

```json
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "bookmark": 1,
      "asset_type": "snapshot",
      "date_created": "2023-10-01T12:00:00Z",
      "content_type": "text/html",
      "display_name": "HTML snapshot from 10/01/2023",
      "status": "complete"
    },
    {
      "id": 2,
      "bookmark": 1,
      "asset_type": "upload",
      "date_created": "2023-10-01T12:05:00Z",
      "content_type": "image/png",
      "display_name": "example.png",
      "status": "complete"
    }
  ]
}
```

--------------------------------

### Create initial superuser with Docker

Source: https://linkding.link/installation

Creates the initial superuser for a Docker-based linkding installation. Run after installation is complete.

```bash
docker exec -it linkding python manage.py createsuperuser --username=joe --email=joe@example.com
```

--------------------------------

### Update bundle - example payload

Source: https://linkding.link/api

Example JSON payload for updating a bundle.

```json
{
  "name": "Updated Bundle Name",
  "search": "updated search terms",
  "any_tags": "new-tag1 new-tag2",
  "order": 10
}
```

--------------------------------

### Create tag - example payload

Source: https://linkding.link/api

Example JSON payload for creating a tag.

```json
{
  "name": "example"
}
```

--------------------------------

### List bundles - example response

Source: https://linkding.link/api

Example JSON response for listing bundles, showing two bundle objects with their fields.

```json
{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Work Resources",
      "search": "productivity tools",
      "any_tags": "work productivity",
      "all_tags": "",
      "excluded_tags": "personal",
      "order": 0,
      "date_created": "2020-09-26T09:46:23.006313Z",
      "date_modified": "2020-09-26T16:01:14.275335Z"
    },
    {
      "id": 2,
      "name": "Tech Articles",
      "search": "",
      "any_tags": "programming development",
      "all_tags": "",
      "excluded_tags": "outdated",
      "order": 1,
      "date_created": "2020-09-27T10:15:30.123456Z",
      "date_modified": "2020-09-27T10:15:30.123456Z"
    },
    ...
  ]
}
```

--------------------------------

### List tags - example response

Source: https://linkding.link/api

Example JSON response for listing tags, showing pagination and a tag object.

```json
{
  "count": 123,
  "next": "http://127.0.0.1:8000/api/tags/?limit=100&offset=100",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "example",
      "date_added": "2020-09-26T09:46:23.006313Z"
    },
    ...
  ]
}
```

--------------------------------

### Create initial superuser with Docker Compose

Source: https://linkding.link/installation

Creates the initial superuser for a Docker Compose-based linkding installation. Run after the installation is complete.

```bash
docker-compose exec linkding python manage.py createsuperuser --username=joe --email=joe@example.com
```

--------------------------------

### GET /api/bundles/

Source: https://linkding.link/api

Lists bundles with optional pagination parameters.

```APIDOC
## GET /api/bundles/

### Description
List bundles.

### Method
GET

### Endpoint
/api/bundles/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Limits the max. number of results. Default is `100`.
- **offset** (integer) - Optional - Index from which to start returning results.

### Response
#### Success Response (200)
- **count** (integer) - Total number of bundles.
- **next** (string|null) - URL for next page of results.
- **previous** (string|null) - URL for previous page of results.
- **results** (array) - List of bundle objects.
  - **id** (integer) - Bundle ID.
  - **name** (string) - Bundle name.
  - **search** (string) - Search terms.
  - **any_tags** (string) - Tags that match any.
  - **all_tags** (string) - Tags that must all match.
  - **excluded_tags** (string) - Tags to exclude.
  - **order** (integer) - Order position.
  - **date_created** (string) - Creation timestamp.
  - **date_modified** (string) - Last modified timestamp.

#### Response Example
{
  "count": 3,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Work Resources",
      "search": "productivity tools",
      "any_tags": "work productivity",
      "all_tags": "",
      "excluded_tags": "personal",
      "order": 0,
      "date_created": "2020-09-26T09:46:23.006313Z",
      "date_modified": "2020-09-26T16:01:14.275335Z"
    },
    {
      "id": 2,
      "name": "Tech Articles",
      "search": "",
      "any_tags": "programming development",
      "all_tags": "",
      "excluded_tags": "outdated",
      "order": 1,
      "date_created": "2020-09-27T10:15:30.123456Z",
      "date_modified": "2020-09-27T10:15:30.123456Z"
    }
  ]
}
```

--------------------------------

### Example rule for reddit.com/r/Music

Source: https://linkding.link/auto-tagging

A single auto tagging rule that maps 'reddit.com/r/Music' to the tags 'music' and 'reddit'. This rule is used in the example to illustrate how URL matching works.

```plaintext
reddit.com/r/Music music reddit
```

--------------------------------

### Search example: #article or #book

Source: https://linkding.link/search

Searches for bookmarks tagged with either 'article' or 'book'.

```text
#article or #book
```

--------------------------------

### Get user profile

Source: https://linkding.link/api

Retrieves user preferences.

```http
GET /api/user/profile/
```

--------------------------------

### GET /api/bookmarks/<bookmark_id>/assets/<id>/download/

Source: https://linkding.link/api

Downloads the asset file for a specific asset.

```APIDOC
## GET /api/bookmarks/<bookmark_id>/assets/<id>/download/

### Description
Downloads the asset file.

### Method
GET

### Endpoint
/api/bookmarks/<bookmark_id>/assets/<id>/download/

### Parameters
#### Path Parameters
- **bookmark_id** (integer) - Required - The ID of the bookmark.
- **id** (integer) - Required - The ID of the asset.

### Response
#### Success Response (200)
Returns the asset file content.
```

--------------------------------

### GET /api/user/profile/

Source: https://linkding.link/api

Retrieves user preferences.

```APIDOC
## GET /api/user/profile/

### Description
User preferences.

### Method
GET

### Endpoint
/api/user/profile/

### Response
#### Success Response (200)
- **theme** (string) - Theme preference.
- **bookmark_date_display** (string) - Date display format.
- **bookmark_link_target** (string) - Link target.
- **web_archive_integration** (string) - Web archive integration setting.
- **tag_search** (string) - Tag search mode.
- **enable_sharing** (boolean) - Whether sharing is enabled.
- **enable_public_sharing** (boolean) - Whether public sharing is enabled.
- **enable_favicons** (boolean) - Whether favicons are enabled.
- **display_url** (boolean) - Whether to display URLs.
- **permanent_notes** (boolean) - Whether permanent notes are enabled.
- **search_preferences** (object) - Search preferences.
  - **sort** (string) - Sort order.
  - **shared** (string) - Shared filter.
  - **unread** (string) - Unread filter.

#### Response Example
{
  "theme": "auto",
  "bookmark_date_display": "relative",
  "bookmark_link_target": "_blank",
  "web_archive_integration": "enabled",
  "tag_search": "lax",
  "enable_sharing": true,
  "enable_public_sharing": true,
  "enable_favicons": false,
  "display_url": false,
  "permanent_notes": false,
  "search_preferences": {
    "sort": "title_asc",
    "shared": "off",
    "unread": "off"
  }
}
```

--------------------------------

### Create SQLite SQL dump backup

Source: https://linkding.link/backups

Creates a plain text SQL dump of the SQLite database using the sqlite3 command. Requires SQLite to be installed on the host system. The output is redirected to backup.sql.

```bash
sqlite3 db.sqlite3 .dump > backup.sql
```

--------------------------------

### GET /api/bookmarks/

Source: https://linkding.link/api

Lists bookmarks with optional filtering and pagination parameters. Returns a paginated list of bookmark objects.

```APIDOC
## GET /api/bookmarks/

### Description
List bookmarks.

### Method
GET

### Endpoint
/api/bookmarks/

### Parameters
#### Query Parameters
- **q** (string) - Optional - Filters results using a search phrase using the same logic as through the UI
- **limit** (integer) - Optional - Limits the max. number of results. Default is `100`.
- **offset** (integer) - Optional - Index from which to start returning results
- **modified_since** (string) - Optional - Filter results to only include bookmarks modified after the specified date (format: ISO 8601, e.g. "2025-01-01T00:00:00Z")
- **added_since** (string) - Optional - Filter results to only include bookmarks added after the specified date (format: ISO 8601, e.g. "2025-05-29T00:00:00Z")
- **bundle** (integer) - Optional - Filter results by bundle id to only include bookmarks matched by a given bundle

### Response
#### Success Response (200)
- **count** (integer) - Total number of results
- **next** (string) - URL for the next page of results, or null
- **previous** (string) - URL for the previous page of results, or null
- **results** (array) - List of bookmark objects
  - **id** (integer) - Bookmark ID
  - **url** (string) - Bookmark URL
  - **title** (string) - Bookmark title
  - **description** (string) - Bookmark description
  - **notes** (string) - Bookmark notes
  - **web_archive_snapshot_url** (string) - URL of the web archive snapshot
  - **favicon_url** (string) - URL of the favicon
  - **preview_image_url** (string) - URL of the preview image
  - **is_archived** (boolean) - Whether the bookmark is archived
  - **unread** (boolean) - Whether the bookmark is unread
  - **shared** (boolean) - Whether the bookmark is shared
  - **tag_names** (array of strings) - List of tag names
  - **date_added** (string) - Date the bookmark was added (ISO 8601)
  - **date_modified** (string) - Date the bookmark was last modified (ISO 8601)

#### Response Example

{
  "count": 123,
  "next": "http://127.0.0.1:8000/api/bookmarks/?limit=100&offset=100",
  "previous": null,
  "results": [
    {
      "id": 1,
      "url": "https://example.com",
      "title": "Example title",
      "description": "Example description",
      "notes": "Example notes",
      "web_archive_snapshot_url": "https://web.archive.org/web/20200926094623/https://example.com",
      "favicon_url": "http://127.0.0.1:8000/static/https_example_com.png",
      "preview_image_url": "http://127.0.0.1:8000/static/0ac5c53db923727765216a3a58e70522.jpg",
      "is_archived": false,
      "unread": false,
      "shared": false,
      "tag_names": [
        "tag1",
        "tag2"
      ],
      "date_added": "2020-09-26T09:46:23.006313Z",
      "date_modified": "2020-09-26T16:01:14.275335Z"
    }
  ]
}

```

--------------------------------

### GET /api/tags/

Source: https://linkding.link/api

Lists tags with optional pagination parameters.

```APIDOC
## GET /api/tags/

### Description
List tags.

### Method
GET

### Endpoint
/api/tags/

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Limits the max. number of results. Default is `100`.
- **offset** (integer) - Optional - Index from which to start returning results.

### Response
#### Success Response (200)
- **count** (integer) - Total number of tags.
- **next** (string|null) - URL for next page of results.
- **previous** (string|null) - URL for previous page of results.
- **results** (array) - List of tag objects.
  - **id** (integer) - Tag ID.
  - **name** (string) - Tag name.
  - **date_added** (string) - Creation timestamp.

#### Response Example
{
  "count": 123,
  "next": "http://127.0.0.1:8000/api/tags/?limit=100&offset=100",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "example",
      "date_added": "2020-09-26T09:46:23.006313Z"
    }
  ]
}
```

--------------------------------

### GET /api/bookmarks/<bookmark_id>/assets/

Source: https://linkding.link/api

Lists all assets for a specific bookmark. Returns a paginated list of asset objects.

```APIDOC
## GET /api/bookmarks/<bookmark_id>/assets/

### Description
List assets for a specific bookmark.

### Method
GET

### Endpoint
/api/bookmarks/<bookmark_id>/assets/

### Parameters
#### Path Parameters
- **bookmark_id** (integer) - Required - The ID of the bookmark.

### Response
#### Success Response (200)
- **count** (integer) - Total number of assets.
- **next** (string|null) - URL for next page of results.
- **previous** (string|null) - URL for previous page of results.
- **results** (array) - List of asset objects.
  - **id** (integer) - Asset ID.
  - **bookmark** (integer) - Bookmark ID.
  - **asset_type** (string) - Type of asset (e.g., snapshot, upload).
  - **date_created** (string) - Creation timestamp.
  - **content_type** (string) - MIME type of the asset.
  - **display_name** (string) - Display name of the asset.
  - **status** (string) - Status of the asset (e.g., complete).

#### Response Example
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "bookmark": 1,
      "asset_type": "snapshot",
      "date_created": "2023-10-01T12:00:00Z",
      "content_type": "text/html",
      "display_name": "HTML snapshot from 10/01/2023",
      "status": "complete"
    },
    {
      "id": 2,
      "bookmark": 1,
      "asset_type": "upload",
      "date_created": "2023-10-01T12:05:00Z",
      "content_type": "image/png",
      "display_name": "example.png",
      "status": "complete"
    }
  ]
}
```

--------------------------------

### Authorization header example

Source: https://linkding.link/api

Shows the required Authorization header format for API requests. Replace <Token> with the user's API token from the Settings page.

```http
Authorization: Token <Token>
```

--------------------------------

### Implicit AND operator example

Source: https://linkding.link/search

Shows that combining words, phrases, or tags without an explicit operator assumes the 'and' operator.

```text
history rome #book
```

```text
history and rome and #book
```

--------------------------------

### List bookmarks - GET /api/bookmarks/

Source: https://linkding.link/api

Returns a paginated list of bookmarks. Supports query parameters: q, limit (default 100), offset, modified_since, added_since, and bundle. The response includes count, next, previous, and results array.

```http
GET /api/bookmarks/
```

```json
{
  "count": 123,
  "next": "http://127.0.0.1:8000/api/bookmarks/?limit=100&offset=100",
  "previous": null,
  "results": [
    {
      "id": 1,
      "url": "https://example.com",
      "title": "Example title",
      "description": "Example description",
      "notes": "Example notes",
      "web_archive_snapshot_url": "https://web.archive.org/web/20200926094623/https://example.com",
      "favicon_url": "http://127.0.0.1:8000/static/https_example_com.png",
      "preview_image_url": "http://127.0.0.1:8000/static/0ac5c53db923727765216a3a58e70522.jpg",
      "is_archived": false,
      "unread": false,
      "shared": false,
      "tag_names": [
        "tag1",
        "tag2"
      ],
      "date_added": "2020-09-26T09:46:23.006313Z",
      "date_modified": "2020-09-26T16:01:14.275335Z"
    },
    ...
  ]
}
```

--------------------------------

### Search example: rome (#article or #book)

Source: https://linkding.link/search

Searches for bookmarks containing 'rome' and tagged with either 'article' or 'book'.

```text
rome (#article or #book)
```

--------------------------------

### GET /api/bookmarks/check/

Source: https://linkding.link/api

Checks if a URL is already bookmarked. Returns bookmark data if it exists, otherwise null, along with metadata and auto tags.

```APIDOC
## GET /api/bookmarks/check/

### Description
Allows to check if a URL is already bookmarked. If the URL is already bookmarked, the `bookmark` property in the response holds the bookmark data, otherwise it is `null`. Also returns a `metadata` property that contains metadata scraped from the website. Finally, the `auto_tags` property contains the tag names that would be automatically added when creating a bookmark for that URL.

### Method
GET

### Endpoint
/api/bookmarks/check/

### Parameters
#### Query Parameters
- **url** (string) - Required - The URL to check (URL-encoded)

### Response
#### Success Response (200)
- **bookmark** (object) - The bookmark data if the URL is already bookmarked, otherwise null
- **metadata** (object) - Metadata scraped from the website
  - **title** (string) - Scraped website title
  - **description** (string) - Scraped website description
- **auto_tags** (array of strings) - Tag names that would be automatically added

#### Response Example

{
  "bookmark": {
    "id": 1,
    "url": "https://example.com",
    "title": "Example title",
    "description": "Example description",
    ...
  },
  "metadata": {
    "title": "Scraped website title",
    "description": "Scraped website description",
    ...
  },
  "auto_tags": [
    "tag1",
    "tag2"
  ]
}

```

--------------------------------

### Search example: history rome #book

Source: https://linkding.link/search

Searches for bookmarks containing both 'history' and 'rome' and tagged with 'book'.

```text
history rome #book
```

--------------------------------

### List archived bookmarks - GET /api/bookmarks/archived/

Source: https://linkding.link/api

Lists archived bookmarks. Parameters and response are the same as the regular list endpoint.

```http
GET /api/bookmarks/archived/
```

--------------------------------

### Search example: history rome not (#article or #book)

Source: https://linkding.link/search

Searches for bookmarks containing both 'history' and 'rome' but not tagged with either 'article' or 'book'.

```text
history rome not (#article or #book)
```

--------------------------------

### Create and copy a full backup with docker exec and docker cp

Source: https://linkding.link/backups

Creates a full backup of the linkding data folder as a zip file inside the Docker container, then copies that backup file to the current folder on the host system. The backup includes the database, assets, favicons, and preview images.

```bash
docker exec -it linkding python manage.py full_backup /etc/linkding/data/backup.zip
```

```bash
docker cp linkding:/etc/linkding/data/backup.zip backup.zip
```

--------------------------------

### Create SQLite database backup with linkding CLI

Source: https://linkding.link/backups

Executes the linkding CLI command to create a backup copy of the database inside the Docker container. The backup file is created at /etc/linkding/data/backup.sqlite3.

```bash
docker exec -it linkding python manage.py backup /etc/linkding/data/backup.sqlite3
```

--------------------------------

### Run linkding with Docker

Source: https://linkding.link/installation

Pulls and runs the linkding Docker image from Docker Hub or GitHub Container Registry. Replace {host-data-folder} with an absolute path for storing the database. The app will be accessible at http://localhost:9090.

```bash
# Using Docker Hub
docker run --name linkding -p 9090:9090 -v {host-data-folder}:/etc/linkding/data -d sissbruecker/linkding:latest
```

```bash
# Using GitHub Container Registry
docker run --name linkding -p 9090:9090 -v {host-data-folder}:/etc/linkding/data -d ghcr.io/sissbruecker/linkding:latest
```

--------------------------------

### GET /api/tags/<id>/

Source: https://linkding.link/api

Retrieves a single tag by ID.

```APIDOC
## GET /api/tags/<id>/

### Description
Retrieves a single tag by ID.

### Method
GET

### Endpoint
/api/tags/<id>/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the tag.

### Response
#### Success Response (200)
Returns the tag object.

#### Response Example
{
  "id": 1,
  "name": "example",
  "date_added": "2020-09-26T09:46:23.006313Z"
}
```

--------------------------------

### Create bookmark - POST /api/bookmarks/

Source: https://linkding.link/api

Creates a new bookmark. Tags are assigned by name. Including is_archived: true saves directly to archive. If URL already bookmarked, silently updates existing bookmark. If title/description empty, attempts to scrape from website unless disable_scraping query parameter is used.

```http
POST /api/bookmarks/
```

```json
{
  "url": "https://example.com",
  "title": "Example title",
  "description": "Example description",
  "notes": "Example notes",
  "is_archived": false,
  "unread": false,
  "shared": false,
  "tag_names": [
    "tag1",
    "tag2"
  ]
}
```

--------------------------------

### GET /api/bookmarks/<id>/

Source: https://linkding.link/api

Retrieves a single bookmark by ID.

```APIDOC
## GET /api/bookmarks/<id>/

### Description
Retrieves a single bookmark by ID.

### Method
GET

### Endpoint
/api/bookmarks/<id>/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the bookmark to retrieve

### Response
#### Success Response (200)
Returns the bookmark object.
```

--------------------------------

### POST /api/bookmarks/

Source: https://linkding.link/api

Creates a new bookmark. Tags are assigned by name. If the URL is already bookmarked, it silently updates the existing bookmark. If title and description are not provided, they are scraped from the website unless disabled.

```APIDOC
## POST /api/bookmarks/

### Description
Creates a new bookmark. Tags are simply assigned using their names. Including `is_archived: true` saves a bookmark directly to the archive. If the provided URL is already bookmarked, this silently updates the existing bookmark instead of creating a new one. If the title and description are not provided or empty, the application automatically tries to scrape them from the bookmarked website. This behavior can be disabled by adding the `disable_scraping` query parameter to the API request.

### Method
POST

### Endpoint
/api/bookmarks/

### Parameters
#### Query Parameters
- **disable_scraping** (boolean) - Optional - Disables automatic scraping of title and description from the bookmarked website

#### Request Body
- **url** (string) - Required - The URL of the bookmark
- **title** (string) - Optional - The title of the bookmark
- **description** (string) - Optional - The description of the bookmark
- **notes** (string) - Optional - Notes for the bookmark
- **is_archived** (boolean) - Optional - Whether the bookmark is archived
- **unread** (boolean) - Optional - Whether the bookmark is unread
- **shared** (boolean) - Optional - Whether the bookmark is shared
- **tag_names** (array of strings) - Optional - List of tag names to assign

### Request Example

{
  "url": "https://example.com",
  "title": "Example title",
  "description": "Example description",
  "notes": "Example notes",
  "is_archived": false,
  "unread": false,
  "shared": false,
  "tag_names": [
    "tag1",
    "tag2"
  ]
}


### Response
#### Success Response (201)
Returns the created bookmark object.
```

--------------------------------

### GET /api/bundles/<id>/

Source: https://linkding.link/api

Retrieves a single bundle by ID.

```APIDOC
## GET /api/bundles/<id>/

### Description
Retrieves a single bundle by ID.

### Method
GET

### Endpoint
/api/bundles/<id>/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the bundle.

### Response
#### Success Response (200)
Returns the bundle object.

#### Response Example
{
  "id": 1,
  "name": "Work Resources",
  "search": "productivity tools",
  "any_tags": "work productivity",
  "all_tags": "",
  "excluded_tags": "personal",
  "order": 0,
  "date_created": "2020-09-26T09:46:23.006313Z",
  "date_modified": "2020-09-26T16:01:14.275335Z"
}
```

--------------------------------

### Retrieve bookmark - GET /api/bookmarks/<id>/

Source: https://linkding.link/api

Retrieves a single bookmark by its ID.

```http
GET /api/bookmarks/<id>/
```

--------------------------------

### POST /api/bundles/

Source: https://linkding.link/api

Creates a new bundle. If no order is specified, the bundle is automatically assigned the next available order position.

```APIDOC
## POST /api/bundles/

### Description
Creates a new bundle. If no `order` is specified, the bundle will be automatically assigned the next available order position.

### Method
POST

### Endpoint
/api/bundles/

### Request Body
- **name** (string) - Required - Bundle name.
- **search** (string) - Optional - Search terms.
- **any_tags** (string) - Optional - Tags that match any.
- **all_tags** (string) - Optional - Tags that must all match.
- **excluded_tags** (string) - Optional - Tags to exclude.
- **order** (integer) - Optional - Order position.

### Request Example
{
  "name": "My Bundle",
  "search": "search terms",
  "any_tags": "tag1 tag2",
  "all_tags": "required-tag",
  "excluded_tags": "excluded-tag",
  "order": 5
}

### Response
#### Success Response (201)
Returns the created bundle object.

#### Response Example
{
  "id": 3,
  "name": "My Bundle",
  "search": "search terms",
  "any_tags": "tag1 tag2",
  "all_tags": "required-tag",
  "excluded_tags": "excluded-tag",
  "order": 5,
  "date_created": "2020-09-26T09:46:23.006313Z",
  "date_modified": "2020-09-26T09:46:23.006313Z"
}
```

--------------------------------

### GET /api/bookmarks/archived/

Source: https://linkding.link/api

Lists archived bookmarks. Parameters and response are the same as for the regular list endpoint.

```APIDOC
## GET /api/bookmarks/archived/

### Description
List archived bookmarks.

### Method
GET

### Endpoint
/api/bookmarks/archived/

### Parameters
#### Query Parameters
Same as for the regular list endpoint.

### Response
#### Success Response (200)
Same as for the regular list endpoint.
```

--------------------------------

### Create bundle

Source: https://linkding.link/api

Creates a new bundle. If no 'order' is specified, the bundle is automatically assigned the next available order position.

```http
POST /api/bundles/
```

--------------------------------

### GET /api/bookmarks/<bookmark_id>/assets/<id>/

Source: https://linkding.link/api

Retrieves a single asset by ID for a specific bookmark.

```APIDOC
## GET /api/bookmarks/<bookmark_id>/assets/<id>/

### Description
Retrieves a single asset by ID for a specific bookmark.

### Method
GET

### Endpoint
/api/bookmarks/<bookmark_id>/assets/<id>/

### Parameters
#### Path Parameters
- **bookmark_id** (integer) - Required - The ID of the bookmark.
- **id** (integer) - Required - The ID of the asset.

### Response
#### Success Response (200)
Returns the asset object.

#### Response Example
{
  "id": 1,
  "bookmark": 1,
  "asset_type": "snapshot",
  "date_created": "2023-10-01T12:00:00Z",
  "content_type": "text/html",
  "display_name": "HTML snapshot from 10/01/2023",
  "status": "complete"
}
```

--------------------------------

### Search example: history rome not #article

Source: https://linkding.link/search

Searches for bookmarks containing both 'history' and 'rome' but not tagged with 'article'.

```text
history rome not #article
```

--------------------------------

### List bundles

Source: https://linkding.link/api

Lists bundles. Supports limit and offset parameters; default limit is 100.

```http
GET /api/bundles/
```

--------------------------------

### List bookmark assets

Source: https://linkding.link/api

Lists all assets for a specific bookmark. The response is a paginated list of asset objects.

```http
GET /api/bookmarks/<bookmark_id>/assets/
```

--------------------------------

### POST /api/bookmarks/<bookmark_id>/assets/upload/

Source: https://linkding.link/api

Uploads a new asset for a specific bookmark. The request must be multipart/form-data with a single part named 'file'.

```APIDOC
## POST /api/bookmarks/<bookmark_id>/assets/upload/

### Description
Uploads a new asset for a specific bookmark. The request must be a `multipart/form-data` request with a single part named `file` containing the file to upload.

### Method
POST

### Endpoint
/api/bookmarks/<bookmark_id>/assets/upload/

### Parameters
#### Path Parameters
- **bookmark_id** (integer) - Required - The ID of the bookmark.

#### Request Body
- **file** (file) - Required - The file to upload.

### Response
#### Success Response (200)
Returns the created asset object.

#### Response Example
{
  "id": 3,
  "bookmark": 1,
  "asset_type": "upload",
  "date_created": "2023-10-01T12:10:00Z",
  "content_type": "application/pdf",
  "display_name": "example.pdf",
  "status": "complete"
}
```

--------------------------------

### Copy SQLite backup from Docker container to host

Source: https://linkding.link/backups

Copies the backup.sqlite3 file from the Docker container to the current folder on the host system. After this, the file can be moved to a backup location.

```bash
docker cp linkding:/etc/linkding/data/backup.sqlite3 backup.sqlite3
```

--------------------------------

### Download bookmark asset

Source: https://linkding.link/api

Downloads the asset file for a specific bookmark asset.

```http
GET /api/bookmarks/<bookmark_id>/assets/<id>/download/
```

--------------------------------

### POST /api/bookmarks/<id>/unarchive/

Source: https://linkding.link/api

Unarchives a bookmark.

```APIDOC
## POST /api/bookmarks/<id>/unarchive/

### Description
Unarchives a bookmark.

### Method
POST

### Endpoint
/api/bookmarks/<id>/unarchive/

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the bookmark to unarchive

### Response
#### Success Response (200)
Returns the unarchived bookmark object.
```

--------------------------------

### Search example: "history of rome" #book

Source: https://linkding.link/search

Searches for bookmarks containing the exact phrase 'history of rome' and tagged with 'book'.

```text
"history of rome" #book
```
Tokens:
Raw