Get list of Environments

GET /apprapp/feature/v1/instances/{guid}/environments

List all the environments in the App Configuration service instance.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.environments.list

Auditing

Calling this method generates the following auditing event.

apprapp.environments.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

expand

boolean

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

sort

string

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

tags

string

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

include

array

Include feature, property, snapshots details in the response.

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.

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.

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

Response

200 - Successfully listed the environments.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Create Environment

POST /apprapp/feature/v1/instances/{guid}/environments

Create an environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.environments.create

Auditing

Calling this method generates the following auditing event.

apprapp.environments.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Environment

PUT /apprapp/feature/v1/instances/{guid}/environments/{environment_id}

Update an environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.environments.update

Auditing

Calling this method generates the following auditing event.

apprapp.environments.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

Environment Id

Query Parameters

Response

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the environment id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Environment

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}

Retrieve the details of the environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.environments.list

Auditing

Calling this method generates the following auditing event.

apprapp.environments.read

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

Environment Id

Query Parameters

expand

boolean

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

include

array

Include feature, property, snapshots details in the response.

Response

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

404 - Not Found. Verify that the environment id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Environment

DELETE /apprapp/feature/v1/instances/{guid}/environments/{environment_id}

Delete an Environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.environments.delete

Auditing

Calling this method generates the following auditing event.

apprapp.environments.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

Environment Id

Query Parameters

Response

202 - Accepted. Workflow approval initiated for the environment delete operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

GET /apprapp/feature/v1/instances/{guid}/collections

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

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.collections.list

Auditing

Calling this method generates the following auditing event.

apprapp.collections.list

Request

Path Parameters

guid

Required *

string

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

Response

200 - Successfully listed the collections.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Create Collection

POST /apprapp/feature/v1/instances/{guid}/collections

Create a collection.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.collections.create

Auditing

Calling this method generates the following auditing event.

apprapp.collections.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

Last updated time of the collection data.

href

string

Collection URL

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Collection

PUT /apprapp/feature/v1/instances/{guid}/collections/{collection_id}

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

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.collections.update

Auditing

Calling this method generates the following auditing event.

apprapp.collections.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

collection_id

Required *

string

Collection Id of the collection

Query Parameters

Response

Last updated time of the collection data.

href

string

Collection URL

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the collection id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Collection

GET /apprapp/feature/v1/instances/{guid}/collections/{collection_id}

Retrieve the details of the collection.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.collections.list

Auditing

Calling this method generates the following auditing event.

apprapp.collections.read

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

collection_id

Required *

string

Collection Id of the collection

Query Parameters

expand

boolean

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

include

array

Include feature, property, snapshots details in the response.

Response

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

404 - Not Found. Verify that the collection id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Collection

DELETE /apprapp/feature/v1/instances/{guid}/collections/{collection_id}

Delete the collection.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.collections.delete

Auditing

Calling this method generates the following auditing event.

apprapp.collections.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

collection_id

Required *

string

Collection Id of the collection

Query Parameters

Response

202 - Accepted. Workflow approval initiated for the collection delete operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

204 - Successfully deleted the specified collection.

404 - Not Found. Verify that the collection id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. Collection delete operation is already under workflow approval.

message

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Get list of Features

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features

List all the feature flags in the specified environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.list

Auditing

Calling this method generates the following auditing event.

apprapp.features.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

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

Response

200 - Successfully listed all the features.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Create Feature

POST /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features

Create a feature flag

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.create

Auditing

Calling this method generates the following auditing event.

apprapp.features.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

Environment Id

Query Parameters

Response

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

400 - Bad request. . Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Feature

PUT /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}

Update a feature flag details

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.update

Auditing

Calling this method generates the following auditing event.

apprapp.features.update

Request

Request Body

Feature Id

Query Parameters

Response

200 - Successfully updated the feature flag details

name

string

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

feature_id

string

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

description

string

Feature description

type

string

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

format

string

enabled_value

object

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

disabled_value

object

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

enabled

boolean

The state of the feature flag.

rollout_percentage

integer

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

WorkflowApprovalInfo

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Feature Values

