Plan Editing (ssd api-management update plan)

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

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

Usage

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

ssd api-management update plan [flags]

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

Below you find some examples of usage in the direct mode:

# Modifies a plan keeping it linked to the same API
$ ssd api-management update plan "My old plan" --name "My new plan" --api "Open Banking" --api-version "1.0.1" --description "New plan description" --default

# Modifies a plan linking it to a new API
$ ssd api-management update plan "My old plan" --name "My new plan" --api "Open Banking" --api-version "1.0.1" --new-api "New Api" --new-api-version "1.0.0" --description "New plan description" --default

Available flags

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

Flag	Type	Description
-a, --api	string	Name of the API that contains the plan
-v, --api-version	string	Version of the API that contains the plan
--default		Sets the plan as the default one
-d, --description	string	Sets a description for the plan
-h, --help		Displays help for the command
-n, --name	string	New name for the plan
--new-api	string	Name of the API to which you want to link the plan
--new-api-version	string	Version of the new API that will contain the plan

Flag

Type

Description

-a, --api

string

Name of the API that contains the plan

-v, --api-version

string

Version of the API that contains the plan

--default

Sets the plan as the default one

-d, --description

string

Sets a description for the plan

-h, --help

Displays help for the command

-n, --name

string

New name for the plan

--new-api

string

Name of the API to which you want to link the plan

--new-api-version

string

Version of the new API that will contain the plan

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 plan 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]