The "symlink" action (NS3)

You can create a symbolic link in FileStore (NS3) with the "symlink" action.

POST /[CP Code]/[path] HTTP/1.1 
Host: [Domain Prefix] 
X-Akamai-ACS-Action: version=1&action=symlink&target=%2F[path]%2F[link] 
[Signature Header 1]
[Signature Header 2]


Required variables

Variable values are as follows:

  • [CP code]: The unique CP code that represents the root directory in the applicable NetStorage Storage Group.
  • [path]: The desired path location (including applicable sub-directories) ending in the object that will be the target of the symlink (for example, /links/mylink). Include the file extension for the object, if applicable.
    Note: Symlinks can be either relative (“../” to denote dropping back a single directory); or absolute (/files/downloads/ to specifically target the downloads sub-directory). Ensure that you establish the [path] variable appropriately.
  • [Domain Prefix]: This is the unique domain prefix set up for the storage group during its creation. It can be viewed in the NetStorage Groups UI in Control Center.
  • [Signature Header 1] and [Signature Header 2]: Applicable signature headers.
  • [Body]: You must also include an applicable request [Body], which is the case with any “PUT” or “POST” action.

Action header field variables

This action has one required action header field, with the following variable(s):

  • target=%2F[path]%2F[link]: Used to define the target of the symlink. Include the complete [path] to, as well as the name ( [link]) for this file (including the extension, if applicable). Ensure that special characters (“ /”) are query string encoded. For example, any forward slashes ("/") would need to be represented as %2F, in support of query string encoding.
Note: The API never follows symlinks for the object named in the Request Path for this call (“ /[CP Code]/[path] ”). Symlinks are only followed for Edge Server downloads.