Forest Admin - API reference
    Preparing search index...

    Type Alias AgentOptions

    Options to configure behavior of an agent's forestadmin driver

    type AgentOptions = {
        auditTrail?: AuditTrailConfig | null;
        authSecret: string;
        bodyParserOptions?: {
            enableRawChecking?: boolean;
            jsonLimit?: number | string;
        };
        customizeErrorMessage?: ((error: Error) => string | null)
        | null;
        envSecret: string;
        experimental?: {
            updateRecordCustomActions?: boolean;
            webhookCustomActions?: boolean;
        };
        forestAdminClient?: ForestAdminClient;
        forestAppUrl?: string;
        forestServerUrl?: string;
        ignoreMissingSchemaElementErrors?: boolean;
        instantCacheRefresh?: boolean;
        isProduction: boolean;
        limitExportSize?: number;
        logger?: Logger;
        loggerLevel?: LoggerLevel;
        maxBodySize?: string;
        maxRecordsForApproval?: number;
        permissionsCacheDurationInSeconds?: number;
        prefix?: string;
        schemaPath?: string;
        skipRelationReadPermissions?: boolean;
        skipSchemaUpdate?: boolean;
        typingsMaxDepth?: number;
        typingsPath?: string
        | null;
        useUnsafeActionEndpoint?: boolean;
        workflowExecutorUrl?: string | null;
    }
    Index

    Properties

    auditTrail? authSecret bodyParserOptions? customizeErrorMessage? envSecret experimental? forestAdminClient? forestAppUrl? forestServerUrl? ignoreMissingSchemaElementErrors? instantCacheRefresh? isProduction limitExportSize? logger? loggerLevel? maxBodySize? maxRecordsForApproval? permissionsCacheDurationInSeconds? prefix? schemaPath? skipRelationReadPermissions? skipSchemaUpdate? typingsMaxDepth? typingsPath? useUnsafeActionEndpoint? workflowExecutorUrl?

    Properties

    auditTrail?: AuditTrailConfig | null

    Records every create/update/delete and exposes /_audit-trail/{collection}/:id and /_audit-trail/correlation* routes. Disabled when null or unset.

    authSecret: string
    bodyParserOptions?: { enableRawChecking?: boolean; jsonLimit?: number | string }

    Refer to @koa/bodyparser options

    https://github.com/koajs/bodyparser?tab=readme-ov-file#options

    customizeErrorMessage?: ((error: Error) => string | null) | null
    envSecret: string
    experimental?: {
        updateRecordCustomActions?: boolean;
        webhookCustomActions?: boolean;
    }
    forestAdminClient?: ForestAdminClient
    forestAppUrl?: string
    forestServerUrl?: string
    ignoreMissingSchemaElementErrors?: boolean

    If true, the agent will not throw an error when a customization error occurs, because of a missing collection for example.

    false
    instantCacheRefresh?: boolean
    isProduction: boolean
    limitExportSize?: number
    logger?: Logger
    loggerLevel?: LoggerLevel
    maxBodySize?: string

    use bodyParserOptions.jsonLimit instead.

    remove option

    maxRecordsForApproval?: number

    Max number of records a "select all" approval-required action may target. Must not exceed the Forest server's own cap (500).

    500
    permissionsCacheDurationInSeconds?: number
    prefix?: string
    schemaPath?: string
    skipRelationReadPermissions?: boolean

    Serve columns of collections the caller has no read permission on when they are reached through a relation path (holder:nationalId) in a projection, a filter, a sort, a search or a chart, and drop the browse a Count leaderboard requires on the collection it counts. No check on the collection being queried is affected: the route's own browse/read/export still runs.

    false
    skipSchemaUpdate?: boolean
    typingsMaxDepth?: number
    typingsPath?: string | null
    useUnsafeActionEndpoint?: boolean
    workflowExecutorUrl?: string | null

    Base URL of the workflow executor to proxy requests to. When set, the agent forwards /_internal/executor/* to the executor verbatim, benefiting from the agent's authentication layer.

    Mutually exclusive with agent.addWorkflowExecutor(): use this option to target a separately-deployed executor, or addWorkflowExecutor() to run one in-process.

    'http://localhost:4001'

    Settings

    Member Visibility

    On This Page

    Properties