Get a storage group

get https://{hostname}/storage/v1/storage-groups/{storageGroupId}

Get a specific storage group based on its storageGroupId.

Recipes

Get a storage group

Open Recipe

Responses

Response body

object

allowEdit

boolean

Defaults to true

Whether this group is enabled for editing.

asperaEnabled

boolean

Whether Aspera Upload Acceleration has been enabled in an upload account that has access to this group.

comments

array of strings

Individual comments that briefly describe the last update made to the group.

comments

contractId

string

The unique identifier set for the contract that contains your instance of NetStorage and this group.

cpcodes

array of objects

Encapsulates CP codes assigned to a group.

cpcodes

object

ageDeletions

array of objects

Automatic Purge Routines that have been set up for the group.

ageDeletions

object

ageDeletionDays

number

When the ageDeletionSizeBytes value is reached for the target directory, this number is subtracted from the current date to determine a timestamp. Files older than this timestamp are purged.

ageDeletionDirectory

string

The target directory for an Automatic Purge Routine.

ageDeletionExclusionRegex

string

POSIX regular expression pattern matching the filenames to exclude from the purge.

ageDeletionInclusionRegex

string

POSIX regular expression pattern matching the filenames to include in the purge.

ageDeletionRecursivePurge

boolean

Defaults to false

Whether subdirectories within the target directory are also included in the purge. If false, only files within the target directory are purged.

ageDeletionSelectionRegex

string

ageDeletionSizeBytes

number

Automatic purge occurs when the target directory reaches this size, in bytes.

cpcodeId

integer

A CP code assigned to the group, and used to identify requests to a specific upload directory. The CP code serves as the root for upload directory. This is also referred to as the CP code root.

dirListing

object

Specifies the file to serve if a request doesn't end in a specific filename and extension.

downloadSecurity

string

enum

The level of security to obtain download access to the group. ALL_EDGE_SERVERS allows requests from all edge servers. STREAMING_SERVERS_ONLY only allows requests from edge servers dedicated to streaming media. G_2_O_AND_ALL_EDGE_SERVERS allows requests from all edge servers, but a warning is issued. It also allows all requests that include a valid G2O token, G_2_O_ONLY requires inclusion of a valid G2O token.

ALL_EDGE_SERVERS STREAMING_SERVERS_ONLY G_2_O_AND_ALL_EDGE_SERVERS G_2_O_ONLY

encodingConfig

object

The type of encoding to use when displaying paths in XML-aware contexts.

f2hConfig

object

FTP to HTTP (F2H) conversion for FTP download efficiency.

g2o

object

Keys you can use to access the group with the NetStorage Usage API.

lastChangesPropagated

boolean

When you create or modify an upload directory and changes are propagated to the NetStorage network, true indicates propagation is complete.

lastModifiedBy

string

The user who last modified the upload directory.

lastModifiedDate

string

The date the upload directory was last modified.

numberOfBytes

integer

The total number of bytes used by the upload directory.

numberOfFiles

integer

The total number of files contained in the upload directory.

pathCheckAndConversion

string

enum

Specifies the action taken when analyzing the request path. See the set of available values.

DISALLOW_ALL_IMPROPER_PATHS DISALLOW_IMPROPER_PATHS_ON_UPLOAD_ONLY TRANSLATE_TO_CANONICAL DO_NOT_CHECK_PATHS

queryStringConversion

object

Specifies how query strings appended to request paths to this group are handled.

quickDelete

boolean

Defaults to false

Whether the quick-delete operation is available in the NetStorage Usage API and the CMShell. Targets a specific directory in this group and recursively deletes all of its contents.

requestUriCaseConversion

string

enum

Standardizes case usage for filenames uploaded to your selected upload directory. NO_CONVERSION, CONVERT_TO_UPPER and CONVERT_TO_LOWER are self-explanatory. STREAM_OS indicates case requirements are applied to support the Stream OS product. This is only seen in a very limited number of legacy groups.

NO_CONVERSION CONVERT_TO_UPPER CONVERT_TO_LOWER STREAM_OS

rootDirectory

string

The CP code root for the upload directory.

sendHash

boolean

Defaults to false

Whether a content item's MD5 digest values is sent in the HTTP Content-MD5 response header.

