launchdarkly_api.IntegrationDeliveryConfigurationsBetaApi

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

Method	HTTP request	Description
create_integration_delivery_configuration	POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}	Create delivery configuration
delete_integration_delivery_configuration	DELETE /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}	Delete delivery configuration
get_integration_delivery_configuration_by_environment	GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}	Get delivery configurations by environment
get_integration_delivery_configuration_by_id	GET /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}	Get delivery configuration by ID
get_integration_delivery_configurations	GET /api/v2/integration-capabilities/featureStore	List all delivery configurations
patch_integration_delivery_configuration	PATCH /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}	Update delivery configuration
validate_integration_delivery_configuration	POST /api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate	Validate delivery configuration

create_integration_delivery_configuration

IntegrationDeliveryConfiguration create_integration_delivery_configuration(project_key, environment_key, integration_key, integration_delivery_configuration_post)

Create delivery configuration

Create a delivery configuration.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.integration_delivery_configuration import IntegrationDeliveryConfiguration
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.integration_delivery_configuration_post import IntegrationDeliveryConfigurationPost
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key
    integration_delivery_configuration_post = IntegrationDeliveryConfigurationPost(
        on=False,
        config=FormVariableConfig(
            key=None,
        ),
        tags=["example-tag"],
        name="Sample integration",
    ) # IntegrationDeliveryConfigurationPost | 

    # example passing only required values which don't have defaults set
    try:
        # Create delivery configuration
        api_response = api_instance.create_integration_delivery_configuration(project_key, environment_key, integration_key, integration_delivery_configuration_post)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->create_integration_delivery_configuration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key
integration_delivery_configuration_post	IntegrationDeliveryConfigurationPost

Return type

IntegrationDeliveryConfiguration

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
201	Integration delivery configuration response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

delete_integration_delivery_configuration

delete_integration_delivery_configuration(project_key, environment_key, integration_key, id)

Delete delivery configuration

Delete a delivery configuration.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key
    id = "id_example" # str | The configuration ID

    # example passing only required values which don't have defaults set
    try:
        # Delete delivery configuration
        api_instance.delete_integration_delivery_configuration(project_key, environment_key, integration_key, id)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->delete_integration_delivery_configuration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key
id	str	The configuration ID

Return type

