How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

CloudBees Unify Platform API

CloudBees Unify is the modern, opinionated software delivery platform that unifies CI, CD, feature management, analytics, and security into a single workflow. The CloudBees Unify Public API is served from https://api.cloudbees.io and is published as two first-party OpenAPI 3.0.3 documents at apidocs.cloudbees.io: the "Current" specification (v1/v2/v3, 40 operations across organizations, teams, users, components, environments, feature flags, flag configurations, target groups, custom properties and flag lifecycle) and the "Beta" specification (v4, 25 operations across users, teams, team memberships, components and delivery runs with their artifacts, test results, security results, evidences and deployments). Both authenticate with a bearer personal access token. CloudBees directs new integrations at the v4 beta; the current endpoints remain supported but no longer receive new features.

CloudBees Unify Platform API is one of 12 APIs that CloudBees publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DevOps, Platform, and Software Delivery. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, and authentication docs.

This API exposes 40 operations across 29 paths, organized into 10 resource areas, and defines 69 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudbees.io.

40 operations 29 paths 69 schemas 4 DELETE24 GET1 PATCH7 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.cloudbees.io
Authentication
HTTP Bearer
Resource Areas
10

Authentication & Security 1

CloudBees Unify Platform API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — CloudBees Unify API access token or personal access token

Paths & Operations 40

Across 29 paths, the API surfaces 40 operations — 4 DELETE, 24 GET, 1 PATCH, 7 POST, 4 PUT. They span 10 resource areas: Flag lifecycle, Organizations, Components, Teams, Flag custom properties, Flag configurations, Flags, Target groups, Environments, Users. Each is listed below with its method, path, parameters, and response codes.

Flag lifecycle 2

Track how often each feature flag variation is served within an environment. Use impression data to monitor flag adoption, validate rollout progress, and analyze which variations…

GET
/v1/applications/{organizationId}/environments/{environmentId}/flags-status
Get flag statuses
FmImpressionsApi_GetFlagsStatus2 2 params → 200default
POST
/v1/applications/{organizationId}/environments/{environmentId}/impressions
Get flag impressions
FmImpressionsApi_GetImpressions2 2 params body → 200default
Organizations 2

Define the structural and governance boundaries within a CloudBees Unify tenant. Organizations model business units or departments, support parent-child hierarchies, and inherit c…

GET
/v1/organizations
List organizations
listOrganizations 12 params → 200default
GET
/v1/organizations/name
Get organization by name
getOrganizationByName 3 params → 200default
Components 1

List components within an organization, and optionally filter by component type, such as applications or services with an associated repository.

GET
/v1/organizations/{orgId}/services
List applications and components
ServiceEndpoint_ListServices2 2 params → 200default
Teams 1

List teams within an organization. Teams group users to manage access and permissions across resources in CloudBees Unify.

GET
/v1/organizations/{organizationId}/teams
List teams in an organization
TeamsService_GetTeams 8 params → 200default
Flag custom properties 8

Create, read, update, and delete custom properties used in targeting conditions and target groups.

GET
/v2/applications/{applicationId}/custom-properties
List custom properties
CustomPropertyApi_ListCustomProperties 1 param → 200default
POST
/v2/applications/{applicationId}/custom-properties
Create a custom property
CustomPropertyApi_AddCustomProperty 1 param body → 200default
GET
/v2/applications/{applicationId}/custom-properties/by-name/{name}
Get a custom property by name
CustomPropertyApi_GetCustomPropertyByName 2 params → 200default
GET
/v2/applications/{applicationId}/custom-properties/{id}
Get a custom property
CustomPropertyApi_GetCustomProperty 2 params → 200default
PUT
/v2/applications/{applicationId}/custom-properties/{id}
Update a custom property
CustomPropertyApi_UpdateCustomProperty 2 params body → 200default
DELETE
/v2/applications/{applicationId}/custom-properties/{id}
Delete a custom property
CustomPropertyApi_DeleteCustomProperty 2 params → 200default
GET
/v2/applications/{applicationId}/custom-properties/{id}/flag-usage-per-environment
Get flag usage per environment
CustomPropertyApi_GetCustomPropertyFlagUsagePerEnvironment 2 params → 200default
GET
/v2/applications/{applicationId}/custom-properties/{id}/target-group-usage
Get target group usage
CustomPropertyApi_GetCustomPropertyTargetGroupUsage 2 params → 200default
Flag configurations 6

Set flag state (enabled or disabled) and targeting rules for a specific environment to determine which users or segments receive each variation.

