App Configuration CLI commands (Valid for versions 2.0.0 and above)

ibmcloud app-configuration docs

Opens the plug-in documentation in the web browser.

ibmcloud app-configuration docs

ibmcloud app-configuration docs

Example

ibmcloud app-configuration
    --region=us-south \
    --output=json \
    --jmes-query="[:10]" \
    --service-url=<service url>
    --quiet

Note: This example only demonstrates the global options available to all sub-commands and is not a valid command itself.

Examples

ibmcloud app-configuration config set service-url \
    'https://{region}.apprapp.cloud.ibm.com'

Examples

ibmcloud app-configuration config get service-url

Examples

ibmcloud app-configuration config unset service-url

Examples

ibmcloud app-configuration config list

Command options

--guid (string)

AppConfiguration instance Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--sort (string)

Sort the environment details based on the specified attribute. By default, items are sorted by name.

Allowable values are: created_time, updated_time, id, name.

--tags (string)

Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.

--include ([]string)

Include feature, property, snapshots details in the response.

Allowable list items are: features, properties, snapshots. The maximum length is 20 items. The minimum length is 0 items.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--search (string)

Searches for the provided keyword and returns the appropriate row with that value. Here the search happens on the '[Name OR Tag]' of the entity.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for environments.

Example

ibmcloud app-configuration environments \
    --guid exampleString \
    --expand=true \
    --sort created_time \
    --tags 'version 1.1,pre-release' \
    --include features,properties,snapshots \
    --limit 10 \
    --offset 0 \
    --search 'test tag'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--name (string)

Environment name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--environment-id (string)

Environment id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--description (string)

Environment description.

The maximum length is 255 characters.

--tags (string)

Tags associated with the environment, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--color-code (string)

Color code to distinguish the environment. The Hex code for the color. For example #FF0000 for red.

Example

ibmcloud app-configuration environment-create \
    --guid exampleString \
    --name 'Dev environment' \
    --environment-id dev-environment \
    --description 'Dev environment description' \
    --tags development \
    --color-code #FDD13A

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--name (string)

Environment name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Environment description.

The maximum length is 255 characters.

--tags (string)

Tags associated with the environment, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--color-code (string)

Color code to distinguish the environment. The Hex code for the color. For example #FF0000 for red.

Example

ibmcloud app-configuration environment-update \
    --guid exampleString \
    --environment-id environment_id \
    --name exampleString \
    --description exampleString \
    --tags exampleString \
    --color-code #FDD13A

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--include ([]string)

Include feature, property, snapshots details in the response.

Allowable list items are: features, properties, snapshots. The maximum length is 20 items. The minimum length is 0 items.

Example

ibmcloud app-configuration environment \
    --guid exampleString \
    --environment-id environment_id \
    --expand=true \
    --include features,properties,snapshots

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

Example

ibmcloud app-configuration environment-delete \
    --guid exampleString \
    --environment-id environment_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--sort (string)

Sort the collection details based on the specified attribute. By default, items are sorted by name.

Allowable values are: created_time, updated_time, id, name.

--tags (string)

Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.

--features ([]string)

Filter collections by a list of comma separated features.

The maximum length is 20 items. The minimum length is 0 items.

--properties ([]string)

Filter collections by a list of comma separated properties.

The maximum length is 20 items. The minimum length is 0 items.

--include ([]string)

Include feature, property, snapshots details in the response.

Allowable list items are: features, properties, snapshots. The maximum length is 20 items. The minimum length is 0 items.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--search (string)

Searches for the provided keyword and returns the appropriate row with that value. Here the search happens on the '[Name OR Tag]' of the entity.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for collections.

Example

ibmcloud app-configuration collections \
    --guid exampleString \
    --expand=true \
    --sort created_time \
    --tags 'version 1.1,pre-release' \
    --features my-feature-id,cycle-rentals \
    --properties my-property-id,email-property \
    --include features,properties,snapshots \
    --limit 10 \
    --offset 0 \
    --search 'test tag'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--name (string)

Collection name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--collection-id (string)

Collection Id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--description (string)

Collection description.

The maximum length is 255 characters.

--tags (string)

Tags associated with the collection, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

Example

ibmcloud app-configuration collection-create \
    --guid exampleString \
    --name 'Web App Collection' \
    --collection-id web-app-collection \
    --description 'Collection for Web application' \
    --tags 'version: 1.1, pre-release'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--collection-id (string)

Collection Id of the collection. Required.

--name (string)

Collection name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Description of the collection.

The maximum length is 255 characters.

--tags (string)

Tags associated with the collection, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

Example

ibmcloud app-configuration collection-update \
    --guid exampleString \
    --collection-id collection_id \
    --name exampleString \
    --description exampleString \
    --tags exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

--collection-id (string)

Collection Id of the collection. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--include ([]string)

Include feature, property, snapshots details in the response.

Allowable list items are: features, properties, snapshots. The maximum length is 20 items. The minimum length is 0 items.

Example

ibmcloud app-configuration collection \
    --guid exampleString \
    --collection-id collection_id \
    --expand=true \
    --include features,properties,snapshots

