Onboard
Introduction
Users
Teams
Introduction
IntroductionPromote an image in Amazon ECRRetrieve an object from Amazon S3Store an object on Amazon S3Copy Docker images with CraneDownload a file from JFrog ArtifactoryMove or copy an image from JFrog ArtifactoryUpload a file to JFrog ArtifactoryGet artifact detailsManage artifact labelsRegister a build artifactRegister a deployed environment artifact
IntroductionCreate or update a functionInvoke a function
IntroductionRun an AWS CodePipelineRun a Bamboo projectRun a Bitbucket pipelineRun a CloudBees CI jobRun a CircleCI workflowRun a GitHub Actions workflowRun a GitLab pipelineRun a Harness pipelineRun a Jenkins® jobRun a JFrog pipelineBuild and publish Docker images with KanikoRun a TeamCity project
IntroductionMigrate from v1 to v2
IntroductionAWS credentialsECR credentialsEKS credentialsGit global credentialsOCI credentials
IntroductionRun Ansible PlaybookDeploy with Argo WorkflowsDeploy with AWS CodeDeployDeploy a binary with Amazon EC2Deploy to ECSRender an Amazon ECS task definitionDeploy with AWS Elastic BeanstalkDeploy with HerokuDeploy with OctopusDeploy with OpenShiftDeploy with SpinnakerDeploy with Tosca
Publish evidence items
Fetch secrets from CyberArk Conjur
IntroductionHelm chart installHelm chart packageHelm chart publishHelm chart uninstall
IntroductionCreate a Kubernetes namespaceCreate/update a Kubernetes resourceDeploy to a Kubernetes cluster
IntroductionVerify with NewRelic
Execute remote commands via SSH
IntroductionAnchoreAquasecJFrog XraySnyk ContainerSonatype (Nexus) ContainerTrivy
IntroductionStackhawkZAP
IntroductionCheckmarxCheckovCoverity on PolarisFind Security BugsGitHub Security ScannerGosecGrypeMendNexus IQnjsscanSnykSonarQube bundledSonarQube
IntroductionBlack DuckMendSnyk
IntroductionGitleaksTruffleHog ContainerTruffleHog CodeTruffleHog S3
IntroductionCreate a change requestUpdate or close a change requestGet a change request current stateQuery a change request approval
Publish test results
Multi-workflows dispatch
Introduction
Get started with feature flags
Create flags in code
Manage multiple SDK keys in your application
Create and manage flags in the UI
Namespaces and labels
Configure feature flags
Feature management custom roles
Flag approval requests and reviews
Audit history
Get started with configuration as code
Set up configuration as code
Configuration as code reference
Configuration-as-Code examples
Flag impressions and activity status
Flag health
Code references
Properties and custom properties
Target groups
Enabling secret mode
IntroductionAndroid / Android TV / Fire TVC/C++ (client-side)C/C++ (server-side)GoJavaJavaScript (browser) / Chromecast / TizenJavaScript SSR.NET/C#Node.jsiOS / tvOSPHPPythonReact NativeRuby
IntroductionClient-side AndroidClient-side C ClientClient-side C++ ClientClient-side JavaClient-side JavaScript (browser)Client-side .NET/C# clientClient-side Objective-CClient-side React NativeClient-side SwiftServer-side CServer-side C++Server-side GoServer-side JavaServer-side .NET/C#Server-side NodeJSServer-side PythonServer-side PHPServer-side RubyBoth client-side and server-side JavaScript SSR
IntroductionAndroid appAngular appDjango appGin appJava Spring Boot app.NET Core appReact appSwift iOS app

API data schemas

3 minute read

This reference documents the data structures used by the Feature Management API.

Flag

Represents a feature flag definition.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "flagType": "Boolean | String | Number",
  "variants": ["string"],
  "labels": ["string"],
  "isPermanent": false,
  "cascUrl": "string",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-02-01T14:22:00Z",
  "configStates": [FlagConfigurationState]
}
▼
Field Type Description

id

string

Unique identifier

name

string

Flag name with namespace (e.g., default.myFlag)

description

string

Human-readable description

flagType

enum

Type: Boolean, String, or Number

variants

array

Available values for String/Number flags

labels

array

Labels for organization and filtering

isPermanent

boolean

Whether the flag is permanent (cannot be deleted)

cascUrl

string

URL to the CasC file in SCM (if managed via CasC)

created

datetime

Creation timestamp

updated

datetime

Last update timestamp

configStates

array

