asset file upload

Upload bytes into the file, with the provided file name, by using the HTTP multi-part format. The command creates a file if the file is missing or overrides the existing file except when override=false.

Extended description

Projects in Cloud Pak for Data have the following directory structure.
  • /projects
  • /projects/<cpd-project-id>
  • /projects/<cpd-project-id>/project
  • /projects/<cpd-project-id>/project/readme.json
  • /projects/<cpd-project-id>/assets
  • /projects/<cpd-project-id>/assets/ <project assets>

The asset file upload command can upload files to the /projects/<cpd-project-id>/assets folder only.

Syntax

cpd-cli asset file upload \
[--account-id=<catalog-id>] \
[--catalog-id=<catalog-id>] \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-scope>] \
[--ensure-dir=true|false] \
[--file=<upload-file-path>] \
[--file-content-type=<file-content-type>] \
[--inflate=true|false] \
[--jmes-query=<jmespath-query>] \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
[--override=true|false] \
--path=<asset-file-path> \
--profile=<cpd-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
[--root=true|false] \
[--signature=<signed-string>] \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The asset file upload command has no arguments.

Options

Table 1: Command options
Option Description
--account-id Specify the catalog ID that the file is associated with. A catalog, project, or space ID must also be 
specified.
Status
Required.
Syntax
--account-id=<catalog-id>
Default value
No default.
Valid values
Any valid catalog ID.
--catalog-id Specify either a catalog ID,
 project ID, or space ID (specify one only).
Status
Optional.
Syntax
--catalog-id=<catalog-id>
Default value
No default.
Valid values
A valid catalog, project, or space ID.
--context Specify the configuration context
 name.
Status
Optional.
Syntax
--context=<catalog-project-or-space-id>
Default value
Not applicable.
Valid values
A valid configuration context name.
--cpd-config The Cloud Pak for Data
 configuration location. For example, $HOME/.cpd-cli/config.
Status
Required.
Syntax
--cpd-config=<cpd-config-location>
Default value
$HOME/.cpd-cli/config
Valid values
A valid Cloud Pak for Data configuration location.
--cpd-scope The Cloud Pak for Data space, project, or catalog scope. For example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135.
Status
Optional.
Syntax
--cpd-scope=<cpd-scope>
Default value
No default.
Valid values
A valid Cloud Pak for Data space, project, or catalog scope.
--ensure-dir When set to true, the override
 utility option ensures that the directory that is specified in the path exists. 201 is returned when the
path is created. 200 is returned when the path exists. 409 is returned when the path is not a
 directory. The option takes precedence over other query options except
'--inflate'.
Status
Optional.
Syntax
--ensure-dir=true|false
Default value
false
Valid values
false
The override utility option does not ensure that the directory that is specified in the path exists.
true
The override utility option ensures that the directory that is specified in the path exists.
--file Specify the path and name of the file to upload.
Status
Optional.
Syntax
--file=<upload-file-path>
Default value
No default.
Valid values
A valid path and file name.
--file-content-type Specify the file content type.
Status
Optional.
Syntax
--file-content-type=<file-content-type>
Default value
No default.
Valid values
A valid file content type.

--help

-h

 Display command help.
Status
Optional.
Syntax
--help
Default value
No default.
Valid values
Not applicable.
--inflate When set to true, the option takes the supplied file and decompresses it into the target directory. The option is acceptable only
 for project, space, and catalog targets and takes precedence over any other options. The root directory must exist.
Status
Optional.
Syntax
--inflate=true|false
Default value
true
Valid values
true
The supplied file is decompressed into the target directory.
false
The supplied file is not decompressed into the target directory.
--jmes-query The Lucene query.
Status
Required.
Syntax
--query=<lucene-query>
Default value
No default.
Valid values
A valid Lucene query.
--output Specify an output format.
Status
Optional.
Syntax
--output=json|yaml|text
Default value
text
Valid values
Valid formats include JSON, YAML, or text (the default format).
--output-file Specify a file path where all output is redirected.
Status
Optional.
Syntax
--output-file=<output-file-location>
Default value
No default.
Valid values
A valid output file path location.
--override When set to true, the specified file is overwritten.
Status
Optional.
Syntax
--override=true|false
Default value
true
Valid values
true
The specified file is overwritten.
false
The specified file is not overwritten.
--path Specify the asset file path.
Status
Required.
Syntax
--path=<asset-file-path>
Default value
No default.
Valid values
A valid asset file path.
--profile The name of the profile that you created to store information about an instance of Cloud Pak for Data and your credentials for the instance.
Status
Required.
Syntax
--profile=<cpd-profile-name>
Default value
No default.
Valid values

The name of the profile that you created.
--project-id Specify a Cloud Pak for Data project instance.
Status
Required.
Syntax
--project-id=<cpd-project-id>
Default value
No default.
Valid values
A valid project identifier.
--quiet Suppress verbose messages.
Status
Optional.
Syntax
--quiet
Default value
No default.
Valid values
Not applicable.
--raw-output When set to true, single values are not surrounded by quotation marks in
 JSON output mode.
Status
Optional.
Syntax
--raw-output=true|false
Default value
false
Valid values
false
Single values in JSON output mode are surrounded by quotation marks.
true
Single values in JSON output mode are not surrounded by quotation marks.
--root When set to true, the API return
 is relative to the target container's root directory instead of the assets directory. The option is supported for services and for account administrators when targeting the account directory.
Status
Optional.
Syntax
--root=true|false
Default value
false
Valid values
false
The API return is not relative to the target container's root directory.
true
The API return is relative to the target container's root directory.
--signature Specify the signed string that is obtained by making an API request to the signing endpoint (this is an additional authorization method).
Status
Optional.
Syntax
--signature=<signed-string>
Default value
No default.
Valid values
Any valid signed string.
--space-id Specify a space identifier.
Status
Required.
Syntax
--space-id=<space-identifier>
Default value
No default.
Valid values
A valid space identifier.
--verbose Logs include more detailed messages.
Status
Optional.
Syntax
--verbose
Default value
No default.
Valid values
Not applicable.

Examples

Note: The following examples use environment variables. Use a script to create environment variables with the correct values for your environment. You can add the listed environment variables to the installation variables script. For more information, see Setting up installation environment variables.
Define the environment variables.
export FILE=<The *.zip file name in the storage that is associated with the deployment space> 
export PATH=<The path of the *.zip file to be uploaded>
export SPACE_ID=<The deployment space ID>
Upload a *.zip file to the storage that is associated with the deployment space.
cpd-cli asset file upload \
--file=code_package/${FILE_NAME} \
--path=${PATH} \
--profile=${CPD_PROFILE_NAME} \
--space-id=${SPACE_ID}