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

Feature management API reference

2 minute read

The CloudBees Unify Feature Management API provides programmatic access to manage feature flags, target groups, and custom properties. Use this API to integrate feature management into CI/CD pipelines, automation scripts, and custom tooling.

Base URL

All API endpoints are relative to your CloudBees Unify instance:

https://api.cloudbees.io/v1
▼

Authentication

All API requests require authentication using a bearer token. Include the token in the Authorization header, as follows:

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
     https://api.cloudbees.io/v2/applications/{applicationId}/flags
▼

To obtain an API token:

  1. Navigate to your organization settings in CloudBees Unify.

  2. Select API tokens.

  3. Create a new token with appropriate permissions.

API overview

The Feature Management API is organized around the following core resources:

Resource Description

Flags

Create, read, update, and delete feature flags

Flag Configurations

Manage per-environment flag settings, conditions, and rollouts

Target Groups

Define reusable targeting rules for flag conditions

Custom Properties

Manage user properties used in targeting conditions

Common patterns

Path parameters

Most endpoints require an applicationId path parameter to identify the FM application:

/v2/applications/{applicationId}/flags
/v2/applications/{applicationId}/target-groups
/v2/applications/{applicationId}/custom-properties
▼

Response format

All responses are returned as JSON. Successful responses include the following requested data:

{
  "flags": [
    {
      "id": "f7d3c8a1-4b2e-5f9a-b6c4-e1d8f3a7b5c2",
      "name": "default.newFeature",
      "description": "Enables new feature",
      "flagType": "Boolean"
    }
  ]
}
▼

Error responses

Errors return a standard error object with details:

{
  "code": 3,
  "message": "Flag not found",
  "details": []
}
▼

Common HTTP status codes:

Code Description

200

Success

400

Bad request - invalid parameters

401

Unauthorized - invalid or missing token

403

Forbidden - insufficient permissions

404

Not found - resource does not exist

500

Internal server error

Rate limiting

This API enforces rate limits to ensure fair usage. When you exceed the limit, you will receive a 429 Too Many Requests response. To handle rate limiting, implement exponential backoff in your client application by progressively increasing the wait time between retry attempts.

Pagination

List endpoints support pagination through query parameters:

Parameter Type Description

pageSize

integer

Maximum number of items to return (default: 100)

pageToken

string

Token for fetching the next page of results

Testing the API

See Testing the API for information on using Postman, curl, and other tools to test API endpoints.

Quick reference

Flag operations

Method Endpoint Description

GET

/v2/applications/{appId}/flags

List all flags

POST

/v2/applications/{appId}/flags

Create a new flag

GET

/v2/applications/{appId}/flags/{id}

Get a flag by ID

GET

/v2/applications/{appId}/flags/by-name/{name}

Get a flag by name

PUT

/v2/applications/{appId}/flags/{id}

Update a flag

DELETE

/v2/applications/{appId}/flags/{id}

Delete a flag

Flag configuration operations

Method Endpoint Description

GET

/v2/applications/{appId}/flags/{flagId}/configuration/environments/{envId}

Get flag configuration

PUT

/v2/applications/{appId}/flags/{flagId}/configuration/environments/{envId}

Update flag configuration

PATCH

/v2/applications/{appId}/flags/{flagId}/configuration/environments/{envId}

Partially update configuration

POST

/v2/applications/{appId}/flags/{flagId}/environment/{envId}/clone

Clone configuration to another environment

Target group operations

Method Endpoint Description

GET

/v2/applications/{appId}/target-groups

List all target groups

POST

/v2/applications/{appId}/target-groups

Create a target group

GET

/v2/applications/{appId}/target-groups/{id}

Get a target group by ID

PUT

/v2/applications/{appId}/target-groups/{id}

Update a target group

DELETE

/v2/applications/{appId}/target-groups/{id}

Delete a target group

Custom property operations

Method Endpoint Description

GET

/v2/applications/{appId}/custom-properties

List all custom properties

POST

/v2/applications/{appId}/custom-properties

Create a custom property

GET

/v2/applications/{appId}/custom-properties/{id}

Get a custom property by ID

PUT

/v2/applications/{appId}/custom-properties/{id}

Update a custom property

DELETE

/v2/applications/{appId}/custom-properties/{id}

Delete a custom property

Next steps

Flags