Back to KB
Difficulty
Intermediate
Read Time
4 min

`/api/local-only/config`

By Codcompass Team··4 min read

/api/local-only/config

Overview

The /api/local-only/config endpoint provides programmatic access to the local crawler configuration system. It enables developers, automation scripts, and administrative interfaces to retrieve the current crawler settings or update them dynamically. The endpoint manages core crawler behavior, including data source definitions, execution schedules, advanced runtime parameters, and content extraction templates.

This endpoint is primarily used when:

  • Synchronizing crawler configuration across deployment environments
  • Automating data source onboarding via CI/CD pipelines
  • Adjusting crawl frequency or extraction strategies without manual UI interaction
  • Backing up or version-controlling crawler settings

Important: This endpoint is environment-gated. It only responds when the local crawler UI feature is explicitly enabled in the platform configuration. If the feature is disabled, all requests will return a 404 Not Found response.

Endpoint Reference

PropertyValue
Path/api/local-only/config
HTTP MethodsGET, PUT
AuthenticationPublic routing. GET requires no credentials. PUT requires a valid authorization token/header enforced by the platform guard.
Content-Typeapplication/json (required for PUT)
Base URLhttps://<your-instance>/api/local-only/config

Request Format

The GET method requires no request body. The PUT method expects a JSON payload containing a config object. The platform performs strict validation, type coercion, and length truncation on incoming data.

Request Body Schema (PUT)

{
  "config": {
    "schedule": { /* platform-specific schedule object */ },
    "advanced": { /* platform-specific advanced settings */ },
    "sources": [
      {
        "id": "string (max 64 chars)",
        "enabled": true,
        "type": "rss

🎉 Mid-Year Sale — Unlock Full Article

Base plan from just $4.99/mo or $49/yr

Sign in to read the full article and unlock all 635+ tutorials.

Sign In / Register — Start Free Trial

7-day free trial · Cancel anytime · 30-day money-back

Sources

  • api-reference