1. Home
  2. ...
  3. Creation (ssd api-management create)
  4. API Creation (ssd api-management create api)

API Creation (ssd api-management create api)

The `ssd api-management create api` command allows you to create an API on Sensedia API Platform.
NOTE

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

TIP

For more specific information, refer to the documentation on creating APIs on Sensedia API Platform.

Usage

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

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

You can create the API by importing a Swagger or setting it by flags, as in the following examples:

Available flags

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

Flag
Type
Description
--api-typestringType of API to be created (default: "REST")
-d, --descriptionstringAPI description
-f, --from-swaggerstringCreates the API through a Swagger file in YAML or JSON format
-h, --helpDisplays help for the command
-p, --pathstringBase path of the API to be created
--responsible-teamTeam responsible for the API
--responsible-userUser responsible (login) for the API
-s, --stagestringWorkflow stage of the API to be created
-t, --teamstringName of the team for which the API will be created. Required if the API visibility type is informed as "TEAM".
-v, --versionstringVersion of the API to be created (default: "1")
--visibility-typestringVisibility type of the API to be created (default: "ORGANIZATION")

Global Flags

Flag
Type
Description
-c, --configstringConfiguration file (default: $HOME/.sensedia/config.json)
--profilestringThe configuration profile you want to use (default: "default")
--verboseLists 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

NOTE

It is possible to create a Rest API using a .yaml file with the declarative mode. Learn more.

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more