Get Plan (ssd api-management get plan)

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

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

Usage

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

ssd api-management get plan [flags]

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

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

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

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

# Gets a plan in a JSON Format
$ ssd api-management get plan --id 111 --output json

# Gets a plan and saves it to a JSON file
$ ssd api-management get plan --id 111 --output json > file.json

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

Interceptor’s ID

-n, --name

string

Interceptor’s name

-o, --output

string

Specifies the display type of the information. E.g.: -o json.

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

Thanks for your feedback!

EDIT

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