Skip to main content
POST
/
v1
/
manifest
/
apply
Apply Manifest
curl --request POST \
  --url https://api.mixpeek.com/v1/manifest/apply \
  --header 'Content-Type: multipart/form-data' \
  --form manifest_file='@example-file'
{
  "success": true,
  "resources": [
    {
      "resource_type": "<string>",
      "name": "<string>",
      "status": "created",
      "resource_id": "<string>",
      "error": "<string>"
    }
  ],
  "created_count": 0,
  "failed_count": 0,
  "skipped_count": 0,
  "errors": [
    "<string>"
  ],
  "rollback_performed": false,
  "dry_run": false
}

Headers

Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

Query Parameters

dry_run
boolean
default:false

Validate only, don't create resources

Body

multipart/form-data
manifest_file
file
required

YAML manifest file

Response

Successful Response

Result of applying a manifest.

success
boolean
required

Whether all resources were created successfully

resources
ResourceResult · object[]

Results for each resource

created_count
integer
default:0

Number of resources created

failed_count
integer
default:0

Number of resources that failed

skipped_count
integer
default:0

Number of resources skipped

errors
string[]

Error messages

rollback_performed
boolean
default:false

Whether rollback was performed due to failure

dry_run
boolean
default:false

Whether this was a dry run (no changes made)