Plan Deletion (ssd api-management delete plan)

The ssd api-management delete plan command allows you to delete a plan from Sensedia API Platform.

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

Usage

The ssd api-management delete plan command can be followed by specific flags, as in the examples below:

ssd api-management delete plan [flags]

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

# Deletes a plan using only its ID.
$ ssd (api-management | apim) delete plan --id 111

# Deletes a plan using its name and related API's ID.
$ ssd (api-management | apim) delete plan --name somePlanName --api-id 222

# Deletes a plan using its name and related API's ID, but without asking to confirm the operation.
$ ssd (api-management | apim) delete plan --name somePlanName --api-id 222 -y

# Deletes a plan using its name, and its related API name and version.
$ ssd (api-management | apim) delete plan --name somePlanName --api-name someApiName --api-version 1.0.0

# Deletes a plan using its name, related api's name and version, but without asking to confirm the operation.
$ ssd (api-management | apim) delete plan --name somePlanName --api-name someApiName --api-version 1.0.0 -y

Available Flags

Flag

Type

Description

--api-id

int

API’s ID to which the plan belongs

--api-name

string

API’s name to which the plan belongs

--api-version

string

API’s version to which the plan belongs

-h, --help

Displays help for the command

-i, --id

int

Plan’s ID

-n, --name

string

Plan’s name

-y, --yes

Skips the confirmation step

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