Feature Flags

APIs to create and manage Feature Flags

Returns all Feature Flags for the project

Returns all the Feature Flag details for the given project

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
environmentIdentifier	string Environment
pageNumber	integer PageNumber
pageSize	integer PageSize
sortOrder	string SortOrder Enum: "ASCENDING" "DESCENDING"
sortByField	string SortByField Enum: "name" "identifier" "archived" "kind" "modifiedAt"
name	string Name of the field
identifier	string Identifier of the field
archived	boolean Status of the feature flag
kind	string Kind of the feature flag Enum: "json" "string" "int" "boolean"
targetIdentifier	string Identifier of a target
targetIdentifierFilter	string Identifier of the target to filter on
metrics	boolean Parameter to indicate if metrics data is requested in response
featureIdentifiers	string Comma separated identifiers for multiple Features
excludedFeatures	string Comma separated identifiers to exclude from the response
status	string Filter for flags based on their status (active,never-requested,recently-accessed,potentially-stale)
lifetime	string Filter for flags based on their lifetime (permanent/temporary)
enabled	boolean Filter for flags based on if they are enabled or disabled
flagCounts	boolean Returns counts for the different types of flags e.g num active, potentially-stale, recently-accessed etc
summary	boolean Returns summary info on flags if set to true
tags	string Filter for flags based on their tag values supplied as comma separated list

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/features

Request samples

curl
Java
Go

Response samples

application/json

{"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1,
"version": 5,
"featureCounts": {"totalActive": 5,
"totalAnomaly": 4,
"totalArchived": 10,
"totalEnabled": 2,
"totalFeatures": 10,
"totalPermanent": 7,
"totalPotentiallyStale": 3,
"totalRecentlyAccessed": 2
},
"features": [{"archived": false,
"createdAt": 0,
"defaultOffVariation": true,
"defaultOnVariation": true,
"description": "A flag to control a new feature in production",
"envProperties": {"ccm": {"anomalies": [{"acknowledgedAt": 0,
"anomalyId": "123456",
"costDifference": 123,
"createdAt": 0,
"foundAt": 0,
"isAcknowledged": false,
"status": "found"
}
],
"perspectiveIdentifier": "123456",
"perspectiveName": "myCluster"
},
"defaultServe": {"distribution": {"bucketBy": "string",
"variations": [{"variation": null,
"weight": null
}
]
},
"variation": "string"
},
"environment": "string",
"jiraEnabled": true,
"jiraIssues": [{"issueKey": "FFM-7777",
"issueURL": "https://harness-dev1.atlassian.net"
}
],
"modifiedAt": 0,
"offVariation": "string",
"pipelineConfigured": true,
"pipelineDetails": {"createdAt": 0,
"description": "string",
"identifier": "string",
"lastUpdatedAt": 0,
"name": "string"
},
"pipelineErrorReason": "string",
"pipelineErrorState": true,
"rules": [{"clauses": [{"attribute": null,
"id": null,
"negate": null,
"op": null,
"values": [ ]
}
],
"priority": 1,
"ruleId": "string",
"serve": {"distribution": {"bucketBy": null,
"variations": [ ]
},
"variation": "string"
}
}
],
"state": "on",
"variationMap": [{"targetSegments": ["string"
],
"targets": [{"identifier": null,
"name": null
}
],
"variation": "off-variation"
}
],
"version": 0
},
"evaluation": true,
"evaluationIdentifier": "on-variation",
"identifier": "bool-flag",
"kind": "boolean",
"modifiedAt": 0,
"name": "My Boolean Flag",
"owner": "johndoe",
"permanent": true,
"prerequisites": [{"feature": "string",
"variations": ["string"
]
}
],
"project": "test-project",
"results": [{"count": 0,
"variationIdentifier": "defaultOnVariation",
"variationName": "Default On Variation"
}
],
"services": [{"identifier": "string",
"name": "string"
}
],
"stale": false,
"staleReason": "matched-criteria",
"status": {"lastAccess": 0,
"status": "active"
},
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"variations": [{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
},
{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
}
]
}
]
}