GET
/v2/applications/{applicationId}/environments/{environmentId}/configuration
List flag configurations for an environment
FlagConfigurationApi_ListFlagConfigurations 2 params → 200default
GET
/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}
Get flag configuration for an environment
FlagConfigurationApi_GetFlagConfiguration 3 params → 200default
PUT
/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}
Update flag configuration for an environment
FlagConfigurationApi_UpdateFlagConfiguration 3 params body → 200default
PATCH
/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}
Partially update flag configuration for an environment
FlagConfigurationApi_PatchFlagConfiguration 3 params body → 200default
POST
/v2/applications/{applicationId}/flags/{flagId}/configuration/environments/{environmentId}/configstate
Update flag enabled state for an environment
FlagConfigurationApi_UpdateFlagConfigurationConfigState 3 params body → 200default
POST
/v2/applications/{applicationId}/flags/{flagId}/environment/{environmentId}/clone
Clone flag configuration to other environments
FlagConfigurationApi_CloneFlagConfiguration 3 params body → 200default
Flags 9

Control runtime feature visibility and behavior to enable gradual rollouts, A/B testing, progressive delivery, and safe deployments without redeployment.

GET
/v2/applications/{applicationId}/flags
List feature flags
FlagApi_ListFlags 2 params → 200default
POST
/v2/applications/{applicationId}/flags
Create a feature flag
FlagApi_AddFlag 1 param body → 200default
GET
/v2/applications/{applicationId}/flags/by-name/{name}
Get a feature flag by name
FlagApi_GetFlagByName 2 params → 200default
GET
/v2/applications/{applicationId}/flags/labels
List flag labels
FlagApi_ListLabels 1 param → 200default
GET
/v2/applications/{applicationId}/flags/{id}
Get a feature flag
FlagApi_GetFlag 2 params → 200default
PUT
/v2/applications/{applicationId}/flags/{id}
Update a feature flag
FlagApi_UpdateFlag 2 params body → 200default
DELETE
/v2/applications/{applicationId}/flags/{id}
Delete a feature flag
FlagApi_DeleteFlag 2 params → 200default
GET
/v2/applications/{applicationId}/flags/{id}/configuration-state
Get flag configuration state per environment
FlagApi_GetFlagConfigurationState 2 params → 200default
GET
/v2/applications/{applicationId}/flags/{id}/flag-usage-per-environment
Get flag target group usage per environment
FlagApi_GetFlagFlagUsagePerEnvironment 2 params → 200default
Target groups 8

Define reusable sets of targeting conditions for feature flags. Specify rules once (such as matching users by role, region, or custom property) and apply them across multiple flag…

GET
/v2/applications/{applicationId}/target-groups
List target groups
TargetGroupApi_ListTargetGroups 1 param → 200default
POST
/v2/applications/{applicationId}/target-groups
Create a target group
TargetGroupApi_AddTargetGroup 1 param body → 200default
GET
/v2/applications/{applicationId}/target-groups/by-name/{name}
Get a target group by name
TargetGroupApi_GetTargetGroupByName 2 params → 200default
GET
/v2/applications/{applicationId}/target-groups/with-flags-usage
List target groups with flag usage
TargetGroupApi_ListTargetGroupsWithFlagsUsage 1 param → 200default
GET
/v2/applications/{applicationId}/target-groups/{id}
Get a target group
TargetGroupApi_GetTargetGroup 2 params → 200default
PUT
/v2/applications/{applicationId}/target-groups/{id}
Update a target group
TargetGroupApi_UpdateTargetGroup 2 params body → 200default
DELETE
/v2/applications/{applicationId}/target-groups/{id}
Delete a target group
TargetGroupApi_DeleteTargetGroup 2 params → 200default
GET
/v2/applications/{applicationId}/target-groups/{id}/flag-usage-per-environment
List flag usage per environment for a target group
TargetGroupApi_GetTargetGroupFlagUsagePerEnvironment 2 params → 200default
Environments 1

Discover and manage environments within your organization. Use environments to maintain an up-to-date inventory for feature flag targeting, deployment scripts, and monitoring work…

GET
/v2/organizations/{orgId}/environments
List environments
ReportServiceHandler_GetEnvironmentsv2 4 params → 200default
Users 2

Invite or remove users, and define custom attributes for feature flag targeting based on application-specific criteria such as account tier, region, or subscription status.

POST
/v3/organizations/{organizationId}/invite
Create invites for users to join an organization
InvitesService_CreateInviteV3 1 param body → 200default
DELETE
/v3/organizations/{organizationId}/user/{userId}
Remove a user from an organization
MembershipsService_RemoveUsersFromTeamV3 2 params → 200default

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are api.auth.User (17 properties), api.auth.Organization (16 properties), api.auth.Team (16 properties), api.auth.Org (15 properties). Each schema is shown below with its type and property counts.

