FeatureHub

https://docs.featurehub.io
Admin
FeatureHub is a cloud-native feature flag and remote configuration platform for teams to manage...
Tokens:104,609
Snippets:588
Trust Score:7.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run Example Application with Docker

Source: https://docs.featurehub.io/featurehub/latest/evaluation.html

Configure environment variables for API keys and edge URL, then start the example Node/React application container.

```bash
# set the Client eval API key used by the example server, e.g:
export FEATUREHUB_CLIENT_API_KEY="default/82afd7ae-e7de-4567-817b-dd684315adf7/SHxmTA83AJupii4TsIciWvhaQYBIq2*JxIKxiUoswZPmLQAIIWN"
# Set the Server eval API key used by the React front-end, e.g:
export FEATUREHUB_SERVER_API_KEY="default/d8ba747d-7d3c-4454-9c58-130390848412/5EE3vua1NqY0ez6Zd4TXU7XnsZdAPHtR96XaDmhfegitKGiQ9aCdmtmeNUNPubkRZLJLUUpaC7b05ELk"
export MY_IP=192.168.XX.XX
export FEATUREHUB_EDGE_URL=http://$MY_IP:8085/

docker run --rm -e  FEATUREHUB_EDGE_URL=$FEATUREHUB_EDGE_URL -e FEATUREHUB_CLIENT_API_KEY=$FEATUREHUB_CLIENT_API_KEY -e FEATUREHUB_SERVER_API_KEY=$FEATUREHUB_SERVER_API_KEY -p 5000:5000  featurehub/example_node:1.3.0
```

```bash
docker run --network host --rm -e  FEATUREHUB_EDGE_URL=$FEATUREHUB_EDGE_URL -e FEATUREHUB_CLIENT_API_KEY=$FEATUREHUB_CLIENT_API_KEY -e FEATUREHUB_SERVER_API_KEY=$FEATUREHUB_SERVER_API_KEY -p 5000:5000  featurehub/example_node:1.3.0
```

--------------------------------

### GET /mr-api/initialize

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Pings the Feature Hub to check installation status.

```APIDOC
## GET /mr-api/initialize

### Description
Ping Feature Hub.

### Method
GET

### Endpoint
/mr-api/initialize

### Response
#### Success Response (200)
- **SetupResponse** (object) - Hello from Feature Hub.
```

--------------------------------

### Example connection properties

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Example output showing the connection name format.

```text
backendType: SECOND_GEN
connectionName: featurehub-example:us-central1:featurehub-db
databaseVersion: POSTGRES_13
...
```

--------------------------------

### Install FeatureHub APIs

Source: https://docs.featurehub.io/featurehub/latest/developers.html

Installs only the API components to ensure consistency.

```bash
mvn -f pom-api.xml clean install
```

--------------------------------

### Install FeatureHub from command line

Source: https://docs.featurehub.io/featurehub/latest/developers.html

Executes a full build of the FeatureHub backend components.

```bash
cd backend && mvn -f pom-first.xml clean install && cd .. && mvn -T4C clean install
```

--------------------------------

### GET /info/version

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves version and server information.

```APIDOC
## GET /info/version

### Description
Gets information as to what this server is.

### Method
GET

### Endpoint
/info/version
```

--------------------------------

### Retrieve all features response sample

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Example JSON response for the getAllFeaturesForApplication endpoint.

```json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "key": "string",
    "alias": "string",
    "link": "string",
    "name": "string",
    "valueType": "BOOLEAN",
    "version": 0,
    "whenArchived": "2019-08-24T14:15:22Z",
    "secret": true,
    "description": "string",
    "metaData": "string"
  }
]
```

--------------------------------

### GET /info/version

Source: https://docs.featurehub.io/featurehub/latest/_attachments/sdk-api.yaml

Retrieves information about the server version.

```APIDOC
## GET /info/version

### Description
Gets information as to what this server is.

### Method
GET

### Endpoint
/info/version

### Response
#### Success Response (200)
- **ApplicationVersionInfo** (object) - The basic information on this server
```

--------------------------------

### Install ADK via Gradle

Source: https://docs.featurehub.io/featurehub/latest/admin-development-kit.html