Command options

--guid (string)

AppConfiguration instance Id. Required.

--collection-id (string)

Collection Id of the collection. Required.

Example

ibmcloud app-configuration collection-delete \
    --guid exampleString \
    --collection-id collection_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--sort (string)

Sort the feature details based on the specified attribute. By default, items are sorted by name.

Allowable values are: created_time, updated_time, id, name.

--tags (string)

Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.

--collections ([]string)

Filter features by a list of comma separated collections.

The maximum length is 20 items. The minimum length is 0 items.

--segments ([]string)

Filter features by a list of comma separated segments.

The maximum length is 20 items. The minimum length is 0 items.

--include ([]string)

Include the associated collections or targeting rules or change request details in the response.

Allowable list items are: collections, rules, change_request. The maximum length is 20 items. The minimum length is 0 items.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--search (string)

Searches for the provided keyword and returns the appropriate row with that value. Here the search happens on the '[Name OR Tag]' of the entity.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for features.

Example

ibmcloud app-configuration features \
    --guid exampleString \
    --environment-id environment_id \
    --expand=true \
    --sort created_time \
    --tags 'version 1.1,pre-release' \
    --collections my-collection-id,ghzindiapvtltd \
    --segments my-segment-id,beta-users \
    --include collections,rules,change_request \
    --limit 10 \
    --offset 0 \
    --search 'test tag'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--name (string)

Feature name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--feature-id (string)

Feature id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--type (string)

Type of the feature (BOOLEAN, STRING, NUMERIC). If type is STRING, then format attribute is required. Required.

Allowable values are: BOOLEAN, STRING, NUMERIC.

--enabled-value (interface{})

Value of the feature when it is enabled. The value can be Boolean, Numeric, String - TEXT, String - JSON, String - YAML value as per the type and format attributes. Required.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --enabled-value=@path/to/file.json.

--disabled-value (interface{})

Value of the feature when it is disabled. The value can be Boolean, Numeric, String - TEXT, String - JSON, String - YAML value as per the type and format attributes. Required.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --disabled-value=@path/to/file.json.

--description (string)

Feature description.

The maximum length is 255 characters.

--format (string)

Format of the feature (TEXT, JSON, YAML) and it is a required attribute when type is STRING. It is not required for BOOLEAN and NUMERIC types. This property is populated in the response body of POST, PUT and GET calls if the type STRING is used and not populated for BOOLEAN and NUMERIC types.

Allowable values are: TEXT, JSON, YAML.

--enabled (bool)

The state of the feature flag.

--rollout-percentage (int64)

Rollout percentage associated with feature flag. Supported only for Lite and Enterprise plans.

The default value is 100. The maximum value is 100. The minimum value is 0.

--tags (string)

Tags associated with the feature, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--segment-rules (FeatureSegmentRule[])

Specify the targeting rules that is used to set different feature flag values for different segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segment-rules=@path/to/file.json.

--collections (CollectionRef[])

List of collection id representing the collections that are associated with the specified feature flag.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --collections=@path/to/file.json.

Example

ibmcloud app-configuration feature-create \
    --guid exampleString \
    --environment-id environment_id \
    --name 'Cycle Rentals' \
    --feature-id cycle-rentals \
    --type BOOLEAN \
    --enabled-value "true" \
    --disabled-value "false" \
    --description 'Feature flag to enable Cycle Rentals' \
    --format TEXT \
    --enabled=true \
    --rollout-percentage 100 \
    --tags 'version: 1.1, pre-release' \
    --segment-rules '[{"rules": [{"segments": ["betausers","premiumusers"]}], "value": "true", "order": 1, "rollout_percentage": 50}]' \
    --collections '[{"collection_id": "ghzinc"}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--feature-id (string)

Feature Id. Required.

--name (string)

Feature name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Feature description.

The maximum length is 255 characters.

--enabled-value (interface{})

Value of the feature when it is enabled. The value can be Boolean, Numeric, String - TEXT, String - JSON, String - YAML value as per the type and format attributes.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --enabled-value=@path/to/file.json.

--disabled-value (interface{})

Value of the feature when it is disabled. The value can be Boolean, Numeric, String - TEXT, String - JSON, String - YAML value as per the type and format attributes.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --disabled-value=@path/to/file.json.

--enabled (bool)

The state of the feature flag.

--rollout-percentage (int64)

Rollout percentage associated with feature flag. Supported only for Lite and Enterprise plans.

The default value is 100. The maximum value is 100. The minimum value is 0.

--tags (string)

Tags associated with the feature, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--segment-rules (FeatureSegmentRule[])

Specify the targeting rules that is used to set different property values for different segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segment-rules=@path/to/file.json.

--collections (CollectionUpdateRef[])

List of collection id representing the collections that are associated with the specified property.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --collections=@path/to/file.json.

Example

