Targets

APIs to create and manage Feature Flag Targets

Returns all Targets

Returns all the Targets 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: "ASC" "DESC"
sortByField	string SortByField Enum: "createdAt" "name" "identifier"
targetName	string Name of the target
targetIdentifier	string Identifier of the target

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/targets

Request samples

curl
Java
Go

Response samples

application/json

{"itemCount": 1,
"pageCount": 100,
"pageIndex": 0,
"pageSize": 1,
"version": 5,
"targets": [{"account": "abcXDdffdaffd",
"anonymous": true,
"attributes": {"age": 20,
"location": "Belfast"
},
"createdAt": 0,
"environment": "string",
"identifier": "john-doe",
"name": "John Doe",
"org": "string",
"project": "string",
"segments": [{"createdAt": 0,
"environment": "Production",
"excluded": [{ }
],
"identifier": "string",
"included": [{ }
],
"modifiedAt": 0,
"name": "Beta Testers",
"rules": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": [null
]
}
],
"servingRules": [{"clauses": [null
],
"priority": 1,
"ruleId": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"version": 1
}
]
}
]
}

Creates a Target

Create Targets 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

Request Body schema: application/json
required

account required	string The account ID that the target belongs to
anonymous	boolean Indicates if this target is anonymous
attributes	object a JSON representation of the attributes for this target
createdAt	integer <int64> The date and time in milliseconds when this Target was created
environment required	string The identifier for the environment that the target belongs to
identifier required	string The unique identifier for this target
name required	string The name of this Target
org required	string The identifier for the organization that the target belongs to
project required	string The identifier for the project that this target belongs to
	Array of objects (Segment) A list of Target Groups (Segments) that this Target belongs to

Responses

201

Created

400

Bad request

401

Unauthenticated

403

Unauthorized

409

The specified resource already exists

500

Internal server error

post/cf/admin/targets

Request samples

Payload
curl
Java
Go

application/json

{"account": "abcXDdffdaffd",
"anonymous": true,
"attributes": {"age": 20,
"location": "Belfast"
},
"createdAt": 0,
"environment": "string",
"identifier": "john-doe",
"name": "John Doe",
"org": "string",
"project": "string",
"segments": [{"createdAt": 0,
"environment": "Production",
"excluded": [{ }
],
"identifier": "string",
"included": [{ }
],
"modifiedAt": 0,
"name": "Beta Testers",
"rules": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": ["string"
]
}
],
"servingRules": [{"clauses": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": [null
]
}
],
"priority": 1,
"ruleId": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"version": 1
}
]
}

Response samples

application/json

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

Add Target details

Add targets by uploading a CSV file

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

Request Body schema: multipart/form-data

fileName

string <binary>

Responses

200

Created

400

Bad request

401

Unauthenticated

403

Unauthorized

409

The specified resource already exists

500

Internal server error

post/cf/admin/targets/upload

Request samples

curl
Java
Go

Response samples

application/json

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

Deletes a Target

Deletes a Target for the given identifier

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 required	string Environment Identifier

Responses

204

No content

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

delete/cf/admin/targets/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"code": "404",
"details": { },
"message": "string"
}

Returns details of a Target

Returns details of a Target for the given identifier

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 required	string Environment Identifier

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/targets/{identifier}

Request samples

curl
Java
Go

Response samples

application/json

{"account": "abcXDdffdaffd",
"anonymous": true,
"attributes": {"age": 20,
"location": "Belfast"
},
"createdAt": 0,
"environment": "string",
"identifier": "john-doe",
"name": "John Doe",
"org": "string",
"project": "string",
"segments": [{"createdAt": 0,
"environment": "Production",
"excluded": [{ }
],
"identifier": "string",
"included": [{ }
],
"modifiedAt": 0,
"name": "Beta Testers",
"rules": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": ["string"
]
}
],
"servingRules": [{"clauses": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": [null
]
}
],
"priority": 1,
"ruleId": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"version": 1
}
]
}

Updates a Target

Updates a Target for the given identifier

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 required	string Environment Identifier

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

500

Internal server error

patch/cf/admin/targets/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"gitDetails": {"commitMsg": "Making some changes"
},
"instructions": [{"kind": "addToIncludeList",
"parameters": {"segments": ["alpha-testers",
"beta-testers"
]
}
},
{"kind": "removeFromIncludeList",
"parameters": {"segments": ["alpha-testers",
"beta-testers"
]
}
},
{"kind": "addToExcludeList",
"parameters": {"segments": ["alpha-testers",
"beta-testers"
]
}
},
{"kind": "removeFromExcludeList",
"parameters": {"segments": ["alpha-testers",
"beta-testers"
]
}
},
{"kind": "addTargetToFlagsVariationTargetMap",
"parameters": {"features": [{"identifier": "flag1",
"variation": "true"
},
{"identifier": "flag2",
"variation": "false"
}
]
}
},
{"kind": "removeTargetFromFlagsVariationTargetMap",
"parameters": {"features": [{"identifier": "flag1",
"variation": "true"
},
{"identifier": "flag2",
"variation": "false"
}
]
}
}
]
}

