github.com/launchdarkly/api-client-go@v5.3.0+incompatible/docs/FeatureFlagsApi.md (about)

     1  # \FeatureFlagsApi
     2  
     3  All URIs are relative to *https://app.launchdarkly.com/api/v2*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CopyFeatureFlag**](FeatureFlagsApi.md#CopyFeatureFlag) | **Post** /flags/{projectKey}/{featureFlagKey}/copy | Copies the feature flag configuration from one environment to the same feature flag in another environment.
     8  [**DeleteApprovalRequest**](FeatureFlagsApi.md#DeleteApprovalRequest) | **Delete** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Delete an approval request for a feature flag config
     9  [**DeleteFeatureFlag**](FeatureFlagsApi.md#DeleteFeatureFlag) | **Delete** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
    10  [**DeleteFlagConfigScheduledChanges**](FeatureFlagsApi.md#DeleteFlagConfigScheduledChanges) | **Delete** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Delete a scheduled change on a feature flag in an environment.
    11  [**FlagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet**](FeatureFlagsApi.md#FlagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet) | **Get** /flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | Get dependent flags for the flag in the environment specified in path parameters
    12  [**FlagsProjectKeyFeatureFlagKeyDependentFlagsGet**](FeatureFlagsApi.md#FlagsProjectKeyFeatureFlagKeyDependentFlagsGet) | **Get** /flags/{projectKey}/{featureFlagKey}/dependent-flags | Get dependent flags across all environments for the flag specified in the path parameters
    13  [**GetApprovalRequest**](FeatureFlagsApi.md#GetApprovalRequest) | **Get** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Get a single approval request for a feature flag config
    14  [**GetApprovalRequests**](FeatureFlagsApi.md#GetApprovalRequests) | **Get** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag config
    15  [**GetExpiringUserTargets**](FeatureFlagsApi.md#GetExpiringUserTargets) | **Get** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
    16  [**GetFeatureFlag**](FeatureFlagsApi.md#GetFeatureFlag) | **Get** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
    17  [**GetFeatureFlagStatus**](FeatureFlagsApi.md#GetFeatureFlagStatus) | **Get** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
    18  [**GetFeatureFlagStatusAcrossEnvironments**](FeatureFlagsApi.md#GetFeatureFlagStatusAcrossEnvironments) | **Get** /flag-status/{projectKey}/{featureFlagKey} | Get the status for a particular feature flag across environments
    19  [**GetFeatureFlagStatuses**](FeatureFlagsApi.md#GetFeatureFlagStatuses) | **Get** /flag-statuses/{projectKey}/{environmentKey} | Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
    20  [**GetFeatureFlags**](FeatureFlagsApi.md#GetFeatureFlags) | **Get** /flags/{projectKey} | Get a list of all features in the given project.
    21  [**GetFlagConfigScheduledChange**](FeatureFlagsApi.md#GetFlagConfigScheduledChange) | **Get** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Get a scheduled change on a feature flag by id.
    22  [**GetFlagConfigScheduledChanges**](FeatureFlagsApi.md#GetFlagConfigScheduledChanges) | **Get** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Get all scheduled workflows for a feature flag by key.
    23  [**GetFlagConfigScheduledChangesConflicts**](FeatureFlagsApi.md#GetFlagConfigScheduledChangesConflicts) | **Post** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts | Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
    24  [**PatchExpiringUserTargets**](FeatureFlagsApi.md#PatchExpiringUserTargets) | **Patch** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on feature flag
    25  [**PatchFeatureFlag**](FeatureFlagsApi.md#PatchFeatureFlag) | **Patch** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
    26  [**PatchFlagConfigScheduledChange**](FeatureFlagsApi.md#PatchFlagConfigScheduledChange) | **Patch** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Updates an existing scheduled-change on a feature flag in an environment.
    27  [**PostApplyApprovalRequest**](FeatureFlagsApi.md#PostApplyApprovalRequest) | **Post** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply | Apply approval request for a feature flag config
    28  [**PostApprovalRequest**](FeatureFlagsApi.md#PostApprovalRequest) | **Post** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Create an approval request for a feature flag config
    29  [**PostFeatureFlag**](FeatureFlagsApi.md#PostFeatureFlag) | **Post** /flags/{projectKey} | Creates a new feature flag.
    30  [**PostFlagConfigScheduledChanges**](FeatureFlagsApi.md#PostFlagConfigScheduledChanges) | **Post** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Creates a new scheduled change for a feature flag.
    31  [**PostReviewApprovalRequest**](FeatureFlagsApi.md#PostReviewApprovalRequest) | **Post** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review | Review approval request for a feature flag config
    32  
    33  
    34  # **CopyFeatureFlag**
    35  > FeatureFlag CopyFeatureFlag(ctx, projectKey, featureFlagKey, featureFlagCopyBody)
    36  Copies the feature flag configuration from one environment to the same feature flag in another environment.
    37  
    38  ### Required Parameters
    39  
    40  Name | Type | Description  | Notes
    41  ------------- | ------------- | ------------- | -------------
    42   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    43    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    44    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
    45    **featureFlagCopyBody** | [**FeatureFlagCopyBody**](FeatureFlagCopyBody.md)| Copy feature flag configurations between environments. | 
    46  
    47  ### Return type
    48  
    49  [**FeatureFlag**](FeatureFlag.md)
    50  
    51  ### Authorization
    52  
    53  [Token](../README.md#Token)
    54  
    55  ### HTTP request headers
    56  
    57   - **Content-Type**: application/json
    58   - **Accept**: application/json
    59  
    60  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    61  
    62  # **DeleteApprovalRequest**
    63  > DeleteApprovalRequest(ctx, projectKey, environmentKey, featureFlagKey, approvalRequestId, optional)
    64  Delete an approval request for a feature flag config
    65  
    66  ### Required Parameters
    67  
    68  Name | Type | Description  | Notes
    69  ------------- | ------------- | ------------- | -------------
    70   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    71    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    72    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
    73    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
    74    **approvalRequestId** | **string**| The approval request ID | 
    75   **optional** | ***FeatureFlagsApiDeleteApprovalRequestOpts** | optional parameters | nil if no parameters
    76  
    77  ### Optional Parameters
    78  Optional parameters are passed through a pointer to a FeatureFlagsApiDeleteApprovalRequestOpts struct
    79  
    80  Name | Type | Description  | Notes
    81  ------------- | ------------- | ------------- | -------------
    82  
    83  
    84  
    85  
    86   **approvalRequestConfigBody** | [**optional.Interface of ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | 
    87  
    88  ### Return type
    89  
    90   (empty response body)
    91  
    92  ### Authorization
    93  
    94  [Token](../README.md#Token)
    95  
    96  ### HTTP request headers
    97  
    98   - **Content-Type**: application/json
    99   - **Accept**: application/json
   100  
   101  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   102  
   103  # **DeleteFeatureFlag**
   104  > DeleteFeatureFlag(ctx, projectKey, featureFlagKey)
   105  Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
   106  
   107  ### Required Parameters
   108  
   109  Name | Type | Description  | Notes
   110  ------------- | ------------- | ------------- | -------------
   111   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   112    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   113    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   114  
   115  ### Return type
   116  
   117   (empty response body)
   118  
   119  ### Authorization
   120  
   121  [Token](../README.md#Token)
   122  
   123  ### HTTP request headers
   124  
   125   - **Content-Type**: application/json
   126   - **Accept**: application/json
   127  
   128  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   129  
   130  # **DeleteFlagConfigScheduledChanges**
   131  > DeleteFlagConfigScheduledChanges(ctx, projectKey, featureFlagKey, environmentKey, scheduledChangeId)
   132  Delete a scheduled change on a feature flag in an environment.
   133  
   134  ### Required Parameters
   135  
   136  Name | Type | Description  | Notes
   137  ------------- | ------------- | ------------- | -------------
   138   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   139    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   140    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   141    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   142    **scheduledChangeId** | **string**| The id of the scheduled change | 
   143  
   144  ### Return type
   145  
   146   (empty response body)
   147  
   148  ### Authorization
   149  
   150  [Token](../README.md#Token)
   151  
   152  ### HTTP request headers
   153  
   154   - **Content-Type**: application/json
   155   - **Accept**: application/json
   156  
   157  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   158  
   159  # **FlagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet**
   160  > DependentFlagsByEnvironment FlagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet(ctx, projectKey, environmentKey, featureFlagKey)
   161  Get dependent flags for the flag in the environment specified in path parameters
   162  
   163  ### Required Parameters
   164  
   165  Name | Type | Description  | Notes
   166  ------------- | ------------- | ------------- | -------------
   167   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   168    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   169    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   170    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   171  
   172  ### Return type
   173  
   174  [**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
   175  
   176  ### Authorization
   177  
   178  [Token](../README.md#Token)
   179  
   180  ### HTTP request headers
   181  
   182   - **Content-Type**: application/json
   183   - **Accept**: application/json
   184  
   185  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   186  
   187  # **FlagsProjectKeyFeatureFlagKeyDependentFlagsGet**
   188  > MultiEnvironmentDependentFlags FlagsProjectKeyFeatureFlagKeyDependentFlagsGet(ctx, projectKey, featureFlagKey)
   189  Get dependent flags across all environments for the flag specified in the path parameters
   190  
   191  ### Required Parameters
   192  
   193  Name | Type | Description  | Notes
   194  ------------- | ------------- | ------------- | -------------
   195   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   196    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   197    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   198  
   199  ### Return type
   200  
   201  [**MultiEnvironmentDependentFlags**](MultiEnvironmentDependentFlags.md)
   202  
   203  ### Authorization
   204  
   205  [Token](../README.md#Token)
   206  
   207  ### HTTP request headers
   208  
   209   - **Content-Type**: application/json
   210   - **Accept**: application/json
   211  
   212  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   213  
   214  # **GetApprovalRequest**
   215  > ApprovalRequests GetApprovalRequest(ctx, projectKey, featureFlagKey, environmentKey, approvalRequestId)
   216  Get a single approval request for a feature flag config
   217  
   218  ### Required Parameters
   219  
   220  Name | Type | Description  | Notes
   221  ------------- | ------------- | ------------- | -------------
   222   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   223    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   224    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   225    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   226    **approvalRequestId** | **string**| The approval request ID | 
   227  
   228  ### Return type
   229  
   230  [**ApprovalRequests**](ApprovalRequests.md)
   231  
   232  ### Authorization
   233  
   234  [Token](../README.md#Token)
   235  
   236  ### HTTP request headers
   237  
   238   - **Content-Type**: application/json
   239   - **Accept**: application/json
   240  
   241  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   242  
   243  # **GetApprovalRequests**
   244  > ApprovalRequests GetApprovalRequests(ctx, projectKey, featureFlagKey, environmentKey)
   245  Get all approval requests for a feature flag config
   246  
   247  ### Required Parameters
   248  
   249  Name | Type | Description  | Notes
   250  ------------- | ------------- | ------------- | -------------
   251   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   252    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   253    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   254    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   255  
   256  ### Return type
   257  
   258  [**ApprovalRequests**](ApprovalRequests.md)
   259  
   260  ### Authorization
   261  
   262  [Token](../README.md#Token)
   263  
   264  ### HTTP request headers
   265  
   266   - **Content-Type**: application/json
   267   - **Accept**: application/json
   268  
   269  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   270  
   271  # **GetExpiringUserTargets**
   272  > UserTargetingExpirationForFlags GetExpiringUserTargets(ctx, projectKey, environmentKey, featureFlagKey)
   273  Get expiring user targets for feature flag
   274  
   275  ### Required Parameters
   276  
   277  Name | Type | Description  | Notes
   278  ------------- | ------------- | ------------- | -------------
   279   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   280    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   281    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   282    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   283  
   284  ### Return type
   285  
   286  [**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
   287  
   288  ### Authorization
   289  
   290  [Token](../README.md#Token)
   291  
   292  ### HTTP request headers
   293  
   294   - **Content-Type**: application/json
   295   - **Accept**: application/json
   296  
   297  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   298  
   299  # **GetFeatureFlag**
   300  > FeatureFlag GetFeatureFlag(ctx, projectKey, featureFlagKey, optional)
   301  Get a single feature flag by key.
   302  
   303  ### Required Parameters
   304  
   305  Name | Type | Description  | Notes
   306  ------------- | ------------- | ------------- | -------------
   307   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   308    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   309    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   310   **optional** | ***FeatureFlagsApiGetFeatureFlagOpts** | optional parameters | nil if no parameters
   311  
   312  ### Optional Parameters
   313  Optional parameters are passed through a pointer to a FeatureFlagsApiGetFeatureFlagOpts struct
   314  
   315  Name | Type | Description  | Notes
   316  ------------- | ------------- | ------------- | -------------
   317  
   318  
   319   **env** | [**optional.Interface of []string**](string.md)| By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment. | 
   320  
   321  ### Return type
   322  
   323  [**FeatureFlag**](FeatureFlag.md)
   324  
   325  ### Authorization
   326  
   327  [Token](../README.md#Token)
   328  
   329  ### HTTP request headers
   330  
   331   - **Content-Type**: application/json
   332   - **Accept**: application/json
   333  
   334  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   335  
   336  # **GetFeatureFlagStatus**
   337  > FeatureFlagStatus GetFeatureFlagStatus(ctx, projectKey, environmentKey, featureFlagKey)
   338  Get the status for a particular feature flag.
   339  
   340  ### Required Parameters
   341  
   342  Name | Type | Description  | Notes
   343  ------------- | ------------- | ------------- | -------------
   344   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   345    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   346    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   347    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   348  
   349  ### Return type
   350  
   351  [**FeatureFlagStatus**](FeatureFlagStatus.md)
   352  
   353  ### Authorization
   354  
   355  [Token](../README.md#Token)
   356  
   357  ### HTTP request headers
   358  
   359   - **Content-Type**: application/json
   360   - **Accept**: application/json
   361  
   362  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   363  
   364  # **GetFeatureFlagStatusAcrossEnvironments**
   365  > FeatureFlagStatusAcrossEnvironments GetFeatureFlagStatusAcrossEnvironments(ctx, projectKey, featureFlagKey)
   366  Get the status for a particular feature flag across environments
   367  
   368  ### Required Parameters
   369  
   370  Name | Type | Description  | Notes
   371  ------------- | ------------- | ------------- | -------------
   372   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   373    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   374    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   375  
   376  ### Return type
   377  
   378  [**FeatureFlagStatusAcrossEnvironments**](FeatureFlagStatusAcrossEnvironments.md)
   379  
   380  ### Authorization
   381  
   382  [Token](../README.md#Token)
   383  
   384  ### HTTP request headers
   385  
   386   - **Content-Type**: application/json
   387   - **Accept**: application/json
   388  
   389  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   390  
   391  # **GetFeatureFlagStatuses**
   392  > FeatureFlagStatuses GetFeatureFlagStatuses(ctx, projectKey, environmentKey)
   393  Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
   394  
   395  ### Required Parameters
   396  
   397  Name | Type | Description  | Notes
   398  ------------- | ------------- | ------------- | -------------
   399   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   400    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   401    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   402  
   403  ### Return type
   404  
   405  [**FeatureFlagStatuses**](FeatureFlagStatuses.md)
   406  
   407  ### Authorization
   408  
   409  [Token](../README.md#Token)
   410  
   411  ### HTTP request headers
   412  
   413   - **Content-Type**: application/json
   414   - **Accept**: application/json
   415  
   416  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   417  
   418  # **GetFeatureFlags**
   419  > FeatureFlags GetFeatureFlags(ctx, projectKey, optional)
   420  Get a list of all features in the given project.
   421  
   422  ### Required Parameters
   423  
   424  Name | Type | Description  | Notes
   425  ------------- | ------------- | ------------- | -------------
   426   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   427    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   428   **optional** | ***FeatureFlagsApiGetFeatureFlagsOpts** | optional parameters | nil if no parameters
   429  
   430  ### Optional Parameters
   431  Optional parameters are passed through a pointer to a FeatureFlagsApiGetFeatureFlagsOpts struct
   432  
   433  Name | Type | Description  | Notes
   434  ------------- | ------------- | ------------- | -------------
   435  
   436   **env** | [**optional.Interface of []string**](string.md)| By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment. | 
   437   **summary** | **optional.Bool**| By default in api version >= 1, flags will _not_ include their list of prerequisites, targets or rules.  Set summary=0 to include these fields for each flag returned. | 
   438   **archived** | **optional.Bool**| When set to 1, only archived flags will be included in the list of flags returned.  By default, archived flags are not included in the list of flags. | 
   439   **limit** | **optional.Float32**| The number of objects to return. Defaults to -1, which returns everything. | 
   440   **offset** | **optional.Float32**| Where to start in the list. This is for use with pagination. For example, an offset of 10 would skip the first 10 items and then return the next limit items. | 
   441   **filter** | **optional.String**| A comma-separated list of filters. Each filter is of the form field:value. | 
   442   **sort** | **optional.String**| A comma-separated list of fields to sort by. A field prefixed by a - will be sorted in descending order. | 
   443   **tag** | **optional.String**| Filter by tag. A tag can be used to group flags across projects. | 
   444  
   445  ### Return type
   446  
   447  [**FeatureFlags**](FeatureFlags.md)
   448  
   449  ### Authorization
   450  
   451  [Token](../README.md#Token)
   452  
   453  ### HTTP request headers
   454  
   455   - **Content-Type**: application/json
   456   - **Accept**: application/json
   457  
   458  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   459  
   460  # **GetFlagConfigScheduledChange**
   461  > FeatureFlagScheduledChange GetFlagConfigScheduledChange(ctx, projectKey, featureFlagKey, environmentKey, scheduledChangeId)
   462  Get a scheduled change on a feature flag by id.
   463  
   464  ### Required Parameters
   465  
   466  Name | Type | Description  | Notes
   467  ------------- | ------------- | ------------- | -------------
   468   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   469    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   470    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   471    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   472    **scheduledChangeId** | **string**| The id of the scheduled change | 
   473  
   474  ### Return type
   475  
   476  [**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
   477  
   478  ### Authorization
   479  
   480  [Token](../README.md#Token)
   481  
   482  ### HTTP request headers
   483  
   484   - **Content-Type**: application/json
   485   - **Accept**: application/json
   486  
   487  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   488  
   489  # **GetFlagConfigScheduledChanges**
   490  > FeatureFlagScheduledChanges GetFlagConfigScheduledChanges(ctx, projectKey, featureFlagKey, environmentKey)
   491  Get all scheduled workflows for a feature flag by key.
   492  
   493  ### Required Parameters
   494  
   495  Name | Type | Description  | Notes
   496  ------------- | ------------- | ------------- | -------------
   497   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   498    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   499    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   500    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   501  
   502  ### Return type
   503  
   504  [**FeatureFlagScheduledChanges**](FeatureFlagScheduledChanges.md)
   505  
   506  ### Authorization
   507  
   508  [Token](../README.md#Token)
   509  
   510  ### HTTP request headers
   511  
   512   - **Content-Type**: application/json
   513   - **Accept**: application/json
   514  
   515  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   516  
   517  # **GetFlagConfigScheduledChangesConflicts**
   518  > FeatureFlagScheduledChangesConflicts GetFlagConfigScheduledChangesConflicts(ctx, projectKey, featureFlagKey, environmentKey, flagConfigScheduledChangesConflictsBody)
   519  Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
   520  
   521  ### Required Parameters
   522  
   523  Name | Type | Description  | Notes
   524  ------------- | ------------- | ------------- | -------------
   525   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   526    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   527    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   528    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   529    **flagConfigScheduledChangesConflictsBody** | [**FlagConfigScheduledChangesConflictsBody**](FlagConfigScheduledChangesConflictsBody.md)| Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag. | 
   530  
   531  ### Return type
   532  
   533  [**FeatureFlagScheduledChangesConflicts**](FeatureFlagScheduledChangesConflicts.md)
   534  
   535  ### Authorization
   536  
   537  [Token](../README.md#Token)
   538  
   539  ### HTTP request headers
   540  
   541   - **Content-Type**: application/json
   542   - **Accept**: application/json
   543  
   544  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   545  
   546  # **PatchExpiringUserTargets**
   547  > UserTargetingExpirationForFlags PatchExpiringUserTargets(ctx, projectKey, environmentKey, featureFlagKey, semanticPatchWithComment)
   548  Update, add, or delete expiring user targets on feature flag
   549  
   550  ### Required Parameters
   551  
   552  Name | Type | Description  | Notes
   553  ------------- | ------------- | ------------- | -------------
   554   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   555    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   556    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   557    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   558    **semanticPatchWithComment** | [**interface{}**](interface{}.md)| Requires a Semantic Patch representation of the desired changes to the resource. 'https://apidocs.launchdarkly.com/reference#updates-via-semantic-patches'. The addition of comments is also supported. | 
   559  
   560  ### Return type
   561  
   562  [**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
   563  
   564  ### Authorization
   565  
   566  [Token](../README.md#Token)
   567  
   568  ### HTTP request headers
   569  
   570   - **Content-Type**: application/json
   571   - **Accept**: application/json
   572  
   573  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   574  
   575  # **PatchFeatureFlag**
   576  > FeatureFlag PatchFeatureFlag(ctx, projectKey, featureFlagKey, patchComment)
   577  Perform a partial update to a feature.
   578  
   579  ### Required Parameters
   580  
   581  Name | Type | Description  | Notes
   582  ------------- | ------------- | ------------- | -------------
   583   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   584    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   585    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   586    **patchComment** | [**PatchComment**](PatchComment.md)| Requires a JSON Patch representation of the desired changes to the project, and an optional comment. 'http://jsonpatch.com/' Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386' The addition of comments is also supported. | 
   587  
   588  ### Return type
   589  
   590  [**FeatureFlag**](FeatureFlag.md)
   591  
   592  ### Authorization
   593  
   594  [Token](../README.md#Token)
   595  
   596  ### HTTP request headers
   597  
   598   - **Content-Type**: application/json
   599   - **Accept**: application/json
   600  
   601  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   602  
   603  # **PatchFlagConfigScheduledChange**
   604  > FeatureFlagScheduledChange PatchFlagConfigScheduledChange(ctx, projectKey, featureFlagKey, flagConfigScheduledChangesPatchBody, environmentKey, scheduledChangeId)
   605  Updates an existing scheduled-change on a feature flag in an environment.
   606  
   607  ### Required Parameters
   608  
   609  Name | Type | Description  | Notes
   610  ------------- | ------------- | ------------- | -------------
   611   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   612    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   613    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   614    **flagConfigScheduledChangesPatchBody** | [**FlagConfigScheduledChangesPatchBody**](FlagConfigScheduledChangesPatchBody.md)| Update scheduled changes on a feature flag. | 
   615    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   616    **scheduledChangeId** | **string**| The id of the scheduled change | 
   617  
   618  ### Return type
   619  
   620  [**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
   621  
   622  ### Authorization
   623  
   624  [Token](../README.md#Token)
   625  
   626  ### HTTP request headers
   627  
   628   - **Content-Type**: application/json
   629   - **Accept**: application/json
   630  
   631  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   632  
   633  # **PostApplyApprovalRequest**
   634  > ApprovalRequests PostApplyApprovalRequest(ctx, projectKey, featureFlagKey, environmentKey, approvalRequestId, approvalRequestApplyConfigBody)
   635  Apply approval request for a feature flag config
   636  
   637  ### Required Parameters
   638  
   639  Name | Type | Description  | Notes
   640  ------------- | ------------- | ------------- | -------------
   641   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   642    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   643    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   644    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   645    **approvalRequestId** | **string**| The approval request ID | 
   646    **approvalRequestApplyConfigBody** | [**ApprovalRequestApplyConfigBody**](ApprovalRequestApplyConfigBody.md)| Apply an approval request | 
   647  
   648  ### Return type
   649  
   650  [**ApprovalRequests**](ApprovalRequests.md)
   651  
   652  ### Authorization
   653  
   654  [Token](../README.md#Token)
   655  
   656  ### HTTP request headers
   657  
   658   - **Content-Type**: application/json
   659   - **Accept**: application/json
   660  
   661  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   662  
   663  # **PostApprovalRequest**
   664  > ApprovalRequest PostApprovalRequest(ctx, projectKey, featureFlagKey, environmentKey, approvalRequestId, optional)
   665  Create an approval request for a feature flag config
   666  
   667  ### Required Parameters
   668  
   669  Name | Type | Description  | Notes
   670  ------------- | ------------- | ------------- | -------------
   671   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   672    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   673    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   674    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   675    **approvalRequestId** | **string**| The approval request ID | 
   676   **optional** | ***FeatureFlagsApiPostApprovalRequestOpts** | optional parameters | nil if no parameters
   677  
   678  ### Optional Parameters
   679  Optional parameters are passed through a pointer to a FeatureFlagsApiPostApprovalRequestOpts struct
   680  
   681  Name | Type | Description  | Notes
   682  ------------- | ------------- | ------------- | -------------
   683  
   684  
   685  
   686  
   687   **approvalRequestConfigBody** | [**optional.Interface of ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | 
   688  
   689  ### Return type
   690  
   691  [**ApprovalRequest**](ApprovalRequest.md)
   692  
   693  ### Authorization
   694  
   695  [Token](../README.md#Token)
   696  
   697  ### HTTP request headers
   698  
   699   - **Content-Type**: application/json
   700   - **Accept**: application/json
   701  
   702  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   703  
   704  # **PostFeatureFlag**
   705  > FeatureFlag PostFeatureFlag(ctx, projectKey, featureFlagBody, optional)
   706  Creates a new feature flag.
   707  
   708  ### Required Parameters
   709  
   710  Name | Type | Description  | Notes
   711  ------------- | ------------- | ------------- | -------------
   712   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   713    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   714    **featureFlagBody** | [**FeatureFlagBody**](FeatureFlagBody.md)| Create a new feature flag. | 
   715   **optional** | ***FeatureFlagsApiPostFeatureFlagOpts** | optional parameters | nil if no parameters
   716  
   717  ### Optional Parameters
   718  Optional parameters are passed through a pointer to a FeatureFlagsApiPostFeatureFlagOpts struct
   719  
   720  Name | Type | Description  | Notes
   721  ------------- | ------------- | ------------- | -------------
   722  
   723  
   724   **clone** | **optional.String**| The key of the feature flag to be cloned. The key identifies the flag in your code.  For example, setting clone=flagKey will copy the full targeting configuration for all environments (including on/off state) from the original flag to the new flag. | 
   725  
   726  ### Return type
   727  
   728  [**FeatureFlag**](FeatureFlag.md)
   729  
   730  ### Authorization
   731  
   732  [Token](../README.md#Token)
   733  
   734  ### HTTP request headers
   735  
   736   - **Content-Type**: application/json
   737   - **Accept**: application/json
   738  
   739  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   740  
   741  # **PostFlagConfigScheduledChanges**
   742  > FeatureFlagScheduledChange PostFlagConfigScheduledChanges(ctx, projectKey, flagConfigScheduledChangesPostBody, featureFlagKey, environmentKey)
   743  Creates a new scheduled change for a feature flag.
   744  
   745  ### Required Parameters
   746  
   747  Name | Type | Description  | Notes
   748  ------------- | ------------- | ------------- | -------------
   749   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   750    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   751    **flagConfigScheduledChangesPostBody** | [**FlagConfigScheduledChangesPostBody**](FlagConfigScheduledChangesPostBody.md)| Create scheduled changes on a feature flag. | 
   752    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   753    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   754  
   755  ### Return type
   756  
   757  [**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
   758  
   759  ### Authorization
   760  
   761  [Token](../README.md#Token)
   762  
   763  ### HTTP request headers
   764  
   765   - **Content-Type**: application/json
   766   - **Accept**: application/json
   767  
   768  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   769  
   770  # **PostReviewApprovalRequest**
   771  > ApprovalRequests PostReviewApprovalRequest(ctx, projectKey, featureFlagKey, environmentKey, approvalRequestId, approvalRequestReviewConfigBody)
   772  Review approval request for a feature flag config
   773  
   774  ### Required Parameters
   775  
   776  Name | Type | Description  | Notes
   777  ------------- | ------------- | ------------- | -------------
   778   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   779    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   780    **featureFlagKey** | **string**| The feature flag's key. The key identifies the flag in your code. | 
   781    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   782    **approvalRequestId** | **string**| The approval request ID | 
   783    **approvalRequestReviewConfigBody** | [**ApprovalRequestReviewConfigBody**](ApprovalRequestReviewConfigBody.md)| Review an approval request | 
   784  
   785  ### Return type
   786  
   787  [**ApprovalRequests**](ApprovalRequests.md)
   788  
   789  ### Authorization
   790  
   791  [Token](../README.md#Token)
   792  
   793  ### HTTP request headers
   794  
   795   - **Content-Type**: application/json
   796   - **Accept**: application/json
   797  
   798  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   799