ibmcloud app-configuration feature-update \
    --guid exampleString \
    --environment-id environment_id \
    --feature-id feature_id \
    --name 'Cycle Rentals' \
    --description 'Feature flags to enable Cycle Rentals' \
    --enabled-value "true" \
    --disabled-value "false" \
    --enabled=true \
    --rollout-percentage 100 \
    --tags 'version: 1.1, yet-to-release' \
    --segment-rules '[{"rules": [{"segments": ["betausers","premiumusers"]}], "value": "true", "order": 1, "rollout_percentage": 90}]' \
    --collections '[{"collection_id": "ghzinc", "deleted": true}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--feature-id (string)

Feature Id. Required.

--name (string)

Feature name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Feature description.

The maximum length is 255 characters.

--tags (string)

Tags associated with the feature, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--enabled-value (interface{})

Value of the feature when it is enabled. The value can be Boolean, Numeric, String - TEXT, String - JSON, String - YAML value as per the type and format attributes.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --enabled-value=@path/to/file.json.

--disabled-value (interface{})

Value of the feature when it is disabled. The value can be Boolean, Numeric, String - TEXT, String - JSON, String - YAML value as per the type and format attributes.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --disabled-value=@path/to/file.json.

--rollout-percentage (int64)

Rollout percentage associated with feature flag. Supported only for Lite and Enterprise plans.

The default value is 100. The maximum value is 100. The minimum value is 0.

--segment-rules (FeatureSegmentRule[])

Specify the targeting rules that is used to set different property values for different segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segment-rules=@path/to/file.json.

Example

ibmcloud app-configuration feature-values-update \
    --guid exampleString \
    --environment-id environment_id \
    --feature-id feature_id \
    --name 'Cycle Rentals' \
    --description 'Feature flags to enable Cycle Rentals' \
    --tags 'version: 1.1, yet-to-release' \
    --enabled-value "true" \
    --disabled-value "false" \
    --rollout-percentage 100 \
    --segment-rules '[{"rules": [{"segments": ["betausers","premiumusers"]}], "value": "true", "order": 1, "rollout_percentage": 100}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--feature-id (string)

Feature Id. Required.

--include ([]string)

Include the associated collections or targeting rules or change request details in the response.

Allowable list items are: collections, rules, change_request. The maximum length is 20 items. The minimum length is 0 items.

Example

ibmcloud app-configuration feature \
    --guid exampleString \
    --environment-id environment_id \
    --feature-id feature_id \
    --include collections,rules,change_request

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--feature-id (string)

Feature Id. Required.

Example

ibmcloud app-configuration feature-delete \
    --guid exampleString \
    --environment-id environment_id \
    --feature-id feature_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--feature-id (string)

Feature Id. Required.

--enabled (bool)

The state of the feature flag. Required.

Example

ibmcloud app-configuration feature-toggle \
    --guid exampleString \
    --environment-id environment_id \
    --feature-id feature_id \
    --enabled=true

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--sort (string)

Sort the property details based on the specified attribute. By default, items are sorted by name.

Allowable values are: created_time, updated_time, id, name.

--tags (string)

Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.

--collections ([]string)

Filter properties by a list of comma separated collections.

The maximum length is 20 items. The minimum length is 0 items.

--segments ([]string)

Filter properties by a list of comma separated segments.

The maximum length is 20 items. The minimum length is 0 items.

--include ([]string)

Include the associated collections or targeting rules details in the response.

Allowable list items are: collections, rules. The maximum length is 20 items. The minimum length is 0 items.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--search (string)

Searches for the provided keyword and returns the appropriate row with that value. Here the search happens on the '[Name OR Tag]' of the entity.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for properties.

Example

ibmcloud app-configuration properties \
    --guid exampleString \
    --environment-id environment_id \
    --expand=true \
    --sort created_time \
    --tags 'version 1.1,pre-release' \
    --collections my-collection-id,ghzindiapvtltd \
    --segments my-segment-id,beta-users \
    --include collections,rules \
    --limit 10 \
    --offset 0 \
    --search 'test tag'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--name (string)

Property name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--property-id (string)

Property id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--type (string)

Type of the property (BOOLEAN, STRING, NUMERIC, SECRETREF). If type is STRING, then format attribute is required. Required.

Allowable values are: BOOLEAN, STRING, NUMERIC, SECRETREF. To see example usage of the different types, see App Configuration API.

--value (interface{})

Value of the Property. The value can be Boolean, Numeric, SecretRef, String - TEXT, String - JSON, String - YAML as per the type and format attributes. Required.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --value=@path/to/file.json.

--description (string)

Property description.

The maximum length is 255 characters.

--format (string)

Format of the property (TEXT, JSON, YAML) and it is a required attribute when type is STRING. It is not required for BOOLEAN, NUMERIC or SECRETREF types. This attribute is populated in the response body of POST, PUT and GET calls if the type STRING is used and not populated for BOOLEAN, NUMERIC and SECRETREF types.

Allowable values are: TEXT, JSON, YAML.

--tags (string)

Tags associated with the property, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--segment-rules (SegmentRule[])

Specify the targeting rules that is used to set different property values for different segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segment-rules=@path/to/file.json.

--collections (CollectionRef[])