Add the implementation dependency to your build.gradle file.

```groovy
implementation 'io.featurehub.mr.sdk:java8-admin-client:[1.1,2)'
```

```groovy
implementation 'io.featurehub.mr.sdk:java11-admin-client:[1.1,2)'
```

--------------------------------

### View Generated Logs

Source: https://docs.featurehub.io/featurehub/latest/configuration

Example of a JSON-formatted log entry generated by the system.

```json
{"@timestamp":"2022-01-22T14:58:15.854+1300","message":"txn[1109] select t0.id, t0.when_archived, t0.feature_key, t0.alias, t0.name, t0.secret, t0.link, t0.value_type, t0.when_updated, t0.when_created, t0.version, t0.fk_app_id from fh_app_feature t0 where t0.id = ?; --bind(2b86605b-1a81-4fc7-80b7-17edc5e3206e, ) --micros(697)","priority":"DEBUG","path":"io.ebean.SQL","thread":"grizzly-http-server-1","host":"my-computer","user":{"id":"68c09a3d-6e44-4379-bfc1-3e75af59af38","email":"irina@i.com"}}
```

--------------------------------

### Retrieve Application Rollout Strategies Response

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Example JSON response structure for the listApplicationRolloutStrategies endpoint.

```json
[
  {
    "rolloutStrategy": {
      "id": "string",
      "percentage": 0,
      "percentageAttributes": [
        "string"
],
      "value": null,
      "attributes": [
        {
          "conditional": "EQUALS",
          "fieldName": "string",
          "values": [
            null
],
          "type": "STRING",
          "id": "string"
        }
],
      "name": "string",
      "colouring": 0,
      "avatar": "string"
    },
    "whenArchived": "2019-08-24T14:15:22Z",
    "changedBy": {
      "id": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "name": "string",
      "email": "user@example.com",
      "personType": "person",
      "other": "string",
      "source": "string",
      "version": 0,
      "passwordRequiresReset": true,
      "groups": [
        {
          "createdBy": { },
          "updatedBy": { },
          "whenCreated": "2019-08-24T14:15:22Z",
          "whenUpdated": "2019-08-24T14:15:22Z",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "admin": true,
          "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
          "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
          "version": 0,
          "name": "string",
          "members": [
            { }
],
          "applicationRoles": [
            {
              "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
              "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
              "roles": [
                "FEATURE_EDIT"
              ]
            }
],
          "environmentRoles": [
            {
              "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
              "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
              "roles": [
                "READ"
              ]
            }
],
          "whenArchived": "2019-08-24T14:15:22Z"
        }
],
      "whenArchived": "2019-08-24T14:15:22Z",
      "whenLastAuthenticated": "2019-08-24T14:15:22Z",
      "whenLastSeen": "2019-08-24T14:15:22Z",
      "additional": [
        {
          "key": "string",
          "value": "string"
        }
]
    }
  }
]
```

--------------------------------

### POST /mr-api/initialize

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Sets up the site administrator for the Feature Hub instance.

```APIDOC
## POST /mr-api/initialize

### Description
Setup site admin.

### Method
POST

### Endpoint
/mr-api/initialize

### Parameters
#### Request Body
- **SetupSiteAdmin** (object) - Required - Data required to setup site admin.

### Response
#### Success Response (200)
- **TokenizedPerson** (object) - Successfully setup site admin.
```

--------------------------------

### SetupSiteAdmin Schema

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Defines the structure for initializing a site administrator account.

```APIDOC
## SetupSiteAdmin

### Request Body
- **portfolio** (string) - Required - The portfolio name.
- **organizationName** (string) - Required - The organization name.
- **emailAddress** (string) - Optional - User's email or blank if using oauth/saml.
- **password** (string) - Optional - User's password or blank if using oauth/saml.
- **name** (string) - Optional - User's name. Will be taken from external provider if using oauth/saml.
- **authProvider** (string) - Optional - If the site is using external providers, this is the key of the provider chosen.
```

--------------------------------

### List Cloud SQL databases

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Verify the existing database schemas on the instance.

```bash
gcloud sql databases list --instance=$FH_DB_NAME
```

--------------------------------

### GET /mr-api/logout

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Deactivates the current user session by token.

