Skip to content
DezfilDocsv0.1.0

API and agentsAPI reference

TemplateCatalogueState

object

Where the template catalogue stands for this list.

  • statestringrequired

    listed: the last read listed templates; empty: it listed none this server reads; not_read: no read since this process started or since the address or the switch changed; off: an admin turned the catalogue off; unreachable: nothing answered; slow: no answer within the link import's time bound; refused: see reason.

    One of listed, empty, not_read, off, unreachable, slow, refused

  • hoststringor nullrequired

    The catalogue's scheme and host, never its path or query; null for a folder or an address this server cannot read.

  • folderbooleanrequired

    True when DEZFIL_TEMPLATES_CATALOGUE names a folder on this server; its path is never given.

  • readAtstringor nullrequiredformat date-time

    When the kept list was read; null before any read.

  • reasonstringor nullrequired

    Why it was refused: status (the catalogue answered with the status below), egress_blocked (the egress rules), service_address_unreadable (a saved address the instance's key no longer opens), template_index_too_large (over 1 MB), template_index_invalid (not an index this server reads), template_index_repeats_id (an id twice) or template_address_outside (an archive or picture address outside the catalogue's origin or folder). Null unless the state is refused.

    One of status, egress_blocked, service_address_unreadable, template_index_too_large, template_index_invalid, template_index_repeats_id, template_address_outside, null

  • statusintegeror nullrequiredminimum 100maximum 599

    The status the catalogue answered with; null unless the reason is status.

  • messagestring

    Only for template_index_invalid, a plain-text reason naming the first offending field and its entry's zero-based position and id when available, with names limited to 120 characters and no other index values.

No other keys.

Dezfil · Apache-2.0docs from 7439201b