ONonkernel
Config Registry

Look up a config

Changed on

Returns current global knowledge without resolving DNS, creating an analysis, or updating config registry data.

post/config-registry/lookup

Request

  • Base URL
    https://api.onkernel.com
  • URL
    https://api.onkernel.com/config-registry/lookup
  • Auth
    HTTP bearer

Request body

allowed_proxy_countriesstring[]

ISO 3166 country codes Kernel may use when returning a proxy configuration. When omitted, Kernel uses its default country selection.

urlstring uri required

Public HTTP(S) URL to look up.

Example request

{
  "allowed_proxy_countries": [
    "US"
  ]
}

Response

Current recommendation, or a null recommendation when no eligible knowledge exists.

guidancestring nullable

Short advisory markdown to facilitate navigating this target. Returned even when no configuration reached the target, since knowing what prevented success is useful without a configuration. Not verified against this target. Null when nothing applicable was observed or no notes exist.

Example response

{
  "recommendation": {
    "browser": {
      "viewport": {
        "height": 800,
        "refresh_rate": 60,
        "width": 1280
      }
    },
    "proxy": {
      "create": {
        "config": {
          "country": "US"
        }
      }
    }
  },
  "working_configurations": [
    {
      "browser": {
        "viewport": {
          "height": 800,
          "refresh_rate": 60,
          "width": 1280
        }
      },
      "proxy": {
        "create": {
          "config": {
            "country": "US"
          }
        }
      }
    }
  ]
}

Changes

  • 713ee18ed886Revision changes
    • info

      response property recommendation/allOf[ConfigRegistryRecommendationResult]/oneOf[ConfigRegistryRecommendation]/proxy/oneOf[ConfigRegistryManagedProxy]/create/config/oneOf[subschema #1: Datacenter]/ deprecated

    • info

      response property working_configurations/items/proxy/oneOf[ConfigRegistryManagedProxy]/create/config/oneOf[subschema #1: Datacenter]/ deprecated

  • eef3d52b62f8Revision changes
    • warning

      added the new target_not_evaluable enum value to the ///////// response property for the response status