PATCH /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}

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.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.patch

Auditing

Calling this method generates the following auditing event.

apprapp.features.updatevalues

Request

Request Body

Feature Id

Query Parameters

Response

200 - Successfully updated the feature values.

name

string

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

feature_id

string

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

description

string

Feature description

type

string

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

format

string

enabled_value

object

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

disabled_value

object

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

enabled

boolean

The state of the feature flag.

rollout_percentage

integer

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

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

202 - Accepted. Workflow approval initiated for the feature patch operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the feature id is correct.

code

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Feature

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}

Retrieve details of a feature.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.list

Auditing

Calling this method generates the following auditing event.

apprapp.features.read

Request

Feature Id

Query Parameters

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

404 - Not Found. Verify that the feature id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Feature

DELETE /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}

Delete a feature flag

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.delete

Auditing

Calling this method generates the following auditing event.

apprapp.features.delete

Request

Feature Id

Query Parameters

Response

202 - Accepted. Workflow approval initiated for the feature delete operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

204 - Successfully deleted the specified feature.

404 - Not Found. Verify that the feature id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. Feature delete operation is already under workflow approval, or the delete is blocked because the feature is being deleted from an environment that is not scoped for workflow, while another environment in the instance has an active workflow scope for this feature.

Toggle Feature

PUT /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/toggle

Toggle a feature.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features.toggle

Auditing

Calling this method generates the following auditing event.

apprapp.features.toggle

Request

Request Body

Feature Id

Query Parameters

Response

200 - Successfully toggled the specified feature.

name

string

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

feature_id

string

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

description

string

Feature description

type

string

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

format

string

enabled_value

object

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

disabled_value

object

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

enabled

boolean

The state of the feature flag.

rollout_percentage

integer

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

WorkflowApprovalInfo

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Stop Feature Rollout

PATCH /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rollout

Stop an in-progress rollout for a feature flag that is in a Progressive rollout state. The rollout is halted at the specified rollout percentage, which becomes the fixed percentage at which the feature is served until the rollout is reconfigured. This operation is not applicable to features in Manual rollout mode.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rollout-action.patch

Auditing

Calling this method generates the following auditing event.

apprapp.features.update

Request

Request Body

Feature Id

Query Parameters

Response

200 - Successfully stopped the in-progress rollout.

name

string

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

feature_id

string

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

description

string

Feature description

type

string

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

format

string

enabled_value

object

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

disabled_value

object

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

enabled

boolean

The state of the feature flag.

rollout_percentage

integer

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

WorkflowApprovalInfo

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Create Feature Rule

POST /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules

Create a rule for feature flag

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rules.create

Auditing

Calling this method generates the following auditing event.

apprapp.features-rules.create

Request

Request Body

Feature Id

Query Parameters

Response

rollout_configuration

Get All rules for feature

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules

Get all the rules for a feature flag in the specified environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rules.list

Auditing

Calling this method generates the following auditing event.

apprapp.features-rules.read

Request

Feature Id

Query Parameters

Response

200 - Successfully fetched the targeted rules.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Get rule for feature by rule id

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules/{rule_id}

Get the rule by rule id for the feature flag in the specified environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rules.list

Auditing

Calling this method generates the following auditing event.

apprapp.features-rules.read

Request

rule id

Query Parameters

Response

rollout_configuration

RolloutConfiguration

Configuration that controls the rollout behaviour for a Progressive or Guarded rollout type.

order

integer

Order of the rule, used during evaluation. The evaluation is performed in the order defined and the value associated with the first matching rule is used for evaluation.

href

string

Feature flag rule URL

401 - Unauthorized

message

string

The message describing the error.

Update Feature rule

PATCH /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules/{rule_id}

Update Feature rule.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rule.patch

Auditing

Calling this method generates the following auditing event.

apprapp.features-rule.patch

Request

Request Body

rule id

Query Parameters

Response

rollout_configuration

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the feature id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict occurred

message

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Delete Feature rule

DELETE /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules/{rule_id}

Delete a feature rule

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rules.delete

Auditing

