App Configuration API | IBM Cloud API Docs

Introduction

Last updated: 2024-03-25

IBM Cloud App Configuration is a centralized feature management and configuration service for use with web and mobile applications, microservices, and distributed environments.

Instrument your applications with App Configuration SDKs, and use the App Configuration dashboard or App Configuration administrator API to define features flags, which are organized into collections and targeted to segments. Change feature flag states in the cloud to activate or deactivate features in your application or environment, often without restarting.

App Owners - Roll out features by segment and independent from code deployments.
Developers - Reduce source code branch complexity and troublesome merges by including untested or unfinished features behind a feature flag in your master branch.
Testers - Increase confidence that new features will smoothly transition to production by testing there. Use flags to activate untested features only for testers and QA personnel until it's time to release.

Before you begin

Make sure that you have access to a paid IBM Cloud account.

Learn more about App Configuration.

SDKs

For more information about installation and technical concepts, see the 'README' document in the SDK.

Table 1. List of App Configuration server, client, and admin SDKs
Server SDKs	Client SDKs	Admin SDKs
Node SDK Documentation	Android SDK Documentation	Go Admin SDK
Python SDK Documentation	JavaScript SDK Documentation
Go SDK Documentation	React SDK Documentation
Java SDK Documentation

Installing the Go SDK

Go modules (recommended): Add the following import in your code, and then run go build or go mod tidy

import (
  "github.com/IBM/appconfiguration-go-admin-sdk/appconfigurationv1"
)

Go get

go get -u github.com/IBM/appconfiguration-go-admin-sdk

View on GitHub

https://github.com/IBM/appconfiguration-go-admin-sdk

Endpoint URLs

The following URLs represents the base URLs for the App Configuration API endpoints. When you call the API, use the URL that corresponds to the region where your service instance is deployed. Add the path for each method to form the complete API endpoint for your requests.

Dallas: https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
Washington DC: https://us-east.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
London: https://eu-gb.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
Sydney: https://au-syd.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
Frankfurt: https://eu-de.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}

If you have enabled service endpoints in your account, you can send API requests over the IBM Cloud® private network at the following base endpoint URLs.

Dallas: https://private.us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
Washington DC: https://private.us-east.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
London: https://private.eu-gb.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
Sydney: https://private.au-syd.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}
Frankfurt: https://private.eu-de.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}

The following table details the location where the App Configuration actions run, data stored and replicated:

Table 2. Location where App Configuration actions run, data storage and replication
Location	Location where App Configuration actions run	Data is stored in	Data is replicated to
Dallas	All App Configuration actions run in the Dallas (`us-south`) location.	All metadata for the app's features are stored in the Dallas (`us-south`) location.	Data is replicated between three zones within `us-south` for high-availability.
Washington DC	All App Configuration actions run in the Washington DC (`us-east`) location.	All metadata for the app's features are stored in the Washington DC (`us-east`) location.	Data is replicated between three zones within `us-east` for high-availability.
London	All App Configuration actions run in the London (`eu-gb`) location.	All metadata for the app's features are stored in the London (`eu-gb`) location.	Data is replicated between three zones within `eu-gb` for high-availability.
Sydney	All App Configuration actions run in the Sydney (`au-syd`) location.	All metadata for the app's features are stored in the Sydney (`au-syd`) location.	Data is replicated between three zones within `au-syd` for high-availability.
Frankfurt	All App Configuration actions run in the Frankfurt (`eu-de`) location.	All metadata for the app's features are stored in the Frankfurt (`eu-de`) location.	Data is replicated between three zones within `eu-de` for high-availability.

Base URL

https://{region}.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}

Example request to a Dallas endpoint:

curl -H "Authorization:Bearer {token}" -X "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}"

Replace {token} and {guid} in this example with the values for your particular API call.

Example request to a Dallas endpoint:

import (
    "encoding/json"
    "fmt"
    "github.com/IBM/go-sdk-core/v5/core"
    ac "github.com/IBM/appconfiguration-go-admin-sdk/appconfigurationv1"
)

func main() {

    appConfigurationService, err := ac.NewAppConfigurationV1(&ac.AppConfigurationV1Options {
        URL: "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/{guid}",
        Authenticator: & core.IamAuthenticator {
            ApiKey: "<API_KEY>",
        },
    })

    if err != nil {
        panic(err)
    }
}
Copy to clipboard

Authentication

Authorization to the App Configuration API is enforced by using an IBM Cloud Identity and Access Management (IAM) access token. The token is used to determine the actions that a user or service ID has access to when they use the API.

To work with the API, include a valid IAM token in each outgoing request to the service. You can generate an access token by first creating an API key and then exchanging your API key for an IBM Cloud IAM token. By default, the IAM access token have a lifetime of 60 minutes. See Managing access token expiration to decrease the IAM access token lifetime.

Don't have an API key? Try running ibmcloud iam oauth-tokens in the IBM Cloud Shell to quickly generate a personal access token.

When you use the SDK, configure an IAM authenticator with an IBM Cloud IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can configure an authenticator in either of two ways:

Programmatically by constructing an IAM authenticator instance and supplying your IAM API key.
By defining the API key in external configuration properties and then using the SDK authenticator factory to construct an IAM authenticator that uses the configured IAM API key.

For more information, see the Authentication section of the IBM Cloud SDK Common documentation.

To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Assigning access to account management services.

To retrieve your access token:

curl -X POST   "https://iam.cloud.ibm.com/identity/token"   --header 'Content-Type: application/x-www-form-urlencoded'   --header 'Accept: application/json'   --data-urlencode 'grant_type=urn:ibm:params:oauth:grant-type:apikey'   --data-urlencode 'apikey={API_KEY}'
Copy to clipboard

Replace {API_KEY} with your IAM API key.

Setting client options through external configuration

Example environment variables, where {SERVICE_URL} is the endpoint URL and {API_KEY} is your IAM API key

export APP_CONFIGURATION_URL={SERVICE_URL}
export APP_CONFIGURATION_AUTH_TYPE=iam
export APP_CONFIGURATION_APIKEY={API_KEY}
Copy to clipboard

Example of constructing the service client

import {
     ac "github.com/IBM/appconfiguration-go-admin-sdk/appconfigurationv1"
}
...
serviceClientOptions := &ac.AppConfigurationV1Options{}
serviceClient, err := ac.NewAppConfigurationV1UsingExternalConfig(serviceClientOptions)

Auditing

You can monitor API activity within your account by using the IBM Cloud Activity Tracker service. Whenever an API method is called, an event is generated that you can then track and audit from within Activity Tracker. The specific event type is listed for each individual method.

For more information about how to track App Configuration activity, see Auditing events for App Configuration.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 2xx response always indicates success. A 4xx type response is some sort of failure, and a 5xx type response usually indicates an internal system error.

Table 3. List of HTTP response codes
HTTP status code	Description	Recovery
`200`	Success	The request was successful.
`201`	Success	The resource was successfully created and added to your IBM Cloud account.
`400`	Bad Request	The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request. Log in to IBM Cloud and try again. If this error persists, contact the account owner to check your permissions.
`403`	Forbidden	The supplied authentication is not authorized to access the apps. Check that you have the correct access credentials and permissions.
`404`	Not Found	The requested resource could not be found.
`408`	Request timeout	The connection to the server timed out. Wait a few minutes, then try again.
`409`	Conflict	The entity is already in the requested state.
`429`	Too Many Requests	Too many requests have been made within a time window. Wait before calling the API again.
`500`	Internal Server Error	IBM Cloud App Configuration is not available. Your request could not be processed. Wait a few minutes and try again. If you still encounter this problem, note the incident ID and contact IBM Cloud support.
`503`	Service Temporarily Unavailable	IBM Cloud App Configuration could not process the request, due to a temporary overloading or maintenance. Try to reduce your request rate, or retry after a few minutes. If the error persists, contact IBM Cloud support.

Example error handling

import ac "github.com/IBM/appconfiguration-go-admin-sdk/appconfigurationv1"

// Instantiate a service
appConfigurationService, err := ac.NewAppConfigurationV1(&ac.AppConfigurationV1Options)

// Check for errors
if err != nil {
  panic(err)
}

// Call a method
result, response, err := appConfigurationService.MethodName(&methodOptions)

// Check for errors
if err != nil {
  panic(err)
}
Copy to clipboard

List all the environments in the App Configuration service instance.

GET /environments

