Edit an upload account

put

https://{hostname}/storage/v1/upload-accounts/{uploadAccountId}

Update an upload account based on its uploadAccountId.

To edit an upload account, you first need to Get an upload account to GET the data. You can change any permissible items in the GET response for use in this PUT operation. View a full list of required and optional fields in the BODY PARAMS.

Path Params

uploadAccountId

string

required

The unique ID assigned to the target upload account. This value can be obtained by performing a GET of all of your accounts and obtaining this value for the desired account.

Query Params

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

accessConfig

object

bruteForceAttackConfig

object

string

enableAspera

boolean

enableFileManagerAccess

boolean

isEditable

boolean

isVisible

boolean

ruleSetId

integer

technicalContactInfo

object

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Response body

object

An upload account is used to access a specific storage group. You can list, create and get details of an account.

accessConfig

object

Specifies the settings for the upload directory that has been selected for this account.

chrootDirectory

string

The directory set up to serve as the Directory Limit, if applicable. This is a directory other than the storage group's actual CP code root, that has been set up as the root for the account. Access for the account is limited to this directory and any existing subdirectories.

cpcodes

array of objects

The upload directory assigned to this account. The CP code for the upload directory is set as the cpcodeId via the cpcodes array for the account.

cpcodes

object

cpcodeId

integer

The CP code serving as an upload directory.

lastModifiedBy

string

The user who last modified this upload directory.

lastModifiedDate

string

The ISO 8601 timestamp labeling when this upload directory was last modified.

subDirectoryRestrictions

array of strings

A Subdirectory Restriction limits management operations to the specified directory. The account can only upload, download, move, or delete content within that directory, or its children. Multiple Subdirectory Restrictions can be applied to a single account.

hasDirectoryLimit

boolean

Defaults to false

Whether a Directory Limit has been established for the account.

hasReadOnlyAccess

boolean

Defaults to true

The account's read-write or read-only setting. A value of true indicates the account can only view content in its associated storage group.

loginDirectory

string

Specifies the default directory for the account, if configured. The directory named here is the default point of access when connecting to the storage group. If not configured, loginDirectory is blank.

asperaEnabled

boolean

Defaults to false

Whether Aspera Upload Acceleration was enabled as an access method during creation of the account. Aspera Upload Acceleration makes use of a third party client application from AsperaSoft that offers expedited uploads to a storage group.

bruteForceAttackConfig

object

Configures how to prevent brute force attacks over FTP. This protects the target storage group from excessive incorrect FTP login attempts.

failedLoginThreshold

number

The number of failed login attempts to trigger the lockdown for an offending client IP address.

lockDownDurationSeconds

number

The number of seconds an offending IP address is blocked from FTP access once the failedLoginThreshold total is reached.

changeHistory

array of objects

Lists each change made to the account.

changeHistory

object

action

string

enum

The action performed with the change. ADDED indicates the account was actually added. DELETED indicates the account was deleted. ENABLED or DISABLED indicates the change was made to affect the availability of the account. ROTATED indicates a password or key assigned to an access method was rotated to a new instance. UPDATED indicates an option or setting was changed in the account.

ADDED DELETED ENABLED DISABLED ROTATED UPDATED

changeType

string

enum

The option or functionality that was modified. CPCODE indicates the change applied to the application of a CP code for use in an upload directory. FTP indicates the change applied to FTP authentication access. SSH_KEY indicates the change applied to SSH authentication access. RSYNC indicates the change applied to Rsync (password) authentication. ASPERA indicates the change applied to Aspera Upload Accelerations settings. SUBDIR_RESTRICTION indicates the change applied to a Subdirectory Restriction. CHROOT indicates the change applied to a Directory Limit. LOGINDIR indicates the change applied to a Default Directory. CMS indicates the change applied to settings for the Content Management (CM) Shell. FM indicates the change applied to FileManager access. HTTP_UPLOAD_OPTIONS indicates the change applied to HTTP Upload Service. FTP_DOWNLOAD_OPTIONS indicates the change applied to FTP Download Services. UPLOAD_ACCOUNT indicates the change applied to general account settings. ACCESS indicates the change applied to some form of access for the account. G2O indicates the change applied to the G2O Key used for access to the NetStorage Usage API. RULESET indicates the change applied to and Access Control Group (ACL) Rule Set. BFA indicates the change applied to BFA. IP indicates the change applied to IP. SERVICE_VARIABLE indicates the change applied to a service variable. MFA_CONFIG indicates the change applied to the actual configuration settings Two-factor authentication. MFA_SECRET indicates the change applied to the ftpSecrets assigned to Two-factor authentication for the account.