api.fmimpressions.GetFlagsStatusResponse
object
1 property 1 required
api.fmimpressions.FlagStatus
object
2 properties 2 required
google.rpc.Status
object
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](h…
3 properties
google.protobuf.Any
object
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
1 property
api.fmimpressions.ImpressionParams
object
Parameters controlling which feature flags and time window are included in the impressions response.
4 properties 1 required
api.fmimpressions.GetImpressionsResponse
object
1 property 1 required
api.fmimpressions.SdkKeyImpressions
object
1 property 1 required
api.fmimpressions.AllFlagImpressions
object
1 property
api.fmimpressions.FlagImpression
object
2 properties
api.fmimpressions.ValuesAndCounters
object
2 properties 2 required
api.auth.GetOrganizationsResponse
object
2 properties
api.auth.Organization
object
16 properties
api.Audit
object
Audit records the person that updated the data last.
3 properties
api.auth.Team
object
16 properties
api.auth.User
object
User will live in a separate database from the rest of the platform due to PII
17 properties
api.auth.Login
object
How a user logs in to the system
8 properties
api.auth.Org
object
15 properties
api.auth.Role
object
Roles are a collection of permission actions. PermissionActions can not be granted to a user directly, a role must be created.
8 properties 3 required
api.auth.permission.Permission
object
Permission message represents a permission that can be granted to a user on an API entity.
2 properties 2 required
api.auth.EmailDomain
object
6 properties
api.auth.Connection
object
13 properties
api.auth.Invite
object
Record of the invitation for a new user for an organization
9 properties
api.Pagination
object
Pagination is sent as part of a request to specify handling for paginated results, and returned with paginated results=
4 properties
api.Sort
object
Sort describes which field to sort the results on and the order in which to sort them
2 properties
api.auth.GetOrganizationByNameResponse
object
1 property
api.service.ListServicesResponse
object
1 property
api.service.Service
object
14 properties
api.auth.GetTeamsResponse
object
2 properties
api.CustomProperty.ListCustomPropertiesResponse
object
1 property
api.CustomProperty.CustomProperty
object
6 properties
api.CustomProperty.AddCustomPropertyResponse
object
1 property
api.CustomProperty.GetCustomPropertyResponse
object
1 property
api.CustomProperty.UpdateCustomPropertyResponse
object
1 property
api.CustomProperty.GetCustomPropertyFlagsUsagePerEnvironmentResponse
object
1 property
api.TargetGroup.EnvironmentUsage
object
2 properties
api.TargetGroup.FlagUsageInEnvironment
object
4 properties
api.CustomProperty.GetCustomPropertyTargetGroupUsageResponse
object
1 property
api.TargetGroup.TargetGroupUsage
object
3 properties
api.flag.ListFlagConfigurationsResponse
object
1 property
api.flag.FlagConfigurationEnvironment
object
7 properties
api.flag.FlagConfiguration
object
10 properties
google.protobuf.Value
Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.
google.protobuf.ListValue
array
ListValue is a wrapper around a repeated field of values. The JSON representation for ListValue is JSON array.
api.flag.ListFlagsResponse
object
1 property
api.flag.Flag
object
12 properties
api.flag.FlagConfigurationState
object
3 properties
api.flag.AddFlagResponse
object
1 property
api.flag.GetFlagResponse
object
1 property
api.flag.ListLabelsResponse
object
1 property
api.flag.GetFlagConfigurationResponse
object
1 property
api.flag.FlagConfigurationOptional
object
5 properties
api.flag.FlagConfigState
object
1 property
api.flag.UpdateFlagResponse
object
1 property
api.flag.GetFlagConfigurationStateResponse
object
1 property
api.flag.GetFlagFlagsUsagePerEnvironmentResponse
object
1 property
api.TargetGroup.ListTargetGroupsResponse
object
1 property
api.TargetGroup.TargetGroup
object
6 properties
api.TargetGroup.AddTargetGroupResponse
object
1 property
api.TargetGroup.GetTargetGroupResponse
object
1 property
api.TargetGroup.ListTargetGroupsWithFlagsUsageResponse
object
1 property
api.TargetGroup.TargetGroupWithFlagsUsage
object
6 properties
api.TargetGroup.FlagIdName
object
3 properties
api.TargetGroup.UpdateTargetGroupResponse
object
1 property
api.TargetGroup.GetTargetGroupFlagsUsagePerEnvironmentResponse
object
1 property
api.vsm.report.EnvironmentResponse
object
1 property
api.vsm.report.Environment
object
4 properties
api.auth.CreateInvitesRequestV3
object
6 properties
api.auth.CreateInvitesV3Response
object
1 property
api.auth.InviteV3
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudbees-unify-openapi.yml Raw ↑

Other APIs CloudBees publishes across the network.

CloudBees CI REST API
CloudBees CD/RO REST API
CloudBees Feature Management REST API
CloudBees CD/RO Jenkins Plugin Steps
CloudBees Computer API
CloudBees CreateItem API
CloudBees Job API
CloudBees Json API
CloudBees Python API
CloudBees Queue API
CloudBees Xml API
Where this information came from

This is an independent, third-party profile of CloudBees Unify Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.