Skip to content

Latest commit

 

History

History
377 lines (239 loc) · 10.3 KB

DataExportDestinationsApi.md

File metadata and controls

377 lines (239 loc) · 10.3 KB
Raw

\DataExportDestinationsApi

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

Method HTTP request Description
DeleteDestination Delete /api/v2/destinations/{projKey}/{envKey}/{id} Delete Data Export destination
GetDestination Get /api/v2/destinations/{projKey}/{envKey}/{id} Get destination
GetDestinations Get /api/v2/destinations List destinations
PatchDestination Patch /api/v2/destinations/{projKey}/{envKey}/{id} Update Data Export destination
PostDestination Post /api/v2/destinations/{projKey}/{envKey} Create data export destination

DeleteDestination

DeleteDestination(ctx, projKey, envKey, id).Execute()

Delete Data Export destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    projKey := "projKey_example" // string | The project key
    envKey := "envKey_example" // string | The environment key
    id := "id_example" // string | The Data Export destination ID

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DataExportDestinationsApi.DeleteDestination(context.Background(), projKey, envKey, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataExportDestinationsApi.DeleteDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projKey string The project key
envKey string The environment key
id string The Data Export destination ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteDestinationRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

ApiKey

HTTP request headers

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

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

GetDestination

Destination GetDestination(ctx, projKey, envKey, id).Execute()

Get destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    projKey := "projKey_example" // string | The project key
    envKey := "envKey_example" // string | The environment key
    id := "id_example" // string | The Data Export destination ID

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DataExportDestinationsApi.GetDestination(context.Background(), projKey, envKey, id).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataExportDestinationsApi.GetDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDestination`: Destination
    fmt.Fprintf(os.Stdout, "Response from `DataExportDestinationsApi.GetDestination`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projKey string The project key
envKey string The environment key
id string The Data Export destination ID

Other Parameters

Other parameters are passed through a pointer to a apiGetDestinationRequest struct via the builder pattern

Name Type Description Notes

Return type

Destination

Authorization

ApiKey

HTTP request headers

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

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

GetDestinations

Destinations GetDestinations(ctx).Execute()

List destinations

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DataExportDestinationsApi.GetDestinations(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataExportDestinationsApi.GetDestinations``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetDestinations`: Destinations
    fmt.Fprintf(os.Stdout, "Response from `DataExportDestinationsApi.GetDestinations`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetDestinationsRequest struct via the builder pattern

Return type

Destinations

Authorization

ApiKey

HTTP request headers

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

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

PatchDestination

Destination PatchDestination(ctx, projKey, envKey, id).PatchOperation(patchOperation).Execute()

Update Data Export destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    projKey := "projKey_example" // string | The project key
    envKey := "envKey_example" // string | The environment key
    id := "id_example" // string | The Data Export destination ID
    patchOperation := []openapiclient.PatchOperation{*openapiclient.NewPatchOperation("replace", "/biscuits", interface{}(Chocolate Digestive))} // []PatchOperation | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DataExportDestinationsApi.PatchDestination(context.Background(), projKey, envKey, id).PatchOperation(patchOperation).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataExportDestinationsApi.PatchDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PatchDestination`: Destination
    fmt.Fprintf(os.Stdout, "Response from `DataExportDestinationsApi.PatchDestination`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projKey string The project key
envKey string The environment key
id string The Data Export destination ID

Other Parameters

Other parameters are passed through a pointer to a apiPatchDestinationRequest struct via the builder pattern

Name Type Description Notes

patchOperation | []PatchOperation | |

Return type

Destination

Authorization

ApiKey

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(ctx, projKey, envKey).DestinationPost(destinationPost).Execute()

Create data export destination

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    projKey := "projKey_example" // string | The project key
    envKey := "envKey_example" // string | The environment key
    destinationPost := *openapiclient.NewDestinationPost() // DestinationPost | 

    configuration := openapiclient.NewConfiguration()
    api_client := openapiclient.NewAPIClient(configuration)
    resp, r, err := api_client.DataExportDestinationsApi.PostDestination(context.Background(), projKey, envKey).DestinationPost(destinationPost).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `DataExportDestinationsApi.PostDestination``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `PostDestination`: Destination
    fmt.Fprintf(os.Stdout, "Response from `DataExportDestinationsApi.PostDestination`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
projKey string The project key
envKey string The environment key

Other Parameters

Other parameters are passed through a pointer to a apiPostDestinationRequest struct via the builder pattern

Name Type Description Notes

destinationPost | DestinationPost | |

Return type

Destination

Authorization

ApiKey

HTTP request headers

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

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