List of collection id representing the collections that are associated with the specified property.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --collections=@path/to/file.json.

Example

ibmcloud app-configuration property-create \
    --guid exampleString \
    --environment-id environment_id \
    --name 'Email property' \
    --property-id email-property \
    --type BOOLEAN \
    --value "true" \
    --description 'Property for email' \
    --format TEXT \
    --tags 'version: 1.1, pre-release' \
    --segment-rules '[{"rules": [{"segments": ["betausers","premiumusers"]}], "value": "true", "order": 1}]' \
    --collections '[{"collection_id": "ghzinc"}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--property-id (string)

Property Id. Required.

--name (string)

Property name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Property description.

The maximum length is 255 characters.

--value (interface{})

Value of the Property. The value can be Boolean, Numeric, SecretRef, String - TEXT, String - JSON, String - YAML as per the type and format attributes. To see example usage of the different types, see App Configuration API.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --value=@path/to/file.json.

--tags (string)

Tags associated with the property, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--segment-rules (SegmentRule[])

Specify the targeting rules that is used to set different property values for different segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segment-rules=@path/to/file.json.

--collections (CollectionUpdateRef[])

List of collection id representing the collections that are associated with the specified property.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --collections=@path/to/file.json.

Example

ibmcloud app-configuration property-update \
    --guid exampleString \
    --environment-id environment_id \
    --property-id property_id \
    --name 'Email property' \
    --description 'Property for email' \
    --value "true" \
    --tags 'version: 1.1, pre-release' \
    --segment-rules '[{"rules": [{"segments": ["betausers","premiumusers"]}], "value": "true", "order": 1}]' \
    --collections '[{"collection_id": "ghzinc", "deleted": true}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--property-id (string)

Property Id. Required.

--name (string)

Property name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Property description.

The maximum length is 255 characters.

--tags (string)

Tags associated with the property, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--value (interface{})

Value of the Property. The value can be Boolean, Numeric, SecretRef, String - TEXT, String - JSON, String - YAML as per the type and format attributes.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --value=@path/to/file.json.

To see example usage of the different types, see App Configuration API.

--segment-rules (SegmentRule[])

Specify the targeting rules that is used to set different property values for different segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segment-rules=@path/to/file.json.

Example

ibmcloud app-configuration property-values-update \
    --guid exampleString \
    --environment-id environment_id \
    --property-id property_id \
    --name 'Email property' \
    --description 'Property for email' \
    --tags 'version: 1.1, pre-release' \
    --value "true" \
    --segment-rules '[{"rules": [{"segments": ["betausers","premiumusers"]}], "value": "true", "order": 1}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--property-id (string)

Property Id. Required.

--include ([]string)

Include the associated collections or targeting rules details in the response.

Allowable list items are: collections, rules. The maximum length is 20 items. The minimum length is 0 items.

Example

ibmcloud app-configuration property \
    --guid exampleString \
    --environment-id environment_id \
    --property-id property_id \
    --include collections,rules

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--property-id (string)

Property Id. Required.

Example

ibmcloud app-configuration property-delete \
    --guid exampleString \
    --environment-id environment_id \
    --property-id property_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--sort (string)

Sort the segment details based on the specified attribute. By default, items are sorted by name.

Allowable values are: created_time, updated_time, id, name.

--tags (string)

Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags.

--include (string)

Segment details to include the associated rules in the response.

Allowable values are: rules.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--search (string)

Searches for the provided keyword and returns the appropriate row with that value. Here the search happens on the '[Name OR Tag]' of the entity.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for segments.

Example

ibmcloud app-configuration segments \
    --guid exampleString \
    --expand=true \
    --sort created_time \
    --tags 'version 1.1,pre-release' \
    --include rules \
    --limit 10 \
    --offset 0 \
    --search 'test tag'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--name (string)

Segment name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--segment-id (string)

Segment id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 256 characters.

--rules (Rule[])

List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines. Any feature flag and property value evaluation is performed in the context of an entity when it is targeted to segments. Required.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --rules=@path/to/file.json.

--description (string)

Segment description.

The maximum length is 255 characters.

--tags (string)

Tags associated with the segments, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

Example

ibmcloud app-configuration segment-create \
    --guid exampleString \
    --name 'Beta Users' \
    --segment-id beta-users \
    --rules '[{"attribute_name": "email", "operator": "endsWith", "values": ["@in.mnc.com","@us.mnc.com"]}]' \
    --description 'Segment containing the beta users' \
    --tags 'version: 1.1, stage'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--segment-id (string)

Segment Id. Required.

--name (string)

Segment name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 256 characters.

--description (string)

Segment description.

The maximum length is 255 characters.

--tags (string)

Tags associated with segments, allowed special characters are [_. ,-:].

The value must match regular expression /^[a-zA-Z0-9_\\. ,\\-]+(:[a-zA-Z0-9_\\. ,\\-]+)*$/.

--rules (Rule[])

List of rules that determine if the entity belongs to the segment during feature / property evaluation. An entity is identified by an unique identifier and the attributes that it defines. Any feature flag and property value evaluation is performed in the context of an entity when it is targeted to segments.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --rules=@path/to/file.json.

