Subscriptions
25 endpoints.
list_reservations
Section titled “list_reservations”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is list_reservations in crates/lanrurugi-api/src/subscriptions/api.rs:1003.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:54.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
discard_reservation
Section titled “discard_reservation”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is discard_reservation in crates/lanrurugi-api/src/subscriptions/api.rs:1023.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:55.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is list in crates/lanrurugi-api/src/subscriptions/api.rs:168.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:27.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
create
Section titled “create”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is create in crates/lanrurugi-api/src/subscriptions/api.rs:245.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:27.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
remove
Section titled “remove”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is remove in crates/lanrurugi-api/src/subscriptions/api.rs:348.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:40.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
detail
Section titled “detail”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is detail in crates/lanrurugi-api/src/subscriptions/api.rs:288.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:40.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
update
Section titled “update”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is update in crates/lanrurugi-api/src/subscriptions/api.rs:307.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:40.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
The user’s own “no”: these works are never downloaded by this subscription again
Section titled “The user’s own “no”: these works are never downloaded by this subscription again”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:640), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
The user’s own “no”: these works are never downloaded by this subscription again.
Distinct from a rule rejection on purpose — a rule reads a value that can change, so a rejection is
provisional and decided afresh every cycle (FR-011i), while this is an answer, and re-deciding it
would ask again what the user already said. The preview offers it per row; forget_seen undoes it.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:50.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Runs a real check now rather than waiting for the schedule (FR-024)
Section titled “Runs a real check now rather than waiting for the schedule (FR-024)”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:842), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Runs a real check now rather than waiting for the schedule (FR-024).
Spawned rather than awaited: a check contacts the source and may page through it, which is longer than a request should hold open. The result shows up in the subscription’s own history.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:48.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
disable
Section titled “disable”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is disable in crates/lanrurugi-api/src/subscriptions/api.rs:384.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:45.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
enable
Section titled “enable”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is enable in crates/lanrurugi-api/src/subscriptions/api.rs:374.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:44.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Makes a subscription reconsider works it has already handled
Section titled “Makes a subscription reconsider works it has already handled”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:593), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Makes a subscription reconsider works it has already handled.
Being seen is otherwise permanent, which is correct for the ordinary case — a work the user deleted on purpose must not come back on the next check. But two situations need it undone: a deletion made by mistake, and a rule that has since been widened (works rejected under the old rule were recorded as seen at the moment they were rejected, so nothing would reconsider them).
With sources, forgets exactly those. With all: true, clears the set — kept as a separate,
explicit request because on a long-running subscription it can match the entire back catalogue at
once, which is a different order of consequence.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:49.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
What a check would do, without doing it
Section titled “What a check would do, without doing it”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:799), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
What a check would do, without doing it.
Deliberately works on a disabled subscription: “what would this rule actually catch” is asked precisely while tuning one that is switched off. Nothing is queued, recorded as seen, or logged, so it is safe to run repeatedly — the only cost is one request to the source.
Accepts an optional body carrying an unsaved subscription, so a rule can be previewed before it is committed. Without that, a user would have to save a rule to find out what it does.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:47.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Clears a system-applied pause
Section titled “Clears a system-applied pause”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:396), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Clears a system-applied pause. Distinct from enable, because a paused subscription was stopped
by the system and owes the user an explanation — resuming is the user answering it.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:46.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Every work the user has explicitly blocked, newest first, across all subscriptions
Section titled “Every work the user has explicitly blocked, newest first, across all subscriptions”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:413), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Every work the user has explicitly blocked, newest first, across all subscriptions.
Its own endpoint rather than a filter over the history: a block is an answer — the user said no
to this work — and the history is a log of decisions that keeps being rewritten by later cycles
(a work queued and then catalogued reads already_held in every record). Only the block list
stays exactly as the user left it, which is what makes it worth showing on its own and undoing
from there.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:53.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
generate
Section titled “generate”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is generate in crates/lanrurugi-api/src/subscriptions/ai_condition.rs:302.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:38.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The handler is parse in crates/lanrurugi-api/src/subscriptions/ai_condition.rs:285.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:39.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Every subscription’s recent candidates, newest first, as one stream
Section titled “Every subscription’s recent candidates, newest first, as one stream”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:446), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Every subscription’s recent candidates, newest first, as one stream.
Per-subscription history already exists, but it answers “what did this rule do” — the question actually asked is usually the other one: what has arrived lately, and why did something expected not. That needs the subscriptions interleaved rather than read one at a time.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:52.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Matched works waiting for the user’s go-ahead
Section titled “Matched works waiting for the user’s go-ahead”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:855), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Matched works waiting for the user’s go-ahead. Only reachable because auto_download defaults
off — without this, that default would leave candidates recorded but unanswerable.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:31.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Approving is the moment unattended matching becomes attended spending — nothing before this point
Section titled “Approving is the moment unattended matching becomes attended spending — nothing before this point”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:888), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Approving is the moment unattended matching becomes attended spending — nothing before this point consumes download credit.
Partial success is reported rather than rolled back: with several items, one that fails to queue is no reason to un-approve the rest, and the caller is told exactly which ones did not make it.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:32.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Dismissing marks each work seen, so later checks do not raise the same question again
Section titled “Dismissing marks each work seen, so later checks do not raise the same question again”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:976), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Dismissing marks each work seen, so later checks do not raise the same question again. This is the user answering “no” — distinct from a reservation, which is the system reporting it could not download something.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:33.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Previews a subscription that does not exist yet
Section titled “Previews a subscription that does not exist yet”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:740), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Previews a subscription that does not exist yet.
The id-bearing route cannot serve this: there is no record to read. Yet a subscription being created is exactly when “what would this actually catch” matters most — afterwards the user has already committed to the rule. The draft is evaluated against the source as it is now, and nothing is stored either way.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:36.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Re-judges a listing already fetched, against possibly-different conditions
Section titled “Re-judges a listing already fetched, against possibly-different conditions”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:680), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Re-judges a listing already fetched, against possibly-different conditions.
Changing a condition changes nothing about what the source would return — only criteria shapes
the request — so re-fetching would be wasted, slow, and one more hit on a source that rate-limits.
The judgment still happens here rather than in the browser, because a second implementation of the
condition tree would eventually disagree with the real one.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:37.
This response carries no example body.
This endpoint needs an administrator token — a guest (read-only) token is refused by the server.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Which sources can back a subscription, with their interval bounds — so the UI can offer only
Section titled “Which sources can back a subscription, with their interval bounds — so the UI can offer only”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:182), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Which sources can back a subscription, with their interval bounds — so the UI can offer only viable sources and show the bounds before the user submits, rather than teaching them the rules through a rejection.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:28.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.
Which subscriptions have already handled a given work, by its source URL
Section titled “Which subscriptions have already handled a given work, by its source URL”Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.
The note below is the handler’s own documentation comment (crates/lanrurugi-api/src/subscriptions/api.rs:551), quoted verbatim. It is written for maintainers of this codebase and may reference internal identifiers.
Which subscriptions have already handled a given work, by its source URL.
Asked before deleting an archive, so the delete flow only offers “stop this coming back” for an archive a subscription actually brought in — offering it for a hand-uploaded file would be an option with no effect, which is worse than no option at all.
Responses
200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/subscriptions/api.rs:51.
This response carries no example body.
Request failed — Usual causes: the instance address is wrong or unreachable; cross-origin access is not enabled on the instance; or this page is HTTPS while the instance is plain HTTP on a LAN address, which the browser blocks as mixed content. “Copy as cURL” above sends the same request from a terminal.
Your own instance address. Requests go from this browser straight to it.