Skip to main content
GET
/
search
/
docs
Search Altostrat Documentation
curl --request GET \
  --url https://api.altostrat.io/search/docs \
  --header 'Authorization: Bearer <token>'
[
  {
    "title": "Configuring BGP on MikroTik",
    "description": "A step-by-step guide to setting up BGP peering sessions on MikroTik RouterOS.",
    "type": "doc",
    "href": "https://altostrat.io/docs/networking/bgp-mikrotik",
    "content": "...to establish a BGP session, you must first define a remote peer with the correct ASN..."
  }
]

Authorizations

​
Authorization
string
header
required

Enter your bearer token in the format: Bearer {token}

Query Parameters

​
q
string
required

The search query string for finding relevant documentation.

Maximum length: 255
​
limit
integer
default:10

The maximum number of search results to return.

Required range: 1 <= x <= 20
​
include_content
boolean
default:false

If true, the response will include a snippet of the matching content from the document.

Response

A list of matching documentation pages.

​
title
string

The title of the documentation page.

Example:

"Configuring BGP on MikroTik"

​
description
string

The summary or meta description of the page.

Example:

"A step-by-step guide to setting up BGP peering sessions on MikroTik RouterOS."

​
type
enum<string>

The type of documentation. api for API reference, doc for guides and articles.

Available options:
api,
doc
Example:

"doc"

​
href
string<uri>

The full URL to the documentation page.

Example:

"https://altostrat.io/docs/networking/bgp-mikrotik"

​
content
string

A snippet of the page content that matches the search query. Only included if include_content=true.

Example:

"...to establish a BGP session, you must first define a remote peer with the correct ASN..."