Creates a Feature Flag

Creates a Feature Flag in the Project

Securityx-api-key

Request

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org

Request Body schema: application/json

archived	boolean
defaultOffVariation required	string
defaultOnVariation required	string
description	string
	object (CfGitDetails) The commit message to use as part of a gitsync operation
identifier required	string
kind required	string (FeatureFlagRequestKind) Enum: "boolean" "int" "string" "json"
name required	string
owner	string
permanent required	boolean
	Array of objects (Prerequisite)
project required	string
	Array of objects (CfService)
	Array of objects (Tag)
required	Array of objects (Variation) >= 2 items

Responses

201

400

Bad request

401

Unauthenticated

403

Unauthorized

409

The specified resource already exists

424

An error with git syncing

500

Internal server error

post/cf/admin/features

Request samples

Payload
curl
Java
Go

application/json

{"archived": true,
"defaultOffVariation": "string",
"defaultOnVariation": "string",
"description": "string",
"gitDetails": {"commitMsg": "Turning on flag test-flag for production"
},
"identifier": "string",
"kind": "boolean",
"name": "string",
"owner": "string",
"permanent": true,
"prerequisites": [{"feature": "string",
"variations": ["string"
]
}
],
"project": "string",
"services": [{"identifier": "string",
"name": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"variations": [{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
},
{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
}
]
}

Response samples

application/json

{"details": {"governanceMetadata": { },
"pipelineMetadata": {"pipelineExecutionId": "string",
"pipelineTriggered": true
}
}
}

Delete a Feature Flag

Delete Feature Flag for the given identifier and account ID

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
commitMsg	string Git commit message
forceDelete	boolean Permanently deletes the the feature flag

Responses

204

No content

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

424

An error with git syncing

500

Internal server error

delete/cf/admin/features/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"code": 404,
"details": { },
"message": "Error retrieving projects, organization 'default_org' does not exist"
}

Returns a Feature Flag

Returns details such as Variation name, identifier etc for the given Feature Flag

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
environmentIdentifier	string Environment
metrics	boolean Parameter to indicate if metrics data is requested in response
archived	boolean Status of the feature flag

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/features/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"archived": false,
"createdAt": 0,
"defaultOffVariation": true,
"defaultOnVariation": true,
"description": "A flag to control a new feature in production",
"envProperties": {"ccm": {"anomalies": [{"acknowledgedAt": 0,
"anomalyId": "123456",
"costDifference": 123,
"createdAt": 0,
"foundAt": 0,
"isAcknowledged": false,
"status": "found"
}
],
"perspectiveIdentifier": "123456",
"perspectiveName": "myCluster"
},
"defaultServe": {"distribution": {"bucketBy": "string",
"variations": [{"variation": "off-variation",
"weight": 50
}
]
},
"variation": "string"
},
"environment": "string",
"jiraEnabled": true,
"jiraIssues": [{"issueKey": "FFM-7777",
"issueURL": "https://harness-dev1.atlassian.net"
}
],
"modifiedAt": 0,
"offVariation": "string",
"pipelineConfigured": true,
"pipelineDetails": {"createdAt": 0,
"description": "string",
"identifier": "string",
"lastUpdatedAt": 0,
"name": "string"
},
"pipelineErrorReason": "string",
"pipelineErrorState": true,
"rules": [{"clauses": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": ["string"
]
}
],
"priority": 1,
"ruleId": "string",
"serve": {"distribution": {"bucketBy": "string",
"variations": [{"variation": null,
"weight": null
}
]
},
"variation": "string"
}
}
],
"state": "on",
"variationMap": [{"targetSegments": ["string"
],
"targets": [{"identifier": "string",
"name": "string"
}
],
"variation": "off-variation"
}
],
"version": 0
},
"evaluation": true,
"evaluationIdentifier": "on-variation",
"identifier": "bool-flag",
"kind": "boolean",
"modifiedAt": 0,
"name": "My Boolean Flag",
"owner": "johndoe",
"permanent": true,
"prerequisites": [{"feature": "string",
"variations": ["string"
]
}
],
"project": "test-project",
"results": [{"count": 0,
"variationIdentifier": "defaultOnVariation",
"variationName": "Default On Variation"
}
],
"services": [{"identifier": "string",
"name": "string"
}
],
"stale": false,
"staleReason": "matched-criteria",
"status": {"lastAccess": 0,
"status": "active"
},
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"variations": [{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
},
{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
}
]
}

