Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Core functionalities for the Search GAIA API, such as configuration and health check.

Status Check

This endpoint allows you to check the status of the server. It is used to verify if the Search GAIA API is up and running.

Note

No authentication is required to call this endpoint.

Parameters

Info

This endpoint does not require any parameters.

Table of Contents
maxLevel2

Example

Code Block
languagebash
GET /es/api/

Response

Successful Response [200]

Code Block
SearchGAIA API Running

Get Config

This endpoint retrieves the configuration of the Search GAIA API.

Parameters

Info

This endpoint does not require any parameters.


Example

Code Block
languagebash
GET /es/api/v1/core/config

Response

Successful Response [200]

Code Block
{
  "host": "string",
  "port": 8085,
  "workers": 1,
  "cors": {
    "allow_origins": [],
    "allow_credentials": true,
    "allow_methods": [
      "*"
    ],
    "allow_headers": [
      "*"
    ],
    "expose_headers": [
      "*"
    ],
    "max_age": 600
  },
  "security": {
    "authentication": {
      "enabled": false,
      "type": "local",
   .       .
       .}