```APIDOC
## GET /mr-api/logout

### Description
Deactivates the current user session using the provided bearer token.

### Method
GET

### Endpoint
/mr-api/logout

### Response
#### Success Response (204)
- Token deactivated

#### Error Response (400)
- Bad Request

#### Error Response (401)
- no permission
```

--------------------------------

### GET /mr-api/features/{eid}

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves all features for a specified environment.

```APIDOC
## GET /mr-api/features/{eid}

### Description
Get all features for this environment.

### Method
GET

### Endpoint
/mr-api/features/{eid}

### Parameters
#### Path Parameters
- **eid** (string/uuid) - Required - The id of the environment to find features or 'latest'

#### Query Parameters
- **includeFeatures** (boolean) - Optional - include the features in the result
- **filter** (string) - Optional - Filter the feature names by this filter.

### Response
#### Success Response (200)
- **EnvironmentFeaturesResult** (object) - Resulting features
```

--------------------------------

### Deploy Low Volume FeatureHub

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Commands to start the simplified party-server-ish deployment using Docker Compose.

```bash
cd docker-compose-options/party-server-ish-postgres
docker compose up
```

--------------------------------

### Start FeatureHub Server on Linux

Source: https://docs.featurehub.io/featurehub/latest/evaluation.html

Run the FeatureHub party-server container on Linux using host networking.

```bash
docker run --network host --user 999:999 -p 8085:8085 -v $HOME/party:/db featurehub/party-server:latest
```

--------------------------------

### GET /mr-api/environment/{eid}

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves details for a specific environment.

```APIDOC
## GET /mr-api/environment/{eid}

### Description
Get environment details.

### Method
GET

### Endpoint
/mr-api/environment/{eid}

### Parameters
#### Path Parameters
- **eid** (string/uuid) - Required - The id of the environment to find

#### Query Parameters
- **includeSdkUrl** (boolean) - Optional - include the sdk url
- **includeServiceAccounts** (boolean) - Optional - Include the service accounts attached to this environment

### Response
#### Success Response (200)
- **Environment** (object) - Resulting environment
```

--------------------------------

### Initialize API Client

Source: https://docs.featurehub.io/featurehub/latest/admin-development-kit.html

Configure the base path or host/port for the API client and set it as the default.

```java
import io.featurehub.admin.ApiClient;
import io.featurehub.admin.Configuration;

ApiClient api = new ApiClient();
// wherever your host is located
api.setBasePath("http://localhost:8085");

// if you are running a single authenticated client, you can now do this:
Configuration.setDefaultApiClient(api);
// and you won't have to pass the api around
```

```java
import io.featurehub.admin.ApiClient;

ApiClient api = new ApiClient();
// wherever your host is located
api.setHost("localhost").setPort(8085)
// if you are running a single authenticated client, you can now do this:
Configuration.setDefaultApiClient(api);
// and you won't have to pass the api around
```

--------------------------------

### GET /mr-api/person/{id}

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves information about a specific person.

```APIDOC
## GET /mr-api/person/{id}

### Description
Get person.

### Method
GET

### Endpoint
/mr-api/person/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The id of the person to find.

### Response
#### Success Response (200)
- **Person** (object) - If this is a sdk service acocunt, ID of the service account is in the PersonInfo fields with the key serviceAccountId
```

--------------------------------

### GET /mr-api/portfolio/{id}

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves details for a specific portfolio.

```APIDOC
## GET /mr-api/portfolio/{id}

### Description
Get portfolio.

### Method
GET

### Endpoint
/mr-api/portfolio/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The id of the portfolio.

### Response
#### Success Response (200)
- **Portfolio** (object) - Resulting portfolio.
```

--------------------------------

### Deploy to Cloud Run

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Execute the deployment command with environment variables for database connectivity.

```bash
export HOST_URL=http://localhost
gcloud run deploy $FH_CR_NAME --image=$FH_IMAGE --min-instances=0 --max-instances=3 --cpu=2 --memory=512Mi --port=8085 --concurrency=400 "--set-env-vars=db.url=jdbc:postgresql:///$FH_DB_SCHEMA,db.username=postgres,db.password=$FH_DB_PASSWORD,db.minConnections=3,db.maxConnections=100,monitor.port=8701,db.customProperties=cloudSqlInstance=$FH_DB_CONN_NAME;socketFactory=com.google.cloud.sql.postgres.SocketFactory" --set-cloudsql-instances=$FH_DB_NAME --platform=managed --region=$GCP_REGION --allow-unauthenticated
```

