Manifest

Export Manifest Get

Changed on

Export current resources to a YAML manifest.

Exports all resources (or a specific namespace) to a YAML file that can be version-controlled and re-applied to another environment.

Features:

  • Resource IDs are converted to human-readable names
  • Secret values are replaced with placeholder references (${{ secrets.NAME }})
  • Output is formatted for readability and git-friendliness

Note: You must configure actual secrets before applying the exported manifest to a new environment.

Example:

# Export all resources
curl /v1/manifest/export \
  -H "Authorization: Bearer $API_KEY" \
  -o mixpeek.yaml

# Export specific namespace
curl "/v1/manifest/export?namespace_id=ns_abc123" \
  -H "Authorization: Bearer $API_KEY" \
  -o namespace.yaml
get/v1/manifest/export

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/manifest/export
  • Auth: HTTP bearer

Query parameters

namespace_idstring

Export specific namespace (None = all)

formatstring

Output format (yaml)

manifest_namestring

Name for the manifest

detail'config' | 'stats'

'config' (default) exports the resources only. 'stats' also writes a read-only status section describing what is in the data: each collection's document count, field types and most common field values, and each cluster's groups with labels and sizes. Requires namespace_id. Apply ignores status.

Response

Successful Response

unknown required

Changes

  • d4b5fad18960Revision changes
    • info

      added the new optional query request parameter detail

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status