Tags

APIs to create and manage Feature Flag Tags

Returns all Tags

Returns all the Tags for the given Account ID

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 required	string Environment Identifier
pageNumber	integer PageNumber
pageSize	integer PageSize
sortOrder	string SortOrder Enum: "ASCENDING" "DESCENDING"
sortByField	string SortByField Enum: "name" "identifier" "archived" "kind" "modifiedAt"
tagIdentifierFilter	string Partial Search of Tag Identifiers to filter on

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/tags

Request samples

curl
Java
Go

Response samples

application/json

{"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1,
"version": 5,
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
]
}

Creates a Tag

Create Tags for the given identifier

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

Request Body schema: application/json
required

identifier required	string The identifier of the tag
name required	string The name of the tag

Responses

201

400

Bad request

401

Unauthenticated

403

Unauthorized

409

The specified resource already exists

500

Internal server error

post/cf/admin/tags

Request samples

Payload
curl
Java
Go

application/json

{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}

Response samples

application/json

{"details": {"governanceMetadata": { }
}
}

Delete a Tag

Delete Tag 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/tags/{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 Tag

Returns details such as identifier,Associated Feature Flag etc for the given Tag

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/tags/{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"
}
]
}

➔ Next to Monitored Services

Tags

Returns all Tags

query Parameters

Creates a Tag

query Parameters

Request Body schema: application/jsonrequired

Delete a Tag

path Parameters

query Parameters

Returns a Tag

path Parameters

query Parameters

Request Body schema: application/json
required