Example

ibmcloud app-configuration segment-update \
    --guid exampleString \
    --segment-id segment_id \
    --name exampleString \
    --description exampleString \
    --tags exampleString \
    --rules '[{"attribute_name": "exampleString", "operator": "is", "values": ["exampleString","anotherTestString"]}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

--segment-id (string)

Segment Id. Required.

--include ([]string)

Include feature and property details in the response.

Allowable list items are: features, properties. The maximum length is 20 items. The minimum length is 0 items.

Example

ibmcloud app-configuration segment \
    --guid exampleString \
    --segment-id segment_id \
    --include features,properties

Command options

--guid (string)

AppConfiguration instance Id. Required.

--segment-id (string)

Segment Id. Required.

Example

ibmcloud app-configuration segment-delete \
    --guid exampleString \
    --segment-id segment_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--sort (string)

Sort the git configurations details based on the specified attribute. By default, items are sorted by name.

Allowable values are: created_time, updated_time, id, name.

--collection-id (string)

Filters the response based on the specified collection_id.

--environment-id (string)

Filters the response based on the specified environment_id.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--search (string)

Searches for the provided keyword and returns the appropriate row with that value. Here the search happens on the '[Name]' of the entity.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for gitconfigs.

Example

ibmcloud app-configuration gitconfigs \
    --guid exampleString \
    --sort created_time \
    --collection-id collection_id \
    --environment-id environment_id \
    --limit 10 \
    --offset 0 \
    --search search_string

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-name (string)

Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 100 characters.

--git-config-id (string)

Git config id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

The maximum length is 30 characters.

--collection-id (string)

Collection Id. Required.

--environment-id (string)

Environment Id. Required.

--git-url (string)

Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account. If you are using the organization account then url must be in this format https://github.{organization_name}.com/api/v3/repos/{owner}/{repo_name} . Note do not provide /(slash) in the beginning or at the end of the url. Required.

--git-branch (string)

Branch name to which you need to write or update the configuration. Just provide the branch name, do not provide any /(slashes) in the beginning or at the end of the branch name. Note make sure branch exists in your repository. Required.

--git-file-path (string)

Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension. We only create or update json extension file. Note do not provide any /(slashes) in the beginning or at the end of the file path. Required.

--git-token (string)

Git token, this needs to be provided with enough permission to write and update the file. Required.

Example

ibmcloud app-configuration gitconfig-create \
    --guid exampleString \
    --git-config-name boot-strap-configuration \
    --git-config-id boot-strap-configuration \
    --collection-id web-app-collection \
    --environment-id dev \
    --git-url https://github.<company-name>.com/api/v3/repos/jhondoe-owner/my-test-repo \
    --git-branch main \
    --git-file-path code/development/README.json \
    --git-token 61a792eahhGHji223jijb55a6cfdd4d5cde4c8a67esjjhjhHVH

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-id (string)

Git Config Id. Required.

--git-config-name (string)

Git config name. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only.

The maximum length is 100 characters.

--collection-id (string)

Collection Id.

--environment-id (string)

Environment Id.

--git-url (string)

Git url which will be used to connect to the github account. The url must be formed in this format, https://api.github.com/repos/{owner}/{repo_name} for the personal git account. If you are using the organization account then url must be in this format https://github.{organization_name}.com/api/v3/repos/{owner}/{repo_name} . Note do not provide /(slash) in the beginning or at the end of the url.

--git-branch (string)

Branch name to which you need to write or update the configuration. Just provide the branch name, do not provide any /(slashes) in the beginning or at the end of the branch name. Note make sure branch exists in your repository.

--git-file-path (string)

Git file path, this is a path where your configuration file will be written. The path must contain the file name with json extension. We only create or update json extension file. Note do not provide any /(slashes) in the beginning or at the end of the file path.

--git-token (string)

Git token, this needs to be provided with enough permission to write and update the file.

Example

ibmcloud app-configuration gitconfig-update \
    --guid exampleString \
    --git-config-id git_config_id \
    --git-config-name exampleString \
    --collection-id exampleString \
    --environment-id exampleString \
    --git-url exampleString \
    --git-branch exampleString \
    --git-file-path exampleString \
    --git-token exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-id (string)

Git Config Id. Required.

Example

ibmcloud app-configuration gitconfig \
    --guid exampleString \
    --git-config-id git_config_id

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-id (string)

Git Config Id. Required.

Example

ibmcloud app-configuration gitconfig-delete \
    --guid exampleString \
    --git-config-id git_config_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-id (string)

Git Config Id. Required.

Example

ibmcloud app-configuration gitconfig-promote \
    --guid exampleString \
    --git-config-id git_config_id

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-id (string)

Git Config Id. Required.

Example

ibmcloud app-configuration gitconfig-restore \
    --guid exampleString \
    --git-config-id git_config_id

Command options

--guid (string)

AppConfiguration instance Id. Required.

--expand (bool)

If set to true, returns expanded view of the resource details.

