/options

GET /options

Get runtime options

Retrieves the current runtime options configuration. SuperAdmin role required.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Try it out

Output:

Responses

Description

Runtime options retrieved successfully

{
  "logHealthChecks": false,
  "logRequestHeaders": false,
  "logRequestBody": false,
  "logResponseHeaders": false,
  "logResponseBody": false,
  "logObjects": false
}

References

#/components/schemas/RuntimeOptions

OpenAPI
TypeScript

type: object
properties:
  logHealthChecks:
    type: boolean
    description: Whether to log health check requests
  logRequestHeaders:
    type: boolean
    description: Whether to log request headers
  logRequestBody:
    type: boolean
    description: Whether to log request bodies
  logResponseHeaders:
    type: boolean
    description: Whether to log response headers
  logResponseBody:
    type: boolean
    description: Whether to log response bodies
  logObjects:
    type: boolean
    description: Whether to log objects

|
export interface RuntimeOptions {
  /** Whether to log health check requests */
  logHealthChecks?: boolean;
  /** Whether to log request headers */
  logRequestHeaders?: boolean;
  /** Whether to log request bodies */
  logRequestBody?: boolean;
  /** Whether to log response headers */
  logResponseHeaders?: boolean;
  /** Whether to log response bodies */
  logResponseBody?: boolean;
  /** Whether to log objects */
  logObjects?: boolean;
}

Route Source Code

Check out the source code for this route entrypoint here: /options/route.ts

Or the swagger.yaml spec this documentation was generated from: /options/swagger.yaml