Skip to main content

Retrieves an archive file by link ID

GET 

/api/v1/archives/:linkId

Retrieves an archive file in the specified format.

Request

Path Parameters

    linkId stringrequired

    The ID of the desired link

Query Parameters

    format integer

    Possible values: [0, 1, 2, 3, 4]

    The numeric value corresponding to the format of the file being uploaded:

    • 0: PNG
    • 1: JPEG
    • 2: PDF
    • 3: Readability JSON
    • 4 Monolith HTML
    preview boolean

    Indicates whether to return a preview of the archive.

Responses

Archive file retrieved successfully.
Schema
    response object

    The archive file.

Authorization: http

name: bearerAuthtype: httpscheme: bearerbearerFormat: JWT
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://docs.linkwarden.app/api/v1/archives/:linkId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <TOKEN>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Auth
Parameters
— pathrequired
— query
— query