Read IANA registry records
iana_get_registry_recordsRead records from any IANA XML registry by id, e.g. registry "tls-parameters" with subregistry "tls-parameters-4" (TLS Cipher Suites), "protocol-numbers", "http-methods", or "cbor-tags"; an iana.org/assignments URL also works. Filter with value (exact match on the key column, or on the column field names; digits compare by number with a cell of digits ("0443" finds "443") and one 0x token with a one-token 0x cell ("0x5" finds "0x05"), each also matching its own kind of range row ("105-199", "0x11-0xff"); other 0x forms compare their digits as written, in any comma, space, or brace spelling) and contains (words in any field; records with a field equal to the words come first). When a registry has several sub-registries and none is given, the response lists them instead of records; a table that nests tables lists them too. Field names are the registry's XML element names (e.g. "rec" is the Recommended column). Large registries page through cursor. Find ids with iana_search_registries.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| field | No | Column for value to match instead of the key column, case-insensitive, one of the names in columns: e.g. "type" for a DNS RR type mnemonic, or "name" for every row of a service name. Ignored without value. | |
| limit | No | Maximum number of results to return, 1–100. Default 25. | |
| value | No | Exact match on the key column named by value_field (value, else number, else the first column), or on field when set; case and whitespace are ignored. A value of digits compares by number with a cell of digits, so "0443" finds "443", and also matches range rows such as "105-199"; it never matches a 0x cell. One 0x token compares by number with a one-token 0x cell, so "0x5" finds "0x05", and also matches range rows such as "0x11-0xff". Any other pair of 0x forms compares the digits as written: "0x1301", "{0x13,0x01}", and "0x13 0x01" all find "0x13,0x01", while "0x13" never finds "0x00,0x13". | |
| cursor | No | next_cursor from the previous page; reuse it only with the same registry, subregistry, value, field, and contains. | |
| contains | No | Words matched as whole tokens against every field and reference id, e.g. "chacha20". Records with a field equal to the words come first. | |
| registry | Yes | Registry id, e.g. "tls-parameters", or its https://www.iana.org/assignments/<id> URL (a #fragment selects the sub-registry when subregistry is unset). | |
| subregistry | No | Sub-registry id, case-insensitive, e.g. "tls-parameters-4". Omit to read the only sub-registry, or to list them when there are several. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | The limit applied. | |
| error | No | Present when the call failed. Absent on success. | |
| notes | No | Notes of the table read (of the registry, when listing), first page only. With registry_notes: the first 25 and 4,000 characters at most, these first. | |
| shown | No | Results returned. | |
| notice | No | Guidance on a miss, a cut list, or another condition. | |
| offset | No | Matching records before this page, on pages after the first. | |
| source | No | Provenance and freshness of the answer. | |
| columns | No | Field (XML element) names seen, first-seen order, the first 50. | |
| records | No | Records in registry order (with contains, records with a field equal to the words first), up to limit and a 48,000-character page budget. | |
| truncated | No | True when more matches exist than were returned. | |
| references | No | The documents that define the table read, the first 25. | |
| totalCount | No | Matches before the limit was applied. | |
| description | No | Description of the table read, or of the registry when listing; a YANG module registry names its module file here. At most 2,000 characters. | |
| next_cursor | No | Pass as cursor, with the same filters, for the next page. | |
| registry_id | No | Registry id. | |
| value_field | No | The table's key column: each record's value comes from it, and the value filter matches it unless field names another. | |
| subregistries | No | Tables to read next, the first 250: every sub-registry when one must be chosen (records is then empty), or the tables nested directly in the table read, on its first page. | |
| registry_notes | No | The registry root's notes and footnotes, on the first page of a sub-registry read; records cite them by anchor. Shares the notes caps, after notes. | |
| registry_title | No | Registry title. | |
| subregistry_id | No | Id of the sub-registry the records come from. | |
| notes_truncated | No | True when notes or registry_notes were cut at 4,000 characters. | |
| subregistry_title | No | Title of that sub-registry. | |
| registration_ranges | No | Allocation ranges, when the table defines them: the first 25, each text at most 2,000 characters. | |
| registration_procedure | No | Registration rule of the table read, or of the registry when listing; at most 2,000 characters. |