--limit (int64)

The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use limit with offset to page through the available records.

The default value is 10. The maximum value is 100. The minimum value is 1.

--offset (int64)

The number of records to skip. By specifying offset, you retrieve a subset of items that starts with the offset value. Use offset with limit to page through the available records.

The default value is 0. The minimum value is 0.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for integrations.

Example

ibmcloud app-configuration integrations \
    --guid exampleString \
    --expand=true \
    --limit 10 \
    --offset 0

Command options

--guid (string)

AppConfiguration instance Id. Required.

--integration-id (string)

Integration id. Allowed special characters are dot ( . ), hyphen( - ), underscore ( _ ) only. Required.

--integration-type (string)

Integration type. Required.

Allowable values are: KMS, EVENT_NOTIFICATIONS.

--metadata (CreateIntegrationMetadata)

This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --metadata=@path/to/file.json.

--metadata-event-notifications-instance-crn (string)

The CRN of the Event Notifications service instance. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

--metadata-event-notifications-endpoint (string)

The URL endpoint of the Event Notifications service instance. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

--metadata-event-notifications-source-name (string)

Source name. This name will be shown in your Event Notification instance sources page. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

--metadata-event-notifications-source-description (string)

Source description. This description will be shown in your Event Notification instance sources page under above source name. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

--metadata-kms-instance-crn (string)

The CRN of the Key Protect service instance. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

--metadata-kms-endpoint (string)

The URL endpoint of Key Protect instance. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

--metadata-root-key-id (string)

The rootkey id of Key Protect instance. This option provides a value for a sub-field of the JSON option 'metadata'. It is mutually exclusive with that option.

Examples

ibmcloud app-configuration integration-create \
    --guid exampleString \
    --integration-id lckkhp34t \
    --integration-type EVENT_NOTIFICATIONS \
    --metadata '{"event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:eu-gb:a/4f631ea3b3204b2b878a295604994acf:0eb42def-21aa-4f0a-a975-0812ead6ceee::", "event_notifications_endpoint": "https://eu-gb.event-notifications.cloud.ibm.com", "event_notifications_source_name": "My App Config", "event_notifications_source_description": "All the events from App Configuration instance"}'

Alternatively, granular options are available for the sub-fields of JSON string options:

ibmcloud app-configuration integration-create \
    --guid exampleString \
    --integration-id lckkhp34t \
    --integration-type EVENT_NOTIFICATIONS \
    --metadata-event-notifications-instance-crn crn:v1:bluemix:public:event-notifications:eu-gb:a/4f631ea3b3204b2b878a295604994acf:0eb42def-21aa-4f0a-a975-0812ead6ceee:: \
    --metadata-event-notifications-endpoint https://eu-gb.event-notifications.cloud.ibm.com \
    --metadata-event-notifications-source-name exampleString \
    --metadata-event-notifications-source-description exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

--integration-id (string)

Integration Id of the integration. Required.

Example

ibmcloud app-configuration integration \
    --guid exampleString \
    --integration-id integration_id

Command options

--guid (string)

AppConfiguration instance Id. Required.

--integration-id (string)

Integration Id of the integration. Required.

Example

ibmcloud app-configuration integration-delete \
    --guid exampleString \
    --integration-id integration_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

Example

ibmcloud app-configuration originconfigs \
    --guid exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

--allowed-origins ([]string)

List of allowed origins. Specify the parameter as a list of comma separated origins. Required.

The maximum length is 20 items. The minimum length is 0 items.

Example

ibmcloud app-configuration originconfigs-update \
    --guid exampleString \
    --allowed-origins exampleString,anotherTestString

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

Example

ibmcloud app-configuration workflowconfig \
    --guid exampleString \
    --environment-id environment_id

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--workflow-config (CreateWorkflowConfig)

The request body to create a new workflow config. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --workflow-config=@path/to/file.json.

--workflow-config-workflow-url (string)

Only service now url https://xxxxx.service-now.com allowed, xxxxx is the service now instance id. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The maximum length is 200 characters.

--workflow-config-approval-group-name (string)

Group name of personals who can approve the Change Request on your ServiceNow. It must be first registered in your ServiceNow then it must be added here. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The maximum length is 100 characters.

--workflow-config-approval-expiration (int64)

Integer number identifies as hours which helps in adding approval start and end time to the created Change Request. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The maximum value is 999. The minimum value is 1.

--workflow-config-workflow-credentials (ExternalServiceNowCredentials)

The credentials of the External ServiceNow instance. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --workflow-config-workflow-credentials=@path/to/file.json.

--workflow-config-enabled (bool)

This option enables the workflow configuration per environment. User must set it to true if they wish to create Change Request for flag state changes. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The default value is false.

--workflow-config-service-crn (string)

Only service crn will be allowed. Example: crn:v1:staging:staging:appservice:us-south::::. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The maximum length is 255 characters.

--workflow-config-workflow-type (string)

Allowed value is SERVICENOW_IBM case-sensitive. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

--workflow-config-sm-instance-crn (string)