Calling this method generates the following auditing event.

apprapp.features-rules.delete

Request

rule id

Query Parameters

Response

202 - Accepted. Workflow approval initiated for the feature rule delete operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

204 - Successfully deleted the specified rule.

404 - Not Found. Verify that the rule id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. Feature rule delete operation is already under workflow approval.

message

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Stop Feature Rule Rollout

PATCH /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules/{rule_id}/rollout

Stop an in-progress rollout for a specific rule of a feature flag that is in a Progressive rollout state. The rollout for the rule is halted at the specified rollout percentage, which becomes the fixed percentage at which the rule is evaluated until the rollout is reconfigured. This operation is not applicable to rules that are in Manual rollout mode.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rules-rollout-action.patch

Auditing

Calling this method generates the following auditing event.

apprapp.features.update

Request

Request Body

rule id

Query Parameters

Response

rollout_configuration

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the feature id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. Feature rule stop rollout operation is already under workflow approval.

message

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Update Feature rule order

PATCH /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/rules_order

Update Feature rule order.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.features-rules-order.patch

Auditing

Calling this method generates the following auditing event.

apprapp.features-rules-order.patch

Request

Request Body

Feature Id

Query Parameters

Response

200 - Successfully update the specified feature rule.

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

List Guarded Rollouts

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/guarded-rollouts

List all the guarded rollouts for the specified feature flag in the given environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.rollouts.list

Auditing

Calling this method generates the following auditing event.

apprapp.rollouts.list

Request

Feature Id

Query Parameters

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.

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.

Response

200 - Successfully listed all the guarded rollouts for the feature.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

400 - Bad Request. The server request does not contain proper values to complete the API request.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Guarded Rollout

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/guarded-rollouts/{rollout_id}

Get the details of a specific guarded rollout for a feature flag.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.rollouts.list

Auditing

Calling this method generates the following auditing event.

apprapp.rollouts.read

Request

Guarded rollout Id

Query Parameters

Response

200 - Successfully retrieved the guarded rollout details.

rollout_id

string

The unique identifier of the guarded rollout.

rule_id

string

The rule identifier associated with this guarded rollout.

array

Metrics monitored during the guarded rollout.

400 - Bad Request. The server request does not contain proper values to complete the API request.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Guarded Rollout Metric

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/features/{feature_id}/guarded-rollouts/{rollout_id}/metrics/{metric_id}

Get the metric details and statistical results for a specific metric of a guarded rollout.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.rollout-metric-timeseries.read

Auditing

Calling this method generates the following auditing event.

apprapp.rollout-metric-timeseries.read

Request

Metric ID

Query Parameters

Response

200 - Successfully retrieved the guarded rollout metric details.

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get list of Properties

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/properties

List all the properties in the specified environment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.properties.list

Auditing

Calling this method generates the following auditing event.

apprapp.properties.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

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

Response

200 - Successfully listed all the properties.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Create Property

POST /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/properties

Create a Property

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.properties.create

Auditing

Calling this method generates the following auditing event.

apprapp.properties.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

environment_id

Required *

string

Environment Id

Query Parameters

Response

Property URL.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Property

PUT /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/properties/{property_id}

Update a Property.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.properties.update

Auditing

Calling this method generates the following auditing event.

apprapp.properties.update

Request

Request Body

Property Id

Query Parameters

Response

200 - Successfully updated the property details.

name

string

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

property_id

string

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

description

string

Property description

type

string

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

WorkflowApprovalInfo

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Property values

PATCH /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/properties/{property_id}

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.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.properties.patch

Auditing

Calling this method generates the following auditing event.

apprapp.properties.updatevalues

Request

Request Body

Property Id

Query Parameters

Response

200 - Successfully updated the property values.

name

string

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

property_id

string

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

description

string

Property description

type

string

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

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

202 - Accepted. Workflow approval initiated for the property patch operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the property id is correct.

code

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Property

GET /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/properties/{property_id}

Retrieve details of a property.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.properties.list

Auditing

Calling this method generates the following auditing event.

apprapp.properties.read

Request

Property Id

Query Parameters

