API
TrainingSupportCommunity

Concepts

This lists the various conceptual objects the API makes available.

  • Storage Group. This is the basic unit within a NetStorage instance. There's a limit on the number of storage groups you can maintain. View this and other Technical limits with NetStorage. Each storage group comprises:

    • A unique name value. You provide this when creating the group.

    • A contractual amount of storage space. You negotiate this with ​Akamai​.

    • At least one upload account. You can create an upload account using the API.

    • At least two geographic replication zones.

    • One or more content provider (CP) codes. These are used to define upload directories in the group.

    • One or more upload directories. This is the base destination for uploaded content. Multiple upload directories can exist in a single group, one per CP code.

  • Upload Account. You use this account to access a storage group to upload, download, and manage content. You can configure a host of options that specify how you access the storage group. The API allows you to create and edit these accounts. There's a limit on the number of storage groups you can maintain.

  • Rule Sets. Access Control List (ACL) rule sets are collections of IP addresses or Geographic Regions (geos) that you create to either allow or block access to a storage group. Rule sets are applied to an upload account, either during its creation, or when editing an existing one. Rule sets apply to FTP and SSH-supported protocols.

  • Site Snapshots. The Site Snapshot Tool (SST) is a failover solution that automates the process of downloading content from an enterprise onto NetStorage. Here are a few scenarios where Site Snapshot would be beneficial:

    • Failover. Pull files from your origin to your failover site.

    • Origin offload. Automatically keep an up-to-date copy of your site on NetStorage. This is useful when NetStorage acts as the primary origin, rather than the backup origin.

    • Backups. Used as a backup copy of your content.

    • Automation. Any use case that requires automated ingest into NetStorage.

  • Geographic Replication Zone. Your content is replicated to nearby regions for added stability. For example, you might have access to regions such as West Coast and East Coast, or East Coast and Europe. The default is two zones per storage group. You can choose the zones when creating a storage group.