CPCODE FTP SSH_KEY RSYNC ASPERA SUBDIR_RESTRICTION CHROOT LOGINDIR CMS FM HTTP_UPLOAD_OPTIONS FTP_DOWNLOAD_OPTIONS UPLOAD_ACCOUNT ACCESS G2O RULESET BFA IP SERVICE_VARIABLE MFA_CONFIG MFA_SECRET

lastModifiedBy

string

The user who made the change.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the change occurred.

propagated

boolean

Defaults to false

Whether the change has completed propagation to the NetStorage network. Propagation can take upwards of 60 minutes.

string

The primary contact email address set up for the account.

ftpEnabled

boolean

Defaults to false

Whether FTP was enabled as an access method when the account was created. This allows the account to access the storage group using FTP and a unique password you've set up for use with FTP.

globalUploadAccount

boolean

Indicates the upload account is globally mapped.

hasFileManagerAccess

boolean

Defaults to false

Whether access to FileManager was enabled during creation of the account. FileManager is a NetStorage interface that allows you to perform basic file management operations from Control Center. If enabled, this account can be used to access the storage group via FileManager.

hasHttpApiAccess

boolean

Defaults to false

Whether access to the NetStorage Usage API was enabled during creation of the account. This API is used to interact with your content, including operations such as upload, download, move and delete. If enabled, this account can be used to access the storage group via this API.

hasPendingPropagation

boolean

Defaults to false

Whether the account is currently being propagated. Any changes made to an account needs to propagate to the NetStorage network. This can take upwards of 60 minutes.

isEditable

boolean

Whether this account is enabled for editing. Editing accounts is currently only supported in Control Center.

isVisible

boolean

keys

object

The various keys and passwords configured for the access methods set in this account.

aspera

array of objects

Settings pertaining to Aspera Upload Acceleration.

aspera

object

comments

string

Any optional notes made for the SSH key.

string

A unique identifier for Aspera Upload Acceleration.

isActive

boolean

Defaults to false

Whether Aspera Upload Acceleration has been enabled for this account.

key

string

The SSH key applied to the account that has been assigned to Aspera. SSH-2 RSA and SSH-2 DSA formats are supported.

lastModifiedBy

string

The user who last modified the SSH key.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the SSH key was last modified.

ftp

array of objects

Settings applied for the FTP access method.

ftp

object

comments

string

Any optional notes made for the FTP password.

string

A unique identifier generated for FTP authentication.

isActive

boolean

Defaults to true

Whether the FTP password is active for the account. When added to an account, an FTP password is active by default.

lastModifiedBy

string

The user who last modified the FTP password.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the FTP password was last modified.

g2o

array of objects

This information applies to the G2O key applied to the account for use with the NetStorage Usage API. You can have up to three G2O keys per upload account.

g2o

object

string

A unique identifier for the G2O Key.

isActive

boolean

Defaults to false

Whether the NetStorage Usage API has been enabled for use with this account.

key

string

The G2O Key. Referred to as the capitalized Key when used in the NetStorage Usage API.

lastModifiedBy

string

The user who last modified the G2O Key settings.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the G2O Key settings were last modified.

user

string

The name of the upload account. This is referred to as the "Id" in Control Center. It serves as the Key-name when used in the NetStorage Usage API.

rsync

array of objects

Settings applied for the non-secure rsync access method.

rsync

object

comments

string

Any optional notes made for rsync password.

string

A unique identifier generated for rsync password authentication.

isActive

boolean

Whether the non-secure rsync password is active for the account. When added to an account, this password is active by default.

lastModifiedBy

string

The user who last modified the rsync password.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the rsync password was last modified.

ssh

array of objects

Settings applied for the SSH access method.

ssh

object

comments

string

Any optional notes made for the SSH key.

emailId

string

The NetStorage technical contact email address set up for this upload account.

string

A unique identifier generated for SSH authentication.

isActive

boolean

Defaults to true

Whether the SSH key is active for the account. When added to an account, an SSH key is active by default.

key

string

The SSH key applied to the account, if applicable. SSH-2 RSA and SSH-2 DSA formats are supported.

lastModifiedBy

string

The user who last modified the SSH key.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the SSH key was last modified.

lastModifiedBy

string

The user who last modified the account.

lastModifiedDate

string

The ISO 8601 timestamp labeling when the account was last modified.

multiFactorAuthConfig

object

Two-factor authentication settings for the account.

ftpMode

string

enum

The current enabled or disabled status of Two-factor authentication for the account. NONE indicates it's disabled. STRICT Two-factor authentication is enabled. OPTIONAL indicates the account owner can access via FTP by providing only the FTP username and password, or providing the FTP username and password with the applicable time-based one time password (TOTP) appended to it.

NONE STRICT OPTIONAL

ftpSecrets

array of objects

This is revealed if the shared secret for Two-factor authentication is to be generated manually.

ftpSecrets

object

comment

string

