Skip to content

README.md

Latest commit

 

History

History
87 lines (65 loc) · 2.24 KB

README.md

File metadata and controls

87 lines (65 loc) · 2.24 KB

CloudBees Feature Management API - Postman Collection

Postman collection for the CloudBees Feature Management API.

Download

Download the Postman Collection

Or import directly into Postman using this URL:

https://raw.githubusercontent.com/cloudbees-oss/fm-api-postman/main/cloudbees-fm-api.postman_collection.json

Setup

1. Import the Collection

  1. Open Postman
  2. Click Import
  3. Select the downloaded JSON file or paste the raw URL above
  4. The collection appears in your sidebar

2. Configure Environment Variables

Create a Postman environment with these variables:

Variable Description Example
baseUrl API base URL https://api.cloudbees.io
applicationId Your FM application ID app-abc123
apiToken Your API bearer token eyJhbGciOiJ...

3. Authentication

The collection uses Bearer token authentication. Your apiToken variable is automatically used for all requests.

Collection Contents

The collection includes 32 requests organized by resource:

Flags (10 requests)

  • List flags
  • Create flag
  • Get flag by ID
  • Get flag by name
  • Update flag
  • Delete flag
  • Restore deleted flag
  • List labels
  • Get flag configuration state
  • Get flag usage per environment

Flag Configurations (6 requests)

  • Get flag configuration
  • Update flag configuration
  • Patch flag configuration
  • Update configuration state
  • Clone flag configuration
  • List flag configurations

Target Groups (8 requests)

  • List target groups
  • Create target group
  • Get target group by ID
  • Get target group by name
  • Update target group
  • Delete target group
  • List target groups with flag usage
  • Get target group flag usage per environment

Custom Properties (8 requests)

  • List custom properties
  • Create custom property
  • Get custom property by ID
  • Get custom property by name
  • Update custom property
  • Delete custom property
  • Get property flag usage per environment
  • Get property target group usage

Documentation

For complete API documentation, see the CloudBees Feature Management API Reference.

License

MIT - See LICENSE