rfcs

Search Ietf Rfcs

Search the IETF RFCs that 3GPP specs depend on (SIP, SDP, Diameter, SCTP, QUIC, HTTP/2, OAuth, RTP, DetNet, IGP Flex-Algo and more), by meaning and by exact term.

Use when a question is about a protocol the IETF defines and 3GPP references, or when a 3GPP clause says "as defined in RFC xxxx". The corpus is every RFC a current 3GPP spec cites (obsoleted ones included, since specs cite them by number) plus the current RFCs of the transport and signalling working groups. It holds no Internet-Drafts. RFC numbers in the query (for example "RFC 3261") bring in that RFC's passages. For 3GPP's own text use search_text; this tool never returns 3GPP clauses.

Each result is one passage with its RFC number, title, section number and title, verbatim text, a link to the section on rfc-editor.org (url), status, obsoleted_by and updated_by, the attribution line to show with any quote, and cited_by: the 3GPP clauses that name this RFC (read one with get_sections). Call get_rfc_section for a whole section or an RFC's outline.

Quoting rules: at most 100 words per excerpt and 300 words from one RFC per answer, verbatim, each with its attribution line.

Errors: 400 invalid_parameter, 502 search_unavailable.

post/rfcs/search

Request

  • Base URL: https://api.3gppscout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.3gppscout.com/rfcs/search
  • Auth: none declared

Request body

querystring required

What the RFC text should say, in plain words or exact terms, e.g. 'SCTP path failure detection', 'Flex-Algo prefix advertisement', 'RFC 3261 3xx response handling'.

rfcsinteger[] nullable

Only these RFC numbers, e.g. [3261, 3264].

include_obsoletedboolean

Include RFCs that a later RFC obsoletes. 3GPP specs often cite those by number.

cited_onlyboolean

Only RFCs that a current 3GPP spec cites.

top_kinteger

Passages to return.

max_per_rfcinteger

At most this many passages from one RFC. Use 1 for a list of distinct RFCs.

include_textboolean

Include each passage's text.

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.