ONonkernel
Config Registry

Get a config analysis

Changed on

Returns a project-scoped historical analysis and the recommendation outcome concluded by that run. Later knowledge does not change this response.

get/config-registry/analyses/{id}

Request

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

Path parameters

idstring required

Response

Analysis state and the recommendation outcome concluded by that historical run.

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.

workload_outcome'completed' | 'turn_limit' | 'auth_required' | 'payment_required' | 'blocked' | 'error' nullable

How far the workload pass got, when an intent was supplied and a pass ran. A run outcome rather than advice, so it is reported whether or not any guidance could be assembled. Null when no intent was supplied or no pass ran.

Example response

{
  "analysis": {
    "failure": {
      "code": "bad_request",
      "details": [
        {
          "code": "invalid_input",
          "message": "Provided version string is not semver compliant"
        }
      ],
      "inner_error": {
        "code": "invalid_input",
        "message": "Provided version string is not semver compliant"
      },
      "message": "Missing required field: app_name"
    }
  },
  "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