Linkwarden Worker API

The Worker API from Linkwarden — 2 operation(s) for worker.

Operations 2

GET /api/v1/worker Get worker statistics #
DELETE /api/v1/worker/preservation Reset preserved data in bulk #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/linkwarden:linkwarden-worker-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

linkwarden-worker-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: Linkwarden OpenAPI Documentation.
  version: 1.0.0
  title: Introduction Worker API
  license:
    name: GNU Affero General Public License v3.0
    url: https://www.gnu.org/licenses/agpl-3.0.html
tags:
- name: Worker
paths:
  /api/v1/worker:
    get:
      security:
      - bearerAuth: []
      tags:
      - Worker
      summary: Get worker statistics
      description: Returns preservation and search indexing queue statistics for the server admin user.
      responses:
        '200':
          description: Worker statistics retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      link:
                        type: object
                        properties:
                          pending:
                            type: integer
                          done:
                            type: integer
                          failed:
                            type: integer
                      search:
                        type: object
                        properties:
                          pending:
                            type: integer
                          done:
                            type: integer
                  success:
                    type: boolean
                  message:
                    type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      operationId: getApiV1Worker
      x-operation-id-source: derived
  /api/v1/worker/preservation:
    delete:
      security:
      - bearerAuth: []
      tags:
      - Worker
      summary: Reset preserved data in bulk
      description: Server-admin-only endpoint for clearing preserved files across all links or only links with broken archives.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - action
              properties:
                action:
                  type: string
                  enum:
                  - allAndRePreserve
                  - allBroken
      responses:
        '200':
          description: Preservation reset started successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: string
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
      operationId: deleteApiV1WorkerPreservation
      x-operation-id-source: derived
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    BadRequest:
      description: Bad request error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      properties:
        response:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT