Skip to content

MSR Documentation

API Reference

Initializing search

MSR Documentation

Product Overview
Reference Architecture
Reference Architecture
- Introduction to MSR
- Components
- System Requirements
- Networks
- Volumes
- Storage
- MSR Web UI
  MSR Web UI
  - Rule engine
Installation Guide
Installation Guide
Operations Guide
Operations Guide
- Access MSR
  Access MSR
- Manage access tokens
- Configure MSR
  Configure MSR
  - Add a custom TLS certificate
  - Enable single sign-on
  - Enable read-only mode
  - Disable persistent cookies
  - Disable MSR telemetry
  - Configure external storage
    
    Configure external storage
    
    Configure MSR image storage
    
    Deploy MSR on NFS
    
    Configure MSR for S3-compatible cloud storage providers
    
    Migrate to a new storage backend
  - Set up high availability
  - Use a load balancer
  - Set up security scanning
    
    Set up security scanning
    
    Enable MSR security scanning
    
    Set repository scanning mode
    
    Update the CVE scanning database
  - Caches
    
    Caches
    
    MSR cache prerequisites
    
    MSR cache deployment scenario
    
    Deploy an MSR cache with Swarm
    
    Deploy an MSR cache with Swarm
    
    Prepare the cache deployment
    
    Deploy the cache
    
    Deploy an MSR cache with Kubernetes
    
    Deploy an MSR cache with Kubernetes
    
    Prepare the cache deployment
    
    Create Kubernetes resources
    
    Expose the MSR Cache
    
    Configure caches for high availability
    
    MSR cache configuration
  - Garbage collection
    
    Garbage collection
    
    Schedule garbage collection
    
    How garbage collection works
  - Create a new repository when pushing an image
  - Use a web proxy
- Manage applications
- Manage images
  Manage images
  - Create a repository
  - Review repository information
  - Pull and push images
  - Delete images
  - Scan images for vulnerabilities
    
    Scan images for vulnerabilities
    
    Security scan process
    
    Scan images
    
    Review security scan results
    
    Override a vulnerability
    
    Scanner reporting
  - Prevent tags from being overwritten
  - Sign images
    
    Sign images
    
    Sign images with Cosign
    
    Sign images with Cosign
    
    Initial local setup
    
    Image signing and verification scenarios
    
    Sign images that MKE can trust
    
    Delete signed images
    
    Delete legacy Docker Content Trust
    
    Sign images with Docker Content Trust
    
    Sign images with Docker Content Trust
    
    Initial local setup
    
    Sign images that MKE can trust
    
    Add a delegation
    
    Delete trust data
    
    Delete signed images
    
    Using Docker Content Trust with a Remote MKE Cluster
- Manage jobs
- Manage users
- Manage webhooks
  Manage webhooks
  - Webhook types
  - Manage repository webhooks using web UI
  - Manage repository webhooks using API
    
    Manage repository webhooks using API
    
    API curl requests
    
    Manage content structure using API
    
    View and manage subscriptions
- Manage repository events
  Manage repository events
  - Audit repository events
  - Enable Auto-Deletion of Repository Events
- Promotion policies and monitoring
  Promotion policies and monitoring
- Use Helm charts
  Use Helm charts
- Tag pruning
- Image enforcement policies and monitoring
- Upgrade MSR
- Monitor MSR
- Troubleshoot MSR
- Disaster recovery
  Disaster recovery
- Customer feedback
Migration Guide
Support, Services, Contact
Reference Documentation
API Reference
API Reference
- 2.10.2
- 2.10.1
- 2.10.0
CLI Reference
CLI Reference
Release Notes
Release Notes
Release Notes
- 2.10.2
  2.10.2
- 2.10.1
  2.10.1
- 2.10.0
  2.10.0
Release Compatibility Matrix
Release Compatibility Matrix
Release Cadence and Support Lifecycle
Open Source Components and Licenses
Previous Versions
MSR 4.0 (EOL)
MSR 3.1 (EOL)
MSR 3.0 (EOL)
MSR 2.8 (EOL)

API reference#

Browse the MSR API reference for each supported release.

MSR 2.10.2
MSR 2.10.1
MSR 2.10.0

Copyright © 2026 Mirantis Inc. - All rights reserved

Made with Material for MkDocs