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

     1  # \DataExportDestinationsApi
     2  
     3  All URIs are relative to *https://app.launchdarkly.com/api/v2*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**DeleteDestination**](DataExportDestinationsApi.md#DeleteDestination) | **Delete** /destinations/{projectKey}/{environmentKey}/{destinationId} | Get a single data export destination by ID
     8  [**GetDestination**](DataExportDestinationsApi.md#GetDestination) | **Get** /destinations/{projectKey}/{environmentKey}/{destinationId} | Get a single data export destination by ID
     9  [**GetDestinations**](DataExportDestinationsApi.md#GetDestinations) | **Get** /destinations | Returns a list of all data export destinations.
    10  [**PatchDestination**](DataExportDestinationsApi.md#PatchDestination) | **Patch** /destinations/{projectKey}/{environmentKey}/{destinationId} | Perform a partial update to a data export destination.
    11  [**PostDestination**](DataExportDestinationsApi.md#PostDestination) | **Post** /destinations/{projectKey}/{environmentKey} | Create a new data export destination
    12  
    13  
    14  # **DeleteDestination**
    15  > DeleteDestination(ctx, projectKey, environmentKey, destinationId)
    16  Get a single data export destination by ID
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    24    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
    25    **destinationId** | **string**| The data export destination ID. | 
    26  
    27  ### Return type
    28  
    29   (empty response body)
    30  
    31  ### Authorization
    32  
    33  [Token](../README.md#Token)
    34  
    35  ### HTTP request headers
    36  
    37   - **Content-Type**: application/json
    38   - **Accept**: application/json
    39  
    40  [[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)
    41  
    42  # **GetDestination**
    43  > Destination GetDestination(ctx, projectKey, environmentKey, destinationId)
    44  Get a single data export destination by ID
    45  
    46  ### Required Parameters
    47  
    48  Name | Type | Description  | Notes
    49  ------------- | ------------- | ------------- | -------------
    50   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    51    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
    52    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
    53    **destinationId** | **string**| The data export destination ID. | 
    54  
    55  ### Return type
    56  
    57  [**Destination**](Destination.md)
    58  
    59  ### Authorization
    60  
    61  [Token](../README.md#Token)
    62  
    63  ### HTTP request headers
    64  
    65   - **Content-Type**: application/json
    66   - **Accept**: application/json
    67  
    68  [[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)
    69  
    70  # **GetDestinations**
    71  > Destinations GetDestinations(ctx, )
    72  Returns a list of all data export destinations.
    73  
    74  ### Required Parameters
    75  This endpoint does not need any parameter.
    76  
    77  ### Return type
    78  
    79  [**Destinations**](Destinations.md)
    80  
    81  ### Authorization
    82  
    83  [Token](../README.md#Token)
    84  
    85  ### HTTP request headers
    86  
    87   - **Content-Type**: application/json
    88   - **Accept**: application/json
    89  
    90  [[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)
    91  
    92  # **PatchDestination**
    93  > Destination PatchDestination(ctx, projectKey, environmentKey, destinationId, patchOnly)
    94  Perform a partial update to a data export destination.
    95  
    96  ### Required Parameters
    97  
    98  Name | Type | Description  | Notes
    99  ------------- | ------------- | ------------- | -------------
   100   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   101    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   102    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   103    **destinationId** | **string**| The data export destination ID. | 
   104    **patchOnly** | [**[]PatchOperation**](PatchOperation.md)| Requires a JSON Patch representation of the desired changes to the project. '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. | 
   105  
   106  ### Return type
   107  
   108  [**Destination**](Destination.md)
   109  
   110  ### Authorization
   111  
   112  [Token](../README.md#Token)
   113  
   114  ### HTTP request headers
   115  
   116   - **Content-Type**: application/json
   117   - **Accept**: application/json
   118  
   119  [[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)
   120  
   121  # **PostDestination**
   122  > Destination PostDestination(ctx, projectKey, environmentKey, destinationBody)
   123  Create a new data export destination
   124  
   125  ### Required Parameters
   126  
   127  Name | Type | Description  | Notes
   128  ------------- | ------------- | ------------- | -------------
   129   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   130    **projectKey** | **string**| The project key, used to tie the flags together under one project so they can be managed together. | 
   131    **environmentKey** | **string**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. | 
   132    **destinationBody** | [**DestinationBody**](DestinationBody.md)| Create a new data export destination. | 
   133  
   134  ### Return type
   135  
   136  [**Destination**](Destination.md)
   137  
   138  ### Authorization
   139  
   140  [Token](../README.md#Token)
   141  
   142  ### HTTP request headers
   143  
   144   - **Content-Type**: application/json
   145   - **Accept**: application/json
   146  
   147  [[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)
   148