KEkernel
Config Registry

Cancel a config analysis

Changed on

Requests cancellation of a running project-scoped analysis. Cancellation is asynchronous; poll the analysis until its status becomes canceled. Repeating the request after the analysis reaches a terminal state returns the existing outcome.

post/config-registry/analyses/{id}/cancel

Request

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

Path parameters

idstring required

Response

The analysis had already reached a terminal state.

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