Skip to main content
POST
Validate 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.

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

Result of validating a manifest.

valid
boolean
required

Whether the manifest is valid

resources
Resources · object

Count of each resource type

missing_secrets
string[]

Secret names referenced but not configured

errors
string[]

Validation errors

warnings
string[]

Validation warnings

parameters
ManifestParameterSpec · object[]

The parameters the manifest declares, returned whether or not values were supplied, so a form can collect them before apply