Welcome to Swift’s documentation!

Swift is a highly available, distributed, eventually consistent object/blob store. Organizations can use Swift to store lots of data efficiently, safely, and cheaply.

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on Swift and other components of OpenStack can be found on the OpenStack wiki and at http://docs.openstack.org.

Note

If you’re looking for associated projects that enhance or use Swift, please see the Associated Projects page.

• Getting Started

Overview and Concepts

• Object Storage API overview
• Swift Architectural Overview
• The Rings
• Storage Policies
• The Account Reaper
• The Auth System
• Access Control Lists (ACLs)
• Replication
• Rate Limiting
• Large Object Support
• Global Clusters
• Container to Container Synchronization
• Expiring Object Support
• CORS
• Cross-domain Policy File
• Erasure Code Support
• Object Encryption
• Using Swift as Backing Store for Service Data
• Container Sharding
• Building a Consistent Hashing Ring
• Modifying Ring Partition Power
• Associated Projects

Developer Documentation

• Development Guidelines
• SAIO - Swift All In One
• First Contribution to Swift
• Adding Storage Policies to an Existing SAIO
• Auth Server and Middleware
• Middleware and Metadata
• Pluggable On-Disk Back-end APIs

Administrator Documentation

• Instructions for a Multiple Server Swift Installation
• Deployment Guide
• Apache Deployment Guide
• Administrator’s Guide
• Dedicated replication network
• Logs
• Swift Ops Runbook
• OpenStack Swift Administrator Guide
• Object Storage Install Guide

Object Storage v1 REST API Documentation

See Complete Reference for the Object Storage REST API

The following provides supporting information for the REST API:

• Object Storage API overview
• Discoverability
• Authentication
• Container quotas
• Object versioning
• Large objects
• Temporary URL middleware
• Form POST middleware
• Use Content-Encoding metadata
• Use the Content-Disposition metadata
• Pseudo-hierarchical folders and directories
• Page through large lists of containers or objects
• Serialized response formats
• Create static website
• Object expiration
• Bulk delete

S3 Compatibility Info

• S3/Swift REST API Comparison Matrix

OpenStack End User Guide

The OpenStack End User Guide has additional information on using Swift. See the Manage objects and containers section.

Source Documentation

• Partitioned Consistent Hash Ring
  • Ring
  • Ring Builder
  • Composite Ring Builder
• Proxy
  • Proxy Controllers
  • Proxy Server
• Account
  • Account Auditor
  • Account Backend
  • Account Reaper
  • Account Server
• Container
  • Container Auditor
  • Container Backend
  • Container Replicator
  • Container Server
  • Container Reconciler
  • Container Sharder
  • Container Sync
  • Container Updater
• Account DB and Container DB
  • DB
  • DB replicator
• Object
  • Object Auditor
  • Object Backend
  • Object Replicator
  • Object Reconstructor
  • Object Server
  • Object Updater
• Misc
  • ACLs
  • Buffered HTTP
  • Constraints
  • Container Sync Realms
  • Direct Client
  • Exceptions
  • Internal Client
  • Manager
  • MemCacheD
  • Request Helpers
  • Swob
  • Utils
  • WSGI
  • Storage Policy
• Middleware
  • Account Quotas
  • AWS S3 Api
  • Bulk Operations (Delete and Archive Auto Extraction)
  • CatchErrors
  • CNAME Lookup
  • Container Quotas
  • Container Sync Middleware
  • Cross Domain Policies
  • Discoverability
  • Domain Remap
  • Dynamic Large Objects
  • Encryption
  • FormPost
  • GateKeeper
  • Healthcheck
  • Keymaster
  • KeystoneAuth
  • List Endpoints
  • Memcache
  • Name Check (Forbidden Character Filter)
  • Object Versioning
  • Proxy Logging
  • Ratelimit
  • Read Only
  • Recon
  • Server Side Copy
  • Static Large Objects
  • StaticWeb
  • Symlink
  • TempAuth
  • TempURL
  • XProfile

Indices and tables

• Index

• Module Index

• Search Page