include

array

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

Response

200 - Successfully retrieved the property details.

name

string

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

property_id

string

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

description

string

Property description

type

string

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

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

404 - Not Found. Verify that the property id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Property

DELETE /apprapp/feature/v1/instances/{guid}/environments/{environment_id}/properties/{property_id}

Delete a Property

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.properties.delete

Auditing

Calling this method generates the following auditing event.

apprapp.properties.delete

Request

Property Id

Query Parameters

Response

202 - Accepted. Workflow approval initiated for the property delete operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

204 - Successfully deleted the specified property

404 - Not Found. Verify that the property id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. Property delete operation is already under workflow approval, or the delete is blocked because the property is being deleted from an environment that is not scoped for workflow, while another environment in the instance has an active workflow scope for this property.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get list of Segments

GET /apprapp/feature/v1/instances/{guid}/segments

List all the segments

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.segments.list

Auditing

Calling this method generates the following auditing event.

apprapp.segments.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

expand

boolean

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

sort

string

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

tags

string

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

include

array

Segment details to include the associated rules in the response.

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.

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.

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

Response

200 - Successfully listed all the segments.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Create Segment

POST /apprapp/feature/v1/instances/{guid}/segments

Create a segment.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.segments.create

Auditing

Calling this method generates the following auditing event.

apprapp.segments.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

List of properties associated with the segment.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Segment

PUT /apprapp/feature/v1/instances/{guid}/segments/{segment_id}

Update the segment properties

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.segments.update

Auditing

Calling this method generates the following auditing event.

apprapp.segments.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

segment_id

Required *

string

Segment Id

Query Parameters

Response

200 - Successfully updated the segment details.

name

string

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

segment_id

string

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

description

string

Segment description

tags

string

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

WorkflowApprovalInfo

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Get Segment

GET /apprapp/feature/v1/instances/{guid}/segments/{segment_id}

Retrieve details of a segment

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.segments.list

Auditing

Calling this method generates the following auditing event.

apprapp.segments.read

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

segment_id

Required *

string

Segment Id

Query Parameters

include

array

Include feature and property details in the response.

Response

200 - Successfully retrieved the segment details.

name

string

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

segment_id

string

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

description

string

Segment description

tags

string

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

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

404 - Not Found. Verify that the segment id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Segment

DELETE /apprapp/feature/v1/instances/{guid}/segments/{segment_id}

Delete a segment

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.segments.delete

Auditing

Calling this method generates the following auditing event.

apprapp.segments.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

segment_id

Required *

string

Segment Id

Query Parameters

Response

202 - Accepted. Workflow approval initiated for the segment delete operation.

message

string

Message describing the workflow approval initiation. Message varies based on resource type and operation.

workflow_approval

WorkflowApprovalDetails

Details of the workflow approval.

204 - Successfully deleted the specified segment.

404 - Not Found. Verify that the segment id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. Segment delete operation is already under workflow approval.

message

string

Message describing the conflict. Format varies by resource type and operation.

workflow_approval

WorkflowApprovalInfo

Workflow approval information attached to a resource when it's under approval. This field is only present when workflow is enabled and the resource has an active change request.

Get list of Git configs

GET /apprapp/feature/v1/instances/{guid}/gitconfigs

List all the Git configs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.view

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.list

Request

Path Parameters

guid

Required *

string

string

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

Response

200 - Successfully listed all the git configurations.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Create Git config

POST /apprapp/feature/v1/instances/{guid}/gitconfigs

Create a Git config.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.create

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

Git config URL.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Git Config

PUT /apprapp/feature/v1/instances/{guid}/gitconfigs/{git_config_id}

Update the gitconfig properties

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.update

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

git_config_id

Required *

string

Git Config Id

Query Parameters

Response

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Git Config

GET /apprapp/feature/v1/instances/{guid}/gitconfigs/{git_config_id}

Retrieve details of a gitconfig

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.view

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.read

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

git_config_id

Required *

string

Git Config Id

Query Parameters

Response

Last modified time of the git config data.

href

string

Git config URL.

404 - Not Found. Verify that the gitconfig id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Git Config

