1. Home
  2. ...
  3. Editing (ssd api-management update)
  4. API Editing (ssd api-management update api)

API Editing (ssd api-management update api)

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

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

Usage

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

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

See below an example of usage in the direct mode:

Available flags

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

Flag
Type
Description
-d, --descriptionstringAPI Description
-h, --helpDisplays help for the command
-n, --namestringNew name for the API
--new-versionstringNew value for the API version. If omitted, the value of the version field will remain the same
-p, --pathstringBase path of the API to be modified
--responsible-teamTeam responsible for the API
--responsible-userUser responsible (login) for the API
-r, --revisionstringRevision of the API to be modified
-s, --stagestringWorkflow stage of the API to be modified
-t, --teamstringName of the team if the API has the visibility type "TEAM"
-v, --versionstringVersion of the API to be modified
--visibility-typestringVisibility type of the API to be modified

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 update 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