--------------------------------

### Start FeatureHub Server on Mac or Windows

Source: https://docs.featurehub.io/featurehub/latest/evaluation.html

Run the FeatureHub party-server container on non-Linux systems, mapping a local directory for database persistence.

```bash
docker run -p 8085:8085 --user 999:999 -v $HOME/party:/db featurehub/party-server:latest
```

--------------------------------

### GET /features/

Source: https://docs.featurehub.io/featurehub/latest/_attachments/sdk-api.yaml

Requests all features for the specified SDK URL.

```APIDOC
## GET /features/

### Description
Requests all features for this sdkurl and disconnects.

### Method
GET

### Endpoint
/features/

### Parameters
#### Query Parameters
- **apiKey** (array) - Required - A list of API keys to retrieve information about
- **contextSha** (string) - Optional - A SHA of the context in string form designed to break any cache if the client changes context.

### Response
#### Success Response (200)
- **FeatureEnvironmentCollection** (array) - feature request successful, all environments you have permission to or that were found are returned
```

--------------------------------

### GET /mr-api/application/{appId}/summary

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Retrieves a summary of the application status.

```APIDOC
## GET /mr-api/application/{appId}/summary

### Description
Get a summary of the application status.

### Method
GET

### Endpoint
/mr-api/application/{appId}/summary

### Parameters
#### Path Parameters
- **appId** (string <uuid>) - Required - The id of the application to find

### Response
#### Success Response (200)
- **groupsHavePermission** (boolean) - Resulting application status
- **serviceAccountsHavePermission** (boolean) - Resulting application status
- **featureCount** (integer) - Resulting application status
- **environmentCount** (integer) - Resulting application status
```

--------------------------------

### Create Cloud SQL Postgres instance

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Initialize a small Postgres 13 instance with SSL enabled.

```bash
export FH_DB_NAME=featurehub-db
export FH_DB_PASSWORD=FeatureHub17#
export FH_DB_SCHEMA=featurehub

gcloud sql instances create $FH_DB_NAME --database-version=POSTGRES_13 --zone=$GCP_ZONE --tier=db-f1-micro "--root-password=$FH_DB_PASSWORD" --assign-ip --require-ssl --storage-type=SSD
```

--------------------------------

### GET /mr-api/application/{appId}

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Retrieves the details of a specific application by its ID.

```APIDOC
## GET /mr-api/application/{appId}

### Description
Get application details by providing the application ID.

### Method
GET

### Endpoint
/mr-api/application/{appId}

### Parameters
#### Path Parameters
- **appId** (string <uuid>) - Required - The id of the application to find

#### Query Parameters
- **includeEnvironments** (boolean) - Optional - Include the environments in the result

### Response
#### Success Response (200)
- **Resulting application** (object) - The application object containing details like name, description, and metadata.

#### Response Example
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  "version": 0
}
```

--------------------------------

### Request Payload for setupSiteAdmin

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

JSON payload required to initialize the site administrator.

```json
{
  * "portfolio": "string",
  * "organizationName": "string",
  * "emailAddress": "user@example.com",
  * "password": "string",
  * "name": "string",
  * "authProvider": "string"

}
```

--------------------------------

### GET /mr-api/group/{gid}

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves details for a specific group by its ID.

```APIDOC
## GET /mr-api/group/{gid}

### Description
Get group

### Method
GET

### Endpoint
/mr-api/group/{gid}

### Parameters
#### Path Parameters
- **gid** (string/uuid) - Required - The id of the group to find

#### Query Parameters
- **byApplicationId** (string/uuid) - Optional - Filter by application ID
- **includeMembers** (boolean) - Optional - Include people in each group

### Response
#### Success Response (200)
- **Group** (object) - Resulting group
```

--------------------------------

### GET /mr-api/portfolio

Source: https://docs.featurehub.io/featurehub/latest/_attachments/api.yaml