Response samples

application/json

{"account": "abcXDdffdaffd",
"anonymous": true,
"attributes": {"age": 20,
"location": "Belfast"
},
"createdAt": 0,
"environment": "string",
"identifier": "john-doe",
"name": "John Doe",
"org": "string",
"project": "string",
"segments": [{"createdAt": 0,
"environment": "Production",
"excluded": [{ }
],
"identifier": "string",
"included": [{ }
],
"modifiedAt": 0,
"name": "Beta Testers",
"rules": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": ["string"
]
}
],
"servingRules": [{"clauses": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": [null
]
}
],
"priority": 1,
"ruleId": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"version": 1
}
]
}

Modifies a Target

Modifies a Target for the given account identifier

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 required	string Environment Identifier

Request Body schema: application/json
required

account required	string The account ID that the target belongs to
anonymous	boolean Indicates if this target is anonymous
attributes	object a JSON representation of the attributes for this target
createdAt	integer <int64> The date and time in milliseconds when this Target was created
environment required	string The identifier for the environment that the target belongs to
identifier required	string The unique identifier for this target
name required	string The name of this Target
org required	string The identifier for the organization that the target belongs to
project required	string The identifier for the project that this target belongs to
	Array of objects (Segment) A list of Target Groups (Segments) that this Target belongs to

Responses

200

400

Bad request

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

409

The specified resource already exists

500

Internal server error

put/cf/admin/targets/{identifier}

Request samples

Payload
curl
Java
Go

application/json

{"account": "abcXDdffdaffd",
"anonymous": true,
"attributes": {"age": 20,
"location": "Belfast"
},
"createdAt": 0,
"environment": "string",
"identifier": "john-doe",
"name": "John Doe",
"org": "string",
"project": "string",
"segments": [{"createdAt": 0,
"environment": "Production",
"excluded": [{ }
],
"identifier": "string",
"included": [{ }
],
"modifiedAt": 0,
"name": "Beta Testers",
"rules": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": ["string"
]
}
],
"servingRules": [{"clauses": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": [null
]
}
],
"priority": 1,
"ruleId": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"version": 1
}
]
}

Response samples

application/json

{"account": "abcXDdffdaffd",
"anonymous": true,
"attributes": {"age": 20,
"location": "Belfast"
},
"createdAt": 0,
"environment": "string",
"identifier": "john-doe",
"name": "John Doe",
"org": "string",
"project": "string",
"segments": [{"createdAt": 0,
"environment": "Production",
"excluded": [{ }
],
"identifier": "string",
"included": [{ }
],
"modifiedAt": 0,
"name": "Beta Testers",
"rules": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": ["string"
]
}
],
"servingRules": [{"clauses": [{"attribute": "identifier",
"id": 32434243,
"negate": false,
"op": "starts_with",
"values": [null
]
}
],
"priority": 1,
"ruleId": "string"
}
],
"tags": [{"identifier": "feature-flag-tag-1",
"name": "feature-flag-tag-1"
}
],
"version": 1
}
]
}

Returns Target Groups for the given Target

Returns the Target Groups that the specified Target belongs to.

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 required	string Environment Identifier

Responses

200

401

Unauthenticated

403

Unauthorized

404

The specified resource was not found

500

Internal server error

get/cf/admin/targets/{identifier}/segments

Request samples

curl
Java
Go

Response samples

application/json

{"excludedSegments": [{"identifier": "string",
"name": "string"
}
],
"identifier": "string",
"includedSegments": [{"identifier": "string",
"name": "string"
}
],
"ruleSegments": [{"identifier": "string",
"name": "string"
}
]
}

➔ Next to Target Groups

Targets

Returns all Targets

query Parameters

Creates a Target

query Parameters

Request Body schema: application/jsonrequired

Add Target details

query Parameters

Request Body schema: multipart/form-data

Deletes a Target

path Parameters

query Parameters

Returns details of a Target

path Parameters

query Parameters

Updates a Target

path Parameters

query Parameters

Request Body schema: application/json

Modifies a Target

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Returns Target Groups for the given Target

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required