DELETE /apprapp/feature/v1/instances/{guid}/gitconfigs/{git_config_id}

Delete a gitconfig

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.delete

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

git_config_id

Required *

string

Git Config Id

Query Parameters

Response

204 - Successfully deleted the specified gitconfig.

404 - Not Found. Verify that the gitconfig id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

501 - Not Implemented.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Promote configuration

PUT /apprapp/feature/v1/instances/{guid}/gitconfigs/{git_config_id}/promote

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

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.promote

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.promote

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

git_config_id

Required *

string

Git Config Id

Query Parameters

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Restore configuration

PUT /apprapp/feature/v1/instances/{guid}/gitconfigs/{git_config_id}/restore

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.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.gitconfigs.restore

Auditing

Calling this method generates the following auditing event.

apprapp.snapshots.restore

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

git_config_id

Required *

string

Git Config Id

Query Parameters

Response

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get list of integrations

GET /apprapp/feature/v1/instances/{guid}/integrations

List all the integrations.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.integrations.list

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

expand

boolean

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

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.

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.

Response

200 - Successfully listed the integrations.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

Create integration

POST /apprapp/feature/v1/instances/{guid}/integrations

Create an integration with App Configuration service instance.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.integrations.create

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

201 - Successfully created the integration

integration_id

string

Integration id.

integration_type

string

Integration type.

metadata

object

created_time

string

Creation time of the integration.

updated_time

string

Last updated time of the integration.

href

string

Integration URL

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get integration

GET /apprapp/feature/v1/instances/{guid}/integrations/{integration_id}

Retrieve the details of the integration

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.integrations.list

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.read

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

integration_id

Required *

string

Integration Id of the integration

Query Parameters

Response

200 - Successfully retrived the integration details

integration_id

string

Integration id.

integration_type

string

Integration type.

metadata

object

created_time

string

Creation time of the integration.

updated_time

string

Last updated time of the integration.

href

string

Integration URL

404 - Not Found. Verify that the integration id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete integration

DELETE /apprapp/feature/v1/instances/{guid}/integrations/{integration_id}

Delete an integration

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.integrations.delete

Auditing

Calling this method generates the following auditing event.

apprapp.integrations.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

integration_id

Required *

string

Integration Id of the integration

Query Parameters

Response

204 - Successfully deleted the integration.

404 - Not Found. Verify that the integration id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get list of Origin Configs

GET /apprapp/feature/v1/instances/{guid}/originconfigs

List all the Origin Configs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.originconfigs.list

Auditing

Calling this method generates the following auditing event.

apprapp.originconfigs.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully listed all the origin configuration.

allowed_origins

array

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

created_time

string

Creation time of the origin configs.

updated_time

string

Last modified time of the origin configs.

href

string

Origin Config URL.

401 - Unauthorized

message

string

The message describing the error.

Update Origin Configs

PUT /apprapp/feature/v1/instances/{guid}/originconfigs

Update the Origin Configs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.originconfigs.update

Auditing

Calling this method generates the following auditing event.

apprapp.originconfigs.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully updated the origin configs details.

allowed_origins

array

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

created_time

string

Creation time of the origin configs.

updated_time

string

Last modified time of the origin configs.

href

string

Origin Config URL.

404 - Not Found. Verify that the instance id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

List Workflow Config

GET /apprapp/feature/v1/instances/{guid}/workflow/configs

List workflow configs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.list

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

sort

string

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

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

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.

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.

Response

200 - Successfully listed workflow configurations.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized

message

string

The message describing the error.

403 - Forbidden Request - Requested feature is not supported for instance type 'lite' / 'standard'

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Create Approval Workflow config

POST /apprapp/feature/v1/instances/{guid}/workflow/configs

Create a Approval Workflow.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.create

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

URL to access this workflow configuration.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

get single Approval Workflow Config

GET /apprapp/feature/v1/instances/{guid}/workflow/configs/{workflow_config_id}

get single approval workflow configs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.list

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

workflow_config_id

Required *

string

id of workflow configuration

Query Parameters

Response

