Get flag
Returns the full flag definition including rules, variations, and audit fields.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYYAPI Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
X-Auth-Email: user@example.comThe previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194Accepted Permissions (at least one required)
Flagship ReadParametersExpand Collapse
ReturnsExpand Collapse
type AppFlagGetResponse struct{…}
Variation served when no rule matches or the flag is disabled. Must be a key in variations.
Unique identifier for the flag within an app. Used in all evaluation and SDK calls.
Rules []AppFlagGetResponseRuleTargeting rules evaluated in ascending priority; the first matching rule wins. An empty array means the flag always serves default_variation.
Targeting rules evaluated in ascending priority; the first matching rule wins. An empty array means the flag always serves default_variation.
Conditions []AppFlagGetResponseRulesConditionConditions the context must satisfy for this rule to match. An empty array matches all contexts.
Conditions the context must satisfy for this rule to match. An empty array matches all contexts.
type AppFlagGetResponseRulesConditionsObject struct{…}
Operator AppFlagGetResponseRulesConditionsObjectOperator
type AppFlagGetResponseRulesConditionsObject struct{…}
Clauses []AppFlagGetResponseRulesConditionsObjectClause
type AppFlagGetResponseRulesConditionsObjectClausesObject struct{…}
Operator AppFlagGetResponseRulesConditionsObjectClausesObjectOperator
type AppFlagGetResponseRulesConditionsObjectClausesObject struct{…}
Clauses []AppFlagGetResponseRulesConditionsObjectClausesObjectClause
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObject struct{…}
Operator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectOperator
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObject struct{…}
Clauses []AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClause
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObject struct{…}
Operator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectOperator
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObject struct{…}
Clauses []AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClause
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObject struct{…}
Operator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectOperator
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObject struct{…}
Clauses []AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectClause
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectClausesObject struct{…}
Operator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectClausesObjectOperator
type AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectClausesObject struct{…}
Clauses []AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectClausesObjectClausesUnion
LogicalOperator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectClausesObjectLogicalOperator
LogicalOperator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectClausesObjectLogicalOperator
LogicalOperator AppFlagGetResponseRulesConditionsObjectClausesObjectClausesObjectClausesObjectLogicalOperator
Evaluation order; lower numbers are evaluated first. Must be unique across the flag’s rules.
Variation served when this rule matches. Must be a key in variations.
Variations map[string, AppFlagGetResponseVariationsUnion]Map of variation name to value. All values must be the same type (boolean, string, number, or JSON object/array). Each serialized value must be 10KB or smaller.
Map of variation name to value. All values must be the same type (boolean, string, number, or JSON object/array). Each serialized value must be 10KB or smaller.
Get flag
package main
import (
"context"
"fmt"
"github.com/stainless-sdks/cloudflare-go"
"github.com/stainless-sdks/cloudflare-go/flagship"
"github.com/stainless-sdks/cloudflare-go/option"
)
func main() {
client := cloudflare.NewClient(
option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
)
flag, err := client.Flagship.Apps.Flags.Get(
context.TODO(),
"app_id",
"flag_key",
flagship.AppFlagGetParams{
AccountID: cloudflare.F("account_id"),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", flag.DefaultVariation)
}
{
"errors": [
{
"message": "message"
}
],
"messages": [
{
"message": "message"
}
],
"result": {
"default_variation": "x",
"enabled": true,
"key": "x",
"rules": [
{
"conditions": [
{
"attribute": "x",
"operator": "equals",
"value": {}
}
],
"priority": 1,
"serve_variation": "x",
"rollout": {
"percentage": 0,
"attribute": "x"
}
}
],
"variations": {
"foo": "string"
},
"description": "description",
"type": "boolean",
"updated_at": "updated_at",
"updated_by": "updated_by"
},
"success": true
}Returns Examples
{
"errors": [
{
"message": "message"
}
],
"messages": [
{
"message": "message"
}
],
"result": {
"default_variation": "x",
"enabled": true,
"key": "x",
"rules": [
{
"conditions": [
{
"attribute": "x",
"operator": "equals",
"value": {}
}
],
"priority": 1,
"serve_variation": "x",
"rollout": {
"percentage": 0,
"attribute": "x"
}
}
],
"variations": {
"foo": "string"
},
"description": "description",
"type": "boolean",
"updated_at": "updated_at",
"updated_by": "updated_by"
},
"success": true
}