API Editing (ssd api-management update api)

The ssd api-management update api command allows you to edit an existing API on Sensedia API Platform.

You can use the ssd api-management update api command or its shortened version ssd apim update api.

Usage

The ssd api-management update api command can be followed by flags with their respective arguments:

ssd api-management update api [flags]

If no flag is specified, the interactive mode will be activated.

See below an example of usage in the direct mode:

$ ssd api-management update api "My old api" --name "My new api" --version 1.0.0 --revision last

Available flags

The following flags can be used with the ssd api-management update api command:

Flag Type Description

-d, --description

string

API Description

-h, --help

Displays help for the command

-n, --name

string

New name for the API

--new-version

string

New value for the API version. If omitted, the value of the version field will remain the same

-p, --path

string

Base path of the API to be modified

-r, --revision

string

Revision of the API to be modified

-s, --stage

string

Workflow stage of the API to be modified

-t, --team

string

Name of the team if the API has the visibility type "TEAM"

-v, --version

string

Version of the API to be modified

--visibility-type

string

Visibility type of the API to be modified

Global Flags

Flag

Type

Description

-c, --config

string

Configuration file (default: $HOME/.sensedia/config.json)

--profile

string

The configuration profile you want to use (default: "default")

--verbose

Lists all requests made by the command. It is possible to store this information in a TXT file instead of displaying it on the terminal. E.g.: $ ssd (api-management | apim) list apis --verbose 2> log.txt

Declarative Mode

It is possible to update a Rest API using a .yaml file with the declarative mode. Learn more.
Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]