Updates a Feature Flag

This operation is used to modify a Feature Flag. The request body can include one or more instructions that can modify flag attributes such as the state (off|on), the variations that are returned and serving rules. For example if you want to turn a flag off you can use this opeartion and send the setFeatureFlagState

{ "kind": "setFeatureFlagState", "parameters": { "state": "off" } }

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
environmentIdentifier	string Environment

Request Body schema: application/json

comment	string A comment explaining the reason for this patch operation
executionTime	integer Time of execution in unix epoch milliseconds when the scheduled changes will be applied
	object (CfGitDetails) The commit message to use as part of a gitsync operation
required	Array of objects (PatchInstruction) A list of Patch Instructions

Responses

200

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

409

The specified resource already exists

424

An error with git syncing

500

Internal server error

patch/cf/admin/features/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"gitDetails": {"commitMsg": "Making some changes"
},
"instructions": [{"kind": "updateName",
"parameters": {"name": "Updated Name"
}
},
{"kind": "updateDescription",
"parameters": {"description": "Updated Description"
}
},
{"kind": "addPrerequisite",
"parameters": {"feature": "feature1",
"variations": ["variation1",
"variation2"
]
}
},
{"kind": "updatePrerequisite",
"parameters": {"feature": "feature1",
"variations": ["variation1"
]
}
},
{"kind": "removePrerequisite",
"parameters": {"feature": "feature1"
}
},
{"kind": "addVariation",
"parameters": {"description": "Variation 1 description",
"identifier": "variation_1",
"name": "variation1",
"value": "v1"
}
},
{"kind": "updateVariation",
"parameters": {"description": "Variation 1 description",
"identifier": "variation_1",
"name": "variation1",
"value": "v1"
}
},
{"kind": "deleteVariation",
"parameters": {"identifier": "variation_1"
}
},
{"kind": "setDefaultOnVariation",
"parameters": {"identifier": "variation_1"
}
},
{"kind": "setDefaultOffVariation",
"parameters": {"identifier": "variation_1"
}
},
{"kind": "addTag",
"parameters": {"name": "TagName",
"value": "TagValue"
}
},
{"kind": "updateTag",
"parameters": {"name": "TagName",
"value": "TagValue"
}
},
{"kind": "removeTag",
"parameters": {"name": "TagName",
"value": "TagValue"
}
},
{"kind": "setFeatureFlagState",
"parameters": {"state": "on"
}
},
{"kind": "setFeatureFlagState",
"parameters": {"state": "off"
}
},
{"kind": "addTargetsToVariationTargetMap",
"parameters": {"targets": ["target1-identifier",
"target2-identifier"
],
"variation": "variation-identifier"
}
},
{"kind": "removeTargetsToVariationTargetMap",
"parameters": {"targets": ["target1-identifier",
"target2-identifier"
],
"variation": "variation-identifier"
}
},
{"kind": "addSegmentToVariationTargetMap",
"parameters": {"targetSegments": ["segment1",
"segment2"
],
"variation": "variation-identifier"
}
},
{"kind": "removeSegmentToVariationTargetMap",
"parameters": {"targetSegments": ["segment3",
"segment4"
],
"variation": "variation-identifier"
}
},
{"kind": "clearVariationTargetMapping",
"parameters": {"variation": "variation-identifier"
}
},
{"kind": "addRule",
"parameters": {"clauses": [{"attribute": "email",
"op": "eq",
"values": ["user1@gmail.com",
"user2@gmail.com"
]
}
],
"priority": 1,
"serve": {"variation": "variation1"
},
"uuid": "fd2ebf1f-7efb-4324-a7ee-6de0a47bf826"
}
},
{"kind": "removeRule",
"parameters": {"ruleID": "testRuleID"
}
},
{"kind": "addClause",
"parameters": {"clause": {"attribute": "email",
"op": "eq",
"values": ["user1@gmail.com",
"user2@gmail.com"
]
},
"ruleID": "testRuleID"
}
},
{"kind": "removeClause",
"parameters": {"clauseID": "testClauseID",
"ruleID": "testRuleID"
}
},
{"kind": "updateClause",
"parameters": {"clause": [{"attribute": "email",
"op": "eq",
"values": ["user1@gmail.com",
"user2@gmail.com"
]
}
],
"clauseID": "testClauseID",
"ruleID": "testRuleID"
}
},
{"kind": "reorderRules",
"parameters": {"rules": ["rule1",
"rule2",
"rule3"
]
}
},
{"kind": "updateDefaultServe",
"parameters": {"bucketBy": "accountID",
"variations": [{"variation": "variation1",
"weight": 30
},
{"variation": "variation2",
"weight": 60
},
{"variation": "variation3",
"weight": 10
}
]
}
},
{"kind": "updateRule",
"parameters": {"ruleID": "testRuleID",
"variation": "variation1"
}
},
{"kind": "updateRule",
"parameters": {"bucketBy": "accountID",
"ruleID": "testRuleID",
"variations": [{"variation": "variation1",
"weight": 30
},
{"variation": "variation2",
"weight": 60.66
},
{"variation": "variation3",
"weight": 10.01
}
]
}
},
{"kind": "updateDefaultServe",
"parameters": {"variation": "variation1"
}
},
{"kind": "updateOffVariation",
"parameters": {"variation": "variation1"
}
},
{"Kind": "updateArchived",
"parameters": {"archived": true
}
},
{"Kind": "updatePermanent",
"parameters": {"permanent": true
}
}
]
}

