Skip to content

Preview the policy decision for a package/version

POST
/api/v1/policy/{registry_type}/check
curl --request POST \
--url https://api.pkgplease.com/api/v1/policy/example/check \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "package_name": "example", "version": "example" }'

Backs the MCP check_package tool. Runs the same evaluatePolicy logic the registry proxy uses, read-only, scoped to the caller's org.

registry_type
required
string

One of the org's configured registry types (npm is the one in active use).

Media typeapplication/json
object
package_name
required
string
version
required
string
Examplegenerated
{
"package_name": "example",
"version": "example"
}

Either an unscored placeholder (enqueues scoring) or a full decision

Media typeapplication/json
One of:
object
decision
string
Allowed values: unknown
reason
string
jobId
string
Example
{
"decision": "unknown"
}

Missing package_name or version

Media typeapplication/json
object
error
required
string
Examplegenerated
{
"error": "example"
}