Contents Menu Expand Light mode Dark mode Auto light/dark mode
Documentation Portal
  • 2.9
  • 2.8 (EOL)
Logo
Mirantis Secure Registry
  • Product Overview
  • Reference Architecture
    • Introduction to MSR
    • Components
    • System requirements
    • Volumes
    • Storage
    • MSR web UI
      • Rule engine
  • Installation Guide
    • System requirements
    • Prepare MKE for MSR Install
    • Install MSR online
      • Prerequisites
      • Run install command
      • Check the Pods
      • Add load balancer (AWS)
    • Install MSR offline
      • Prepare your environment
      • Set up a Docker registry
      • Prerequisites
      • Run install command
      • Check the Pods
    • Obtain the license
    • Uninstall MSR
  • Operations Guide
    • Access MSR
      • Configure your Mirantis Container Runtime
      • Configure your Notary client
      • Use a cache
    • Manage access tokens
    • Configure MSR
      • Add a custom TLS certificate
      • Disable persistent cookies
      • Disable MSR telemetry
      • Configure external storage
        • Configure MSR image storage
        • Configure MSR for NFS
        • Configure MSR for a cloud storage provider (S3)
        • Switch storage back ends
      • Set up high availability
        • Install an HA MSR deployment
        • Modify replica counts on an existing installation
        • Modify replica counts for RethinkDB resources
      • Set up security scanning in MSR
      • Caches
        • MSR cache fundamentals
        • Cache deployment strategy
        • Deploy an MSR cache with Kubernetes
        • Configure caches for high availability
        • MSR cache configuration reference
      • 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
      • Create a repository
      • Review repository info
      • Pull and push images
      • Delete images
      • Scan images for vulnerabilities
      • Override a vulnerability
      • Prevent tags from being overwritten
      • Sign images
        • Sign an image
        • Using Docker Content Trust with a Remote MKE Cluster
    • Manage jobs
    • Manage users
      • Authentication and authorization
        • Enable LDAP and sync teams and users
        • Configure SAML integration on MSR
        • SCIM integration
      • Create and manage teams
      • Create and manage organizations
      • Permission levels
    • Manage webhooks
    • Manage repository events
      • Audit repository events
      • Enable Auto-Deletion of Repository Events
    • Promotion policies and monitoring
      • Promotion policies overview
      • Promote an image using policies
      • Mirror images to another registry
      • Mirror images from another registry
      • Template reference
    • Use Helm charts
      • Add a Helm chart repository
      • Pull charts and their provenance files
      • Push charts and their provenance files
      • View charts in a Helm repository
      • Delete charts from a Helm repository
      • Helm chart linting
        • Implement Helm linting
        • Helm chart linting rules
      • Helm limitations
    • Tag pruning
    • Vulnerability scanning
      • Scanner reporting
    • Image enforcement policies and monitoring
    • Upgrade MSR
    • Monitor MSR
    • Troubleshoot MSR
      • Troubleshoot your MSR Kubernetes deployment
      • Access RethinkDB
      • Troubleshoot scanning or CVE updates failure
      • Vulnerability scan warnings
      • Certificate issues when pushing and pulling images
    • Disaster recovery
      • Disaster recovery overview
      • Repair a single replica
      • Repair a cluster
      • Create an MSR backup
      • Restore from an MSR backup
    • Customer feedback
  • Mirantis Migration Tool Guide
    • MMT architecture
    • Migration prerequisites
    • Select the storage mode
    • Step-by-step migration
      • Verify the source system configuration
      • Estimate the migration
      • Extract the data
      • Transform the data extract
      • Restore the data extract
    • Settings not migrated
    • Troubleshoot migration
      • Filesystem storage back ends
      • Too many open files
      • Failure to load data error message
      • No space left on device
      • Failed to estimate migration error message
      • rethinkdb row cannot be restored
      • Admin password on MSR 3.0.x target no longer works
      • Blob image copy considerations
      • Additional parameters
      • Additional volume mappings for containers
      • Failed to query for metadata size
      • flag provided but not defined: -append
      • Storage configuration is out of sync with metadata
  • Get Support

Reference documentation

  • API Reference Updated
  • CLI Reference
    • mirantis/msr auth register
    • mirantis/msr auth status
    • mirantis/msr backup
    • mirantis/msr db migrate
    • mirantis/msr db scale
    • mirantis/msr db wait
    • mirantis/msr db emergency-repair
    • mirantis/msr init
    • mirantis/msr restore
    • mirantis/msr rethinkdb count
    • mirantis/msr rethinkdb list
    • mirantis/msr rethinkdb decommission

Release notes

  • Release Notes
    • 3.0.6
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.0.5
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.0.4
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.0.3
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.0.2
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.0.1
      • Enhancements
      • Addressed issues
      • Known issues
      • Major component versions
      • Security information
    • 3.0.0
      • Enhancements
      • Known issues
      • Major component versions
      • Changes to the API
  • Release Compatibility Matrix
    • MSR 3.0 Compatibility Matrix
    • MKE and MSR Browser compatibility
    • MKE, MSR, and MCR Maintenance Lifecycle
  • Release Cadence and Support Lifecycle
  • Open Source Components and Licenses

API Reference Updated¶

The Mirantis Secure Registry (MSR) API is a REST API, available using HTTPS, that enables programmatic access to resources managed by MSR.

For details, by product version:

  • MSR 3.0.6 API Reference

  • MSR 3.0.5 API Reference

  • MSR 3.0.4 API Reference

  • MSR 3.0.3 API Reference

  • MSR 3.0.2 API Reference

  • MSR 3.0.1 API Reference

  • MSR 3.0.0 API Reference

Next
CLI Reference
Previous
Get Support
  • Multi-page view
  • Single-page view

Mirantis Inc. 900 E Hamilton Avenue, Suite 650, Campbell, CA 95008 +1-650-963-9828

© 2005 - 2023 Mirantis, Inc. All rights reserved. "Mirantis" and "FUEL" are registered trademarks of Mirantis, Inc. All other trademarks are the property of their respective owners.