Response samples

application/json

{"details": {"governanceMetadata": { },
"pipelineMetadata": {"pipelineExecutionId": "string",
"pipelineTriggered": true
}
}
}

Updates a Feature Flag

Updates a Feature Flag in the Project

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier

Request Body schema: application/json

defaultOffVariation	string
defaultOnVariation	string
description	string
	Array of objects (ActivationUpdate)
	object (CfGitDetails) The commit message to use as part of a gitsync operation
name	string
permanent	boolean
	Array of objects (Tag)
	Array of objects (Variation) >= 2 items

Responses

200

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

409

The specified resource already exists

424

An error with git syncing

500

Internal server error

put/cf/admin/features/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"defaultOffVariation": "string",
"defaultOnVariation": "string",
"description": "string",
"environments": [{"defaultOffVariation": "red",
"defaultOnVariation": "blue",
"identifier": "env1",
"rules": [{"targets": ["target1",
"target2"
],
"variation": true
}
],
"state": "on"
}
],
"gitDetails": {"commitMsg": "Turning on flag test-flag for production"
},
"name": "string",
"permanent": true,
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"variations": [{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
},
{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
}
]
}

Response samples

application/json

{"details": {"governanceMetadata": { },
"pipelineMetadata": {"pipelineExecutionId": "string",
"pipelineTriggered": true
}
}
}

Return a list of dependant flags

Given identifier return list all the flags which depend on it.

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
environmentIdentifier	string Environment
pageNumber	integer PageNumber
pageSize	integer PageSize
sortOrder	string SortOrder Enum: "ASCENDING" "DESCENDING"
sortByField	string SortByField Enum: "name" "identifier" "archived" "kind" "modifiedAt"
name	string Name of the field
archived	boolean Status of the feature flag
kind	string Kind of the feature flag Enum: "json" "string" "int" "boolean"
targetIdentifier	string Identifier of a target
targetIdentifierFilter	string Identifier of the target to filter on
metrics	boolean Parameter to indicate if metrics data is requested in response
featureIdentifiers	string Comma separated identifiers for multiple Features
excludedFeatures	string Comma separated identifiers to exclude from the response
status	string Filter for flags based on their status (active,never-requested,recently-accessed,potentially-stale)
lifetime	string Filter for flags based on their lifetime (permanent/temporary)
enabled	boolean Filter for flags based on if they are enabled or disabled
flagCounts	boolean Returns counts for the different types of flags e.g num active, potentially-stale, recently-accessed etc
summary	boolean Returns summary info on flags if set to true
tags	string Filter for flags based on their tag values supplied as comma separated list