Configuration state per environment

FlagConfiguration

Represents a flag’s configuration in a specific environment.

{
  "enabled": true,
  "defaultValue": "any",
  "conditions": [],
  "seed": "string",
  "stickinessProperty": "string",
  "variantsEnabled": false,
  "resourceId": "string",
  "cascUrl": "string",
  "created": "2024-01-15T10:30:00Z",
  "updated": "2024-02-01T14:22:00Z"
}
▼
Field Type Description

enabled

boolean

Whether the flag is enabled in this environment

defaultValue

any

Default value when no conditions match

conditions

array

Array of targeting conditions

seed

string

Seed for percentage-based randomization

stickinessProperty

string

Property for consistent percentage-based evaluation

variantsEnabled

boolean

Whether multiple variants are enabled

resourceId

string

Associated resource ID

cascUrl

string

URL to CasC file

created

datetime

Creation timestamp

updated

datetime

Last update timestamp

FlagConfigurationState

Represents the enabled state of a flag in an environment.

{
  "environmentId": "string",
  "enabled": true,
  "updated": "2024-02-01T14:22:00Z"
}
▼
Field Type Description

environmentId

string

Environment identifier

enabled

boolean

Whether the flag is enabled

updated

datetime

Last update timestamp

TargetGroup

Represents a target group definition.

{
  "id": "string",
  "name": "string",
  "description": "string",
  "conditions": {
    "operator": "and | or",
    "conditions": [Condition]
  },
  "resourceId": "string",
  "cascUrl": "string"
}
▼
Field Type Description

id

string

Unique identifier

name

string

Target group name

description

string

Human-readable description

conditions

object

Targeting conditions

resourceId

string

Associated resource ID

cascUrl

string

URL to CasC file

CustomProperty

Represents a custom property definition.

{
  "id": "string",
  "name": "string",
  "type": "Boolean | String | Number | Semver | DateTime",
  "description": "string",
  "resourceId": "string",
  "cascUrl": "string"
}
▼
Field Type Description

id

string

Unique identifier

name

string

Property name

type

enum

Data type: Boolean, String, Number, Semver, or DateTime

description

string

Human-readable description

resourceId

string

Associated resource ID

cascUrl

string

URL to CasC file

Condition

Represents a targeting condition.

Property Condition

{
  "property": "string",
  "operator": "string",
  "operand": "any"
}
▼
Field Type Description

property

string

Property name to evaluate

operator

string

Comparison operator

operand

any

Value to compare against (not required for is-true, is-false, is-undefined)

Group Condition

{
  "group": {
    "name": "string | [string]",
    "operator": "and | or | not"
  },
  "value": "any"
}
▼

Dependency Condition

{
  "dependency": {
    "flag": "string",
    "value": "any"
  },
  "value": "any"
}
▼

Version Condition

{
  "version": {
    "operator": "string",
    "semver": "string"
  },
  "value": "any"
}
▼

Operators

Boolean Operators

Operator Description

is-undefined

Property has no value

is-true

Boolean property is true

is-false

Boolean property is false

Comparison Operators

Operator Description

eq

Equals

ne

Not equals

gt

Greater than

gte

Greater than or equal

lt

Less than

lte

Less than or equal

Array Operators

Operator Description

in-array

Value is in the provided array

String Operators

Operator Description

regex

Matches regular expression

Semantic Version Operators

Operator Description

semver-eq

Version equals

semver-ne

Version not equals

semver-gt

Version greater than

semver-gte

Version greater than or equal

semver-lt

Version less than

semver-lte

Version less than or equal

Error Response

Standard error response format.

{
  "code": 3,
  "message": "Error message",
  "details": []
}
▼
Field Type Description

code

integer

gRPC status code

message

string

Human-readable error message

details

array

Additional error details

Common Error Codes

Code HTTP Status Description

0

200

OK - Success

3

400

INVALID_ARGUMENT - Invalid parameters

5

404

NOT_FOUND - Resource not found

7

403

PERMISSION_DENIED - Insufficient permissions

16

401

UNAUTHENTICATED - Invalid or missing credentials

List Response Pattern

All list endpoints return paginated responses:

{
  "items": [],
  "nextPageToken": "string",
  "totalCount": 0
}
▼
Field Type Description

items

array

Array of items (flags, targetGroups, etc.)

nextPageToken

string

Token for fetching the next page (empty if no more pages)

totalCount

integer

Total number of items (if supported)

Next steps

Custom Properties
Testing the API