---
url: https://gudhub.com/docs/ssr-ssg/server/endpoints/
title: "API Endpoints Documentation\n                #"
description: "This document describes the API endpoints available in the SSR SSG server, their purposes, and expected behaviors. Each section outlines the HTTP method, endpoi"
lang: uk
updated: 2026-09-08T15:34:11.633Z
---

# API Endpoints Documentation [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#api-endpoints-documentation)

## Overview [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#overview)

This document describes the API endpoints available in the SSR-SSG server, their purposes, and expected behaviors. Each section outlines the HTTP method, endpoint path, description, and details of the expected request and response.

---

## Content [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#content)

-   [API Endpoints Documentation](#api-endpoints-documentation)
    -   [Overview](#overview)
    -   [Content](#content)
    -   [Sitemap and Feed Endpoints](#sitemap-and-feed-endpoints)
        -   [`/sitemap.xml`](#sitemapxml)
        -   [`/:type-sitemap.xml`](#type-sitemapxml)
    -   [Page and File Endpoint](#page-and-file-endpoint)
        -   [`*`](#)
    -   [SSR Menu Endpoints](#ssr-menu-endpoints)
        -   [`/auth`](#auth)
        -   [`/ssr-menu`](#ssr-menu)
    -   [Utility Endpoints](#utility-endpoints)
        -   [`/version`](#version)

---

## Sitemap and Feed Endpoints [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#sitemap-and-feed-endpoints)

### `/sitemap.xml` [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#sitemap-xml)

-   **Method**: `GET`
-   **Description**: Generates a general sitemap for the website.
-   **Behavior**:
    -   Uses website sitemap configurations to determine sitemap structure.
    -   Returns xml file with list of typed-sitemap with link for it ( `/:type-sitemap.xml` ).

### `/:type-sitemap.xml` [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#type-sitemap-xml)

-   **Method**: `GET`
-   **Description**: Generates a type-specific sitemap (e.g., articles, categories, pages).
-   **Behavior**:
    -   Uses website sitemap configurations for type-specific generation.

## Page and File Endpoint [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#page-and-file-endpoint)

### `*` [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#section-7)

-   **Method**: `GET`
-   **Description**: Catches all unspecified requests and serves the appropriate content or error page.
-   **Behavior**:
    -   Resolves requests to static files or generates pages dynamically (SSR/SSG mode).
    -   Handles redirects, trailing slash enforcement, and query parameter sanitization.
    -   Attempts to serve a `404.html` page or defaults to a "404" response if no page or file is found.

---

## SSR Menu Endpoints [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#ssr-menu-endpoints)

### `/auth` [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#auth)

-   **Method**: `GET`
-   **Description**: Serves the authentication page.

### `/ssr-menu` [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#ssr-menu)

-   **Method**: `GET`
-   **Description**: Provides indexed site pages with opportunity to update them ( SSR ).
-   **Middleware**: `authenticateToken` (Validates user authentication).

---

## Utility Endpoints [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#utility-endpoints)

### `/version` [#](https://gudhub.com/docs/ssr-ssg/server/endpoints/#version)

-   **Method**: `GET`
-   **Description**: Returns the current version of the package.
-   **Response**: Plain text containing the version number.