Responses

200

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/features/{identifier}/dependants

Request samples

curl
Java
Go

Response samples

application/json

{"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1,
"version": 5,
"featureCounts": {"totalActive": 5,
"totalAnomaly": 4,
"totalArchived": 10,
"totalEnabled": 2,
"totalFeatures": 10,
"totalPermanent": 7,
"totalPotentiallyStale": 3,
"totalRecentlyAccessed": 2
},
"features": [{"archived": false,
"createdAt": 0,
"defaultOffVariation": true,
"defaultOnVariation": true,
"description": "A flag to control a new feature in production",
"envProperties": {"ccm": {"anomalies": [{"acknowledgedAt": 0,
"anomalyId": "123456",
"costDifference": 123,
"createdAt": 0,
"foundAt": 0,
"isAcknowledged": false,
"status": "found"
}
],
"perspectiveIdentifier": "123456",
"perspectiveName": "myCluster"
},
"defaultServe": {"distribution": {"bucketBy": "string",
"variations": [{"variation": null,
"weight": null
}
]
},
"variation": "string"
},
"environment": "string",
"jiraEnabled": true,
"jiraIssues": [{"issueKey": "FFM-7777",
"issueURL": "https://harness-dev1.atlassian.net"
}
],
"modifiedAt": 0,
"offVariation": "string",
"pipelineConfigured": true,
"pipelineDetails": {"createdAt": 0,
"description": "string",
"identifier": "string",
"lastUpdatedAt": 0,
"name": "string"
},
"pipelineErrorReason": "string",
"pipelineErrorState": true,
"rules": [{"clauses": [{"attribute": null,
"id": null,
"negate": null,
"op": null,
"values": [ ]
}
],
"priority": 1,
"ruleId": "string",
"serve": {"distribution": {"bucketBy": null,
"variations": [ ]
},
"variation": "string"
}
}
],
"state": "on",
"variationMap": [{"targetSegments": ["string"
],
"targets": [{"identifier": null,
"name": null
}
],
"variation": "off-variation"
}
],
"version": 0
},
"evaluation": true,
"evaluationIdentifier": "on-variation",
"identifier": "bool-flag",
"kind": "boolean",
"modifiedAt": 0,
"name": "My Boolean Flag",
"owner": "johndoe",
"permanent": true,
"prerequisites": [{"feature": "string",
"variations": ["string"
]
}
],
"project": "test-project",
"results": [{"count": 0,
"variationIdentifier": "defaultOnVariation",
"variationName": "Default On Variation"
}
],
"services": [{"identifier": "string",
"name": "string"
}
],
"stale": false,
"staleReason": "matched-criteria",
"status": {"lastAccess": 0,
"status": "active"
},
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"variations": [{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
},
{"description": "string",
"identifier": "off-variation",
"name": "Off VAriation",
"value": "true"
}
]
}
]
}

Restore a Feature Flag

Restore Feature Flag for the given identifier and account ID

Securityx-api-key

Request

path Parameters

identifier

required

string

Unique identifier for the object in the API.

query Parameters

accountIdentifier required	string Account Identifier Examples: default accountIdentifier=default
orgIdentifier required	string Organization Identifier Examples: default orgIdentifier=default_org
projectIdentifier required	string The Project identifier
commitMsg	string Git commit message

Responses

204

No content

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

424

An error with git syncing

500

Internal server error

post/cf/admin/features/{identifier}/restore

Request samples

curl
Java
Go

Response samples

application/json

{"code": 404,
"details": { },
"message": "Error retrieving projects, organization 'default_org' does not exist"
}

➔ Next to Targets