stat action

get

https://{domainPrefix}-nsu.akamaihd.net/{cpCode}/{path}/{filename}

Use this action to view the stat structure (information) for a named file, symlink, or directory.

Path Params

cpCode

integer

required

The unique CP code that represents the root directory in the applicable NetStorage storage group.

Learn more about CP codes.

path

string

required

If applicable, any additional sub-directories that exist within the path to the desired file or symbolic link.

filename

string

required

The complete filename and extension of the object.

Headers

X-Akamai-ACS-Action

string

required

Form the header value as a query parameter string with these fields:

version=1. This value is constant.
action=stat. This is the action for this API operation.

Optional parameters
You can append these optional parameters to the end of the header, prefaced by an ampersand ("&").

format=xml&[Optional variables]:
- encoding=[applicable XML encoding type]. NetStorage supports a wider range of XML encodings for use in this action's response. Include this field to define the desired type.
- implicit=yes. Adding this argument to the action header will look for an implicit directory that fits the specified [path].
  Note: Including this argument will result in slower output, as it requires more NetStorage resources. Therefore, it's recommended that you use it sparingly.
- slash=both. In the event of duplicate file, symlink and directory names in the same parent, NetStorage will default to only displaying the file or symlink. Include this optional action header to have both files/symlinks and directories with the same name displayed. To differentiate entries in the response, refer to the "file type" attribute.

X-Akamai-ACS-Auth-Data

string

required

This required header is referred to as [signature header 1].

X-Akamai-ACS-Auth-Data: [version], [0.0.0.0], [0.0.0.0], [current epoch time], [unique-number-id], [uploadAccountId]

[version]. Indicate your authentication encryption format.
[0.0.0.0]. This is a reserved field you specify as 0.0.0.0.
[current epoch time]. This is the time of your API client within one (1) minute of the current time.
[unique-number-id]. A random numeric ID your client creates to guarantee uniqueness to support multiple requests.
[uploadAccountId]. The name of an upload account with access to the target storage group.

Learn more about the "X-Akamai-ACS-Auth-Data" authentication header.

X-Akamai-ACS-Auth-Sign

string

required

This required header is referred to as [signature header 2]. It's a Base64-encoded-signature comprised of HMAC-SHA256([key], [data] + [sign-string]).

Learn more about the "X-Akamai-ACS-Auth-Sign" authentication header.

Host

string

required

This is your full NetStorage Usage API connection hostname.

Responses

400

Malformed request, such as an illegal combination of parameters in the X-Akamai-ACS-Action request header. There may be more information in the response body, represented as unstructured text.

403

Forbidden operation, such as an action=stat in the HTTP PUT request, or an authentication or authorization error. There may be more information in the response body, represented as unstructured text.

404

Not found. The object referenced by action=stat does not exist.

500

Internal server error. There will be more information in the response body, represented as unstructured text.

200Response data indicates a successful action.