Retrieves a list of portfolios with optional filtering and ordering.

```APIDOC
## GET /mr-api/portfolio

### Description
Gets a list of portfolios.

### Method
GET

### Endpoint
/mr-api/portfolio

### Parameters
#### Query Parameters
- **order** (SortOrder) - Optional - how to order the results
- **filter** (string) - Optional - What to filter the results by
- **parentPortfolioId** (string) - Optional - The parent portfolio to search under. If none is provided, use the top level one
- **includeGroups** (boolean) - Optional - Include groups for this this portfolio in results
- **includeApplications** (boolean) - Optional - Include applications for this portfolio in results

### Response
#### Success Response (200)
- **Portfolio[]** (array) - Gets all portfolios, alphabetically sorted.
```

--------------------------------

### Configure ClientContext in C#

Source: https://docs.featurehub.io/featurehub/latest/sdks-development.html

Demonstrates the fluid API for setting attributes and building the context in the C# SDK.

```csharp
     await _fhConfig.NewContext()
        .Attr("city", "Istanbul City")
        .Attrs("family", new List<String> {"Bambam", "DJ Elif"})
        .Country(StrategyAttributeCountryName.Turkey)
        .Platform(StrategyAttributePlatformName.Ios)
        .Device(StrategyAttributeDeviceName.Mobile)
        .UserKey("tv-show")
        .Version("6.2.3")
        .SessionKey("session-key").Build();
```

--------------------------------

### Configure Google Cloud SDK environment

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Set the project, region, and zone for your Google Cloud environment.

```bash
export GCP_REGION=us-east1
export GCP_ZONE=us-east1-b
gcloud config set project your-project
gcloud config set compute/zone $GCP_ZONE
```

--------------------------------

### Deploy Low Volume Production Environment

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Deploys an all-in-one containerized instance configured for production use with persistent external databases.

```bash
cd docker-compose-options/all-in-one-postgres
docker compose up
```

```bash
cd docker-compose-options/all-in-one-mysql
docker compose up
```

--------------------------------

