Skip to main content
POST
Lint Manifest

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.

Query Parameters

skip_rules
string[]

Rule codes to skip (e.g., MISSING_DESCRIPTION)

Body

multipart/form-data
manifest_file
file
required

YAML manifest file

parameters
string | null

JSON object of values for the manifest's declared parameters, e.g. {"camera_url": "rtsp://host/stream", "polling_seconds": 300}. Each value must match its declared type. Omit when the manifest declares none.

Response

Successful Response

Response from the lint endpoint.

Example: { "valid": true, "results": [...], "summary": {"error": 0, "warning": 2, "info": 3} }

valid
boolean
required

Whether the manifest is valid (no errors, warnings OK)

results
LintResult · object[]

List of lint results

summary
Summary · object

Count of results by severity