ConfigCat Public Management

Add or update Integration link

Create Config

This endpoint creates a new Config in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Create Environment

This endpoint creates a new Environment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Create Flag

This endpoint creates a new Feature Flag or Setting in a specified Config identified by the `configId` parameter. **Important:** The `key` attribute must be unique within the given Config.

Create Permission Group

This endpoint creates a new Permission Group in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Create Product

This endpoint creates a new Product in a specified Organization identified by the `organizationId` parameter, which can be obtained from the [List Organizations](#operation/get-organizations) endpoint.

Create Segment

This endpoint creates a new Segment in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Create Tag

This endpoint creates a new Tag in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

Delete Config

This endpoint removes a Config identified by the `configId` parameter.

Delete Environment

This endpoint removes an Environment identified by the `environmentId` parameter.

Delete Flag

This endpoint removes a Feature Flag or Setting from a specified Config, identified by the `configId` parameter.

Delete Integration link

Delete Member from Organization

This endpoint removes a Member identified by the `userId` from the given Organization identified by the `organizationId` parameter.

Delete Member from Product

This endpoint removes a Member identified by the `userId` from the given Product identified by the `productId` parameter.

Delete Permission Group

This endpoint removes a Permission Group identified by the `permissionGroupId` parameter.

Delete Product

This endpoint removes a Product identified by the `productId` parameter.

Delete Segment

This endpoint removes a Segment identified by the `segmentId` parameter.

Delete Tag

This endpoint deletes a Tag identified by the `tagId` parameter. To remove a Tag from a Feature Flag or Setting use the [Update Flag](#operation/update-setting) endpoint.

Get authenticated user details

Get Config

This endpoint returns the metadata of a Config identified by the `configId`.

Get Environment

This endpoint returns the metadata of an Environment identified by the `environmentId`.

Get Flag

This endpoint returns the metadata attributes of a Feature Flag or Setting identified by the `settingId` parameter.

Get Integration link

Get Permission Group

This endpoint returns the metadata of a Permission Group identified by the `permissionGroupId`.

Get Product

This endpoint returns the metadata of a Product identified by the `productId`.

Get SDK Key

This endpoint returns the SDK Key for your Config in a specified Environment.

Get Segment

This endpoint returns the metadata of a Segment identified by the `segmentId`.

Get Tag

This endpoint returns the metadata of a Tag identified by the `tagId`.

Get value

This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/).

Get value

This endpoint returns the value of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer" href="https://app.configcat.com/sdkkey">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/).

Get values

This endpoint returns the value of a specified Config's Feature Flags or Settings identified by the `configId` parameter in a specified Environment identified by the `environmentId` parameter. The most important attributes in the response are the `value`, `rolloutRules` and `percentageRules`. The `value` represents what the clients will get when the evaluation requests of our SDKs are not matching to any of the defined Targeting or Percentage Rules, or when there are no additional rules to evaluate. The `rolloutRules` and `percentageRules` attributes are representing the current Targeting and Percentage Rules configuration of the actual Feature Flag or Setting in an **ordered** collection, which means the order of the returned rules is matching to the evaluation order. You can read more about these rules [here](https://configcat.com/docs/advanced/targeting/).

Invite Member

This endpoint invites a Member into the given Product identified by the `productId` parameter.

jira-add-or-update-integration-link

List Audit log items for Organization

This endpoint returns the list of Audit log items for a given Organization and the result can be optionally filtered by Product and/or Config and/or Environment.

List Audit log items for Product

This endpoint returns the list of Audit log items for a given Product and the result can be optionally filtered by Config and/or Environment.

List Configs

This endpoint returns the list of the Configs that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

List Deleted Settings

This endpoint returns the list of Feature Flags and Settings that were deleted from the given Config.

List Environments

This endpoint returns the list of the Environments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

List Flags

This endpoint returns the list of the Feature Flags and Settings defined in a specified Config, identified by the `configId` parameter.

List Organization Members

This endpoint returns the list of Members that belongs to the given Organization, identified by the `organizationId` parameter.

List Organizations

This endpoint returns the list of the Organizations that belongs to the user.

List Permission Groups

This endpoint returns the list of the Permission Groups that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

List Product Members

This endpoint returns the list of Members that belongs to the given Product, identified by the `productId` parameter.

List Products

This endpoint returns the list of the Products that belongs to the user.

List Segments

This endpoint returns the list of the Segments that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.

List Settings by Tag

This endpoint returns the list of the Settings that has the specified Tag, identified by the `tagId` parameter.

List Tags

This endpoint returns the list of the Tags in a specified Product, identified by the `productId` parameter.

post_v1_code_references

post_v1_code_references_delete_reports

post_v1_jira_Connect

Replace value

This endpoint replaces the whole value of a Feature Flag or Setting in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means that it will reset. For example: We have the following resource. ``` { "rolloutPercentageItems": [ { "percentage": 30, "value": true }, { "percentage": 70, "value": false } ], "rolloutRules": [], "value": false } ``` If we send a replace request body as below: ``` { "value": true } ``` Then besides that the default value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ``` { "rolloutPercentageItems": [], "rolloutRules": [], "value": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targenting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.

Replace value

This endpoint replaces the value of a Feature Flag or Setting in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer" href="https://app.configcat.com/sdkkey">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change to its original state. Not listing one means that it will reset. For example: We have the following resource. ``` { "rolloutPercentageItems": [ { "percentage": 30, "value": true }, { "percentage": 70, "value": false } ], "rolloutRules": [], "value": false } ``` If we send a replace request body as below: ``` { "value": true } ``` Then besides that the default served value is set to `true`, all the Percentage Rules are deleted. So we get a response like this: ``` { "rolloutPercentageItems": [], "rolloutRules": [], "value": true } ```

Update Config

This endpoint updates a Config identified by the `configId` parameter.

Update Environment

This endpoint updates an Environment identified by the `environmentId` parameter.

Update Flag

This endpoint updates the metadata of a Feature Flag or Setting with a collection of [JSON Patch](http://jsonpatch.com) operations in a specified Config. Only the `name`, `hint` and `tags` attributes are modifiable by this endpoint. The `tags` attribute is a simple collection of the [tag IDs](#operation/get-tags) attached to the given setting. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ``` { "settingId": 5345, "key": "myGrandFeature", "name": "Tihs is a naem with soem typos.", "hint": "This flag controls my grandioso feature.", "settingType": "boolean", "tags": [ { "tagId": 0, "name": "sample tag", "color": "whale" } ] } ``` If we send an update request body as below (it changes the name and adds the already existing tag with the id 2): ``` [ { "op": "replace", "path": "/name", "value": "This is the name without typos." }, { "op": "add", "path": "/tags/-", "value": 2 } ] ``` Only the `name` and `tags` are going to be updated and all the other attributes are remaining unchanged. So we get a response like this: ``` { "settingId": 5345, "key": "myGrandFeature", "name": "This is the name without typos.", "hint": "This flag controls my grandioso feature.", "settingType": "boolean", "tags": [ { "tagId": 0, "name": "sample tag", "color": "whale" }, { "tagId": 2, "name": "another tag", "color": "koala" } ] } ```

Update Member Permissions

This endpoint adds a Member identified by the `userId` to one or more Permission Groups. This endpoint can also be used to move a Member between Permission Groups within a Product. Only a single Permission Group can be set per Product.

Update Permission Group

This endpoint updates a Permission Group identified by the `permissionGroupId` parameter.

Update Product

This endpoint updates a Product identified by the `productId` parameter.

Update Segment

This endpoint updates a Segment identified by the `segmentId` parameter.

Update Tag

This endpoint updates a Tag identified by the `tagId` parameter.

Update value

This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](http://jsonpatch.com) operations in a specified Environment. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource. ``` { "rolloutPercentageItems": [ { "percentage": 30, "value": true }, { "percentage": 70, "value": false } ], "rolloutRules": [], "value": false } ``` If we send an update request body as below: ``` [ { "op": "replace", "path": "/value", "value": true } ] ``` Only the default value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ``` { "rolloutPercentageItems": [ { "percentage": 30, "value": true }, { "percentage": 70, "value": false } ], "rolloutRules": [], "value": true } ``` The `rolloutRules` property describes two types of rules: - **Targeting rules**: When you want to add or update a targenting rule, the `comparator`, `comparisonAttribute`, and `comparisonValue` members are required. - **Segment rules**: When you want to add add or update a segment rule, the `segmentId` which identifies the desired segment and the `segmentComparator` members are required.

Update value

This endpoint updates the value of a Feature Flag or Setting with a collection of [JSON Patch](http://jsonpatch.com) operations in a specified Environment identified by the <a target="_blank" rel="noopener noreferrer" href="https://app.configcat.com/sdkkey">SDK key</a> passed in the `X-CONFIGCAT-SDKKEY` header. Only the `value`, `rolloutRules` and `percentageRules` attributes are modifiable by this endpoint. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. It supports collection reordering, so it also can be used for reordering the targeting rules of a Feature Flag or Setting. For example: We have the following resource. ``` { "rolloutPercentageItems": [ { "percentage": 30, "value": true }, { "percentage": 70, "value": false } ], "rolloutRules": [], "value": false } ``` If we send an update request body as below: ``` [ { "op": "replace", "path": "/value", "value": true } ] ``` Only the default served value is going to be set to `true` and all the Percentage Rules are remaining unchanged. So we get a response like this: ``` { "rolloutPercentageItems": [ { "percentage": 30, "value": true }, { "percentage": 70, "value": false } ], "rolloutRules": [], "value": true } ```