Plan Creation (ssd api-management create plan)

The ssd api-management create plan command allows you to create a plan on Sensedia API Platform.

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

For more specific information, refer to the documentation on the creation of plans on Sensedia API Platform.

Usage

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

ssd api-management create plan [flags]

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

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

# Simple plan creation
$ ssd api-management create plan "Basic Plan" --api customers --api-version 1.0.0

# Specifying a description for the plan
$ ssd api-management create plan "Basic Plan" --api customers --api-version 1.0.0 --description "Plan for customers API"

# Setting the plan as the default one
$ ssd api-management create plan "Basic Plan" --api customers --api-version 1.0.0 --default

Available flags

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

Flag	Type	Description
-a, --api	string	Name of the API to which the plan will be linked
-v, --api-version	string	Version of the API to which the plan will be linked
--default		Sets the plan as the default one
-d, --description	string	Sets a description for the plan
-h, --help		Displays help for the command

Flag

Type

Description

-a, --api

string

Name of the API to which the plan will be linked

-v, --api-version

string

Version of the API to which the plan will be linked

--default

Sets the plan as the default one

-d, --description

string

Sets a description for the plan

-h, --help

Displays help for the command

Global Flags

Flag Type Description

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`

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