cloudfoundry/cloud_controller_ng

View on GitHub
docs/v3/source/includes/resources/feature_flags/_update.md.erb

Summary

Maintainability
Test Coverage
### Update a feature flag

```
Example Request
```

```shell
curl "https://api.example.org/v3/feature_flags/[name]" \
  -X PATCH \
  -H "Authorization: bearer [token]" \
  -H "Content-type: application/json" \
  -d '{
    "enabled": true,
    "custom_error_message": "error message the user sees"
  }'
```

```
Example Response
```

```http
HTTP/1.1 200 OK
Content-Type: application/json

<%= yield_content :single_feature_flag %>
```

#### Definition
`PATCH /v3/feature_flags/:name`

#### Optional parameters

Name         | Type      | Description
-----------  | --------  | -----------------------------------------------------------------------------
**enabled**  | _boolean_ | Whether the feature flag is enabled
**custom_error_message** | _string_  | The error string returned by the API when a client performs an action disabled by the feature flag

#### Permitted roles

      |
----- | ---
Admin |