(appConfiguration *AppConfigurationV1) ListEnvironments(listEnvironmentsOptions *ListEnvironmentsOptions) (result *EnvironmentList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListEnvironmentsWithContext(ctx context.Context, listEnvironmentsOptions *ListEnvironmentsOptions) (result *EnvironmentList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.environments.list

Auditing

Calling this method generates the following auditing event.

apprapp.environments.list

Request

Instantiate the ListEnvironmentsOptions struct and set the fields to provide parameter values for the ListEnvironments method.

Query Parameters

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

Example: true
sort
string
Sort the environment details based on the specified attribute. By default, items are sorted by name.

Allowable values: [created_time,updated_time,id,name]
Example: created_time
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.

Example: version 1.1,pre-release
include
string[]
Include feature, property, snapshots details in the response.

Allowable values: [features,properties,snapshots]
Examples:
[ "features", "properties", "snapshots" ]
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 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

Example: test tag

parameter

WithContext method only

ListEnvironmentsOptions

The ListEnvironments options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments?expand=true&sort=created_time&tags=version 1.1,pre-release&include=features,properties,snapshots&search=test tag"
Copy to clipboard

Example request

listEnvironmentsOptions := &appconfigurationv1.ListEnvironmentsOptions{
  Expand: core.BoolPtr(true),
  Sort: core.StringPtr("created_time"),
  Tags: core.StringPtr("version 1.1,pre-release"),
  Include: []string{"features", "properties", "snapshots"},
  Limit: core.Int64Ptr(int64(10)),
  Search: core.StringPtr("test tag"),
}

pager, err := appConfigurationService.NewEnvironmentsPager(listEnvironmentsOptions)
if err != nil {
  panic(err)
}

var allResults []appconfigurationv1.Environment
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

EnvironmentList

List of all environments.

EnvironmentList

List of all environments.

Examples:

Status Code

200
Successfully listed the environments.
401
Unauthorized

Example responses

Status 200

{
  "environments": [
    {
      "name": "Dev environment",
      "environment_id": "dev-environment",
      "description": "Dev environment description",
      "tags": "development",
      "color_code": "#FDD13A",
      "created_time": "2021-05-12T23:20:50.52Z",
      "updated_time": "2021-05-12T23:20:50.52Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments?limit=10&offset=0"
  }
}
Copy to clipboard

Success example

{
  "environments": [
    {
      "name": "Dev environment",
      "environment_id": "dev-environment",
      "description": "Dev environment description",
      "tags": "development",
      "color_code": "#FDD13A",
      "created_time": "2021-05-12T23:20:50.52Z",
      "updated_time": "2021-05-12T23:20:50.52Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments?limit=10&offset=0"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Create an environment.

POST /environments

(appConfiguration *AppConfigurationV1) CreateEnvironment(createEnvironmentOptions *CreateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreateEnvironmentWithContext(ctx context.Context, createEnvironmentOptions *CreateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.environments.create

Auditing

Calling this method generates the following auditing event.

apprapp.environments.create

Request

Instantiate the CreateEnvironmentOptions struct and set the fields to provide parameter values for the CreateEnvironment method.

Request Body

Required*

Environment

The request body to create a new environment.

Examples:

parameter

WithContext method only

CreateEnvironmentOptions

The CreateEnvironment options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "Dev environment", "environment_id": "dev-environment", "description": "Dev environment description", "tags": "development", "color_code": "#FDD13A" }'   "{base_url}/environments"
Copy to clipboard

Example request

createEnvironmentOptions := appConfigurationService.NewCreateEnvironmentOptions(
  "Dev environment",
  "dev-environment",
)
createEnvironmentOptions.SetDescription("Dev environment description")
createEnvironmentOptions.SetTags("development")
createEnvironmentOptions.SetColorCode("#FDD13A")

environment, response, err := appConfigurationService.CreateEnvironment(createEnvironmentOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(environment, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Environment

Details of the environment.

Environment

Details of the environment.

Examples:

Status Code

201
Successfully created the environment.
400
Bad request. Verify that the information in the request body is complete and correct.

Example responses

Status 201

{
  "name": "Dev environment",
  "environment_id": "dev-environment",
  "description": "Dev environment description",
  "tags": "development",
  "color_code": "#FDD13A",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
}
Copy to clipboard

Success example

{
  "name": "Dev environment",
  "environment_id": "dev-environment",
  "description": "Dev environment description",
  "tags": "development",
  "color_code": "#FDD13A",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1000E",
  "message": "Error while creating the environment."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while creating the environment."
}
Copy to clipboard

Update an environment.

PUT /environments/{environment_id}

(appConfiguration *AppConfigurationV1) UpdateEnvironment(updateEnvironmentOptions *UpdateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateEnvironmentWithContext(ctx context.Context, updateEnvironmentOptions *UpdateEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.environments.update

Auditing

Calling this method generates the following auditing event.

apprapp.environments.update

Request

Instantiate the UpdateEnvironmentOptions struct and set the fields to provide parameter values for the UpdateEnvironment method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Request Body

Required*

UpdateEnvironment

The request body to update a environment.

Examples:

parameter

WithContext method only

UpdateEnvironmentOptions

The UpdateEnvironment options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"name":"Dev environment","description":"Dev environment description","tags":"development","color_code":"#FDD13A"}'   "{base_url}/environments/{environment_id}"
Copy to clipboard

Example request

updateEnvironmentOptions := appConfigurationService.NewUpdateEnvironmentOptions(
  "environment_id",
)

environment, response, err := appConfigurationService.UpdateEnvironment(updateEnvironmentOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(environment, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Environment

Details of the environment.

Environment

Details of the environment.

Examples:

Status Code

200
Successfully updated the environment details.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the environment id is correct.

Example responses

Status 200

{
  "name": "Dev environment",
  "environment_id": "dev-environment",
  "description": "Dev environment description",
  "tags": "development",
  "color_code": "#FDD13A",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
}
Copy to clipboard

Success example

{
  "name": "Dev environment",
  "environment_id": "dev-environment",
  "description": "Dev environment description",
  "tags": "development",
  "color_code": "#FDD13A",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the environment."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the environment."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the environment. The queried resource 'Environment' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the environment. The queried resource 'Environment' is not available on the server."
}
Copy to clipboard

Retrieve the details of the environment.

GET /environments/{environment_id}

(appConfiguration *AppConfigurationV1) GetEnvironment(getEnvironmentOptions *GetEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) GetEnvironmentWithContext(ctx context.Context, getEnvironmentOptions *GetEnvironmentOptions) (result *Environment, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.environments.list

Auditing

Calling this method generates the following auditing event.

apprapp.environments.read

Request

Instantiate the GetEnvironmentOptions struct and set the fields to provide parameter values for the GetEnvironment method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Query Parameters

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

Example: true
include
string[]
Include feature, property, snapshots details in the response.

Allowable values: [features,properties,snapshots]
Examples:
[ "features", "properties", "snapshots" ]

parameter

WithContext method only

GetEnvironmentOptions

The GetEnvironment options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments/{environment_id}?expand=true&include=features,properties,snapshots"
Copy to clipboard

Example request

getEnvironmentOptions := appConfigurationService.NewGetEnvironmentOptions(
  "environment_id",
)
getEnvironmentOptions.SetExpand(true)
getEnvironmentOptions.SetInclude([]string{"features", "properties", "snapshots"})

environment, response, err := appConfigurationService.GetEnvironment(getEnvironmentOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(environment, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Environment

Details of the environment.

Environment

Details of the environment.

Examples:

Status Code

200
Successfully retrieved the environment details.
404
Not Found. Verify that the environment id is correct.

Example responses

Status 200

{
  "name": "Dev environment",
  "environment_id": "dev-environment",
  "description": "Dev environment description",
  "tags": "development",
  "color_code": "#FDD13A",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
}
Copy to clipboard

Success example

{
  "name": "Dev environment",
  "environment_id": "dev-environment",
  "description": "Dev environment description",
  "tags": "development",
  "color_code": "#FDD13A",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev-environment"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the environment. The queried resource 'Environment' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the environment. The queried resource 'Environment' is not available on the server."
}
Copy to clipboard

Delete an Environment.

DELETE /environments/{environment_id}

(appConfiguration *AppConfigurationV1) DeleteEnvironment(deleteEnvironmentOptions *DeleteEnvironmentOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeleteEnvironmentWithContext(ctx context.Context, deleteEnvironmentOptions *DeleteEnvironmentOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.environments.delete

Auditing

Calling this method generates the following auditing event.

apprapp.environments.delete

Request

Instantiate the DeleteEnvironmentOptions struct and set the fields to provide parameter values for the DeleteEnvironment method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

parameter

WithContext method only

DeleteEnvironmentOptions

The DeleteEnvironment options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/environments/{environment_id}"

Example request

deleteEnvironmentOptions := appConfigurationService.NewDeleteEnvironmentOptions(
  "environment_id",
)

response, err := appConfigurationService.DeleteEnvironment(deleteEnvironmentOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteEnvironment(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted the specified environment.
400
Bad request. Ensure that at least one environment should exist in the instance.
404
Not Found. Verify that the environment id is correct.

Example responses

Status 400

{
  "code": "FTEC1008E",
  "message": "Error while deleting the environment."
}
Copy to clipboard

Error example

{
  "code": "FTEC1008E",
  "message": "Error while deleting the environment."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the environment. The queried resource 'Environment' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the environment. The queried resource 'Environment' is not available on the server."
}
Copy to clipboard

List of all the collections in the App Configuration service instance.

GET /collections

(appConfiguration *AppConfigurationV1) ListCollections(listCollectionsOptions *ListCollectionsOptions) (result *CollectionList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListCollectionsWithContext(ctx context.Context, listCollectionsOptions *ListCollectionsOptions) (result *CollectionList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.collections.list

Auditing

Calling this method generates the following auditing event.

apprapp.collections.list

Request

Instantiate the ListCollectionsOptions struct and set the fields to provide parameter values for the ListCollections method.

Query Parameters

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

Example: true
sort
string
Sort the collection details based on the specified attribute. By default, items are sorted by name.

Allowable values: [created_time,updated_time,id,name]
Example: created_time
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.

Example: version 1.1,pre-release
features
string[]
Filter collections by a list of comma separated features.
Examples:
[ "my-feature-id", "cycle-rentals" ]
properties
string[]
Filter collections by a list of comma separated properties.
Examples:
[ "my-property-id", "email-property" ]
include
string[]
Include feature, property, snapshots details in the response.

Allowable values: [features,properties,snapshots]
Examples:
[ "features", "properties", "snapshots" ]
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 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

Example: test tag

parameter

WithContext method only

ListCollectionsOptions

The ListCollections options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/collections?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&search=test tag"
Copy to clipboard

Example request

listCollectionsOptions := &appconfigurationv1.ListCollectionsOptions{
  Expand: core.BoolPtr(true),
  Sort: core.StringPtr("created_time"),
  Tags: core.StringPtr("version 1.1,pre-release"),
  Features: []string{"my-feature-id", "cycle-rentals"},
  Properties: []string{"my-property-id", "email-property"},
  Include: []string{"features", "properties", "snapshots"},
  Limit: core.Int64Ptr(int64(10)),
  Search: core.StringPtr("test tag"),
}

pager, err := appConfigurationService.NewCollectionsPager(listCollectionsOptions)
if err != nil {
  panic(err)
}

var allResults []appconfigurationv1.Collection
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

CollectionList

List of all Collections

CollectionList

List of all Collections.

Examples:

Status Code

200
Successfully listed the collections.
401
Unauthorized

Example responses

Status 200

{
  "collections": [
    {
      "name": "GHz India Pvt Ltd",
      "collection_id": "ghzindiapvtltd",
      "description": "Collection for GHz Inc",
      "tags": "version: 1.1, pre-release",
      "created_time": "2020-01-09T00:16:07Z",
      "updated_time": "2020-03-09T12:16:07Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd",
      "features": [
        {
          "feature_id": "cycle-rentals",
          "name": "Cycle Rentals"
        },
        {
          "feature_id": "discountRate",
          "name": "Discount Rate"
        },
        {
          "feature_id": "longDistanceLimit",
          "name": "Long Distance Limit"
        }
      ],
      "properties": [
        {
          "property_id": "bigbillionday",
          "name": "BigBillionDay"
        },
        {
          "property_id": "newyear",
          "name": "NewYear"
        }
      ],
      "features_count": 3,
      "properties_count": 2
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections?limit=10&offset=0"
  }
}
Copy to clipboard

Success example

{
  "collections": [
    {
      "name": "GHz India Pvt Ltd",
      "collection_id": "ghzindiapvtltd",
      "description": "Collection for GHz Inc",
      "tags": "version: 1.1, pre-release",
      "created_time": "2020-01-09T00:16:07Z",
      "updated_time": "2020-03-09T12:16:07Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd",
      "features": [
        {
          "feature_id": "cycle-rentals",
          "name": "Cycle Rentals"
        },
        {
          "feature_id": "discountRate",
          "name": "Discount Rate"
        },
        {
          "feature_id": "longDistanceLimit",
          "name": "Long Distance Limit"
        }
      ],
      "properties": [
        {
          "property_id": "bigbillionday",
          "name": "BigBillionDay"
        },
        {
          "property_id": "newyear",
          "name": "NewYear"
        }
      ],
      "features_count": 3,
      "properties_count": 2
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections?limit=10&offset=0"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Create a collection.

POST /collections

(appConfiguration *AppConfigurationV1) CreateCollection(createCollectionOptions *CreateCollectionOptions) (result *CollectionLite, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreateCollectionWithContext(ctx context.Context, createCollectionOptions *CreateCollectionOptions) (result *CollectionLite, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.collections.create

Auditing

Calling this method generates the following auditing event.

apprapp.collections.create

Request

Instantiate the CreateCollectionOptions struct and set the fields to provide parameter values for the CreateCollection method.

Request Body

Required*

Collection

The request body to create a new collection.

Examples:

parameter

WithContext method only

CreateCollectionOptions

The CreateCollection options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "Web App Collection", "collection_id": "web-app-collection", "description": "Collection for Web application", "tags": "version: 1.1, pre-release" }'   "{base_url}/collections"
Copy to clipboard

Example request

createCollectionOptions := appConfigurationService.NewCreateCollectionOptions(
  "Web App Collection",
  "web-app-collection",
)
createCollectionOptions.SetDescription("Collection for Web application")
createCollectionOptions.SetTags("version: 1.1, pre-release")

collectionLite, response, err := appConfigurationService.CreateCollection(createCollectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(collectionLite, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

CollectionLite

Details of the collection.

CollectionLite

Details of the collection.

Examples:

Status Code

201
Successfully created the collection.
400
Bad request. Verify that the information in the request body is complete and correct.

Example responses

Status 201

{
  "name": "GHz India Pvt Ltd",
  "collection_id": "ghzindiapvtltd",
  "description": "Collection for GHz Inc",
  "tags": "version: 1.1, pre-release",
  "created_time": "2020-01-09T00:16:07Z",
  "updated_time": "2020-03-09T12:16:07Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd"
}
Copy to clipboard

Success example

{
  "name": "GHz India Pvt Ltd",
  "collection_id": "ghzindiapvtltd",
  "description": "Collection for GHz Inc",
  "tags": "version: 1.1, pre-release",
  "created_time": "2020-01-09T00:16:07Z",
  "updated_time": "2020-03-09T12:16:07Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the collection."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the collection."
}
Copy to clipboard

Update the collection name, tags and description. Collection Id cannot be updated.

PUT /collections/{collection_id}

(appConfiguration *AppConfigurationV1) UpdateCollection(updateCollectionOptions *UpdateCollectionOptions) (result *CollectionLite, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateCollectionWithContext(ctx context.Context, updateCollectionOptions *UpdateCollectionOptions) (result *CollectionLite, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.collections.update

Auditing

Calling this method generates the following auditing event.

apprapp.collections.update

Request

Instantiate the UpdateCollectionOptions struct and set the fields to provide parameter values for the UpdateCollection method.

Path Parameters

collection_id
Required*
string
Collection Id of the collection

Example: collection_id

Request Body

Required*

UpdateCollection

The request body to update a collection.

Examples:

parameter

WithContext method only

UpdateCollectionOptions

The UpdateCollection options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"name":"Web Application","description":"Collection for Web Application.","tags":"version: 1.1, pre-release"}'   "{base_url}/collections/{collection_id}"
Copy to clipboard

Example request

updateCollectionOptions := appConfigurationService.NewUpdateCollectionOptions(
  "collection_id",
)

collectionLite, response, err := appConfigurationService.UpdateCollection(updateCollectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(collectionLite, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

CollectionLite

Details of the collection.

CollectionLite

Details of the collection.

Examples:

Status Code

200
Successfully updated the collection details.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the collection id is correct.

Example responses

Status 200

{
  "name": "GHz India Pvt Ltd",
  "collection_id": "ghzindiapvtltd",
  "description": "Collection for GHz Inc",
  "tags": "version: 1.1, pre-release",
  "created_time": "2020-01-09T00:16:07Z",
  "updated_time": "2020-03-09T12:16:07Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd"
}
Copy to clipboard

Success example

{
  "name": "GHz India Pvt Ltd",
  "collection_id": "ghzindiapvtltd",
  "description": "Collection for GHz Inc",
  "tags": "version: 1.1, pre-release",
  "created_time": "2020-01-09T00:16:07Z",
  "updated_time": "2020-03-09T12:16:07Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the collection."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the collection."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the collection. The queried resource 'Collection' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the collection. The queried resource 'Collection' is not available on the server."
}
Copy to clipboard

Retrieve the details of the collection.

GET /collections/{collection_id}

(appConfiguration *AppConfigurationV1) GetCollection(getCollectionOptions *GetCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) GetCollectionWithContext(ctx context.Context, getCollectionOptions *GetCollectionOptions) (result *Collection, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.collections.list

Auditing

Calling this method generates the following auditing event.

apprapp.collections.read

Request

Instantiate the GetCollectionOptions struct and set the fields to provide parameter values for the GetCollection method.

Path Parameters

collection_id
Required*
string
Collection Id of the collection

Example: collection_id

Query Parameters

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

Example: true
include
string[]
Include feature, property, snapshots details in the response.

Allowable values: [features,properties,snapshots]
Examples:
[ "features", "properties", "snapshots" ]

parameter

WithContext method only

GetCollectionOptions

The GetCollection options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/collections/{collection_id}?expand=true&include=features,properties,snapshots"
Copy to clipboard

Example request

getCollectionOptions := appConfigurationService.NewGetCollectionOptions(
  "collection_id",
)
getCollectionOptions.SetExpand(true)
getCollectionOptions.SetInclude([]string{"features", "properties", "snapshots"})

collection, response, err := appConfigurationService.GetCollection(getCollectionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(collection, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Collection

Details of the collection.

Collection

Details of the collection.

Examples:

Status Code

200
Successfully retrieved the collection details.
404
Not Found. Verify that the collection id is correct.

Example responses

Status 200

{
  "name": "GHz India Pvt Ltd",
  "collection_id": "ghzindiapvtltd",
  "description": "Collection for GHz Inc",
  "tags": "version: 1.1, pre-release",
  "created_time": "2020-01-09T00:16:07Z",
  "updated_time": "2020-03-09T12:16:07Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd",
  "features": [
    {
      "feature_id": "cycle-rentals",
      "name": "Cycle Rentals"
    },
    {
      "feature_id": "discountRate",
      "name": "Discount Rate"
    },
    {
      "feature_id": "longDistanceLimit",
      "name": "Long Distance Limit"
    }
  ],
  "properties": [
    {
      "property_id": "bigbillionday",
      "name": "BigBillionDay"
    },
    {
      "property_id": "newyearday",
      "name": "NewYearDay"
    }
  ],
  "features_count": 3,
  "properties_count": 2
}
Copy to clipboard

Success example

{
  "name": "GHz India Pvt Ltd",
  "collection_id": "ghzindiapvtltd",
  "description": "Collection for GHz Inc",
  "tags": "version: 1.1, pre-release",
  "created_time": "2020-01-09T00:16:07Z",
  "updated_time": "2020-03-09T12:16:07Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/collections/ghzindiapvtltd",
  "features": [
    {
      "feature_id": "cycle-rentals",
      "name": "Cycle Rentals"
    },
    {
      "feature_id": "discountRate",
      "name": "Discount Rate"
    },
    {
      "feature_id": "longDistanceLimit",
      "name": "Long Distance Limit"
    }
  ],
  "properties": [
    {
      "property_id": "bigbillionday",
      "name": "BigBillionDay"
    },
    {
      "property_id": "newyearday",
      "name": "NewYearDay"
    }
  ],
  "features_count": 3,
  "properties_count": 2
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the collection. The queried resource 'Collection' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the collection. The queried resource 'Collection' is not available on the server."
}
Copy to clipboard

Delete the collection.

DELETE /collections/{collection_id}

(appConfiguration *AppConfigurationV1) DeleteCollection(deleteCollectionOptions *DeleteCollectionOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeleteCollectionWithContext(ctx context.Context, deleteCollectionOptions *DeleteCollectionOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.collections.delete

Auditing

Calling this method generates the following auditing event.

apprapp.collections.delete

Request

Instantiate the DeleteCollectionOptions struct and set the fields to provide parameter values for the DeleteCollection method.

Path Parameters

collection_id
Required*
string
Collection Id of the collection

Example: collection_id

parameter

WithContext method only

DeleteCollectionOptions

The DeleteCollection options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/collections/{collection_id}"

Example request

deleteCollectionOptions := appConfigurationService.NewDeleteCollectionOptions(
  "collection_id",
)

response, err := appConfigurationService.DeleteCollection(deleteCollectionOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteCollection(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted the specified collection.
404
Not Found. Verify that the collection id is correct.

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the collection. The queried resource 'Collection' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the collection. The queried resource 'Collection' is not available on the server."
}
Copy to clipboard

List all the feature flags in the specified environment.

GET /environments/{environment_id}/features

(appConfiguration *AppConfigurationV1) ListFeatures(listFeaturesOptions *ListFeaturesOptions) (result *FeaturesList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListFeaturesWithContext(ctx context.Context, listFeaturesOptions *ListFeaturesOptions) (result *FeaturesList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.list

Auditing

Calling this method generates the following auditing event.

apprapp.features.list

Request

Instantiate the ListFeaturesOptions struct and set the fields to provide parameter values for the ListFeatures method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Query Parameters

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

Example: true
sort
string
Sort the feature details based on the specified attribute. By default, items are sorted by name.

Allowable values: [created_time,updated_time,id,name]
Example: created_time
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.

Example: version 1.1,pre-release
collections
string[]
Filter features by a list of comma separated collections.
Examples:
[ "my-collection-id", "ghzindiapvtltd" ]
segments
string[]
Filter features by a list of comma separated segments.
Examples:
[ "my-segment-id", "beta-users" ]
include
string[]
Include the associated collections or targeting rules or change request details in the response.

Allowable values: [collections,rules,change_request]
Examples:
[ "collections", "rules", "change_request" ]
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 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

Example: test tag

parameter

WithContext method only

ListFeaturesOptions

The ListFeatures options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments/{environment_id}/features?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&search=test tag"
Copy to clipboard

Example request

listFeaturesOptions := &appconfigurationv1.ListFeaturesOptions{
  EnvironmentID: core.StringPtr("environment_id"),
  Expand: core.BoolPtr(true),
  Sort: core.StringPtr("created_time"),
  Tags: core.StringPtr("version 1.1,pre-release"),
  Collections: []string{"my-collection-id", "ghzindiapvtltd"},
  Segments: []string{"my-segment-id", "beta-users"},
  Include: []string{"collections", "rules", "change_request"},
  Limit: core.Int64Ptr(int64(10)),
  Search: core.StringPtr("test tag"),
}

pager, err := appConfigurationService.NewFeaturesPager(listFeaturesOptions)
if err != nil {
  panic(err)
}

var allResults []appconfigurationv1.Feature
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

FeaturesList

List of all features

FeaturesList

List of all features.

Examples:

Status Code

200
Successfully listed all the features.
401
Unauthorized

Example responses

Status 200

{
  "features": [
    {
      "name": "Cycle Rentals",
      "feature_id": "cycle-rentals",
      "description": "Feature flags to enable Cycle Rentals",
      "type": "BOOLEAN",
      "enabled_value": true,
      "disabled_value": false,
      "rollout_percentage": 90,
      "tags": "version: 1.1, pre-release",
      "change_request_status": "PENDING",
      "change_request_number": "CHG0030423",
      "segment_rules": [
        {
          "rules": [
            {
              "segments": [
                "betausers"
              ]
            }
          ],
          "value": 25,
          "order": 1,
          "rollout_percentage": 10
        }
      ],
      "segment_exists": true,
      "collections": [
        {
          "collection_id": "web-app-collection"
        },
        {
          "collection_id": "mobile-app-collection"
        }
      ],
      "created_time": "2020-06-09T00:16:07Z",
      "updated_time": "2020-06-09T12:16:07Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features?limit=10&offset=0"
  }
}
Copy to clipboard

Success example

{
  "features": [
    {
      "name": "Cycle Rentals",
      "feature_id": "cycle-rentals",
      "description": "Feature flags to enable Cycle Rentals",
      "type": "BOOLEAN",
      "enabled_value": true,
      "disabled_value": false,
      "rollout_percentage": 90,
      "tags": "version: 1.1, pre-release",
      "change_request_status": "PENDING",
      "change_request_number": "CHG0030423",
      "segment_rules": [
        {
          "rules": [
            {
              "segments": [
                "betausers"
              ]
            }
          ],
          "value": 25,
          "order": 1,
          "rollout_percentage": 10
        }
      ],
      "segment_exists": true,
      "collections": [
        {
          "collection_id": "web-app-collection"
        },
        {
          "collection_id": "mobile-app-collection"
        }
      ],
      "created_time": "2020-06-09T00:16:07Z",
      "updated_time": "2020-06-09T12:16:07Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features?limit=10&offset=0"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Create a feature flag

Create a feature flag.

POST /environments/{environment_id}/features

(appConfiguration *AppConfigurationV1) CreateFeature(createFeatureOptions *CreateFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreateFeatureWithContext(ctx context.Context, createFeatureOptions *CreateFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.create

Auditing

Calling this method generates the following auditing event.

apprapp.features.create

Request

Instantiate the CreateFeatureOptions struct and set the fields to provide parameter values for the CreateFeature method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Request Body

Required*

FeatureRequestBody

The request body to create a new feature.

Examples:

parameter

WithContext method only

CreateFeatureOptions

The CreateFeature options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "Cycle Rentals", "feature_id": "cycle-rentals", "description": "Feature flag to enable Cycle Rentals", "type": "BOOLEAN", "enabled_value": true, "disabled_value": false, "enabled": true, "rollout_percentage": 100, "tags": "version: 1.1, pre-release", "segment_rules": [ { "rules": [ { "segments": [ "betausers", "premiumusers" ] } ], "value": true, "order": 1, "rollout_percentage": 50 }, { "rules": [ { "segments": [ "freeusers" ] } ], "value": false, "order": 2, "rollout_percentage": 70 } ], "collections": [ { "collection_id": "ghzinc" }, { "collection_id": "phzsystems" }, { "collection_id": "ghzglobal" } ] }'   "{base_url}/environments/{environment_id}/features"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"betausers", "premiumusers"},
}

featureSegmentRuleModel := &appconfigurationv1.FeatureSegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("true"),
  Order: core.Int64Ptr(int64(1)),
  RolloutPercentage: core.Int64Ptr(int64(50)),
}

collectionRefModel := &appconfigurationv1.CollectionRef{
  CollectionID: core.StringPtr("ghzinc"),
}

createFeatureOptions := appConfigurationService.NewCreateFeatureOptions(
  "environment_id",
  "Cycle Rentals",
  "cycle-rentals",
  "BOOLEAN",
  "true",
  "false",
)
createFeatureOptions.SetDescription("Feature flag to enable Cycle Rentals")
createFeatureOptions.SetEnabled(true)
createFeatureOptions.SetRolloutPercentage(int64(100))
createFeatureOptions.SetTags("version: 1.1, pre-release")
createFeatureOptions.SetSegmentRules([]appconfigurationv1.FeatureSegmentRule{*featureSegmentRuleModel})
createFeatureOptions.SetCollections([]appconfigurationv1.CollectionRef{*collectionRefModel})

feature, response, err := appConfigurationService.CreateFeature(createFeatureOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(feature, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Feature

Details of the feature.

Feature

Details of the feature.

Examples:

Status Code

201
Successfully created the feature flag.
400
Bad request. . Verify that the information in the request body is complete and correct.
501
Not Implemented.

Example responses

Status 201: BOOLEAN

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 70
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: BOOLEAN

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 70
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 201: NUMERIC

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "NUMERIC",
  "enabled_value": 1,
  "disabled_value": 0,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1,
      "rollout_percentage": 40
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 5,
      "order": 2,
      "rollout_percentage": 70
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: NUMERIC

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "NUMERIC",
  "enabled_value": 1,
  "disabled_value": 0,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1,
      "rollout_percentage": 40
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 5,
      "order": 2,
      "rollout_percentage": 70
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 201: STRING - TEXT

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "TEXT",
  "enabled_value": "yes",
  "disabled_value": "no",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "not available",
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "available",
      "order": 2,
      "rollout_percentage": 15
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - TEXT

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "TEXT",
  "enabled_value": "yes",
  "disabled_value": "no",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "not available",
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "available",
      "order": 2,
      "rollout_percentage": 15
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 201: STRING - JSON

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "JSON",
  "enabled_value": {
    "availability": "yes"
  },
  "disabled_value": {
    "availability": "no"
  },
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 2,
      "rollout_percentage": 15
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - JSON

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "JSON",
  "enabled_value": {
    "availability": "yes"
  },
  "disabled_value": {
    "availability": "no"
  },
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 2,
      "rollout_percentage": 15
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 201: STRING - YAML

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "YAML",
  "enabled_value": "---\navailability: 'yes'",
  "disabled_value": "---\navailability: 'no'",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\navailability: 'yes'\npremium_user_ids:\n- custId1\n- custId2",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\navailability: 'no'",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - YAML

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "YAML",
  "enabled_value": "---\navailability: 'yes'",
  "disabled_value": "---\navailability: 'no'",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\navailability: 'yes'\npremium_user_ids:\n- custId1\n- custId2",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\navailability: 'no'",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the feature."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the feature."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'rollout_percentage' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'rollout_percentage' feature is not available"
}
Copy to clipboard

Update a feature flag details

Update a feature flag details.

PUT /environments/{environment_id}/features/{feature_id}

(appConfiguration *AppConfigurationV1) UpdateFeature(updateFeatureOptions *UpdateFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateFeatureWithContext(ctx context.Context, updateFeatureOptions *UpdateFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.update

Auditing

Calling this method generates the following auditing event.

apprapp.features.update

Request

Instantiate the UpdateFeatureOptions struct and set the fields to provide parameter values for the UpdateFeature method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
feature_id
Required*
string
Feature Id

Example: feature_id

Request Body

Required*

UpdateFeature

The request body to update a feature.

Examples:

parameter

WithContext method only

UpdateFeatureOptions

The UpdateFeature options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "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 }, { "rules": [ { "segments": [ "freeusers" ] } ], "value": false, "order": 2, "rollout_percentage": 90 } ], "collections": [ { "collection_id": "ghzinc" }, { "collection_id": "phzsystems" } ] }'   "{base_url}/environments/{environment_id}/features/{feature_id}"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"betausers", "premiumusers"},
}

featureSegmentRuleModel := &appconfigurationv1.FeatureSegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("true"),
  Order: core.Int64Ptr(int64(1)),
  RolloutPercentage: core.Int64Ptr(int64(90)),
}

collectionRefModel := &appconfigurationv1.CollectionRef{
  CollectionID: core.StringPtr("ghzinc"),
}

updateFeatureOptions := appConfigurationService.NewUpdateFeatureOptions(
  "environment_id",
  "feature_id",
)
updateFeatureOptions.SetName("Cycle Rentals")
updateFeatureOptions.SetDescription("Feature flags to enable Cycle Rentals")
updateFeatureOptions.SetEnabledValue("true")
updateFeatureOptions.SetDisabledValue("false")
updateFeatureOptions.SetEnabled(true)
updateFeatureOptions.SetRolloutPercentage(int64(100))
updateFeatureOptions.SetTags("version: 1.1, yet-to-release")
updateFeatureOptions.SetSegmentRules([]appconfigurationv1.FeatureSegmentRule{*featureSegmentRuleModel})
updateFeatureOptions.SetCollections([]appconfigurationv1.CollectionRef{*collectionRefModel})

feature, response, err := appConfigurationService.UpdateFeature(updateFeatureOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(feature, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Feature

Details of the feature.

Feature

Details of the feature.

Examples:

Status Code

200
Successfully updated the feature flag details
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the feature id is correct.
501
Not Implemented.

Example responses

Status 200: BOOLEAN

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 90
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 90
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: BOOLEAN

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 90
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 90
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: NUMERIC

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "NUMERIC",
  "enabled_value": 1,
  "disabled_value": 0,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1,
      "rollout_percentage": 40
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2,
      "rollout_percentage": 70
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: NUMERIC

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "NUMERIC",
  "enabled_value": 1,
  "disabled_value": 0,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1,
      "rollout_percentage": 40
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2,
      "rollout_percentage": 70
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: STRING - TEXT

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "TEXT",
  "enabled_value": "yes",
  "disabled_value": "no",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "no",
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "yes",
      "order": 2,
      "rollout_percentage": 15
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - TEXT

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "TEXT",
  "enabled_value": "yes",
  "disabled_value": "no",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "no",
      "order": 1,
      "rollout_percentage": 50
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "yes",
      "order": 2,
      "rollout_percentage": 15
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: STRING - JSON

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "JSON",
  "enabled_value": {
    "availability": "yes"
  },
  "disabled_value": {
    "availability": "no"
  },
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - JSON

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "JSON",
  "enabled_value": {
    "availability": "yes"
  },
  "disabled_value": {
    "availability": "no"
  },
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: STRING - YAML

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "YAML",
  "enabled_value": "---\navailability: 'yes'",
  "disabled_value": "---\navailability: 'no'",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\navailability: 'yes'\npremium_user_ids:\n- custId1\n- custId2",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\navailability: 'no'",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - YAML

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "YAML",
  "enabled_value": "---\navailability: 'yes'",
  "disabled_value": "---\navailability: 'no'",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\navailability: 'yes'\npremium_user_ids:\n- custId1\n- custId2",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\navailability: 'no'",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the feature."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the feature."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'rollout_percentage' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'rollout_percentage' feature is not available"
}
Copy to clipboard

Update the feature values. This method can be executed only by the writer role. This method allows the update of feature name, feature enabled_value, feature disabled_value, tags, description and feature segment rules, however this method does not allow toggling the feature flag and assigning feature to a collection.

PATCH /environments/{environment_id}/features/{feature_id}

(appConfiguration *AppConfigurationV1) UpdateFeatureValues(updateFeatureValuesOptions *UpdateFeatureValuesOptions) (result *Feature, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateFeatureValuesWithContext(ctx context.Context, updateFeatureValuesOptions *UpdateFeatureValuesOptions) (result *Feature, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.patch

Auditing

Calling this method generates the following auditing event.

apprapp.features.updatevalues

Request

Instantiate the UpdateFeatureValuesOptions struct and set the fields to provide parameter values for the UpdateFeatureValues method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
feature_id
Required*
string
Feature Id

Example: feature_id

Request Body

Required*

UpdateFeatureValues

The request body to update the feature values.

Examples:

parameter

WithContext method only

UpdateFeatureValuesOptions

The UpdateFeatureValues options.

Example request

curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "Cycle Rentals", "description": "Feature flags to enable Cycle Rentals", "enabled_value": true, "disabled_value": false, "rollout_percentage": 100, "tags": "version: 1.1, yet-to-release", "segment_rules": [ { "rules": [ { "segments": [ "betausers", "premiumusers" ] } ], "value": true, "order": 1, "rollout_percentage": 100 }, { "rules": [ { "segments": [ "freeusers" ] } ], "value": false, "order": 2, "rollout_percentage": 100 } ] }'   "{base_url}/environments/{environment_id}/features/{feature_id}"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"betausers", "premiumusers"},
}

featureSegmentRuleModel := &appconfigurationv1.FeatureSegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("true"),
  Order: core.Int64Ptr(int64(1)),
  RolloutPercentage: core.Int64Ptr(int64(100)),
}

updateFeatureValuesOptions := appConfigurationService.NewUpdateFeatureValuesOptions(
  "environment_id",
  "feature_id",
)
updateFeatureValuesOptions.SetName("Cycle Rentals")
updateFeatureValuesOptions.SetDescription("Feature flags to enable Cycle Rentals")
updateFeatureValuesOptions.SetTags("version: 1.1, yet-to-release")
updateFeatureValuesOptions.SetEnabledValue("true")
updateFeatureValuesOptions.SetDisabledValue("false")
updateFeatureValuesOptions.SetRolloutPercentage(int64(100))
updateFeatureValuesOptions.SetSegmentRules([]appconfigurationv1.FeatureSegmentRule{*featureSegmentRuleModel})

feature, response, err := appConfigurationService.UpdateFeatureValues(updateFeatureValuesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(feature, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Feature

Details of the feature.

Feature

Details of the feature.

Examples:

Status Code

200
Successfully updated the feature values.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the feature id is correct.
501
Not Implemented.

Example responses

Status 200: BOOLEAN

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: BOOLEAN

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: NUMERIC

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "NUMERIC",
  "enabled_value": 1,
  "disabled_value": 0,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: NUMERIC

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "NUMERIC",
  "enabled_value": 1,
  "disabled_value": 0,
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: STRING - TEXT

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "TEXT",
  "enabled_value": "yes",
  "disabled_value": "no",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "no",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "yes",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - TEXT

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "TEXT",
  "enabled_value": "yes",
  "disabled_value": "no",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "no",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "yes",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: STRING - JSON

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "JSON",
  "enabled_value": {
    "availability": "yes"
  },
  "disabled_value": {
    "availability": "no"
  },
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - JSON

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "JSON",
  "enabled_value": {
    "availability": "yes"
  },
  "disabled_value": {
    "availability": "no"
  },
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "availability": "no"
      },
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 200: STRING - YAML

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "YAML",
  "enabled_value": "---\navailability: 'yes'",
  "disabled_value": "---\navailability: 'no'",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\navailability: 'yes'\npremium_user_ids:\n- custId1\n- custId2",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\navailability: 'no'",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example: STRING - YAML

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "STRING",
  "format": "YAML",
  "enabled_value": "---\navailability: 'yes'",
  "disabled_value": "---\navailability: 'no'",
  "enabled": true,
  "rollout_percentage": 100,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\navailability: 'yes'\npremium_user_ids:\n- custId1\n- custId2",
      "order": 1,
      "rollout_percentage": 100
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\navailability: 'no'",
      "order": 2,
      "rollout_percentage": 100
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the feature values."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the feature values."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'rollout_percentage' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'rollout_percentage' feature is not available"
}
Copy to clipboard

Retrieve details of a feature.

GET /environments/{environment_id}/features/{feature_id}

(appConfiguration *AppConfigurationV1) GetFeature(getFeatureOptions *GetFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) GetFeatureWithContext(ctx context.Context, getFeatureOptions *GetFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.list

Auditing

Calling this method generates the following auditing event.

apprapp.features.read

Request

Instantiate the GetFeatureOptions struct and set the fields to provide parameter values for the GetFeature method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
feature_id
Required*
string
Feature Id

Example: feature_id

Query Parameters

include
string[]
Include the associated collections or targeting rules or change request details in the response.

Allowable values: [collections,rules,change_request]
Examples:
[ "collections", "rules", "change_request" ]

parameter

WithContext method only

GetFeatureOptions

The GetFeature options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments/{environment_id}/features/{feature_id}?include=collections,rules,change_request"
Copy to clipboard

Example request

getFeatureOptions := appConfigurationService.NewGetFeatureOptions(
  "environment_id",
  "feature_id",
)
getFeatureOptions.SetInclude([]string{"collections", "rules", "change_request"})

feature, response, err := appConfigurationService.GetFeature(getFeatureOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(feature, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Feature

Details of the feature.

Feature

Details of the feature.

Examples:

Status Code

200
Successfully retrieved the feature details.
404
Not Found. Verify that the feature id is correct.

Example responses

Status 200

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 90,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 70
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 20
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 90,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 70
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 20
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while retreiving the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while retreiving the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Delete a feature flag

Delete a feature flag.

DELETE /environments/{environment_id}/features/{feature_id}

(appConfiguration *AppConfigurationV1) DeleteFeature(deleteFeatureOptions *DeleteFeatureOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeleteFeatureWithContext(ctx context.Context, deleteFeatureOptions *DeleteFeatureOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.delete

Auditing

Calling this method generates the following auditing event.

apprapp.features.delete

Request

Instantiate the DeleteFeatureOptions struct and set the fields to provide parameter values for the DeleteFeature method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
feature_id
Required*
string
Feature Id

Example: feature_id

parameter

WithContext method only

DeleteFeatureOptions

The DeleteFeature options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/environments/{environment_id}/features/{feature_id}"

Example request

deleteFeatureOptions := appConfigurationService.NewDeleteFeatureOptions(
  "environment_id",
  "feature_id",
)

response, err := appConfigurationService.DeleteFeature(deleteFeatureOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteFeature(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted the specified feature.
404
Not Found. Verify that the feature id is correct.

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Toggle a feature.

PUT /environments/{environment_id}/features/{feature_id}/toggle

(appConfiguration *AppConfigurationV1) ToggleFeature(toggleFeatureOptions *ToggleFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ToggleFeatureWithContext(ctx context.Context, toggleFeatureOptions *ToggleFeatureOptions) (result *Feature, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.features.toggle

Auditing

Calling this method generates the following auditing event.

apprapp.features.toggle

Request

Instantiate the ToggleFeatureOptions struct and set the fields to provide parameter values for the ToggleFeature method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
feature_id
Required*
string
Feature Id

Example: feature_id

Request Body

Required*

ToggleFeature

The request body to toggle a feature.

Examples:

parameter

WithContext method only

ToggleFeatureOptions

The ToggleFeature options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"enabled":true}'   "{base_url}/environments/{environment_id}/features/{feature_id}/toggle"
Copy to clipboard

Example request

toggleFeatureOptions := appConfigurationService.NewToggleFeatureOptions(
  "environment_id",
  "feature_id",
  true,
)

feature, response, err := appConfigurationService.ToggleFeature(toggleFeatureOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(feature, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Feature

Details of the feature.

Feature

Details of the feature.

Examples:

Status Code

200
Successfully toggled the specified feature.
400
Bad request.
404
Not Found. Verify that the feature id is correct.

Example responses

Status 200

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 90,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 70
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 20
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Success example

{
  "name": "Cycle Rentals",
  "feature_id": "cycle-rentals",
  "description": "Feature flag to enable Cycle Rentals",
  "type": "BOOLEAN",
  "enabled_value": true,
  "disabled_value": false,
  "enabled": true,
  "rollout_percentage": 90,
  "tags": "version: 1.1, pre-release",
  "change_request_status": "PENDING",
  "change_request_number": "CHG0030423",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1,
      "rollout_percentage": 70
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2,
      "rollout_percentage": 20
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/features/cycle-rentals"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1000E",
  "message": "Error in toggle feature request."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error in toggle feature request."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while toggling the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while toggling the feature. The queried resource 'Feature' is not available on the server."
}
Copy to clipboard

List all the properties in the specified environment.

GET /environments/{environment_id}/properties

(appConfiguration *AppConfigurationV1) ListProperties(listPropertiesOptions *ListPropertiesOptions) (result *PropertiesList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListPropertiesWithContext(ctx context.Context, listPropertiesOptions *ListPropertiesOptions) (result *PropertiesList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.properties.list

Auditing

Calling this method generates the following auditing event.

apprapp.properties.list

Request

Instantiate the ListPropertiesOptions struct and set the fields to provide parameter values for the ListProperties method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Query Parameters

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

Example: true
sort
string
Sort the property details based on the specified attribute. By default, items are sorted by name.

Allowable values: [created_time,updated_time,id,name]
Example: created_time
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.

Example: version 1.1,pre-release
collections
string[]
Filter properties by a list of comma separated collections.
Examples:
[ "my-collection-id", "ghzindiapvtltd" ]
segments
string[]
Filter properties by a list of comma separated segments.
Examples:
[ "my-segment-id", "beta-users" ]
include
string[]
Include the associated collections or targeting rules details in the response.

Allowable values: [collections,rules]
Examples:
[ "collections", "rules" ]
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 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

Example: test tag

parameter

WithContext method only

ListPropertiesOptions

The ListProperties options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments/{environment_id}/properties?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&search=test tag"
Copy to clipboard

Example request

listPropertiesOptions := &appconfigurationv1.ListPropertiesOptions{
  EnvironmentID: core.StringPtr("environment_id"),
  Expand: core.BoolPtr(true),
  Sort: core.StringPtr("created_time"),
  Tags: core.StringPtr("version 1.1,pre-release"),
  Collections: []string{"my-collection-id", "ghzindiapvtltd"},
  Segments: []string{"my-segment-id", "beta-users"},
  Include: []string{"collections", "rules"},
  Limit: core.Int64Ptr(int64(10)),
  Search: core.StringPtr("test tag"),
}

pager, err := appConfigurationService.NewPropertiesPager(listPropertiesOptions)
if err != nil {
  panic(err)
}

var allResults []appconfigurationv1.Property
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

PropertiesList

List of all properties.

PropertiesList

List of all properties.

Examples:

Status Code

200
Successfully listed all the properties.
401
Unauthorized

Example responses

Status 200

{
  "properties": [
    {
      "name": "Email property",
      "property_id": "email-property",
      "description": "Property for email",
      "type": "BOOLEAN",
      "value": true,
      "tags": "version: 1.1, pre-release",
      "segment_rules": [
        {
          "rules": [
            {
              "segments": [
                "betausers",
                "premiumusers"
              ]
            }
          ],
          "value": true,
          "order": 1
        },
        {
          "rules": [
            {
              "segments": [
                "freeusers"
              ]
            }
          ],
          "value": false,
          "order": 2
        }
      ],
      "segment_exists": true,
      "collections": [
        {
          "collection_id": "ghzinc"
        },
        {
          "collection_id": "phzsystems"
        },
        {
          "collection_id": "ghzglobal"
        }
      ],
      "created_time": "2021-05-12T23:20:50.52Z",
      "updated_time": "2021-05-12T23:20:50.52Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties?limit=10&offset=0"
  }
}
Copy to clipboard

Success example

{
  "properties": [
    {
      "name": "Email property",
      "property_id": "email-property",
      "description": "Property for email",
      "type": "BOOLEAN",
      "value": true,
      "tags": "version: 1.1, pre-release",
      "segment_rules": [
        {
          "rules": [
            {
              "segments": [
                "betausers",
                "premiumusers"
              ]
            }
          ],
          "value": true,
          "order": 1
        },
        {
          "rules": [
            {
              "segments": [
                "freeusers"
              ]
            }
          ],
          "value": false,
          "order": 2
        }
      ],
      "segment_exists": true,
      "collections": [
        {
          "collection_id": "ghzinc"
        },
        {
          "collection_id": "phzsystems"
        },
        {
          "collection_id": "ghzglobal"
        }
      ],
      "created_time": "2021-05-12T23:20:50.52Z",
      "updated_time": "2021-05-12T23:20:50.52Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties?limit=10&offset=0"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Create a Property

Create a Property.

POST /environments/{environment_id}/properties

(appConfiguration *AppConfigurationV1) CreateProperty(createPropertyOptions *CreatePropertyOptions) (result *Property, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreatePropertyWithContext(ctx context.Context, createPropertyOptions *CreatePropertyOptions) (result *Property, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.properties.create

Auditing

Calling this method generates the following auditing event.

apprapp.properties.create

Request

Instantiate the CreatePropertyOptions struct and set the fields to provide parameter values for the CreateProperty method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Request Body

Required*

Property

The request body to create a new property.

Examples:

parameter

WithContext method only

CreatePropertyOptions

The CreateProperty options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "Email property", "property_id": "email-property", "description": "Property for email", "type": "BOOLEAN", "value": true, "tags": "version: 1.1, pre-release", "segment_rules": [ { "rules": [ { "segments": [ "betausers", "premiumusers" ] } ], "value": true, "order": 1 }, { "rules": [ { "segments": [ "freeusers" ] } ], "value": false, "order": 2 } ], "collections": [ { "collection_id": "ghzinc" }, { "collection_id": "phzsystems" }, { "collection_id": "ghzglobal" } ] }'   "{base_url}/environments/{environment_id}/properties"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"betausers", "premiumusers"},
}

segmentRuleModel := &appconfigurationv1.SegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("true"),
  Order: core.Int64Ptr(int64(1)),
}

collectionRefModel := &appconfigurationv1.CollectionRef{
  CollectionID: core.StringPtr("ghzinc"),
}

createPropertyOptions := appConfigurationService.NewCreatePropertyOptions(
  "environment_id",
  "Email property",
  "email-property",
  "BOOLEAN",
  "true",
)
createPropertyOptions.SetDescription("Property for email")
createPropertyOptions.SetTags("version: 1.1, pre-release")
createPropertyOptions.SetSegmentRules([]appconfigurationv1.SegmentRule{*segmentRuleModel})
createPropertyOptions.SetCollections([]appconfigurationv1.CollectionRef{*collectionRefModel})

property, response, err := appConfigurationService.CreateProperty(createPropertyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(property, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Property

Details of the property.

Property

Details of the property.

Examples:

Status Code

201
Successfully created the property.
400
Bad request. Verify that the information in the request body is complete and correct.
501
Not Implemented.

Example responses

Status 201: BOOLEAN

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: BOOLEAN

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 201: NUMERIC

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "NUMERIC",
  "value": 1,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: NUMERIC

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "NUMERIC",
  "value": 1,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 10,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 201: SECRETREF

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "SECRETREF",
  "value": {
    "secret_type": "kv",
    "id": "1312414-12341243fdsf-324dfsg-43fffg",
    "sm_instance_crn": "crn:v1:staging:public:apprapp_dev:us-south:a/7bf663503fc5e2e06b03d2ada843bf54:ssfffgr-f6ee-48a5-a11b-ade4aecfe378::"
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: SECRETREF

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "SECRETREF",
  "value": {
    "secret_type": "kv",
    "id": "1312414-12341243fdsf-324dfsg-43fffg",
    "sm_instance_crn": "crn:v1:staging:public:apprapp_dev:us-south:a/7bf663503fc5e2e06b03d2ada843bf54:ssfffgr-f6ee-48a5-a11b-ade4aecfe378::"
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 201: STRING - TEXT

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "TEXT",
  "value": "success",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "failed",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "success",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - TEXT

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "TEXT",
  "value": "success",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "failed",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "success",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 201: STRING - JSON

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "JSON",
  "value": {
    "name": "email configuration",
    "id": "email-config-1",
    "description": "This email configuration for internal use",
    "value": {
      "Name": "ABC Inc",
      "Location": "India"
    },
    "tags": "internal",
    "employees_id": [
      "empId1",
      "empId2",
      "empId3",
      "empId4",
      "empId5"
    ]
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId100"
        ]
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId11",
          "empId22",
          "empId33",
          "empId44",
          "empId55"
        ]
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - JSON

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "JSON",
  "value": {
    "name": "email configuration",
    "id": "email-config-1",
    "description": "This email configuration for internal use",
    "value": {
      "Name": "ABC Inc",
      "Location": "India"
    },
    "tags": "internal",
    "employees_id": [
      "empId1",
      "empId2",
      "empId3",
      "empId4",
      "empId5"
    ]
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId100"
        ]
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId11",
          "empId22",
          "empId33",
          "empId44",
          "empId55"
        ]
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 201: STRING - YAML

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "YAML",
  "value": "---\nname: email configuration\nid: email-config-1\ndescription: This email configuration for internal use\nvalue:\n Name: ABC Inc\n Location: India\ntags: internal\nemployees_id:\n- empId1\n- empId2\n- empId3\n- empId4\n- empId5",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId100",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId11\n- empId22\n- empId33\n- empId44\n- empId55",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - YAML

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "YAML",
  "value": "---\nname: email configuration\nid: email-config-1\ndescription: This email configuration for internal use\nvalue:\n Name: ABC Inc\n Location: India\ntags: internal\nemployees_id:\n- empId1\n- empId2\n- empId3\n- empId4\n- empId5",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId100",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId11\n- empId22\n- empId33\n- empId44\n- empId55",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the property."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the property."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Update a Property.

PUT /environments/{environment_id}/properties/{property_id}

(appConfiguration *AppConfigurationV1) UpdateProperty(updatePropertyOptions *UpdatePropertyOptions) (result *Property, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdatePropertyWithContext(ctx context.Context, updatePropertyOptions *UpdatePropertyOptions) (result *Property, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.properties.update

Auditing

Calling this method generates the following auditing event.

apprapp.properties.update

Request

Instantiate the UpdatePropertyOptions struct and set the fields to provide parameter values for the UpdateProperty method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
property_id
Required*
string
Property Id

Example: property_id

Request Body

Required*

UpdateProperty

The request body to update a property.

Examples:

parameter

WithContext method only

UpdatePropertyOptions

The UpdateProperty options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "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 }, { "rules": [ { "segments": [ "freeusers" ] } ], "value": false, "order": 2 } ], "collections": [ { "collection_id": "ghzinc" }, { "collection_id": "phzsystems" }, { "collection_id": "ghzglobal" } ] }'   "{base_url}/environments/{environment_id}/properties/{property_id}"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"betausers", "premiumusers"},
}

segmentRuleModel := &appconfigurationv1.SegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("true"),
  Order: core.Int64Ptr(int64(1)),
}

collectionRefModel := &appconfigurationv1.CollectionRef{
  CollectionID: core.StringPtr("ghzinc"),
}

updatePropertyOptions := appConfigurationService.NewUpdatePropertyOptions(
  "environment_id",
  "property_id",
)
updatePropertyOptions.SetName("Email property")
updatePropertyOptions.SetDescription("Property for email")
updatePropertyOptions.SetValue("true")
updatePropertyOptions.SetTags("version: 1.1, pre-release")
updatePropertyOptions.SetSegmentRules([]appconfigurationv1.SegmentRule{*segmentRuleModel})
updatePropertyOptions.SetCollections([]appconfigurationv1.CollectionRef{*collectionRefModel})

property, response, err := appConfigurationService.UpdateProperty(updatePropertyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(property, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Property

Details of the property.

Property

Details of the property.

Examples:

Status Code

200
Successfully updated the property details.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the property id is correct.
501
Not Implemented.

Example responses

Status 200: BOOLEAN

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: BOOLEAN

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: NUMERIC

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "NUMERIC",
  "value": 10,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 100,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: NUMERIC

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "NUMERIC",
  "value": 10,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 100,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: SECRETREF

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "SECRETREF",
  "value": {
    "secret_type": "kv",
    "id": "1312414-12341243fdsf-324dfsg-43fffg",
    "sm_instance_crn": "crn:v1:staging:public:apprapp_dev:us-south:a/7bf663503fc5e2e06b03d2ada843bf54:ssfffgr-f6ee-48a5-a11b-ade4aecfe378::"
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: SECRETREF

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "SECRETREF",
  "value": {
    "secret_type": "kv",
    "id": "1312414-12341243fdsf-324dfsg-43fffg",
    "sm_instance_crn": "crn:v1:staging:public:apprapp_dev:us-south:a/7bf663503fc5e2e06b03d2ada843bf54:ssfffgr-f6ee-48a5-a11b-ade4aecfe378::"
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: STRING - TEXT

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "TEXT",
  "value": "success",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "fail",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "success",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - TEXT

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "TEXT",
  "value": "success",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "fail",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "success",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: STRING - JSON

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "JSON",
  "value": {
    "activate": "yes",
    "employees_id": [
      "empId1",
      "empId2",
      "empId3",
      "empId4",
      "empId5"
    ]
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "activate": "no"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId100"
        ]
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - JSON

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "JSON",
  "value": {
    "activate": "yes",
    "employees_id": [
      "empId1",
      "empId2",
      "empId3",
      "empId4",
      "empId5"
    ]
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "activate": "no"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId100"
        ]
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: STRING - YAML

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "YAML",
  "value": "activate: 'yes'\nemployees_id:\n- empId1\n- empId2\n- empId3\n- empId4\n- empId5",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\nactivate: 'no'",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId100",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - YAML

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "YAML",
  "value": "activate: 'yes'\nemployees_id:\n- empId1\n- empId2\n- empId3\n- empId4\n- empId5",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\nactivate: 'no'",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId100",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the property."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the property."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the property. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the property. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Update the property values. This method can be executed by the writer role. Property value and targeting rules can be updated, however this method does not allow assigning property to a collection.

PATCH /environments/{environment_id}/properties/{property_id}

(appConfiguration *AppConfigurationV1) UpdatePropertyValues(updatePropertyValuesOptions *UpdatePropertyValuesOptions) (result *Property, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdatePropertyValuesWithContext(ctx context.Context, updatePropertyValuesOptions *UpdatePropertyValuesOptions) (result *Property, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.properties.patch

Auditing

Calling this method generates the following auditing event.

apprapp.properties.updatevalues

Request

Instantiate the UpdatePropertyValuesOptions struct and set the fields to provide parameter values for the UpdatePropertyValues method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
property_id
Required*
string
Property Id

Example: property_id

Request Body

Required*

UpdatePropertyValues

The request body update the property values.

Examples:

parameter

WithContext method only

UpdatePropertyValuesOptions

The UpdatePropertyValues options.

Example request

curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "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 }, { "rules": [ { "segments": [ "freeusers" ] } ], "value": false, "order": 2 } ] }'   "{base_url}/environments/{environment_id}/properties/{property_id}"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"betausers", "premiumusers"},
}

segmentRuleModel := &appconfigurationv1.SegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("true"),
  Order: core.Int64Ptr(int64(1)),
}

updatePropertyValuesOptions := appConfigurationService.NewUpdatePropertyValuesOptions(
  "environment_id",
  "property_id",
)
updatePropertyValuesOptions.SetName("Email property")
updatePropertyValuesOptions.SetDescription("Property for email")
updatePropertyValuesOptions.SetTags("version: 1.1, pre-release")
updatePropertyValuesOptions.SetValue("true")
updatePropertyValuesOptions.SetSegmentRules([]appconfigurationv1.SegmentRule{*segmentRuleModel})

property, response, err := appConfigurationService.UpdatePropertyValues(updatePropertyValuesOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(property, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Property

Details of the property.

Property

Details of the property.

Examples:

Status Code

200
Successfully updated the property values.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the property id is correct.
501
Not Implemented.

Example responses

Status 200: BOOLEAN

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: BOOLEAN

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: NUMERIC

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "NUMERIC",
  "value": 10,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 100,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: NUMERIC

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "NUMERIC",
  "value": 10,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": 100,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": 0,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: SECRETREF

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "SECRETREF",
  "value": {
    "secret_type": "kv",
    "id": "1312414-12341243fdsf-324dfsg-43fffg",
    "sm_instance_crn": "crn:v1:staging:public:apprapp_dev:us-south:a/7bf663503fc5e2e06b03d2ada843bf54:ssfffgr-f6ee-48a5-a11b-ade4aecfe378::"
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: SECRETREF

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "SECRETREF",
  "value": {
    "secret_type": "kv",
    "id": "1312414-12341243fdsf-324dfsg-43fffg",
    "sm_instance_crn": "crn:v1:staging:public:apprapp_dev:us-south:a/7bf663503fc5e2e06b03d2ada843bf54:ssfffgr-f6ee-48a5-a11b-ade4aecfe378::"
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "id": "2234566-334g566ghjj-222-4000123fg"
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: STRING - TEXT

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "TEXT",
  "value": "success",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "fail",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "success",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - TEXT

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "TEXT",
  "value": "success",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "fail",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "success",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: STRING - JSON

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "JSON",
  "value": {
    "activate": "yes",
    "employees_id": [
      "empId1",
      "empId2",
      "empId3",
      "empId4",
      "empId5"
    ]
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "activate": "no"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId100"
        ]
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - JSON

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "JSON",
  "value": {
    "activate": "yes",
    "employees_id": [
      "empId1",
      "empId2",
      "empId3",
      "empId4",
      "empId5"
    ]
  },
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": {
        "activate": "no"
      },
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": {
        "employees_id": [
          "empId100"
        ]
      },
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 200: STRING - YAML

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "YAML",
  "value": "activate: 'yes'\nemployees_id:\n- empId1\n- empId2\n- empId3\n- empId4\n- empId5",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\nactivate: 'no'",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId100",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example: STRING - YAML

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "STRING",
  "format": "YAML",
  "value": "activate: 'yes'\nemployees_id:\n- empId1\n- empId2\n- empId3\n- empId4\n- empId5",
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": "---\nactivate: 'no'",
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": "---\nemployees_id:\n- empId100",
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc",
      "name": "GHz Inc"
    },
    {
      "collection_id": "phzsystems",
      "name": "PHz Systems"
    },
    {
      "collection_id": "ghzglobal",
      "name": "GHz Global"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the property values."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the property values."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the property values. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the property values. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Retrieve details of a property.

GET /environments/{environment_id}/properties/{property_id}

(appConfiguration *AppConfigurationV1) GetProperty(getPropertyOptions *GetPropertyOptions) (result *Property, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) GetPropertyWithContext(ctx context.Context, getPropertyOptions *GetPropertyOptions) (result *Property, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.properties.list

Auditing

Calling this method generates the following auditing event.

apprapp.properties.read

Request

Instantiate the GetPropertyOptions struct and set the fields to provide parameter values for the GetProperty method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
property_id
Required*
string
Property Id

Example: property_id

Query Parameters

include
string[]
Include the associated collections or targeting rules details in the response.

Allowable values: [collections,rules]
Examples:
[ "collections", "rules" ]

parameter

WithContext method only

GetPropertyOptions

The GetProperty options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments/{environment_id}/properties/{property_id}?include=collections,rules"
Copy to clipboard

Example request

getPropertyOptions := appConfigurationService.NewGetPropertyOptions(
  "environment_id",
  "property_id",
)
getPropertyOptions.SetInclude([]string{"collections", "rules"})

property, response, err := appConfigurationService.GetProperty(getPropertyOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(property, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Property

Details of the property.

Property

Details of the property.

Examples:

Status Code

200
Successfully retrieved the property details.
404
Not Found. Verify that the property id is correct.
501
Not Implemented.

Example responses

Status 200

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc"
    },
    {
      "collection_id": "phzsystems"
    },
    {
      "collection_id": "ghzglobal"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Success example

{
  "name": "Email property",
  "property_id": "email-property",
  "description": "Property for email",
  "type": "BOOLEAN",
  "value": true,
  "tags": "version: 1.1, pre-release",
  "segment_rules": [
    {
      "rules": [
        {
          "segments": [
            "betausers",
            "premiumusers"
          ]
        }
      ],
      "value": true,
      "order": 1
    },
    {
      "rules": [
        {
          "segments": [
            "freeusers"
          ]
        }
      ],
      "value": false,
      "order": 2
    }
  ],
  "segment_exists": true,
  "collections": [
    {
      "collection_id": "ghzinc"
    },
    {
      "collection_id": "phzsystems"
    },
    {
      "collection_id": "ghzglobal"
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/environments/dev/properties/email-property"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the property. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the property. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Delete a Property

Delete a Property.

DELETE /environments/{environment_id}/properties/{property_id}

(appConfiguration *AppConfigurationV1) DeleteProperty(deletePropertyOptions *DeletePropertyOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeletePropertyWithContext(ctx context.Context, deletePropertyOptions *DeletePropertyOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.properties.delete

Auditing

Calling this method generates the following auditing event.

apprapp.properties.delete

Request

Instantiate the DeletePropertyOptions struct and set the fields to provide parameter values for the DeleteProperty method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id
property_id
Required*
string
Property Id

Example: property_id

parameter

WithContext method only

DeletePropertyOptions

The DeleteProperty options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/environments/{environment_id}/properties/{property_id}"

Example request

deletePropertyOptions := appConfigurationService.NewDeletePropertyOptions(
  "environment_id",
  "property_id",
)

response, err := appConfigurationService.DeleteProperty(deletePropertyOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteProperty(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted the specified property
404
Not Found. Verify that the property id is correct.
501
Not Implemented.

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the property. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the property. The queried resource 'Property' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'secret manager integration' feature is not available"
}
Copy to clipboard

List all the segments

List all the segments.

GET /segments

(appConfiguration *AppConfigurationV1) ListSegments(listSegmentsOptions *ListSegmentsOptions) (result *SegmentsList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListSegmentsWithContext(ctx context.Context, listSegmentsOptions *ListSegmentsOptions) (result *SegmentsList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.segments.list

Auditing

Calling this method generates the following auditing event.

apprapp.segments.list

Request

Instantiate the ListSegmentsOptions struct and set the fields to provide parameter values for the ListSegments method.

Query Parameters

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

Example: true
sort
string
Sort the segment details based on the specified attribute. By default, items are sorted by name.

Allowable values: [created_time,updated_time,id,name]
Example: created_time
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.

Example: version 1.1,pre-release
include
string
Segment details to include the associated rules in the response.

Allowable values: [rules]
Example: rules
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 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

Example: test tag

parameter

WithContext method only

ListSegmentsOptions

The ListSegments options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/segments?expand=true&sort=created_time&tags=version 1.1,pre-release&include=rules&search=test tag"
Copy to clipboard

Example request

listSegmentsOptions := &appconfigurationv1.ListSegmentsOptions{
  Expand: core.BoolPtr(true),
  Sort: core.StringPtr("created_time"),
  Tags: core.StringPtr("version 1.1,pre-release"),
  Include: core.StringPtr("rules"),
  Limit: core.Int64Ptr(int64(10)),
  Search: core.StringPtr("test tag"),
}

pager, err := appConfigurationService.NewSegmentsPager(listSegmentsOptions)
if err != nil {
  panic(err)
}

var allResults []appconfigurationv1.Segment
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

SegmentsList

List of all segments.

SegmentsList

List of all segments.

Examples:

Status Code

200
Successfully listed all the segments.
401
Unauthorized

Example responses

Status 200

{
  "segments": [
    {
      "name": "Beta Users",
      "segment_id": "beta-users",
      "description": "Segment containing the beta users",
      "tags": "preprod, users, ghz",
      "created_time": "2020-06-09T00:16:07Z",
      "updated_time": "2020-06-09T12:16:07Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users",
      "rules": [
        {
          "attribute_name": "email",
          "operator": "endsWith",
          "values": [
            "@in.mnc.com",
            "@us.mnc.com"
          ]
        },
        {
          "attribute_name": "country",
          "operator": "is",
          "values": [
            "India",
            "USA"
          ]
        }
      ]
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments?limit=10&offset=0"
  }
}
Copy to clipboard

Success example

{
  "segments": [
    {
      "name": "Beta Users",
      "segment_id": "beta-users",
      "description": "Segment containing the beta users",
      "tags": "preprod, users, ghz",
      "created_time": "2020-06-09T00:16:07Z",
      "updated_time": "2020-06-09T12:16:07Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users",
      "rules": [
        {
          "attribute_name": "email",
          "operator": "endsWith",
          "values": [
            "@in.mnc.com",
            "@us.mnc.com"
          ]
        },
        {
          "attribute_name": "country",
          "operator": "is",
          "values": [
            "India",
            "USA"
          ]
        }
      ]
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments?limit=10&offset=0"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Create a segment.

POST /segments

(appConfiguration *AppConfigurationV1) CreateSegment(createSegmentOptions *CreateSegmentOptions) (result *Segment, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreateSegmentWithContext(ctx context.Context, createSegmentOptions *CreateSegmentOptions) (result *Segment, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.segments.create

Auditing

Calling this method generates the following auditing event.

apprapp.segments.create

Request

Instantiate the CreateSegmentOptions struct and set the fields to provide parameter values for the CreateSegment method.

Request Body

Required*

Segment

The request body to create a new segment.

Examples:

parameter

WithContext method only

CreateSegmentOptions

The CreateSegment options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "name": "Beta Users", "segment_id": "beta-users", "description": "Segment containing the beta users", "tags": "version: 1.1, stage", "rules": [ { "attribute_name": "email", "operator": "endsWith", "values": [ "@in.mnc.com", "@us.mnc.com" ] }, { "attribute_name": "country", "operator": "is", "values": [ "India", "USA" ] } ] }'   "{base_url}/segments"
Copy to clipboard

Example request

ruleModel := &appconfigurationv1.Rule{
  AttributeName: core.StringPtr("email"),
  Operator: core.StringPtr("endsWith"),
  Values: []string{"@in.mnc.com", "@us.mnc.com"},
}

createSegmentOptions := appConfigurationService.NewCreateSegmentOptions(
  "Beta Users",
  "beta-users",
  []appconfigurationv1.Rule{*ruleModel},
)
createSegmentOptions.SetDescription("Segment containing the beta users")
createSegmentOptions.SetTags("version: 1.1, stage")

segment, response, err := appConfigurationService.CreateSegment(createSegmentOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(segment, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Segment

Details of the segment.

Segment

Details of the segment.

Examples:

Status Code

201
Successfully created the segment
400
Bad request. Verify that the information in the request body is complete and correct.

Example responses

Status 201

{
  "name": "Beta Users",
  "segment_id": "beta-users",
  "description": "Segment containing the beta users",
  "tags": "version: 1.1, stage",
  "rules": [
    {
      "attribute_name": "email",
      "operator": "endsWith",
      "values": [
        "@in.mnc.com",
        "@us.mnc.com"
      ]
    },
    {
      "attribute_name": "country",
      "operator": "is",
      "values": [
        "India",
        "USA"
      ]
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users"
}
Copy to clipboard

Success example

{
  "name": "Beta Users",
  "segment_id": "beta-users",
  "description": "Segment containing the beta users",
  "tags": "version: 1.1, stage",
  "rules": [
    {
      "attribute_name": "email",
      "operator": "endsWith",
      "values": [
        "@in.mnc.com",
        "@us.mnc.com"
      ]
    },
    {
      "attribute_name": "country",
      "operator": "is",
      "values": [
        "India",
        "USA"
      ]
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the segment."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the segment."
}
Copy to clipboard

Update the segment properties

Update the segment properties.

PUT /segments/{segment_id}

(appConfiguration *AppConfigurationV1) UpdateSegment(updateSegmentOptions *UpdateSegmentOptions) (result *Segment, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateSegmentWithContext(ctx context.Context, updateSegmentOptions *UpdateSegmentOptions) (result *Segment, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.segments.update

Auditing

Calling this method generates the following auditing event.

apprapp.segments.update

Request

Instantiate the UpdateSegmentOptions struct and set the fields to provide parameter values for the UpdateSegment method.

Path Parameters

segment_id
Required*
string
Segment Id

Example: segment_id

Request Body

Required*

UpdateSegment

The request body to update a segment.

Examples:

parameter

WithContext method only

UpdateSegmentOptions

The UpdateSegment options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"name":"Beta Users","description":"Segment containing the beta users","tags":"version: 1.1, pre-release","rules":[{"attribute_name":"email","operator":"endsWith","values":["@in.mnc.com","@us.mnc.com"]},{"attribute_name":"country","operator":"is","values":["India","USA"]}]}'   "{base_url}/segments/{segment_id}"
Copy to clipboard

Example request

updateSegmentOptions := appConfigurationService.NewUpdateSegmentOptions(
  "segment_id",
)

segment, response, err := appConfigurationService.UpdateSegment(updateSegmentOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(segment, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Segment

Details of the segment.

Segment

Details of the segment.

Examples:

Status Code

200
Successfully updated the segment details.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the segment id is correct.

Example responses

Status 200

{
  "name": "Beta Users",
  "segment_id": "beta-users",
  "description": "Segment containing the beta users",
  "tags": "version: 1.1, stage",
  "rules": [
    {
      "attribute_name": "email",
      "operator": "endsWith",
      "values": [
        "@in.mnc.com",
        "@us.mnc.com"
      ]
    },
    {
      "attribute_name": "country",
      "operator": "is",
      "values": [
        "India",
        "USA"
      ]
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users"
}
Copy to clipboard

Success example

{
  "name": "Beta Users",
  "segment_id": "beta-users",
  "description": "Segment containing the beta users",
  "tags": "version: 1.1, stage",
  "rules": [
    {
      "attribute_name": "email",
      "operator": "endsWith",
      "values": [
        "@in.mnc.com",
        "@us.mnc.com"
      ]
    },
    {
      "attribute_name": "country",
      "operator": "is",
      "values": [
        "India",
        "USA"
      ]
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the segment."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the segment."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the segment. The queried resource 'Segment' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the segment. The queried resource 'Segment' is not available on the server."
}
Copy to clipboard

Retrieve details of a segment

Retrieve details of a segment.

GET /segments/{segment_id}

(appConfiguration *AppConfigurationV1) GetSegment(getSegmentOptions *GetSegmentOptions) (result *Segment, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) GetSegmentWithContext(ctx context.Context, getSegmentOptions *GetSegmentOptions) (result *Segment, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.segments.list

Auditing

Calling this method generates the following auditing event.

apprapp.segments.read

Request

Instantiate the GetSegmentOptions struct and set the fields to provide parameter values for the GetSegment method.

Path Parameters

segment_id
Required*
string
Segment Id

Example: segment_id

Query Parameters

include
string[]
Include feature and property details in the response.

Allowable values: [features,properties]
Examples:
[ "features", "properties" ]

parameter

WithContext method only

GetSegmentOptions

The GetSegment options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/segments/{segment_id}?include=features,properties"
Copy to clipboard

Example request

getSegmentOptions := appConfigurationService.NewGetSegmentOptions(
  "segment_id",
)
getSegmentOptions.SetInclude([]string{"features", "properties"})

segment, response, err := appConfigurationService.GetSegment(getSegmentOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(segment, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

Segment

Details of the segment.

Segment

Details of the segment.

Examples:

Status Code

200
Successfully retrieved the segment details.
404
Not Found. Verify that the segment id is correct.

Example responses

Status 200

{
  "name": "Beta Users",
  "segment_id": "beta-users",
  "description": "Segment containing the beta users",
  "tags": "version: 1.1, stage",
  "rules": [
    {
      "attribute_name": "email",
      "operator": "endsWith",
      "values": [
        "@in.mnc.com",
        "@us.mnc.com"
      ]
    },
    {
      "attribute_name": "country",
      "operator": "is",
      "values": [
        "India",
        "USA"
      ]
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users"
}
Copy to clipboard

Success example

{
  "name": "Beta Users",
  "segment_id": "beta-users",
  "description": "Segment containing the beta users",
  "tags": "version: 1.1, stage",
  "rules": [
    {
      "attribute_name": "email",
      "operator": "endsWith",
      "values": [
        "@in.mnc.com",
        "@us.mnc.com"
      ]
    },
    {
      "attribute_name": "country",
      "operator": "is",
      "values": [
        "India",
        "USA"
      ]
    }
  ],
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/segments/beta-users"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the segment. The queried resource 'Segment' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the segment. The queried resource 'Segment' is not available on the server."
}
Copy to clipboard

Delete a segment

Delete a segment.

DELETE /segments/{segment_id}

(appConfiguration *AppConfigurationV1) DeleteSegment(deleteSegmentOptions *DeleteSegmentOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeleteSegmentWithContext(ctx context.Context, deleteSegmentOptions *DeleteSegmentOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.segments.delete

Auditing

Calling this method generates the following auditing event.

apprapp.segments.delete

Request

Instantiate the DeleteSegmentOptions struct and set the fields to provide parameter values for the DeleteSegment method.

Path Parameters

segment_id
Required*
string
Segment Id

Example: segment_id

parameter

WithContext method only

DeleteSegmentOptions

The DeleteSegment options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/segments/{segment_id}"

Example request

deleteSegmentOptions := appConfigurationService.NewDeleteSegmentOptions(
  "segment_id",
)

response, err := appConfigurationService.DeleteSegment(deleteSegmentOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteSegment(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted the specified segment.
404
Not Found. Verify that the segment id is correct.

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the segment. The queried resource 'Segment' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the segment. The queried resource 'Segment' is not available on the server."
}
Copy to clipboard

List all the Git configs

List all the Git configs.

GET /gitconfigs

(appConfiguration *AppConfigurationV1) ListSnapshots(listSnapshotsOptions *ListSnapshotsOptions) (result *GitConfigList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListSnapshotsWithContext(ctx context.Context, listSnapshotsOptions *ListSnapshotsOptions) (result *GitConfigList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.view

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.list

Request

Instantiate the ListSnapshotsOptions struct and set the fields to provide parameter values for the ListSnapshots method.

Query Parameters

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

Allowable values: [created_time,updated_time,id,name]
Example: created_time
collection_id
string
Filters the response based on the specified collection_id.

Example: collection_id
environment_id
string
Filters the response based on the specified environment_id.

Example: environment_id
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 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

Example: search_string

parameter

WithContext method only

ListSnapshotsOptions

The ListSnapshots options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/gitconfigs?sort=created_time&collection_id=collection_id&environment_id=environment_id&search=search_string"
Copy to clipboard

Example request

listSnapshotsOptions := &appconfigurationv1.ListSnapshotsOptions{
  Sort: core.StringPtr("created_time"),
  CollectionID: core.StringPtr("collection_id"),
  EnvironmentID: core.StringPtr("environment_id"),
  Limit: core.Int64Ptr(int64(10)),
  Search: core.StringPtr("search_string"),
}

pager, err := appConfigurationService.NewSnapshotsPager(listSnapshotsOptions)
if err != nil {
  panic(err)
}

var allResults []appconfigurationv1.GitConfig
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

GitConfigList

List of all Git Configs.

GitConfigList

List of all Git Configs.

Examples:

Status Code

200
Successfully listed all the git configurations.
401
Unauthorized
501
Not Implemented.

Example responses

Status 200

{
  "git_config": [
    {
      "git_config_name": "boot-strap-configuration",
      "git_config_id": "boot-strap-configuration",
      "collection": {
        "name": "Web Application",
        "collection_id": "web-app-collection"
      },
      "environment": {
        "name": "Dev",
        "environment_id": "dev",
        "color_code": "#FDD13A"
      },
      "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
      "git_branch": "main",
      "git_file_path": "code/development/README.json",
      "last_sync_time": "2022-05-27T23:20:50.52Z",
      "created_time": "2021-05-12T23:20:50.52Z",
      "updated_time": "2021-05-12T23:20:50.52Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs?limit=10&offset=0"
  }
}
Copy to clipboard

Success example

{
  "git_config": [
    {
      "git_config_name": "boot-strap-configuration",
      "git_config_id": "boot-strap-configuration",
      "collection": {
        "name": "Web Application",
        "collection_id": "web-app-collection"
      },
      "environment": {
        "name": "Dev",
        "environment_id": "dev",
        "color_code": "#FDD13A"
      },
      "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
      "git_branch": "main",
      "git_file_path": "code/development/README.json",
      "last_sync_time": "2022-05-27T23:20:50.52Z",
      "created_time": "2021-05-12T23:20:50.52Z",
      "updated_time": "2021-05-12T23:20:50.52Z",
      "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
    }
  ],
  "limit": 10,
  "offset": 0,
  "total_count": 1,
  "first": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs?limit=10&offset=0"
  },
  "last": {
    "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs?limit=10&offset=0"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Create a Git config.

POST /gitconfigs

(appConfiguration *AppConfigurationV1) CreateGitconfig(createGitconfigOptions *CreateGitconfigOptions) (result *CreateGitConfigResponse, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreateGitconfigWithContext(ctx context.Context, createGitconfigOptions *CreateGitconfigOptions) (result *CreateGitConfigResponse, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.create

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.create

Request

Instantiate the CreateGitconfigOptions struct and set the fields to provide parameter values for the CreateGitconfig method.

Request Body

Required*

CreateGitConfig

The request body to create a new Git config.

Examples:

parameter

WithContext method only

CreateGitconfigOptions

The CreateGitconfig options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "git_config_name": "boot-strap-configuration", "git_config_id": "boot-strap-configuration", "collection_id": "web-app-collection", "environment_id": "dev", "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo", "git_branch": "main", "git_file_path": "code/development/README.json", "git_token": "61a792eahhGHji223jijb55a6cfdd4d5cde4c8a67esjjhjhHVH" }'   "{base_url}/gitconfigs"
Copy to clipboard

Example request

createGitconfigOptions := appConfigurationService.NewCreateGitconfigOptions(
  "boot-strap-configuration",
  "boot-strap-configuration",
  "web-app-collection",
  "dev",
  "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "main",
  "code/development/README.json",
  "61a792eahhGHji223jijb55a6cfdd4d5cde4c8a67esjjhjhHVH",
)

createGitConfigResponse, response, err := appConfigurationService.CreateGitconfig(createGitconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(createGitConfigResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

CreateGitConfigResponse

Details of the created Git config.

CreateGitConfigResponse

Details of the created Git config.

Examples:

Status Code

201
Successfully created the gitconfig
400
Bad request. Verify that the information in the request body is complete and correct.
501
Not Implemented.

Example responses

Status 201

{
  "git_config_name": "boot-strap-configuration",
  "git_config_id": "boot-strap-configuration",
  "collection_id": "web-app-collection",
  "environment_id": "dev",
  "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "git_branch": "main",
  "git_file_path": "code/development/README.json",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
}
Copy to clipboard

Success example

{
  "git_config_name": "boot-strap-configuration",
  "git_config_id": "boot-strap-configuration",
  "collection_id": "web-app-collection",
  "environment_id": "dev",
  "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "git_branch": "main",
  "git_file_path": "code/development/README.json",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the gitconfig."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the gitconfig."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Update the gitconfig properties

Update the gitconfig properties.

PUT /gitconfigs/{git_config_id}

(appConfiguration *AppConfigurationV1) UpdateGitconfig(updateGitconfigOptions *UpdateGitconfigOptions) (result *GitConfig, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateGitconfigWithContext(ctx context.Context, updateGitconfigOptions *UpdateGitconfigOptions) (result *GitConfig, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.update

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.update

Request

Instantiate the UpdateGitconfigOptions struct and set the fields to provide parameter values for the UpdateGitconfig method.

Path Parameters

git_config_id
Required*
string
Git Config Id

Example: git_config_id

Request Body

Required*

UpdateGitConfig

The request body to update a Git config.

Examples:

parameter

WithContext method only

UpdateGitconfigOptions

The UpdateGitconfig options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"git_config_name":"updated git config name","collection_id":"web-app-collection","environment_id":"dev","git_url":"https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo","git_branch":"newbranch","git_file_path":"code/development/README.json","git_token":"61a792eahhGHji223jijb55a6cfdd4d5cde4c8a67esjjhjhHVH"}'   "{base_url}/gitconfigs/{git_config_id}"
Copy to clipboard

Example request

updateGitconfigOptions := appConfigurationService.NewUpdateGitconfigOptions(
  "git_config_id",
)

gitConfig, response, err := appConfigurationService.UpdateGitconfig(updateGitconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(gitConfig, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

GitConfig

Details of the Git Config.

GitConfig

Details of the Git Config.

Examples:

Status Code

200
Successfully updated the gitconfig details.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the git config id is correct.
501
Not Implemented.

Example responses

Status 200

{
  "git_config_name": "boot-strap-configuration",
  "git_config_id": "boot-strap-configuration",
  "collection": {
    "name": "Web Application",
    "collection_id": "web-app-collection"
  },
  "environment": {
    "name": "Dev",
    "environment_id": "dev",
    "color_code": "#FDD13A"
  },
  "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "git_branch": "main",
  "git_file_path": "code/development/README.json",
  "last_sync_time": "2022-05-27T23:20:50.52Z",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
}
Copy to clipboard

Success example

{
  "git_config_name": "boot-strap-configuration",
  "git_config_id": "boot-strap-configuration",
  "collection": {
    "name": "Web Application",
    "collection_id": "web-app-collection"
  },
  "environment": {
    "name": "Dev",
    "environment_id": "dev",
    "color_code": "#FDD13A"
  },
  "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "git_branch": "main",
  "git_file_path": "code/development/README.json",
  "last_sync_time": "2022-05-27T23:20:50.52Z",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while updating the gitconfig."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while updating the gitconfig."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the gitconfig. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the gitconfig. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Retrieve details of a gitconfig

Retrieve details of a gitconfig.

GET /gitconfigs/{git_config_id}

(appConfiguration *AppConfigurationV1) GetGitconfig(getGitconfigOptions *GetGitconfigOptions) (result *GitConfig, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) GetGitconfigWithContext(ctx context.Context, getGitconfigOptions *GetGitconfigOptions) (result *GitConfig, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.view

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.read

Request

Instantiate the GetGitconfigOptions struct and set the fields to provide parameter values for the GetGitconfig method.

Path Parameters

git_config_id
Required*
string
Git Config Id

Example: git_config_id

parameter

WithContext method only

GetGitconfigOptions

The GetGitconfig options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/gitconfigs/{git_config_id}"
Copy to clipboard

Example request

getGitconfigOptions := appConfigurationService.NewGetGitconfigOptions(
  "git_config_id",
)

gitConfig, response, err := appConfigurationService.GetGitconfig(getGitconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(gitConfig, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

GitConfig

Details of the Git Config.

GitConfig

Details of the Git Config.

Examples:

Status Code

200
Successfully retrieved the gitconfig details.
404
Not Found. Verify that the gitconfig id is correct.
501
Not Implemented.

Example responses

Status 200

{
  "git_config_name": "boot-strap-configuration",
  "git_config_id": "boot-strap-configuration",
  "collection": {
    "name": "Web Application",
    "collection_id": "web-app-collection"
  },
  "environment": {
    "name": "Dev",
    "environment_id": "dev",
    "color_code": "#FDD13A"
  },
  "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "git_branch": "main",
  "git_file_path": "code/development/README.json",
  "last_sync_time": "2022-05-27T23:20:50.52Z",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
}
Copy to clipboard

Success example

{
  "git_config_name": "boot-strap-configuration",
  "git_config_id": "boot-strap-configuration",
  "collection": {
    "name": "Web Application",
    "collection_id": "web-app-collection"
  },
  "environment": {
    "name": "Dev",
    "environment_id": "dev",
    "color_code": "#FDD13A"
  },
  "git_url": "https://github.ibm.com/api/v3/repos/jhondoe-owner/my-test-repo",
  "git_branch": "main",
  "git_file_path": "code/development/README.json",
  "last_sync_time": "2022-05-27T23:20:50.52Z",
  "created_time": "2021-05-12T23:20:50.52Z",
  "updated_time": "2021-05-12T23:20:50.52Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/gitconfigs/boot-strap-configuration"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the gitconfig. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while retrieving the gitconfig. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Delete a gitconfig

Delete a gitconfig.

DELETE /gitconfigs/{git_config_id}

(appConfiguration *AppConfigurationV1) DeleteGitconfig(deleteGitconfigOptions *DeleteGitconfigOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeleteGitconfigWithContext(ctx context.Context, deleteGitconfigOptions *DeleteGitconfigOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.delete

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.delete

Request

Instantiate the DeleteGitconfigOptions struct and set the fields to provide parameter values for the DeleteGitconfig method.

Path Parameters

git_config_id
Required*
string
Git Config Id

Example: git_config_id

parameter

WithContext method only

DeleteGitconfigOptions

The DeleteGitconfig options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}" "{base_url}/gitconfigs/{git_config_id}"

Example request

deleteGitconfigOptions := appConfigurationService.NewDeleteGitconfigOptions(
  "git_config_id",
)

response, err := appConfigurationService.DeleteGitconfig(deleteGitconfigOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteGitconfig(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted the specified gitconfig.
404
Not Found. Verify that the gitconfig id is correct.
501
Not Implemented.

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the gitconfig. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the gitconfig. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Promote configuration, this api will write or update your chosen configuration to the GitHub based on the git url, file path and branch data. In simple words this api will create or updates the bootstrap json file

Promote configuration, this api will write or update your chosen configuration to the GitHub based on the git url, file path and branch data. In simple words this api will create or updates the bootstrap json file.

PUT /gitconfigs/{git_config_id}/promote

(appConfiguration *AppConfigurationV1) PromoteGitconfig(promoteGitconfigOptions *PromoteGitconfigOptions) (result *GitConfigPromote, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) PromoteGitconfigWithContext(ctx context.Context, promoteGitconfigOptions *PromoteGitconfigOptions) (result *GitConfigPromote, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.promote

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.promote

Request

Instantiate the PromoteGitconfigOptions struct and set the fields to provide parameter values for the PromoteGitconfig method.

Path Parameters

git_config_id
Required*
string
Git Config Id

Example: git_config_id

parameter

WithContext method only

PromoteGitconfigOptions

The PromoteGitconfig options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/gitconfigs/{git_config_id}/promote"
Copy to clipboard

Example request

promoteGitconfigOptions := appConfigurationService.NewPromoteGitconfigOptions(
  "git_config_id",
)

gitConfigPromote, response, err := appConfigurationService.PromoteGitconfig(promoteGitconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(gitConfigPromote, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

GitConfigPromote

Details of the promote operation.

GitConfigPromote

Details of the promote operation.

Examples:

Status Code

200
Successfully written the configuration details.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the git config id is correct.
501
Not Implemented.

Example responses

Status 200

{
  "last_sync_time": "2022-05-30T05:33:41Z",
  "git_commit_message": "custom config data written from App config instance",
  "git_commit_id": "2fadfe4e71632f32c19ee97d795f1494be95caf8"
}
Copy to clipboard

Success example

{
  "last_sync_time": "2022-05-30T05:33:41Z",
  "git_commit_message": "custom config data written from App config instance",
  "git_commit_id": "2fadfe4e71632f32c19ee97d795f1494be95caf8"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while writing or updating the configuration to the json file."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while writing or updating the configuration to the json file."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the configuration. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the configuration. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Restore configuration, this api will write or update your chosen configuration from the GitHub to App configuration instance. The api will read the contents in the json file that was created using promote API and recreate or updates the App configuration instance with the file contents like properties, features and segments.

PUT /gitconfigs/{git_config_id}/restore

(appConfiguration *AppConfigurationV1) RestoreGitconfig(restoreGitconfigOptions *RestoreGitconfigOptions) (result *GitConfigRestore, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) RestoreGitconfigWithContext(ctx context.Context, restoreGitconfigOptions *RestoreGitconfigOptions) (result *GitConfigRestore, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.gitconfigs.restore

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.restore

Request

Instantiate the RestoreGitconfigOptions struct and set the fields to provide parameter values for the RestoreGitconfig method.

Path Parameters

git_config_id
Required*
string
Git Config Id

Example: git_config_id

parameter

WithContext method only

RestoreGitconfigOptions

The RestoreGitconfig options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/gitconfigs/{git_config_id}/restore"
Copy to clipboard

Example request

restoreGitconfigOptions := appConfigurationService.NewRestoreGitconfigOptions(
  "git_config_id",
)

gitConfigRestore, response, err := appConfigurationService.RestoreGitconfig(restoreGitconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(gitConfigRestore, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

GitConfigRestore

Details of the restore operation.

GitConfigRestore

Details of the restore operation.

Examples:

Status Code

200
Successfully updated the configuration details.
400
Bad request. Verify that the information in the request is complete and correct.
404
Not Found. Verify that the git config id is correct.
501
Not Implemented.

Example responses

Status 200

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "type": "NUMERIC",
          "tags": "pre-release, v1.2",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Success example

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "type": "NUMERIC",
          "tags": "pre-release, v1.2",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while writing or updating the configuration to the App configuration instance."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while writing or updating the configuration to the App configuration instance."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the configuration. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the configuration. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

List all the integrations.

GET /integrations

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.integrations.list

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.list

Request

Query Parameters

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

Example: true
limit
integer
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.

Possible values: 1 ≤ value ≤ 100
Default: 10
offset
integer
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.

Possible values: value ≥ 0
Default: 0

Response

Response Body

IntegrationList

List of all integrations.

Status Code

200
Successfully listed the integrations.
401
Unauthorized

Example responses

Status 200

{
  "integrations": [
    {
      "integration_id": "lckkhp34t",
      "integration_type": "EVENT_NOTIFICATIONS",
      "metadata": {
        "event_notifications_endpoint": "https://eu-gb.event-notifications.cloud.ibm.com",
        "event_notifications_source_id": "crn:v1:bluemix:public:apprapp:eu-gb:a/4f631ea3b3204b2b878a295604994acf:34e45c66-3648-4a51-be67-22eac4a7561c::",
        "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:eu-gb:a/4f631ea3b3204b2b878a295604994acf:0eb42def-21aa-4f0a-a975-0812ead6ceee::"
      },
      "created_time": "2024-02-18T14:46:31Z",
      "updated_time": "2024-02-18T14:46:31Z",
      "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/c6d52ad4-adaa-492b-941b-daa9e8d63d3a/integrations/lckkhp34t"
    },
    {
      "integration_id": "ldxktxso",
      "integration_type": "KMS",
      "metadata": {
        "key_status": "USABLE",
        "root_key_id": "094ab151-1e01-4d30-9e7a-f1311bc0fbc6",
        "kms_endpoint": "https://au-syd.kms.cloud.ibm.com",
        "kms_scheme_type": "BYOK",
        "kms_instance_crn": "crn:v1:bluemix:public:kms:au-syd:a/4f631ea3b3204b2b878a295604994acf:a3d454ea-38f4-4ae1-92e1-6a4aaac24e14::"
      },
      "created_time": "2023-05-26T02:46:33Z",
      "updated_time": "2023-05-26T02:46:34Z",
      "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/c6d52ad4-adaa-492b-941b-daa9e8d63d3a/integrations/ldxktxso"
    }
  ],
  "offset": 0,
  "limit": 10,
  "total_count": 2,
  "first": {
    "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/6e7b594d-3132-484f-9ace-39e30c5c67cd/integrations?offset=0&size=10"
  },
  "last": {
    "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/6e7b594d-3132-484f-9ace-39e30c5c67cd/integrations?offset=0&size=10"
  }
}
Copy to clipboard

{ "message": "Unauthorized" }

Create an integration with App Configuration service instance.

POST /integrations

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.integrations.create

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.create

Request

Request Body

Required*

CreateIntegration

The request body to create a new integration. Currently, integration with Key Protect / HPCS and Event Notifications service is supported.

Examples:

Response

Response Body

Integration

Details of the integration.

Status Code

201
Successfully created the integration
400
Bad request. Verify that the information in the request body is complete and correct.
401
Unauthorized
403
Forbidden

Example responses

Status 201

Example EN integration.

{
  "integration_id": "lckkhp34t",
  "integration_type": "EVENT_NOTIFICATIONS",
  "metadata": {
    "event_notifications_endpoint": "https://eu-gb.event-notifications.cloud.ibm.com",
    "event_notifications_source_id": "crn:v1:bluemix:public:apprapp:eu-gb:a/4f631ea3b3204b2b878a295604994acf:34e45c66-3648-4a51-be67-22eac4a7561c::",
    "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:eu-gb:a/4f631ea3b3204b2b878a295604994acf:0eb42def-21aa-4f0a-a975-0812ead6ceee::"
  },
  "created_time": "2024-02-18T14:46:31Z",
  "updated_time": "2024-02-18T14:46:31Z",
  "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/c6d52ad4-adaa-492b-941b-daa9e8d63d3a/integrations/lckkhp34t"
}
Copy to clipboard

Status 201

Example KMS integration.

{
  "integration_id": "ldxktxso",
  "integration_type": "KMS",
  "metadata": {
    "key_status": "USABLE",
    "root_key_id": "094ab151-1e01-4d30-9e7a-f1311bc0fbc6",
    "kms_endpoint": "https://au-syd.kms.cloud.ibm.com",
    "kms_scheme_type": "BYOK",
    "kms_instance_crn": "crn:v1:bluemix:public:kms:au-syd:a/4f631ea3b3204b2b878a295604994acf:a3d454ea-38f4-4ae1-92e1-6a4aaac24e14::"
  },
  "created_time": "2023-05-26T02:46:33Z",
  "updated_time": "2023-05-26T02:46:34Z",
  "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/c6d52ad4-adaa-492b-941b-daa9e8d63d3a/integrations/ldxktxso"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "An incorrect or incomplete request is sent to the server. The server request does not contain proper values to complete the API request. Check the 'metadata' parameter value."
}
Copy to clipboard

{ "message": "Unauthorized" }

Status 403

{
  "code": "FTEC1021E",
  "message": "Forbidden - Insufficient permission to create the integration."
}
Copy to clipboard

Retrieve the details of the integration

GET /integrations/{integration_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.integrations.list

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.read

Request

Path Parameters

integration_id
Required*
string
Integration Id of the integration

Example: integration_id

Response

Response Body

Integration

Details of the integration.

Status Code

200
Successfully retrived the integration details
404
Not Found. Verify that the integration id is correct.

Example responses

Status 200

Example EN integration.

{
  "integration_id": "lckkhp34t",
  "integration_type": "EVENT_NOTIFICATIONS",
  "metadata": {
    "event_notifications_endpoint": "https://eu-gb.event-notifications.cloud.ibm.com",
    "event_notifications_source_id": "crn:v1:bluemix:public:apprapp:eu-gb:a/4f631ea3b3204b2b878a295604994acf:34e45c66-3648-4a51-be67-22eac4a7561c::",
    "event_notifications_instance_crn": "crn:v1:bluemix:public:event-notifications:eu-gb:a/4f631ea3b3204b2b878a295604994acf:0eb42def-21aa-4f0a-a975-0812ead6ceee::"
  },
  "created_time": "2024-02-18T14:46:31Z",
  "updated_time": "2024-02-18T14:46:31Z",
  "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/c6d52ad4-adaa-492b-941b-daa9e8d63d3a/integrations/lckkhp34t"
}
Copy to clipboard

Status 200

Example KMS integration.

{
  "integration_id": "ldxktxso",
  "integration_type": "KMS",
  "metadata": {
    "key_status": "USABLE",
    "root_key_id": "094ab151-1e01-4d30-9e7a-f1311bc0fbc6",
    "kms_endpoint": "https://au-syd.kms.cloud.ibm.com",
    "kms_scheme_type": "BYOK",
    "kms_instance_crn": "crn:v1:bluemix:public:kms:au-syd:a/4f631ea3b3204b2b878a295604994acf:a3d454ea-38f4-4ae1-92e1-6a4aaac24e14::"
  },
  "created_time": "2023-05-26T02:46:33Z",
  "updated_time": "2023-05-26T02:46:34Z",
  "href": "https://eu-gb.apprapp.cloud.ibm.com/feature/v1/instances/c6d52ad4-adaa-492b-941b-daa9e8d63d3a/integrations/ldxktxso"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Not Found - The queried resource 'Integration' is not available on the server. Check the'lkqwest3ws' parameter."
}
Copy to clipboard

Delete an integration

DELETE /integrations/{integration_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.integrations.delete

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.delete

Request

Path Parameters

integration_id
Required*
string
Integration Id of the integration

Example: integration_id

Response

Status Code

204
Successfully deleted the integration.
404
Not Found. Verify that the integration id is correct.
405
Method Not Allowed

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Not Found - The queried resource 'Integration' is not available on the server. Check the'ekwgg78o' parameter."
}
Copy to clipboard

Status 405

{
  "code": "FTEC1019E",
  "message": "Method Not Allowed. Currently, integration of type KMS cannot be deleted."
}
Copy to clipboard

List all the Origin Configs

List all the Origin Configs.

GET /originconfigs

(appConfiguration *AppConfigurationV1) ListOriginconfigs(listOriginconfigsOptions *ListOriginconfigsOptions) (result *OriginConfigList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListOriginconfigsWithContext(ctx context.Context, listOriginconfigsOptions *ListOriginconfigsOptions) (result *OriginConfigList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.originconfigs.list

Auditing

Calling this method generates the following auditing event.

apprapp.originconfigs.list

Request

No Request Parameters

This method does not accept any request parameters.

parameter

WithContext method only

No Request Parameters

This method does not accept any request parameters.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/originconfigs"
Copy to clipboard

Example request

listOriginconfigsOptions := appConfigurationService.NewListOriginconfigsOptions()

originConfigList, response, err := appConfigurationService.ListOriginconfigs(listOriginconfigsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(originConfigList, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

OriginConfigList

List of all origin configs.

OriginConfigList

List of all origin configs.

Examples:

Status Code

200
Successfully listed all the origin configuration.
401
Unauthorized

Example responses

Status 200

{
  "allowed_origins": [
    "https://www.bluecharge.com",
    "https://blog.hubspot.com",
    "http://127.0.0.1:3000"
  ],
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/originconfigs"
}
Copy to clipboard

Success example

{
  "allowed_origins": [
    "https://www.bluecharge.com",
    "https://blog.hubspot.com",
    "http://127.0.0.1:3000"
  ],
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/originconfigs"
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Update the Origin Configs

Update the Origin Configs.

PUT /originconfigs

(appConfiguration *AppConfigurationV1) UpdateOriginconfigs(updateOriginconfigsOptions *UpdateOriginconfigsOptions) (result *OriginConfigList, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateOriginconfigsWithContext(ctx context.Context, updateOriginconfigsOptions *UpdateOriginconfigsOptions) (result *OriginConfigList, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.originconfigs.update

Auditing

Calling this method generates the following auditing event.

apprapp.originconfigs.update

Request

Instantiate the UpdateOriginconfigsOptions struct and set the fields to provide parameter values for the UpdateOriginconfigs method.

Request Body

Required*

UpdateOriginConfig

The request body to update origin config.

Examples:

parameter

WithContext method only

UpdateOriginconfigsOptions

The UpdateOriginconfigs options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{"allowed_origins":["https://www.bluecharge.com","https://blog.hubspot.com","http://127.0.0.1:3000"]}'   "{base_url}/originconfigs"
Copy to clipboard

Example request

updateOriginconfigsOptions := appConfigurationService.NewUpdateOriginconfigsOptions(
  []string{"testString"},
)

originConfigList, response, err := appConfigurationService.UpdateOriginconfigs(updateOriginconfigsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(originConfigList, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

OriginConfigList

List of all origin configs.

OriginConfigList

List of all origin configs.

Examples:

Status Code

200
Successfully updated the origin configs details.
404
Not Found. Verify that the instance id is correct.

Example responses

Status 200

{
  "allowed_origins": [
    "https://www.bluecharge.com",
    "https://blog.hubspot.com",
    "http://127.0.0.1:3000"
  ],
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/originconfigs"
}
Copy to clipboard

Success example

{
  "allowed_origins": [
    "https://www.bluecharge.com",
    "https://blog.hubspot.com",
    "http://127.0.0.1:3000"
  ],
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.apprapp.cloud.ibm.com/apprapp/feature/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/originconfigs"
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "The queried resource 'Instance' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "The queried resource 'Instance' is not available on the server."
}
Copy to clipboard

Get the environment specific workflow Configs

Get the environment specific workflow Configs.

GET /environments/{environment_id}/workflowconfigs

(appConfiguration *AppConfigurationV1) ListWorkflowconfig(listWorkflowconfigOptions *ListWorkflowconfigOptions) (result ListWorkflowconfigResponseIntf, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListWorkflowconfigWithContext(ctx context.Context, listWorkflowconfigOptions *ListWorkflowconfigOptions) (result ListWorkflowconfigResponseIntf, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.workflowconfigs.list

Auditing

Calling this method generates the following auditing event.

apprapp.workflowconfigs.list

Request

Instantiate the ListWorkflowconfigOptions struct and set the fields to provide parameter values for the ListWorkflowconfig method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

parameter

WithContext method only

ListWorkflowconfigOptions

The ListWorkflowconfig options.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/environments/{environment_id}/workflowconfigs"
Copy to clipboard

Example request

listWorkflowconfigOptions := appConfigurationService.NewListWorkflowconfigOptions(
  "environment_id",
)

listWorkflowconfigResponse, response, err := appConfigurationService.ListWorkflowconfig(listWorkflowconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(listWorkflowconfigResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

One of

Change Schema Parameter List

Details of the External Workflow configuration.

ListWorkflowconfigResponse

Change Schema Parameter List

Details of the External Workflow configuration.

Status Code

200
Successfully listed workflow configuration for the environment.
401
Unauthorized
404
Not Found. Verify that the environment_id is correct.
501
Not Implemented.

Example responses

Status 200

Example WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "workflow_url": "https://xxxxx.service-now.com",
  "approval_group_name": "WorkflowCRApprovers",
  "approval_expiration": 10,
  "workflow_credentials": {
    "client_id": "client id value",
    "client_secret": "clientsecret",
    "password": "pwd",
    "username": "user"
  },
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Success example

Example WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "workflow_url": "https://xxxxx.service-now.com",
  "approval_group_name": "WorkflowCRApprovers",
  "approval_expiration": 10,
  "workflow_credentials": {
    "client_id": "client id value",
    "client_secret": "clientsecret",
    "password": "pwd",
    "username": "user"
  },
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Status 200

Example IBM WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "service_crn": "crn:v1:staging:staging:appservice:us-south::::",
  "sm_instance_crn": "crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::",
  "approval_expiration": 4,
  "secret_id": "Secret ID",
  "workflow_type": "SERVICENOW_IBM",
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Success example

Example IBM WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "service_crn": "crn:v1:staging:staging:appservice:us-south::::",
  "sm_instance_crn": "crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::",
  "approval_expiration": 4,
  "secret_id": "Secret ID",
  "workflow_type": "SERVICENOW_IBM",
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while fetching the configuration. The queried resource is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while fetching the configuration. The queried resource is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Create a Workflow.

POST /environments/{environment_id}/workflowconfigs

(appConfiguration *AppConfigurationV1) CreateWorkflowconfig(createWorkflowconfigOptions *CreateWorkflowconfigOptions) (result CreateWorkflowconfigResponseIntf, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) CreateWorkflowconfigWithContext(ctx context.Context, createWorkflowconfigOptions *CreateWorkflowconfigOptions) (result CreateWorkflowconfigResponseIntf, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.workflowconfigs.create

Auditing

Calling this method generates the following auditing event.

apprapp.workflowconfigs.create

Request

Instantiate the CreateWorkflowconfigOptions struct and set the fields to provide parameter values for the CreateWorkflowconfig method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Request Body

Required*

One of

Change Schema Parameter List

The request body to create a new external workflow config.

Example:

parameter

WithContext method only

CreateWorkflowconfigOptions

The CreateWorkflowconfig options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "workflow_url": "https://xxxxx.service-now.com", "approval_group_name": "WorkflowCRApprovers", "approval_expiration": 10, "workflow_credentials": { "client_id": "client id value", "client_secret": "clientsecret", "password": "pwd", "username": "user" }, "enabled": true }'   "{base_url}/environments/{environment_id}/workflowconfigs"
Copy to clipboard

Example request

workflowCredentialsModel := &appconfigurationv1.WorkflowCredentials{
  Username: core.StringPtr("user"),
  Password: core.StringPtr("pwd"),
  ClientID: core.StringPtr("client id value"),
  ClientSecret: core.StringPtr("clientsecret"),
}

createWorkflowconfigRequestModel := &appconfigurationv1.CreateWorkflowconfigRequestWorkflowConfig{
  WorkflowURL: core.StringPtr("https://xxxxx.service-now.com"),
  ApprovalGroupName: core.StringPtr("WorkflowCRApprovers"),
  ApprovalExpiration: core.Int64Ptr(int64(10)),
  WorkflowCredentials: workflowCredentialsModel,
  Enabled: core.BoolPtr(true),
}

createWorkflowconfigOptions := appConfigurationService.NewCreateWorkflowconfigOptions(
  "environment_id",
  createWorkflowconfigRequestModel,
)

createWorkflowconfigResponse, response, err := appConfigurationService.CreateWorkflowconfig(createWorkflowconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(createWorkflowconfigResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

One of

Change Schema Parameter List

Details of the External Workflow configuration.

CreateWorkflowconfigResponse

Change Schema Parameter List

Details of the External Workflow configuration.

Status Code

201
Successfully created the workflow configuration
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the environment_id is correct.
501
Not Implemented.

Example responses

Status 201

Example WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "workflow_url": "https://xxxxx.service-now.com",
  "approval_group_name": "WorkflowCRApprovers",
  "approval_expiration": 10,
  "workflow_credentials": {
    "client_id": "client id value",
    "client_secret": "clientsecret",
    "password": "pwd",
    "username": "user"
  },
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Success example

Example WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "workflow_url": "https://xxxxx.service-now.com",
  "approval_group_name": "WorkflowCRApprovers",
  "approval_expiration": 10,
  "workflow_credentials": {
    "client_id": "client id value",
    "client_secret": "clientsecret",
    "password": "pwd",
    "username": "user"
  },
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Status 201

Example IBM WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "service_crn": "crn:v1:staging:staging:appservice:us-south::::",
  "sm_instance_crn": "crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::",
  "approval_expiration": 4,
  "secret_id": "Secret ID",
  "workflow_type": "SERVICENOW_IBM",
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Success example

Example IBM WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "service_crn": "crn:v1:staging:staging:appservice:us-south::::",
  "sm_instance_crn": "crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::",
  "approval_expiration": 4,
  "secret_id": "Secret ID",
  "workflow_type": "SERVICENOW_IBM",
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the workflow configuration."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the workflow configuration."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while creating the configuration. The queried evironment resource is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while creating the configuration. The queried evironment resource is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Update a Workflow.

PUT /environments/{environment_id}/workflowconfigs

(appConfiguration *AppConfigurationV1) UpdateWorkflowconfig(updateWorkflowconfigOptions *UpdateWorkflowconfigOptions) (result UpdateWorkflowconfigResponseIntf, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) UpdateWorkflowconfigWithContext(ctx context.Context, updateWorkflowconfigOptions *UpdateWorkflowconfigOptions) (result UpdateWorkflowconfigResponseIntf, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.workflowconfigs.update

Auditing

Calling this method generates the following auditing event.

apprapp.workflowconfigs.update

Request

Instantiate the UpdateWorkflowconfigOptions struct and set the fields to provide parameter values for the UpdateWorkflowconfig method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

Request Body

Required*

One of

Change Schema Parameter List

The request body to update a workflow config.

Example:

parameter

WithContext method only

UpdateWorkflowconfigOptions

The UpdateWorkflowconfig options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "workflow_url": "https://xxxxx.service-now.com", "approval_group_name": "WorkflowCRApprovers", "approval_expiration": 5, "workflow_credentials": { "client_id": "client id value", "client_secret": "updated client secret", "password": "updated password", "username": "user" }, "enabled": true }'   "{base_url}/environments/{environment_id}/workflowconfigs"
Copy to clipboard

Example request

workflowCredentialsModel := &appconfigurationv1.WorkflowCredentials{
  Username: core.StringPtr("user"),
  Password: core.StringPtr("updated password"),
  ClientID: core.StringPtr("client id value"),
  ClientSecret: core.StringPtr("updated client secret"),
}

updateWorkflowconfigRequestModel := &appconfigurationv1.UpdateWorkflowconfigRequestUpdateWorkflowConfig{
  WorkflowURL: core.StringPtr("https://xxxxx.service-now.com"),
  ApprovalGroupName: core.StringPtr("WorkflowCRApprovers"),
  ApprovalExpiration: core.Int64Ptr(int64(5)),
  WorkflowCredentials: workflowCredentialsModel,
  Enabled: core.BoolPtr(true),
}

updateWorkflowconfigOptions := appConfigurationService.NewUpdateWorkflowconfigOptions(
  "environment_id",
  updateWorkflowconfigRequestModel,
)

updateWorkflowconfigResponse, response, err := appConfigurationService.UpdateWorkflowconfig(updateWorkflowconfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(updateWorkflowconfigResponse, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

One of

Change Schema Parameter List

Details of the External Workflow configuration.

UpdateWorkflowconfigResponse

Change Schema Parameter List

Details of the External Workflow configuration.

Status Code

201
Successfully created the workflow configuration
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the environment_id is correct.
501
Not Implemented.

Example responses

Status 201

Example WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "workflow_url": "https://xxxxx.service-now.com",
  "approval_group_name": "WorkflowCRApprovers",
  "approval_expiration": 10,
  "workflow_credentials": {
    "client_id": "client id value",
    "client_secret": "clientsecret",
    "password": "pwd",
    "username": "user"
  },
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Success example

Example WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "workflow_url": "https://xxxxx.service-now.com",
  "approval_group_name": "WorkflowCRApprovers",
  "approval_expiration": 10,
  "workflow_credentials": {
    "client_id": "client id value",
    "client_secret": "clientsecret",
    "password": "pwd",
    "username": "user"
  },
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Status 201

Example IBM WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "service_crn": "crn:v1:staging:staging:appservice:us-south::::",
  "sm_instance_crn": "crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::",
  "approval_expiration": 4,
  "secret_id": "Secret ID",
  "workflow_type": "SERVICENOW_IBM",
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Success example

Example IBM WorkflowConfig integration.

{
  "environment_name": "Dev",
  "environment_id": "dev",
  "service_crn": "crn:v1:staging:staging:appservice:us-south::::",
  "sm_instance_crn": "crn:v1:staging:public:secrets-manager:eu-gb:a/3268cfe9e25d411122f9a731a:0a23274-92d0a-4d42-b1fa-d15b4293cd::",
  "approval_expiration": 4,
  "secret_id": "Secret ID",
  "workflow_type": "SERVICENOW_IBM",
  "enabled": true,
  "created_time": "2022-11-15T23:20:50Z",
  "updated_time": "2022-11-16T21:20:50Z",
  "href": "https://us-south.containers.appdomain.cloud/feature/v1/instances/31232860ac-c4c3-4a6a-9aa4-3dd82affbe1/environments/dev/workflowconfigs"
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while creating the workflow configuration."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while creating the workflow configuration."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while creating the configuration. The queried evironment resource is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while creating the configuration. The queried evironment resource is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Delete a Workflow config

Delete a Workflow config.

DELETE /environments/{environment_id}/workflowconfigs

(appConfiguration *AppConfigurationV1) DeleteWorkflowconfig(deleteWorkflowconfigOptions *DeleteWorkflowconfigOptions) (response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) DeleteWorkflowconfigWithContext(ctx context.Context, deleteWorkflowconfigOptions *DeleteWorkflowconfigOptions) (response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.workflowconfigs.delete

Auditing

Calling this method generates the following auditing event.

apprapp.workflowconfigs.delete

Request

Instantiate the DeleteWorkflowconfigOptions struct and set the fields to provide parameter values for the DeleteWorkflowconfig method.

Path Parameters

environment_id
Required*
string
Environment Id

Example: environment_id

parameter

WithContext method only

DeleteWorkflowconfigOptions

The DeleteWorkflowconfig options.

Example request

curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/environments/{environment_id}/workflowconfigs"

Example request

deleteWorkflowconfigOptions := appConfigurationService.NewDeleteWorkflowconfigOptions(
  "environment_id",
)

response, err := appConfigurationService.DeleteWorkflowconfig(deleteWorkflowconfigOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteWorkflowconfig(): %d\n", response.StatusCode)
}
Copy to clipboard

Response

Status Code

204
Successfully deleted environment specific workflow config.
404
Not Found. Verify that the environment id is correct.
501
Not Implemented.

Example responses

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while deleting the workflow config. The queried resource is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while deleting the workflow config. The queried resource is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'workflow integration' feature is not available"
}
Copy to clipboard

Import configuration to the instance.

POST /config

(appConfiguration *AppConfigurationV1) ImportConfig(importConfigOptions *ImportConfigOptions) (result *ImportConfig, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ImportConfigWithContext(ctx context.Context, importConfigOptions *ImportConfigOptions) (result *ImportConfig, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.config.import

Auditing

Calling this method generates the following auditing event.

apprapp.config.import

Request

Instantiate the ImportConfigOptions struct and set the fields to provide parameter values for the ImportConfig method.

Query Parameters

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

Example: true

Request Body

Required*

ImportConfig

The request body to import configurations.

Examples:

parameter

WithContext method only

ImportConfigOptions

The ImportConfig options.

Example request

curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "environments": [ { "name": "Dev", "environment_id": "dev", "description": "Environment created on instance creation", "tags": "", "color_code": "#FDD13A", "features": [ { "name": "Cycle Rentals", "feature_id": "cycle-rentals", "description": "", "tags": "", "type": "NUMERIC", "disabled_value": 2, "enabled_value": 1, "segment_rules":  ], "enabled": true, "rollout_percentage": 100, "collections": [ { "collection_id": "web-app", "name": "web-app" } ], "isOverridden": true } ], "properties": [ { "name": "Daily Discount", "property_id": "daily_discount", "description": "", "tags": "pre-release, v1.2", "type": "NUMERIC", "value": "100", "segment_rules": [ { "rules": [ { "segments": [ "khpwj68h" ] } ], "value": 200, "order": 1 }, { "rules": [ { "segments": [ "khpwjol7" ] } ], "value": 400, "order": 2 } ], "collections": [ { "collection_id": "web-app", "name": "web-app" } ], "isOverridden": true } ] } ], "collections": [ { "name": "web-app", "collection_id": "web-app", "description": "web app collection", "tags": "v1" } ], "segments": [ { "name": "Testers", "segment_id": "khpwj68h", "description": "Testers", "tags": "test", "rules": [ { "values": [ "john@bluecharge.com", "alice@bluecharge.com" ], "operator": "is", "attribute_name": "email" } ] }, { "name": "IBMers", "segment_id": "khpwjol7", "description": "IBMers", "tags": "company,ibm", "rules": [ { "values": [ "ibm.com" ], "operator": "endsWith", "attribute_name": "email" } ] } ] }'   "{base_url}/config?clean=true"
Copy to clipboard

Example request

targetSegmentsModel := &appconfigurationv1.TargetSegments{
  Segments: []string{"testString"},
}

featureSegmentRuleModel := &appconfigurationv1.FeatureSegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: "testString",
  Order: core.Int64Ptr(int64(38)),
}

collectionRefModel := &appconfigurationv1.CollectionRef{
  CollectionID: core.StringPtr("web-app"),
}

importFeatureRequestBodyModel := &appconfigurationv1.ImportFeatureRequestBody{
  Name: core.StringPtr("Cycle Rentals"),
  FeatureID: core.StringPtr("cycle-rentals"),
  Type: core.StringPtr("NUMERIC"),
  EnabledValue: core.StringPtr("1"),
  DisabledValue: core.StringPtr("2"),
  Enabled: core.BoolPtr(true),
  RolloutPercentage: core.Int64Ptr(int64(100)),
  SegmentRules: []appconfigurationv1.FeatureSegmentRule{*featureSegmentRuleModel},
  Collections: []appconfigurationv1.CollectionRef{*collectionRefModel},
  IsOverridden: core.BoolPtr(true),
}

segmentRuleModel := &appconfigurationv1.SegmentRule{
  Rules: []appconfigurationv1.TargetSegments{*targetSegmentsModel},
  Value: core.StringPtr("200"),
  Order: core.Int64Ptr(int64(1)),
}

importPropertyRequestBodyModel := &appconfigurationv1.ImportPropertyRequestBody{
  Name: core.StringPtr("Daily Discount"),
  PropertyID: core.StringPtr("daily_discount"),
  Type: core.StringPtr("NUMERIC"),
  Value: core.StringPtr("100"),
  Tags: core.StringPtr("pre-release, v1.2"),
  SegmentRules: []appconfigurationv1.SegmentRule{*segmentRuleModel},
  Collections: []appconfigurationv1.CollectionRef{*collectionRefModel},
  IsOverridden: core.BoolPtr(true),
}

importEnvironmentSchemaModel := &appconfigurationv1.ImportEnvironmentSchema{
  Name: core.StringPtr("Dev"),
  EnvironmentID: core.StringPtr("dev"),
  Description: core.StringPtr("Environment created on instance creation"),
  ColorCode: core.StringPtr("#FDD13A"),
  Features: []appconfigurationv1.ImportFeatureRequestBody{*importFeatureRequestBodyModel},
  Properties: []appconfigurationv1.ImportPropertyRequestBody{*importPropertyRequestBodyModel},
}

importCollectionSchemaModel := &appconfigurationv1.ImportCollectionSchema{
  CollectionID: core.StringPtr("web-app"),
  Name: core.StringPtr("web-app"),
  Description: core.StringPtr("web app collection"),
  Tags: core.StringPtr("v1"),
}

ruleModel := &appconfigurationv1.Rule{
  AttributeName: core.StringPtr("email"),
  Operator: core.StringPtr("is"),
  Values: []string{"john@bluecharge.com", "alice@bluecharge.com"},
}

importSegmentSchemaModel := &appconfigurationv1.ImportSegmentSchema{
  Name: core.StringPtr("Testers"),
  SegmentID: core.StringPtr("khpwj68h"),
  Description: core.StringPtr("Testers"),
  Tags: core.StringPtr("test"),
  Rules: []appconfigurationv1.Rule{*ruleModel},
}

importConfigOptions := appConfigurationService.NewImportConfigOptions()
importConfigOptions.SetEnvironments([]appconfigurationv1.ImportEnvironmentSchema{*importEnvironmentSchemaModel})
importConfigOptions.SetCollections([]appconfigurationv1.ImportCollectionSchema{*importCollectionSchemaModel})
importConfigOptions.SetSegments([]appconfigurationv1.ImportSegmentSchema{*importSegmentSchemaModel})
importConfigOptions.SetClean("true")

importConfig, response, err := appConfigurationService.ImportConfig(importConfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(importConfig, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ImportConfig

Full instance configuration.

ImportConfig

Full instance configuration.

Examples:

Status Code

201
Successfully imported the configuration
400
Bad request. Verify that the information in the request body is complete and correct.
403
Forbidden Request - Instance is not empty. Send clean=true query param if you want to override the current instance configuration
501
Not Implemented.

Example responses

Status 201

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "description": "",
          "tags": "",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "description": "",
          "tags": "pre-release, v1.2",
          "type": "NUMERIC",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "collections": [
    {
      "name": "web-app",
      "collection_id": "web-app",
      "description": "web app collection",
      "tags": "v1"
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Success example

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "description": "",
          "tags": "",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "description": "",
          "tags": "pre-release, v1.2",
          "type": "NUMERIC",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "collections": [
    {
      "name": "web-app",
      "collection_id": "web-app",
      "description": "web app collection",
      "tags": "v1"
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 400

{
  "code": "FTEC1003E",
  "message": "Error while import the configuration."
}
Copy to clipboard

Error example

{
  "code": "FTEC1003E",
  "message": "Error while import the configuration."
}
Copy to clipboard

Status 403

{
  "code": "FTI1009E",
  "message": "Forbidden Request - Instance is not empty. Send clean=true query param if you want to override the current instance configuration."
}
Copy to clipboard

Error example

{
  "code": "FTI1009E",
  "message": "Forbidden Request - Instance is not empty. Send clean=true query param if you want to override the current instance configuration."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'Rollout percentage' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'Rollout percentage' feature is not available"
}
Copy to clipboard

Get the instance configuration.

GET /config

(appConfiguration *AppConfigurationV1) ListInstanceConfig(listInstanceConfigOptions *ListInstanceConfigOptions) (result *ImportConfig, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) ListInstanceConfigWithContext(ctx context.Context, listInstanceConfigOptions *ListInstanceConfigOptions) (result *ImportConfig, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.config.export

Auditing

Calling this method generates the following auditing event.

apprapp.config.export

Request

No Request Parameters

This method does not accept any request parameters.

parameter

WithContext method only

No Request Parameters

This method does not accept any request parameters.

Example request

curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/config"
Copy to clipboard

Example request

listInstanceConfigOptions := appConfigurationService.NewListInstanceConfigOptions()

importConfig, response, err := appConfigurationService.ListInstanceConfig(listInstanceConfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(importConfig, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

ImportConfig

Full instance configuration.

ImportConfig

Full instance configuration.

Examples:

Status Code

200
Successfully listed configuration for the instance.
401
Unauthorized

Example responses

Status 200

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "description": "",
          "tags": "",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "description": "",
          "tags": "pre-release, v1.2",
          "type": "NUMERIC",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "collections": [
    {
      "name": "web-app",
      "collection_id": "web-app",
      "description": "web app collection",
      "tags": "v1"
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Success example

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "description": "",
          "tags": "",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "description": "",
          "tags": "pre-release, v1.2",
          "type": "NUMERIC",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "collections": [
    {
      "name": "web-app",
      "collection_id": "web-app",
      "description": "web app collection",
      "tags": "v1"
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

{ "message": "Unauthorized" }
{ "message": "Unauthorized" }

This api will either promote or restore your chosen configuration from or to the GitHub based on the git url, file path and branch data.

PUT /config

(appConfiguration *AppConfigurationV1) PromoteRestoreConfig(promoteRestoreConfigOptions *PromoteRestoreConfigOptions) (result ConfigActionIntf, response *core.DetailedResponse, err error)

(appConfiguration *AppConfigurationV1) PromoteRestoreConfigWithContext(ctx context.Context, promoteRestoreConfigOptions *PromoteRestoreConfigOptions) (result ConfigActionIntf, response *core.DetailedResponse, err error)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

apprapp.config.action

Auditing

Calling this method generates the following auditing event.

apprapp.config.action

Request

Instantiate the PromoteRestoreConfigOptions struct and set the fields to provide parameter values for the PromoteRestoreConfig method.

Query Parameters

git_config_id
Required*
string
Git Config Id.

Example: git_config_id
action
Required*
string
Promote configuration to Git or Restore configuration from Git.

Allowable values: [promote,restore]
Example: promote

parameter

WithContext method only

PromoteRestoreConfigOptions

The PromoteRestoreConfig options.

Example request

curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/config?git_config_id=git_config_id&action=promote"
Copy to clipboard

Example request

promoteRestoreConfigOptions := appConfigurationService.NewPromoteRestoreConfigOptions(
  "git_config_id",
  "promote",
)

configAction, response, err := appConfigurationService.PromoteRestoreConfig(promoteRestoreConfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(configAction, "", "  ")
fmt.Println(string(b))
Copy to clipboard

Response

Response Body

One of

Change Schema Parameter List

Details of the promote operation.

ConfigAction

Change Schema Parameter List

Details of the promote operation.

Status Code

200
Successfully completed the operation.
400
Bad request. Verify that the information in the request body is complete and correct.
404
Not Found. Verify that the git config id is correct.
501
Not Implemented.

Example responses

Status 200

Example promote snapshot configuration.

{
  "last_sync_time": "2022-05-30T05:33:41Z",
  "git_commit_message": "custom config data written from App config instance",
  "git_commit_id": "2fadfe4e71632f32c19ee97d795f1494be95caf8"
}
Copy to clipboard

Success example

Example promote snapshot configuration.

{
  "last_sync_time": "2022-05-30T05:33:41Z",
  "git_commit_message": "custom config data written from App config instance",
  "git_commit_id": "2fadfe4e71632f32c19ee97d795f1494be95caf8"
}
Copy to clipboard

Status 200

Example restore snapshot configuration.

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "type": "NUMERIC",
          "tags": "pre-release, v1.2",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Success example

Example restore snapshot configuration.

{
  "environments": [
    {
      "name": "Dev",
      "environment_id": "dev",
      "description": "Environment created on instance creation",
      "tags": "",
      "color_code": "#FDD13A",
      "features": [
        {
          "name": "Cycle Rentals",
          "feature_id": "cycle-rentals",
          "type": "NUMERIC",
          "disabled_value": 2,
          "enabled_value": 1,
          "segment_rules": [],
          "enabled": true,
          "rollout_percentage": 100,
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ],
      "properties": [
        {
          "name": "Daily Discount",
          "property_id": "daily_discount",
          "type": "NUMERIC",
          "tags": "pre-release, v1.2",
          "value": "100",
          "segment_rules": [
            {
              "rules": [
                {
                  "segments": [
                    "khpwj68h"
                  ]
                }
              ],
              "value": 200,
              "order": 1
            },
            {
              "rules": [
                {
                  "segments": [
                    "khpwjol7"
                  ]
                }
              ],
              "value": 400,
              "order": 2
            }
          ],
          "collections": [
            {
              "collection_id": "web-app",
              "name": "web-app"
            }
          ],
          "isOverridden": true
        }
      ]
    }
  ],
  "segments": [
    {
      "name": "Testers",
      "segment_id": "khpwj68h",
      "description": "Testers",
      "tags": "test",
      "rules": [
        {
          "values": [
            "john@bluecharge.com",
            "alice@bluecharge.com"
          ],
          "operator": "is",
          "attribute_name": "email"
        }
      ]
    },
    {
      "name": "IBMers",
      "segment_id": "khpwjol7",
      "description": "IBMers",
      "tags": "company,ibm",
      "rules": [
        {
          "values": [
            "ibm.com"
          ],
          "operator": "endsWith",
          "attribute_name": "email"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 400

{
  "code": "FTEC1007E",
  "message": "Error while writing or updating the configuration to the json file."
}
Copy to clipboard

Error example

{
  "code": "FTEC1007E",
  "message": "Error while writing or updating the configuration to the json file."
}
Copy to clipboard

Status 404

{
  "code": "FTEC1000E",
  "message": "Error while updating the configuration. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Error example

{
  "code": "FTEC1000E",
  "message": "Error while updating the configuration. The queried resource 'git_config_id' is not available on the server."
}
Copy to clipboard

Status 501

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Error example

{
  "code": "FTEC1011E",
  "message": "Currently 'snapshot' feature is not available"
}
Copy to clipboard

Introduction

Before you begin

SDKs

Endpoint URLs

Authentication

Auditing

Error handling

Methods

Get list of Environments

Authorization

Auditing

Request

Query Parameters

expand

sort

tags

include

limit

offset

search

parameter

ctx

ListEnvironmentsOptions

Expand

Sort

Tags

Include

Limit

Offset

Search

Response

Response Body

environments

limit

offset

total_count

first

last

previous

next

EnvironmentList

Environments

Name

EnvironmentID

Description

Tags

ColorCode

CreatedTime

UpdatedTime

Href

Features

FeatureID

Name

Properties

PropertyID

Name

Snapshots

GitConfigID

Name

Limit

Offset

TotalCount

First

Href

Previous

Href

Next

Href

Last

Href

Status Code

200

401

Create Environment

Authorization

Auditing

Request

Request Body

name

environment_id