### Retrieve Feature Group Response

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Example JSON response for the getFeatureGroup endpoint.

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "order": 0,
  "description": "string",
  "version": 0,
  "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
  "environmentName": "string",
  "features": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "key": "string",
      "value": null,
      "type": "BOOLEAN",
      "locked": true
    }
  ],
  "strategies": [
    {
      "id": "string",
      "name": "string",
      "percentage": 0,
      "percentageAttributes": [
        "string"
      ],
      "attributes": [
        {
          "conditional": "EQUALS",
          "fieldName": "string",
          "values": [
            null
          ],
          "type": "STRING",
          "id": "string"
        }
      ]
    }
  ]
}
```

--------------------------------

### API Request Payload JSON

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Example of the JSON structure for a request payload.

```json
[
  {
    "createdBy": {
      "id": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "name": "string",
      "email": "user@example.com",
      "personType": "person",
      "other": "string",
      "source": "string",
      "version": 0,
      "passwordRequiresReset": true,
      "groups": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "admin": true,
          "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
          "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
          "version": 0,
          "name": "string",
          "members": [
            { }
          ],
          "applicationRoles": [
            {
              "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
              "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
              "roles": [
                "FEATURE_EDIT"
              ]
            }
          ],
          "environmentRoles": [
            {
              "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
              "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
              "roles": [
                "READ"
              ]
            }
          ],
          "whenArchived": "2019-08-24T14:15:22Z"
        }
      ],
      "whenArchived": "2019-08-24T14:15:22Z",
      "whenLastAuthenticated": "2019-08-24T14:15:22Z",
      "whenLastSeen": "2019-08-24T14:15:22Z",
      "additional": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "updatedBy": {
      "id": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "name": "string",
      "email": "user@example.com",
      "personType": "person",
      "other": "string",
      "source": "string",
      "version": 0,
      "passwordRequiresReset": true,
      "groups": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "admin": true,
          "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
          "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
          "version": 0,
          "name": "string",
          "members": [
            { }
          ],
          "applicationRoles": [
            {
              "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
              "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
              "roles": [
                "FEATURE_EDIT"
              ]
            }
          ],
          "environmentRoles": [
            {
              "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
              "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
              "roles": [
                "READ"
              ]
            }
          ],
          "whenArchived": "2019-08-24T14:15:22Z"
        }
      ],
      "whenArchived": "2019-08-24T14:15:22Z",
      "whenLastAuthenticated": "2019-08-24T14:15:22Z",
      "whenLastSeen": "2019-08-24T14:15:22Z",
      "additional": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    },
    "whenCreated": "2019-08-24T14:15:22Z",
    "whenUpdated": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
    "name": "string",
    "priorEnvironmentId": "2aa61e39-26b7-4bfc-9551-f8b7783525ce",
    "version": 0,
    "description": "string",
    "production": true,
    "groupRoles": [
      {
        "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
        "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
        "roles": [
          "READ"
        ]
      }
    ],
    "features": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "key": "string",
        "alias": "string",
        "link": "string",
        "name": "string",
        "valueType": "BOOLEAN",
        "version": 0,
        "whenArchived": "2019-08-24T14:15:22Z",
        "secret": true,
        "description": "string",
        "metaData": "string"
      }
    ],
    "environmentInfo": {
      "property1": "string",
      "property2": "string"
    },
    "serviceAccountPermission": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "permissions": [
          "READ"
        ],
        "serviceAccount": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
          "description": "string",
          "version": 0,
          "apiKeyClientSide": "string",
          "apiKeyServerSide": "string",
          "permissions": [
            { }
          ],
          "whenArchived": "2019-08-24T14:15:22Z"
        },
        "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
        "sdkUrlClientEval": "string",
        "sdkUrlServerEval": "string"
      }
    ],
    "whenArchived": "2019-08-24T14:15:22Z"
  }
]
```

--------------------------------

### Describe Cloud SQL instance

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Retrieve instance details to obtain the connection name.

```bash
gcloud sql instances describe $FH_DB_NAME
```

--------------------------------

### Application Creation Request Payload

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

Example JSON payload for the createApplication request.

```json
{
  "createdBy": {
    "id": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
    "name": "string",
    "email": "user@example.com",
    "personType": "person",
    "other": "string",
    "source": "string",
    "version": 0,
    "passwordRequiresReset": true,
    "groups": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "admin": true,
        "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "version": 0,
        "name": "string",
        "members": [
          { }
],
        "applicationRoles": [
          {
            "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
            "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
            "roles": [
              "FEATURE_EDIT"
]
}
],
        "environmentRoles": [
          {
            "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
            "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
            "roles": [
              "READ"
]
}
],
        "whenArchived": "2019-08-24T14:15:22Z"
}
],
    "whenArchived": "2019-08-24T14:15:22Z",
    "whenLastAuthenticated": "2019-08-24T14:15:22Z",
    "whenLastSeen": "2019-08-24T14:15:22Z",
    "additional": [
      {
        "key": "string",
        "value": "string"
}
]
},
  "updatedBy": {
    "id": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
    "name": "string",
    "email": "user@example.com",
    "personType": "person",
    "other": "string",
    "source": "string",
    "version": 0,
    "passwordRequiresReset": true,
    "groups": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "admin": true,
        "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
        "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
        "version": 0,
        "name": "string",
        "members": [
          { }
],
        "applicationRoles": [
          {
            "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
            "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
            "roles": [
              "FEATURE_EDIT"
]
}
],
        "environmentRoles": [
          {
            "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
            "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
            "roles": [
              "READ"
]
}
],
        "whenArchived": "2019-08-24T14:15:22Z"
}
],
    "whenArchived": "2019-08-24T14:15:22Z",
    "whenLastAuthenticated": "2019-08-24T14:15:22Z",
    "whenLastSeen": "2019-08-24T14:15:22Z",
    "additional": [
      {
        "key": "string",
        "value": "string"
}
]
},
  "whenCreated": "2019-08-24T14:15:22Z",
  "whenUpdated": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
  "version": 0,
  "groups": [
    {
      "createdBy": {
        "id": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
},
        "name": "string",
        "email": "user@example.com",
        "personType": "person",
        "other": "string",
        "source": "string",
        "version": 0,
        "passwordRequiresReset": true,
        "groups": [
          null
],
        "whenArchived": "2019-08-24T14:15:22Z",
        "whenLastAuthenticated": "2019-08-24T14:15:22Z",
        "whenLastSeen": "2019-08-24T14:15:22Z",
        "additional": [
          {
            "key": "string",
            "value": "string"
}
]
},
      "updatedBy": {
        "id": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
```

--------------------------------

### Example x-featurehub Header Output

Source: https://docs.featurehub.io/featurehub/latest/sdks-development.html

The resulting header string generated by the C# ClientContext configuration.

```text
city=Istanbul+City,country=turkey,device=mobile,family=Bambam%2cDJ+Elif,platform=ios,session=session-key,userkey=tv-show,version=6.2.3
```

--------------------------------

### Define deployment variables

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Set the service name and image version for Cloud Run.

```bash
export FH_CR_NAME=featurehub
export FH_IMAGE=featurehub/party-server-ish:1.5.4
```

--------------------------------

### Response sample for getAllFeatureValuesByApplicationForKey

Source: https://docs.featurehub.io/featurehub/latest/api-definition.html

JSON response structure containing environment and user access details for a specific feature key.

```json
[
  {
    "environment": {
      "createdBy": {
        "id": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        },
        "name": "string",
        "email": "user@example.com",
        "personType": "person",
        "other": "string",
        "source": "string",
        "version": 0,
        "passwordRequiresReset": true,
        "groups": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "admin": true,
            "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "version": 0,
            "name": "string",
            "members": [
              {}
            ],
            "applicationRoles": [
              {
                "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
                "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
                "roles": [
                  "FEATURE_EDIT"
                ]
              }
            ],
            "environmentRoles": [
              {
                "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
                "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
                "roles": [
                  "READ"
                ]
              }
            ],
            "whenArchived": "2019-08-24T14:15:22Z"
          }
        ],
        "whenArchived": "2019-08-24T14:15:22Z",
        "whenLastAuthenticated": "2019-08-24T14:15:22Z",
        "whenLastSeen": "2019-08-24T14:15:22Z",
        "additional": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      "updatedBy": {
        "id": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
        },
        "name": "string",
        "email": "user@example.com",
        "personType": "person",
        "other": "string",
        "source": "string",
        "version": 0,
        "passwordRequiresReset": true,
        "groups": [
          {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "admin": true,
            "portfolioId": "2a9b0ad6-e5de-4239-a282-527c92c7c0f1",
            "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
            "version": 0,
            "name": "string",
            "members": [
              {}
            ],
            "applicationRoles": [
              {
                "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
                "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
                "roles": [
                  "FEATURE_EDIT"
                ]
              }
            ],
            "environmentRoles": [
              {
                "environmentId": "19f5cc2e-7657-437a-9268-83cd3d563563",
                "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
                "roles": [
                  "READ"
                ]
              }
            ],
            "whenArchived": "2019-08-24T14:15:22Z"
          }
        ],
        "whenArchived": "2019-08-24T14:15:22Z",
        "whenLastAuthenticated": "2019-08-24T14:15:22Z",
        "whenLastSeen": "2019-08-24T14:15:22Z",
        "additional": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      "whenCreated": "2019-08-24T14:15:22Z"
    }
```

--------------------------------

### Get Portfolio Details

Source: https://docs.featurehub.io/featurehub/latest/admin-development-kit.html

Retrieves detailed information for a specific portfolio by its ID.

```java
Portfolio getPortfolio(UUID id, Boolean includeGroups, Boolean includeApplications, Boolean includeEnvironments)
```

```java
Portfolio portfolio = portfolioService.getPortfolio(id, true, true, true)
```

--------------------------------

### Get Server Version Response

Source: https://docs.featurehub.io/featurehub/latest/sdk-api-definition.html

The JSON structure returned by the getInfoVersion endpoint.

```json
{
  "name": "string",
  "version": "string"
}
```

--------------------------------

### Deploy Scalable FeatureHub

Source: https://docs.featurehub.io/featurehub/latest/installation.html

Commands to start the scalable deployment separating the Management Repository and Edge REST services.

```bash
cd docker-compose-options/mr-edge-rest-postgres
docker compose up
```
Tokens:
Raw