Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

DataExportDestinationsApi.md

Latest commit

 

History

History
351 lines (268 loc) · 13.4 KB

DataExportDestinationsApi.md

File metadata and controls

351 lines (268 loc) · 13.4 KB

LaunchDarkly.Api.Api.DataExportDestinationsApi

All URIs are relative to https://app.launchdarkly.com/api/v2

Method HTTP request Description
DeleteDestination DELETE /destinations/{projectKey}/{environmentKey}/{destinationId} Get a single data export destination by ID
GetDestination GET /destinations/{projectKey}/{environmentKey}/{destinationId} Get a single data export destination by ID
GetDestinations GET /destinations Returns a list of all data export destinations.
PatchDestination PATCH /destinations/{projectKey}/{environmentKey}/{destinationId} Perform a partial update to a data export destination.
PostDestination POST /destinations/{projectKey}/{environmentKey} Create a new data export destination

DeleteDestination

void DeleteDestination (string projectKey, string environmentKey, string destinationId)

Get a single data export destination by ID

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class DeleteDestinationExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataExportDestinationsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var destinationId = destinationId_example;  // string | The data export destination ID.

            try
            {
                // Get a single data export destination by ID
                apiInstance.DeleteDestination(projectKey, environmentKey, destinationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExportDestinationsApi.DeleteDestination: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
destinationId string The data export destination ID.

Return type

void (empty response body)

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDestination

Destination GetDestination (string projectKey, string environmentKey, string destinationId)

Get a single data export destination by ID

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class GetDestinationExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataExportDestinationsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var destinationId = destinationId_example;  // string | The data export destination ID.

            try
            {
                // Get a single data export destination by ID
                Destination result = apiInstance.GetDestination(projectKey, environmentKey, destinationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExportDestinationsApi.GetDestination: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
destinationId string The data export destination ID.

Return type

Destination

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDestinations

Destinations GetDestinations ()

Returns a list of all data export destinations.

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class GetDestinationsExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataExportDestinationsApi();

            try
            {
                // Returns a list of all data export destinations.
                Destinations result = apiInstance.GetDestinations();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExportDestinationsApi.GetDestinations: " + e.Message );
            }
        }
    }
}

Parameters

This endpoint does not need any parameter.

Return type

Destinations

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchDestination

Destination PatchDestination (string projectKey, string environmentKey, string destinationId, List patchOnly)

Perform a partial update to a data export destination.

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class PatchDestinationExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataExportDestinationsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var destinationId = destinationId_example;  // string | The data export destination ID.
            var patchOnly = new List<PatchOperation>(); // List<PatchOperation> | 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.

            try
            {
                // Perform a partial update to a data export destination.
                Destination result = apiInstance.PatchDestination(projectKey, environmentKey, destinationId, patchOnly);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExportDestinationsApi.PatchDestination: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
destinationId string The data export destination ID.
patchOnly List Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/&#39; Feature flag patches also support JSON Merge Patch format. 'https://tools.ietf.org/html/rfc7386&#39; The addition of comments is also supported.

Return type

Destination

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PostDestination

Destination PostDestination (string projectKey, string environmentKey, DestinationBody destinationBody)

Create a new data export destination

Example

using System;
using System.Diagnostics;
using LaunchDarkly.Api.Api;
using LaunchDarkly.Api.Client;
using LaunchDarkly.Api.Model;

namespace Example
{
    public class PostDestinationExample
    {
        public void main()
        {
            
            // Configure API key authorization: Token
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataExportDestinationsApi();
            var projectKey = projectKey_example;  // string | The project key, used to tie the flags together under one project so they can be managed together.
            var environmentKey = environmentKey_example;  // string | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
            var destinationBody = new DestinationBody(); // DestinationBody | Create a new data export destination.

            try
            {
                // Create a new data export destination
                Destination result = apiInstance.PostDestination(projectKey, environmentKey, destinationBody);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataExportDestinationsApi.PostDestination: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
projectKey string The project key, used to tie the flags together under one project so they can be managed together.
environmentKey string The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
destinationBody DestinationBody Create a new data export destination.

Return type

Destination

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]