URL to access this workflow configuration.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the workflow_config_id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Approval Workflow config

PUT /apprapp/feature/v1/instances/{guid}/workflow/configs/{workflow_config_id}

Update a Approval Workflow.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.update

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

workflow_config_id

Required *

string

id of workflow configuration

Query Parameters

Response

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Approval Workflow config

DELETE /apprapp/feature/v1/instances/{guid}/workflow/configs/{workflow_config_id}

Delete a Approval Workflow config

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.delete

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

workflow_config_id

Required *

string

id of workflow configuration

Query Parameters

Response

204 - Successfully deleted environment specific workflow config.

401 - Unauthorized

message

string

The message describing the error.

403 - Forbidden Request - Requested feature is not supported for instance type 'lite' / 'standard'

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the workflow_config_id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Toggle Approval Workflow config

PUT /apprapp/feature/v1/instances/{guid}/workflow/configs/{workflow_config_id}/toggle

Toggle a Approval Workflow.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.toggle

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.toggle

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

workflow_config_id

Required *

string

id of workflow configuration

Query Parameters

Response

URL to access this workflow configuration.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. Verify that the workflow_config_id is correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Test an Approval Workflow config

POST /apprapp/feature/v1/instances/{guid}/workflow/configs/{workflow_config_id}/test

Test a Workflow.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.workflow-configs.create

Auditing

Calling this method generates the following auditing event.

apprapp.workflow-configs.create

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

workflow_config_id

Required *

string

id of workflow configuration

Query Parameters

Response

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Import instance configuration

POST /apprapp/feature/v1/instances/{guid}/config

Import configuration to the instance.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config.import

Auditing

Calling this method generates the following auditing event.

apprapp.config.import

Request

Request Body

Path Parameters

guid

Required *

string

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Export instance configuration

GET /apprapp/feature/v1/instances/{guid}/config

Get the instance configuration.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config.export

Auditing

Calling this method generates the following auditing event.

apprapp.config.export

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully listed configuration for the instance.

environments

array

Array will contain features and properties per environment

collections

array

Array will contain collections details

segments

array

Array will contain segments details

202 - Export request accepted for asynchronous processing

message

string

The message describing the request status.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Promote or Restore snapshot configuration

PUT /apprapp/feature/v1/instances/{guid}/config

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.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config.action

Auditing

Calling this method generates the following auditing event.

apprapp.config.action

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

git_config_id

Required *

string

Git Config Id.

action

Required *

Promote configuration to Git or Restore configuration from Git.

Response

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get status of instance configuration import/export

GET /apprapp/feature/v1/instances/{guid}/config/status/{reference_id}

Get the status of instance configuration operation

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config.status

Auditing

Calling this method generates the following auditing event.

apprapp.config.status

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

reference_id

Required *

string

AppConfiguration config status reference id

Query Parameters

action

Required *

The type of config status that is to be fetched.

Response

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get list of Metrics

GET /apprapp/feature/v1/instances/{guid}/metrics

List all the metrics in the App Configuration service instance.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.metrics.list

Auditing

Calling this method generates the following auditing event.

apprapp.metrics.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

expand

boolean

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

include

array

Include experiments and/or guarded rollouts details in the response.

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

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.

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.

sort

string

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

Response

200 - Successfully listed the metrics.

URL to navigate to the next list of records.

last

PaginatedListLast

URL to navigate to the last page of records.

401 - Unauthorized. The request could not be authorized.

message

string

The message describing the error.

Create Metric

POST /apprapp/feature/v1/instances/{guid}/metrics

Create a metric in the App Configuration service instance.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.metrics.create

Auditing

Calling this method generates the following auditing event.

apprapp.metrics.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

Last modified time of the metric.

href

string

The URL of the metric.

400 - Bad Request. Missing or invalid field, invalid JSON, or is_favorite supplied.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Not Found. The instance is not found.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

409 - Conflict. A metric with this metric_id already exists.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get Metric

GET /apprapp/feature/v1/instances/{guid}/metrics/{metric_id}

Get the details of a specific metric.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.metrics.list

Auditing

Calling this method generates the following auditing event.

