> ## Documentation Index > Fetch the complete documentation index at: https://gproxy.leenhawk.com/llms.txt > Use this file to discover all available pages before exploring further. # GET /admin/api/settings ## OpenAPI ````yaml /generated/openapi.json get /admin/api/settings openapi: 3.1.0 info: description: >- Forwarding, management, portal and OAuth APIs generated from Rust types. Input and output schemas preserve their respective Serde contracts. Streaming events and WebSocket messages are documented alongside HTTP payloads. title: GPROXY HTTP API version: 4.2.1 servers: [] security: - bearer: [] - anthropicKey: [] - googleKey: [] - queryKey: [] paths: /admin/api/settings: get: tags: - Management summary: GET /admin/api/settings parameters: - description: Administrative scope selected by the caller. in: header name: x-gproxy-admin-scope required: false schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Output_SettingsDto' description: Success default: content: application/json: schema: $ref: '#/components/schemas/Output_Envelope' description: Gateway error security: - consoleSession: [] - bearer: [] - anthropicKey: [] - googleKey: [] components: schemas: Output_SettingsDto: properties: instance: $ref: '#/components/schemas/Output_InstanceSettingsDto' logging: $ref: '#/components/schemas/Output_LoggingSettingsDto' required: - instance - logging type: object Output_Envelope: properties: error: $ref: '#/components/schemas/Output_EnvelopeBody' required: - error type: object Output_InstanceSettingsDto: additionalProperties: false description: >- Identity, network, execution limits and maintenance. `config_revision` is read-only: it is the write path's own counter. properties: allowedHeaders: default: [] alwaysSecureCookie: default: false description: Absent in an export from a build without it, which reads as off. type: boolean capturePayloadMaxMb: default: 2048 format: int64 type: - integer - 'null' capturePayloadRetentionDays: default: 7 format: uint32 minimum: 0 type: - integer - 'null' configRevision: format: int64 type: integer connectionProfileId: type: - string - 'null' corsOrigins: true defaultVocabularyFileId: type: - string - 'null' enableAutoUpdateCheck: type: boolean enableSettlement: type: boolean enableTokenizerDownload: type: boolean enableTokenizerVocabs: type: boolean enableUsage: type: boolean hasTokenizerAuthToken: description: |- The vocabulary source token is sealed like a credential secret; only its presence is reported. type: boolean instanceName: type: string maxAttempts: format: uint32 minimum: 0 type: integer maxDatabaseSizeMb: format: int64 type: - integer - 'null' maxMultipartParts: default: 64 format: uint32 minimum: 0 type: integer maxRequestBodyBytes: default: 134217728 format: int64 type: integer maxResponseBodyBytes: default: 268435456 format: int64 type: integer maxStreamEventBytes: default: 33554432 format: int64 type: integer maxUploadBodyBytes: default: 536870912 format: int64 type: integer maxWsFrameBytes: default: 33554432 format: int64 type: integer oauthClientAllowlist: true portalRecentRequestsEnabled: type: boolean proxy: default: null quotaObservationRetentionDays: default: 90 description: |- Days of upstream quota observations to keep; None keeps them all. Cycles are never pruned. Absent in an older export, which reads as the 90-day default. format: uint32 minimum: 0 type: - integer - 'null' requestTimeoutMs: default: 1200000 format: uint32 minimum: 0 type: integer retentionDays: description: Days of completed request captures to keep; None keeps them all. format: uint32 minimum: 0 type: - integer - 'null' streamIdleTimeoutMs: default: 300000 format: uint32 minimum: 0 type: integer trustedProxies: true updateChannel: type: - string - 'null' updateSource: type: - string - 'null' updateVerifySignature: type: - boolean - 'null' usageRetentionDays: default: null description: |- Days of usage records to keep; None keeps them all. Usage statistics and totals are computed from these. Absent in an older export, which reads as keeping everything. format: uint32 minimum: 0 type: - integer - 'null' required: - instanceName - allowedHeaders - oauthClientAllowlist - connectionProfileId - proxy - corsOrigins - trustedProxies - alwaysSecureCookie - maxAttempts - enableSettlement - enableUsage - configRevision - requestTimeoutMs - streamIdleTimeoutMs - maxRequestBodyBytes - maxUploadBodyBytes - maxResponseBodyBytes - maxStreamEventBytes - maxWsFrameBytes - maxMultipartParts - enableTokenizerVocabs - enableTokenizerDownload - defaultVocabularyFileId - hasTokenizerAuthToken - retentionDays - usageRetentionDays - capturePayloadRetentionDays - capturePayloadMaxMb - quotaObservationRetentionDays - maxDatabaseSizeMb - updateChannel - updateSource - updateVerifySignature - enableAutoUpdateCheck - portalRecentRequestsEnabled type: object Output_LoggingSettingsDto: properties: disableLogRedaction: type: boolean enableDownstreamLog: type: boolean enableDownstreamLogBody: type: boolean enableTracing: type: boolean enableUpstreamLog: type: boolean enableUpstreamLogBody: type: boolean logFormat: type: string logLevel: type: string queryParameterBlacklist: true requestHeaderBlacklist: true responseHeaderBlacklist: true required: - enableDownstreamLog - enableDownstreamLogBody - enableUpstreamLog - enableUpstreamLogBody - disableLogRedaction - enableTracing - logLevel - logFormat - requestHeaderBlacklist - responseHeaderBlacklist - queryParameterBlacklist type: object Output_EnvelopeBody: properties: code: type: string message: type: string required: - code - message type: object securitySchemes: bearer: scheme: bearer type: http anthropicKey: in: header name: x-api-key type: apiKey googleKey: in: header name: x-goog-api-key type: apiKey queryKey: in: query name: key type: apiKey consoleSession: in: cookie name: gproxy_session type: apiKey ```` ## Related topics - [PATCH /admin/api/settings](https://gproxy.leenhawk.com/api-reference/management/patch-adminapisettings.md) - [GET /admin/api/providers](https://gproxy.leenhawk.com/api-reference/management/get-adminapiproviders.md) - [GET /admin/api/providers/{id}](https://gproxy.leenhawk.com/api-reference/management/get-adminapiproviders-1.md) - [GET /admin/api/api-keys](https://gproxy.leenhawk.com/api-reference/management/get-adminapiapi-keys.md) - [GET /admin/api/session](https://gproxy.leenhawk.com/api-reference/management/get-adminapisession.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.