serveFromZip

boolean

Defaults to false

Whether NetStorage dynamically examines archived files to directly serve individual files from within the archive.

useSsl

boolean

Defaults to false

Whether the contents within the upload directory are replicated securely via Secure Sockets Layer (SSL).

domainPrefix

string

Your unique domain prefix (subdomain) value that the NetStorage system applies to the Domain Names used to access the group.

estimatedUsageGB

number

The current volume of the group, in gigabytes.

lastModifiedBy

string

The user who last modified the group.

lastModifiedDate

string

The date the group was last modified.

links

array of objects

Hypermedia links to the specific group, as well as any upload accounts or geographic replication zones assigned to it.

links

object

href

string

A navigable path to the specific rel resource, once you prefix it with your hostname token.

rel

string

enum

This represents the link relation to the storage group resource. This can be either self for a link referring to the storage group itself, uploadAccounts for a link to an associated upload account, or zones for a geographic replication zone that can be used with the group.

self uploadAccounts zones

migrationStatus

string

The current migration status from FileStore format to ObjectStore format, if migration has been initiated.

pciEnabled

boolean

Whether Payment Card Industry (PCI) Data Security Standard support has been enabled for the storage group. These standards are designed to ensure that all companies that accept, process, store or transmit credit card information maintain a secure environment.

postFileDomainEnabled

boolean

Defaults to false

The postfile domain, {domain prefix}.postfile.akamai.com configured for use with this group. The {domain prefix} variable is set up by you during the creation of the group.

propagationStatus

object

The current propagation status of the group.

status

string

enum

Propagation statuses can be PENDING which indicates the item is in queue or ACTIVE which indicates the group is propagated.

PENDING ACTIVE

provisionStatus

string

enum

The current provisioning status of the group. PROVISIONED indicates the group is ready for use. MARKED_FOR_DEPROVISIONING indicates deprovisioning has been requested, but the group is still accessible. DEPROVISIONED indicates deprovisioning has completed, and the group is no longer available. NOT_PROVISIONED indicates the group hasn't been requested for provisioning.

NOT_PROVISIONED PROVISIONED MARKED_FOR_DEPROVISIONING DEPROVISIONED

storageGroupId

integer

The unique identifier that's automatically set for the group.

storageGroupName

string

The name you've set for the group.

storageGroupPurpose

string

enum

The specific purpose defined for the storage group. See the set of available values.

NETSTORAGE EDGESTREAM EDGESTREAM_IPHONE ADAPTIVEEDGE AD_INSERTION CONTENT_PREPARATION MSL_ORIGIN FEO

uploadDomain

string

The Upload Domain Name for this group. It's used to access the group to upload content. This is automatically constructed using the domain prefix that you define when creating the group.

zones

array of objects

The geographic replication zones configured for use with this group. These are also referred to as replicas.

zones

object

allowDownload

string

enum

How this zone has been configured to support direct downloads (rather than just for replication use). YES download from the zone is supported, NO not supported, and FAILOVER if other zones aren't available.

true false FAILOVER

allowUpload

string

enum

How this zone has been configured to support direct uploads (rather than just for replication use). YES indicates uploads are supported. NO indicates uploads aren't supported. FAILOVER indicates uploads are supported to this zone only if no other zones are available.

true false FAILOVER

lastModifiedBy

string

The user who last modified zone settings for this group.

lastModifiedDate

string

The date these zone settings were last modified.

noCapacityAction

string

enum

The action taken if the zone has no capacity for additional upload content. SPILL_OUTSIDE indicates content is temporarily uploaded outside the zone, to another zone configured for the group. DENY_UPLOADS indicates the zone doesn't support uploads for a noCapacityAction.

SPILL_OUTSIDE DENY_UPLOADS

overrideReason

string

The reason that a zone should be overridden for another zone.

overrideZoneName

string

The zone that's used for override to accommodate the noCapacityAction operation, if applicable.

zoneName

string

The name of the geographic replication zone.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/storage/v1/storage-groups/storageGroupId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

*/*

200Request OK.

400Badly formatted JSON. Compare with the schema.

401Unauthorized Request.

403Application permission error.

429The maximum request count for a specific time duration for this resource has been reached.