Only Secret Manager instance crn will be allowed. Example: crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The maximum length is 255 characters.

--workflow-config-secret-id (string)

Provide the arbitary secret key id which holds the api key to interact with service now. This is required to perform action on ServiceNow like Create CR or Close CR. This option provides a value for a sub-field of the JSON option 'workflow-config'. It is mutually exclusive with that option.

The maximum length is 100 characters.

Examples

ibmcloud app-configuration workflowconfig-create \
    --guid exampleString \
    --environment-id environment_id \
    --workflow-config '{"workflow_url": "https://xxxxx.service-now.com", "approval_group_name": "WorkflowCRApprovers", "approval_expiration": 10, "workflow_credentials": {"username": "user", "password": "pwd", "client_id": "client id value", "client_secret": "clientsecret"}, "enabled": true}'

Alternatively, granular options are available for the sub-fields of JSON string options:

ibmcloud app-configuration workflowconfig-create \
    --guid exampleString \
    --environment-id environment_id \
    --workflow-config-workflow-url exampleString \
    --workflow-config-approval-group-name exampleString \
    --workflow-config-approval-expiration 1 \
    --workflow-config-workflow-credentials externalServiceNowCredentials \
    --workflow-config-enabled=false

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

--update-workflow-config (UpdateWorkflowConfig)

The request body to update an existing workflow config. This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --update-workflow-config=@path/to/file.json.

--update-workflow-config-workflow-url (string)

ServiceNow instance URL. Only url https://xxxxx.service-now.com allowed, xxxxx is the service now instance id. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The maximum length is 200 characters.

--update-workflow-config-approval-group-name (string)

Group name of personals who can approve the Change Request on your ServiceNow. It must be first registered in your ServiceNow then it must be added here. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The maximum length is 100 characters.

--update-workflow-config-approval-expiration (int64)

Integer number identifies as hours which helps in adding approval start and end time to the created Change Request. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The maximum value is 999. The minimum value is 1.

--update-workflow-config-workflow-credentials (ExternalServiceNowCredentials)

The credentials of the External ServiceNow instance. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --update-workflow-config-workflow-credentials=@path/to/file.json.

--update-workflow-config-enabled (bool)

This option enables the workflow configuration per environment. User must set it to true if they wish to create Change Request for flag state changes. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The default value is false.

--update-workflow-config-service-crn (string)

Only service crn will be allowed. Example: crn:v1:staging:staging:appservice:us-south::::. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The maximum length is 255 characters.

--update-workflow-config-sm-instance-crn (string)

Only Secret Manager instance crn will be allowed. Example: crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The maximum length is 255 characters.

--update-workflow-config-secret-id (string)

Provide the arbitary secret key id which holds the api key to interact with service now. This is required to perform action on ServiceNow like Create CR or Close CR. This option provides a value for a sub-field of the JSON option 'update-workflow-config'. It is mutually exclusive with that option.

The maximum length is 100 characters.

Examples

ibmcloud app-configuration workflowconfig-update \
    --guid exampleString \
    --environment-id environment_id \
    --update-workflow-config '{"workflow_url": "https://xxxxx.service-now.com", "approval_group_name": "WorkflowCRApprovers", "approval_expiration": 5, "workflow_credentials": {"username": "user", "password": "updated password", "client_id": "client id value", "client_secret": "updated client secret"}, "enabled": true}'

Alternatively, granular options are available for the sub-fields of JSON string options:

ibmcloud app-configuration workflowconfig-update \
    --guid exampleString \
    --environment-id environment_id \
    --update-workflow-config-workflow-url exampleString \
    --update-workflow-config-approval-group-name exampleString \
    --update-workflow-config-approval-expiration 1 \
    --update-workflow-config-workflow-credentials externalServiceNowCredentials \
    --update-workflow-config-enabled=false

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environment-id (string)

Environment Id. Required.

Example

ibmcloud app-configuration workflowconfig-delete \
    --guid exampleString \
    --environment-id environment_id

Use command option -f or --force if you want to delete without the confirmation prompt.

Command options

--guid (string)

AppConfiguration instance Id. Required.

--environments (ImportEnvironmentSchema[])

Array will contain features and properties per environment.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --environments=@path/to/file.json.

--collections (ImportCollectionSchema[])

Array will contain collections details.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --collections=@path/to/file.json.

--segments (ImportSegmentSchema[])

Array will contain segments details.

The maximum length is 20 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --segments=@path/to/file.json.

--clean (string)

Full instance import requires query parameter clean=true to perform wiping of the existing data.

Example