apprapp.metrics.read

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

metric_id

Required *

string

Metric ID

Query Parameters

include

array

Include experiments and/or guarded rollouts details in the response.

Response

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update Metric

PUT /apprapp/feature/v1/instances/{guid}/metrics/{metric_id}

Update a metric.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.metrics.update

Auditing

Calling this method generates the following auditing event.

apprapp.metrics.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

metric_id

Required *

string

Metric ID

Query Parameters

Response

Last modified time of the metric.

href

string

The URL of the metric.

400 - Bad Request. Missing or invalid field, or metric cannot be updated due to active experiments or guarded rollouts.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Delete Metric

DELETE /apprapp/feature/v1/instances/{guid}/metrics/{metric_id}

Delete a metric from the App Configuration service instance.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.metrics.delete

Auditing

Calling this method generates the following auditing event.

apprapp.metrics.delete

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

metric_id

Required *

string

Metric ID

Query Parameters

Response

204 - Successfully deleted the metric.

400 - Bad Request. The metric is currently used by a running experiment.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Set Metric Favorite Status

PATCH /apprapp/feature/v1/instances/{guid}/metrics/{metric_id}/favorite

Mark or unmark a metric as favorite.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.metrics.patch

Auditing

Calling this method generates the following auditing event.

apprapp.metrics.patch

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

metric_id

Required *

string

Metric ID

Query Parameters

Response

Last modified time of the metric.

href

string

The URL of the metric.

400 - Bad Request. Missing is_favorite field or invalid JSON.

code

string

The error code returned by the server.

message

string

The message describing the error.

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

List configurations

GET /apprapp/config_aggregator/v1/instances/{guid}/configs

Retrieve the list of resource configurations collected as part of Configuration Aggregator.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator.query

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator.query

Request

Path Parameters

guid

Required *

string

200 - Successfully retrieved the resource configurations.

total_count

integer

The total number of resources present.

limit

integer

The maximum number of resources retrieved per page.

first

PaginatedFirst

array

The array with at least one error.

trace

string

The lowercase UUID uniquely that identifies the request.

status_code

integer

the status code of the response

List configurations for set of crn(s)

POST /apprapp/config_aggregator/v1/instances/{guid}/configs/query

List the resource configurations (requested for set of CRNs) collected as part of Configuration Aggregator.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator.filter

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator.filter

Request

Request Body

ListConfigsQueryRequest

configs

Required *

array

The List of resources requested as part of List Configs Query API.

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

limit

integer

The number of resources to return on the page.

start

string

The starting resource for the page, obtained from a previous list request. If unspecified, the first resource will be returned.

Response

200 - Successfully retrieved the resource configurations for requested CRN(s) and reported errors for CRN(s) not found.

total_count

integer

The total number of resources present.

limit

integer

The maximum number of resources retrieved per page.

first

PaginatedFirst

The reference to the first page of entries.

PaginatedPrevious

PUT /apprapp/config_aggregator/v1/instances/{guid}/settings

Update resource aggregation settings.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-settings.update

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-settings.update

Request

Request Body

UpdateSettings

The request payload to update settings.

resource_collection_enabled

boolean

The field denoting if the resource collection is enabled

realtime_config_enabled

boolean

The field denoting if the realtime collection is enabled

trusted_profile_id

string

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

regions

array

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

additional_scope

array

The additional scope that enables resource collection for Enterprise acccounts.

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully updated the Configuration Aggregator settings.

resource_collection_enabled

boolean

The field to check if the resource collection is enabled

realtime_config_enabled

boolean

The field to check if the resource collection is enabled

trusted_profile_id

the status code of the response

Get settings

GET /apprapp/config_aggregator/v1/instances/{guid}/settings

Retrieve settings for resource collection in Configuration Aggregator.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-settings.list

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-settings.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully retrieved the settings of Configuration Aggregator.

resource_collection_enabled

boolean

The field to check if the resource collection is enabled

realtime_config_enabled

boolean

The field to check if the resource collection is enabled

trusted_profile_id

the status code of the response

Get resource collection status