Manually defined comment text included for the key. This content is used in the generation of the shared secret, but is optional. If left out, placeholder content is automatically generated.

key

string

The manual entry set to serve as the shared secret. The key is exactly 16 characters in length and uses BASE-32 alphanumeric characters. This includes uppercase letters (A-Z), and numbers within the 2 - 7 range.

secretGeneratedBy

string

enum

How the shared secret was rotated. CLIENT indicates it was defined manually. For example, the key field was used and a shared secret was manually input. SERVER indicates it was automatically generated. For example, the "generateSecret": "true" pair was used.

CLIENT SERVER

secretProvisionedBy

string

The user account that was used to generate the shared secret.

generateSecret

boolean

Defaults to false

Whether Akamai automatically generates the shared secret to be used with Two-factor authentication for this account.

quickDelete

boolean

Defaults to false

Whether quick-delete functionality is enabled in the storage group that this account has been configured to access.

rsyncEnabled

boolean

Defaults to false

Whether non-secure rsync was enabled as an access method during creation of the account. This allows the account to access the storage group using the rsync protocol and a unique password you've set up for use with rsync.

ruleSetId

integer

The unique ID assigned to the Access Control List (ACL) Rule Set for the account, if applicable. These rule sets are comprised of a list of IP Addresses or Geographic Regions that are allowed or blocked from access. The appropriate ID integer is set as the type for the ruleSetId object for the account.

sshEnabled

boolean

Defaults to false

Whether Secure Shell (SSH) is enabled as an access method for the account, through application of an SSH key during creation of the account. This allows access to the storage group via this account using SFTP, SecureCopy, Secure Rsync, Aspera Upload Acceleration and the NetStorage CMShell.

status

string

enum

The activation status and availability of the account. INACTIVE indicates the account has been deactivated. NEW indicates the account is being propagated. ACTIVATIONSENT indicates the initial activation email has been sent to the contact on the account, and NetStorage is awaiting a confirmation it was received. ACTIVE indicates the account is fully propagated and available for use.

INACTIVE NEW ACTIVATIONSENT ACTIVE

storageGroupId

integer

The unique identifier for the storage group that this account has been configured to access.

storageGroupName

string

The upload account has been configured to access this specific storage group.

storageGroupType

string

enum

The format or migration status of the storage group that this account has been configured to access. FILESTORE indicates an NS3 format group. OBJECTSTORE indicates an NS4 format group. MIGRATING indicates the group is being migrated from NS3 to NS4.

FILESTORE OBJECTSTORE MIGRATING

technicalContactInfo

object

Technical Contact information set up for the account.

existingNetStorageTechnicalContact

object

The NetStorage technical contact serves as the default contact for this upload account. Configure these contacts in the NetStorage section of the Identity and Access Management tool in Control Center.

existingTechnicalContact

object

A pair of existing Control Center user accounts that have been selected as Technical Contacts for the account. Use Control Center to set up contact information for these accounts.

newTechnicalContact

object

All details for the contact have been manually applied.

uploadAccountId

string

The name you've set for the account. This is referred to as the ID in Control Center.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://hostname/storage/v1/upload-accounts/uploadAccountId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
111
}
1
{
2
  "accessConfig": {
3
    "chrootDirectory": "/456789/j",
4
    "cpcodes": [
5
      {
6
        "cpcodeId": 1234567,
7
        "lastModifiedBy": "tyamada",
8
        "lastModifiedDate": "2017-09-04T09:10:58Z",
9
        "subDirectoryRestrictions": [
10
          "/456789/j/k/s"
11
        ]
12
      }
13
    ],
14
    "hasReadOnlyAccess": false,
15
    "loginDirectory": "/456789/j"
16
  },
17
  "asperaEnabled": true,
18
  "bruteForceAttackConfig": {
19
    "failedLoginThreshold": 10,
20
    "lockDownDurationSeconds": 30
21
  },
22
  "changeHistory": [
23
    {
24
      "action": "ADDED",
25
      "changeType": "UPLOAD_ACCOUNT",
26
      "lastModifiedBy": "mrossi",
27
      "lastModifiedDate": "2017-09-04T09:10:58Z",
28
      "propagated": false
29
    },
30
    {
31
      "action": "ADDED",
32
      "changeType": "RULESET",
33
      "lastModifiedBy": "adevi",
34
      "lastModifiedDate": "2017-09-04T09:10:58Z",
35
      "propagated": false
36
    }
37
  ],
38
  "email": "tyamada@email.com",
39
  "ftpEnabled": true,
40
  "hasFileManagerAccess": true,
41
  "hasHttpApiAccess": true,
42
  "hasPendingPropagation": true,
43
  "isEditable": true,
44
  "keys": {
45
    "aspera": [
46
      {
47
        "identity": "value",
48
        "isActive": true,

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.