Skip to main content
POST
Diff 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 comparing manifest to current state.

to_create
DiffItem · object[]

Resources in manifest but not in system

in_system_only
DiffItem · object[]

Resources in system but not in manifest

differences
DiffItem · object[]

Resources in both with differences