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

Latest commit

 

History

History
169 lines (106 loc) · 5.86 KB

DataExportDestinationsApi.md

File metadata and controls

169 lines (106 loc) · 5.86 KB

DataExportDestinationsApi

All URIs are relative to /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

Get a single data export destination by ID

Example

 deleteDestination projectKey=value environmentKey=value destinationId=value

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

(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

Get a single data export destination by ID

Example

 getDestination projectKey=value environmentKey=value destinationId=value

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

Returns a list of all data export destinations.

Example

 getDestinations

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

Perform a partial update to a data export destination.

Example

 patchDestination projectKey=value environmentKey=value destinationId=value

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 array[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.

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

Create a new data export destination

Example

 postDestination projectKey=value environmentKey=value

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]