Get API (ssd api-management get api)

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

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

Usage

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

ssd api-management get api [flags]

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

# Retrieves an API
$ ssd (api-management | apim) get api --id 111
$ ssd (api-management | apim) get api --name "My API" --version "1.0.0"

# Retrieves an API in a JSON Format
$ ssd (api-management | apim) get api --id 111 --output json

# Retrieves an API and saves it to a JSON file
$ ssd (api-management | apim) get api --id 111 --output json > file.json

Available Flags

Flag

Type

Description

-h, --help

Displays help for the command

-i, --id

int

API’s ID

-n, --name

string

API’s name

-o, --output

string

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

-v, --version

string

API’s version

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]