Config Registry

Lists unique exact targets previously analyzed by the selected project with the recommendation produced by each target's latest analysis.

get/config-registry

Request

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

Query parameters

limitinteger
offsetinteger
searchstring

Case-insensitive substring search over normalized targets, including domain, subdomain, and path.

sort_by'target' | 'analysis_status' | 'recommended_config' | 'last_requested_at' | 'success_rate'
sort_order'asc' | 'desc'

Response

Project-scoped recommended configurations.

analysis_idstring required

ID of the most recently requested analysis for this exact target.

analysis_status'running' | 'completed' | 'failed' | 'canceled' | 'expired' required

Lifecycle status of a background analysis.

last_requested_atstring date-time required

Most recent time the selected project requested an analysis for this exact target.

recommended_config_labelstring nullable required

Display label for the recommended browser configuration.

success_ratenumber nullable required

Success rate for the recommended configuration. Null when the latest analysis did not produce one.

targetstring required

Normalized exact target previously analyzed by the selected project, including scheme, host, port, and path.

Example response

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

Changes

    • info

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

    • breaking

      removed the required property ////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • info

      added the optional property /////// to the response with the status