Environment Creation (ssd api-management create environment)

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

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

For more specific information, refer to the documentation on the creation of environments on Sensedia API Platform.

Usage

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

ssd api-management create environment [flags]

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

See below examples of usage in the direct mode:

# Simple environment creation
$ ssd api-management create environment Production --description "Some description"  --host "Production" --inbound-url "some-inbound"

# Environment creation with a specific gateway pool
$ ssd api-management create environment Production --gateway-pool "classic" --description "Some description" --host "Production" --inbound-url "some-inbound"

# Environment creation with specific permission to deploy APIs in it
$ ssd api-management create environment Production --deployment-permission-type "ME" --description "Some description" --host "Production" --inbound-url "some-inbound"

# Environment creation with deployment permission defined for a specific team
$ ssd api-management create environment Production --deployment-permission-type "TEAM" --deployment-permission-team "DevTeam" --description "Some description" --host "Production" --inbound-url "some-inbound"

# Environment creation with visibility access to Trace restricted
$ ssd api-management create environment Production --environment-trace-type "ME" --description "Some description" --host "Production" --inbound-url "some-inbound"

# Environment creation with visibility access to Trace restricted to a team
$ ssd api-management create environment Production --environment-trace-type "TEAM" --environment-trace-team "DevTeam" --description "Some description" --host "Production" --inbound-url "some-inbound"

Available flags

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

Flag Type Description

-e, --deployment-permission-team

string

Name of the team with permission to deploy an API to the environment. Required if the argument of the --deployment-permission-type flag is specified as "TEAM"

-t, --deployment-permission-type

string

Permission type for the deployment of APIs to the environment. Available options: "ORGANIZATION", "TEAM", "ME" (default: "ORGANIZATION")

-d, --description

string

Description for the environment

-s, --environment-trace-team

string

Name of the team with visibility access to Trace. Required if the argument of the --environment-trace-type flag is specified as "TEAM"

-r, --environment-trace-type

string

Visibility access type to Trace. Available options: "ORGANIZATION", "TEAM", "ME" (default: "ORGANIZATION")

-g, --gateway-pool

string

Gateway pool that will attend the environment (default: "default")

-h, --help

Displays help for the command

-u, --host

string

Domain registered as inbound address to be used for the environment

-i, --inbound-url

string

Complement to the URL (Inbound URL) of the environment

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

Declarative Mode

It is possible to create an environment 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]