void (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Action succeeded	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_integration_delivery_configuration_by_environment

IntegrationDeliveryConfigurationCollection get_integration_delivery_configuration_by_environment(project_key, environment_key)

Get delivery configurations by environment

Get delivery configurations by environment.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.integration_delivery_configuration_collection import IntegrationDeliveryConfigurationCollection
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key

    # example passing only required values which don't have defaults set
    try:
        # Get delivery configurations by environment
        api_response = api_instance.get_integration_delivery_configuration_by_environment(project_key, environment_key)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configuration_by_environment: %s\n" % e)

Parameters

Name	Type	Description	Notes
project_key	str	The project key
environment_key	str	The environment key

Return type

IntegrationDeliveryConfigurationCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Integration delivery configuration collection response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_integration_delivery_configuration_by_id

IntegrationDeliveryConfiguration get_integration_delivery_configuration_by_id(project_key, environment_key, integration_key, id)

Get delivery configuration by ID

Get delivery configuration by ID.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.integration_delivery_configuration import IntegrationDeliveryConfiguration
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key
    id = "id_example" # str | The configuration ID

    # example passing only required values which don't have defaults set
    try:
        # Get delivery configuration by ID
        api_response = api_instance.get_integration_delivery_configuration_by_id(project_key, environment_key, integration_key, id)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configuration_by_id: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key
id	str	The configuration ID

Return type

IntegrationDeliveryConfiguration

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Integration delivery configuration response	-
404	Invalid resource identifier	-
429	Rate limited	-

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

get_integration_delivery_configurations

IntegrationDeliveryConfigurationCollection get_integration_delivery_configurations()

List all delivery configurations

List all delivery configurations.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from launchdarkly_api.model.integration_delivery_configuration_collection import IntegrationDeliveryConfigurationCollection
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # List all delivery configurations
        api_response = api_instance.get_integration_delivery_configurations()
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->get_integration_delivery_configurations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

IntegrationDeliveryConfigurationCollection

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Integration delivery configuration collection response	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

patch_integration_delivery_configuration

IntegrationDeliveryConfiguration patch_integration_delivery_configuration(project_key, environment_key, integration_key, id, json_patch)

Update delivery configuration

Update an integration delivery configuration. Updating an integration delivery configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.integration_delivery_configuration import IntegrationDeliveryConfiguration
from launchdarkly_api.model.json_patch import JSONPatch
from launchdarkly_api.model.patch_failed_error_rep import PatchFailedErrorRep
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key
    id = "id_example" # str | The configuration ID
    json_patch = JSONPatch([
        PatchOperation(
            op="replace",
            path="/exampleField",
            value=None,
        ),
    ]) # JSONPatch | 

    # example passing only required values which don't have defaults set
    try:
        # Update delivery configuration
        api_response = api_instance.patch_integration_delivery_configuration(project_key, environment_key, integration_key, id, json_patch)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->patch_integration_delivery_configuration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key
id	str	The configuration ID
json_patch	JSONPatch

Return type

IntegrationDeliveryConfiguration

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Integration delivery configuration response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
422	Invalid patch content	-
429	Rate limited	-

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

validate_integration_delivery_configuration

IntegrationDeliveryConfigurationResponse validate_integration_delivery_configuration(project_key, environment_key, integration_key, id)

Validate delivery configuration

Validate the saved delivery configuration, using the validationRequest in the integration's manifest.json file.

Example

Api Key Authentication (ApiKey):

import time
import launchdarkly_api
from launchdarkly_api.api import integration_delivery_configurations_beta_api
from launchdarkly_api.model.invalid_request_error_rep import InvalidRequestErrorRep
from launchdarkly_api.model.forbidden_error_rep import ForbiddenErrorRep
from launchdarkly_api.model.integration_delivery_configuration_response import IntegrationDeliveryConfigurationResponse
from launchdarkly_api.model.not_found_error_rep import NotFoundErrorRep
from launchdarkly_api.model.rate_limited_error_rep import RateLimitedErrorRep
from launchdarkly_api.model.unauthorized_error_rep import UnauthorizedErrorRep
from pprint import pprint
# Defining the host is optional and defaults to https://app.launchdarkly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = launchdarkly_api.Configuration(
    host = "https://app.launchdarkly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with launchdarkly_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = integration_delivery_configurations_beta_api.IntegrationDeliveryConfigurationsBetaApi(api_client)
    project_key = "projectKey_example" # str | The project key
    environment_key = "environmentKey_example" # str | The environment key
    integration_key = "integrationKey_example" # str | The integration key
    id = "id_example" # str | The configuration ID

    # example passing only required values which don't have defaults set
    try:
        # Validate delivery configuration
        api_response = api_instance.validate_integration_delivery_configuration(project_key, environment_key, integration_key, id)
        pprint(api_response)
    except launchdarkly_api.ApiException as e:
        print("Exception when calling IntegrationDeliveryConfigurationsBetaApi->validate_integration_delivery_configuration: %s\n" % e)

Parameters

Name	Type	Description
project_key	str	The project key
environment_key	str	The environment key
integration_key	str	The integration key
id	str	The configuration ID

Return type

IntegrationDeliveryConfigurationResponse

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Integration delivery configuration validation response	-
400	Invalid request	-
401	Invalid access token	-
403	Forbidden	-
404	Invalid resource identifier	-
429	Rate limited	-

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

Files

IntegrationDeliveryConfigurationsBetaApi.md

Latest commit

History

IntegrationDeliveryConfigurationsBetaApi.md

File metadata and controls

launchdarkly_api.IntegrationDeliveryConfigurationsBetaApi

create_integration_delivery_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_integration_delivery_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_integration_delivery_configuration_by_environment

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_integration_delivery_configuration_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_integration_delivery_configurations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_integration_delivery_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

validate_integration_delivery_configuration

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details