ibmcloud app-configuration instance-import \
    --guid exampleString \
    --environments '[{"name": "Dev", "environment_id": "dev", "description": "Environment created on instance creation", "tags": "exampleString", "color_code": "#FDD13A", "features": [{"name": "Cycle Rentals", "feature_id": "cycle-rentals", "description": "exampleString", "type": "NUMERIC", "format": "TEXT", "enabled_value": "1", "disabled_value": "2", "enabled": true, "rollout_percentage": 100, "tags": "exampleString", "segment_rules": [{"rules": [{"segments": ["exampleString","anotherTestString"]}], "value": "exampleString", "order": 38, "rollout_percentage": 100}], "collections": [{"collection_id": "web-app"}]}], "properties": [{"name": "Daily Discount", "property_id": "daily_discount", "description": "exampleString", "type": "NUMERIC", "format": "TEXT", "value": "100", "tags": "pre-release, v1.2", "segment_rules": [{"rules": [{"segments": ["exampleString","anotherTestString"]}], "value": "200", "order": 1}], "collections": [{"collection_id": "web-app"}]}]}]' \
    --collections '[{"collection_id": "web-app", "name": "web-app", "description": "web app collection", "tags": "v1"}]' \
    --segments '[{"name": "Testers", "segment_id": "khpwj68h", "description": "Testers", "tags": "test", "rules": [{"attribute_name": "email", "operator": "is", "values": ["john@bluecharge.com","alice@bluecharge.com"]}]}]' \
    --clean true

Command options

--guid (string)

AppConfiguration instance Id. Required.

Example

ibmcloud app-configuration instance-export \
    --guid exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

--git-config-id (string)

Git Config Id. Required.

--action (string)

Promote configuration to Git or Restore configuration from Git. Required.

Allowable values are: promote, restore.

Example

ibmcloud app-configuration gitconfig-promote-restore \
    --guid exampleString \
    --git-config-id git_config_id \
    --action promote

Command options

--guid (string)

AppConfiguration instance Id. Required.

--reference-id (string)

AppConfiguration config status reference id. Required.

--action (string)

The type of config status that is to be fetched. Required.

Allowable values are: import, export.

Example

ibmcloud app-configuration instance-config-status \
    --guid exampleString \
    --reference-id exampleString \
    --action import

Command options

--guid (string)

AppConfiguration instance Id. Required.

--config-type (string)

The type of resource configuration that is to be fetched.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--service-name (string)

The service from which the resource is to be fetched.

The maximum length is 1024 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9 ,\\-_]+$/.

--resource-group-id (string)

The resource group id of the service.

The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--location (string)

The location of the service.

The maximum length is 32 characters. The minimum length is 0 characters. The value must match regular expression /^$|[a-z]-[a-z]/.

--resource-crn (string)

The crn of the resource.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /^[a-zA-Z0-9.\\:\/-]+$/.

--limit (int64)

The number of resources for which the configuration can be fetched.

--start (string)

The start string to fetch the resource.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9]/.

--sub-account (string)

Filter the resource configurations from the specified sub-account in an enterprise hierarchy.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9]/.

--access-tags (string)

Filter the resource configurations attached with the specified access tags.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /[a-z0-9]/.

--user-tags (string)

Filter the resource configurations attached with the specified user tags.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /[a-zA0-9]/.

--service-tags (string)

Filter the resource configurations attached with the specified service tags.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /[a-z0-9]/.

--all-pages (bool)

Invoke multiple requests to display all pages of the collection for configs.

Example

ibmcloud app-configuration configs \
    --guid exampleString \
    --config-type exampleString \
    --service-name exampleString \
    --resource-group-id exampleString \
    --location exampleString \
    --resource-crn exampleString \
    --limit 10 \
    --start exampleString \
    --sub-account exampleString \
    --access-tags role:admin \
    --user-tags test \
    --service-tags test:tag

Command options

--guid (string)

AppConfiguration instance Id. Required.

--resource-collection-enabled (bool)

The field denoting if the resource collection is enabled.

--trusted-profile-id (string)

The trusted profile id that provides Reader access to the App Configuration instance to collect resource metadata.

Length must be 44 characters. The value must match regular expression /^[a-zA-Z0-9-]*$/.

--regions ([]string)

The list of regions across which the resource collection is enabled.

The list items must match regular expression /^[a-zA-Z0-9-]*$/. The maximum length is 10 items. The minimum length is 0 items.

--additional-scope (AdditionalScope[])

The additional scope that enables resource collection for Enterprise acccounts.

The maximum length is 10 items. The minimum length is 0 items.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --additional-scope=@path/to/file.json.

Example

ibmcloud app-configuration config-settings-update \
    --guid exampleString \
    --resource-collection-enabled=true \
    --trusted-profile-id Profile-1260aec2-f2fc-44e2-8697-2cc15a447560 \
    --regions all \
    --additional-scope '[{"type": "Enterprise", "enterprise_id": "2c99aed413954f93b7cf7ce9fda6de61", "profile_template": {"id": "ProfileTemplate-adb55769-ae22-4c60-aead-bd1f84f93c57", "trusted_profile_id": "Profile-39acf232-8969-4c32-9838-83eb60a037f7"}}]'

Command options

--guid (string)

AppConfiguration instance Id. Required.

Example

ibmcloud app-configuration config-settings \
    --guid exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

Example

ibmcloud app-configuration config-resource-collection-status \
    --guid exampleString

Command options

--guid (string)

AppConfiguration instance Id. Required.

Example

ibmcloud app-configuration config-manual-reconcile \
    --guid exampleString