GET /apprapp/config_aggregator/v1/instances/{guid}/resource_collection_status

Retrieve the status of the resource collection as part of Configuration Aggregator.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-status.list

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-status.list

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully retrieved the configuration aggregator status.

last_config_refresh_time

the status code of the response

Manual reconcile

POST /apprapp/config_aggregator/v1/instances/{guid}/reconcile

Manually trigger the recording of the Configuration items as part of Configuration Aggregator.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator.reconcile

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator.reconcile

Request

Request Body

ReconcileRequest

resource_crns

Required *

array

Specific resource CRNs to reconcile (maximum ~20). The resource CRNs should be the instance CRN of the service. Subresource CRNs (such as a Secrets Manager secret) are not supported.

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Query configs

POST /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/query

Retrieve config details based on the intent from user's query and generate response using large language model.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp.query

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp.query

Request

Request Body

Path Parameters

guid

Required *

The response message generated for the resource query.

total_count

integer

The total number of resources present.

limit

integer

The maximum number of resources retrieved per page.

first

PaginatedFirst

The reference to the first page of entries.

PaginatedPrevious

The reference to the previous page of entries. If absent, this is the first page

PaginatedNext

The reference to the next page of entries. If absent, this is the last page

configs

array

The resource details retrieved as a response to the query.

remarks

string

Any additional data related to the response.

llm_tokens_used

integer

The total number of LLM tokens used during the query.

response_score

number

A score between 0.0 and 1.0 indicating the system's confidence in the accuracy or completeness of the resource.

history_id

string

A unique identifier.

401 - Unauthorized

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

List chat history

GET /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/history

Retrieve the chat history for the NLP resource query.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-history.query

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-history.query

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

200 - Successfully retrieved the chat history.

total_count

integer

The total number of chat history entries present.

chats

array

The list of chat history entries.

401 - Unauthorized

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Create chat history

POST /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/history

Create a new chat history entry for the NLP resource query.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-history.create

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-history.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Update chat history

PUT /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/history

Update or rename an existing chat history entry for the NLP resource query.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-history.update

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-history.update

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

List jobs

GET /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/jobs

Get all jobs for NLP resource query.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-jobs.query

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-jobs.query

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

sub_account

string

Filter jobs by the sub-account in an enterprise hierarchy.

status

string

Filter jobs by their current status.

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.

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.

Response

200 - Successfully retrieved the jobs.

total_count

integer

The total number of job entries present.

jobs

array

The list of job entries.

401 - Unauthorized

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Create job

POST /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/jobs

Create a new job to process NLP resource query asynchronously.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-jobs.create

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-jobs.create

Request

Request Body

Path Parameters

guid

Required *

string

AppConfiguration instance Id

Query Parameters

Response

The timestamp when the job was updated.

completed_at

string

The timestamp when the job was completed.

400 - Bad request. Verify that the information in the request body is complete and correct.

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

401 - Unauthorized

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Get job

GET /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/jobs/{job_id}

Retrieve the detail of a specific job by its ID.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-job.query

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-job.query

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

job_id

Required *

The unique identifier of the job.

Query Parameters

Response

The timestamp when the job was updated.

completed_at

string

The timestamp when the job was completed.

401 - Unauthorized

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Job not found

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

Download job result

GET /apprapp/config_aggregator/v1/instances/{guid}/nlp_resource_query/jobs/{job_id}/result

Download the result file of a completed job.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

apprapp.config-aggregator-nlp-job-result.query

Auditing

Calling this method generates the following auditing event.

apprapp.config-aggregator-nlp-job-result.query

Request

Path Parameters

guid

Required *

string

AppConfiguration instance Id

job_id

Required *

The unique identifier of the job.

Query Parameters

Response

200 - Successfully retrieved the job result. Returns a binary file download. The content is a JSON array of resource objects for JSON jobs, or CSV-formatted data for CSV jobs

401 - Unauthorized

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.

404 - Job not found or result not available

code

string

The error code returned by the server.

message

string

The message describing the error.

trace

string

The unique transaction identifier of the request, which can be shared with IBM support for troubleshooting.