Skip to content

Latest commit

 

History

History
437 lines (303 loc) · 16.6 KB

IntegrationsBetaApi.md

File metadata and controls

437 lines (303 loc) · 16.6 KB

launchdarkly_api.IntegrationsBetaApi

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

Method HTTP request Description
create_integration_configuration POST /api/v2/integration-configurations/keys/{integrationKey} Create integration configuration
delete_integration_configuration DELETE /api/v2/integration-configurations/{integrationConfigurationId} Delete integration configuration
get_all_integration_configurations GET /api/v2/integration-configurations/keys/{integrationKey} Get all configurations for the integration
get_integration_configuration GET /api/v2/integration-configurations/{integrationConfigurationId} Get an integration configuration
update_integration_configuration PATCH /api/v2/integration-configurations/{integrationConfigurationId} Update integration configuration

create_integration_configuration

IntegrationConfigurationsRep create_integration_configuration(integration_key, integration_configuration_post)

Create integration configuration

Create a new integration configuration. (Excludes persistent store and flag import configurations.)

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.integration_configuration_post import IntegrationConfigurationPost
from launchdarkly_api.models.integration_configurations_rep import IntegrationConfigurationsRep
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.IntegrationsBetaApi(api_client)
    integration_key = 'integration_key_example' # str | The integration key
    integration_configuration_post = launchdarkly_api.IntegrationConfigurationPost() # IntegrationConfigurationPost | 

    try:
        # Create integration configuration
        api_response = api_instance.create_integration_configuration(integration_key, integration_configuration_post)
        print("The response of IntegrationsBetaApi->create_integration_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IntegrationsBetaApi->create_integration_configuration: %s\n" % e)

Parameters

Name Type Description Notes
integration_key str The integration key
integration_configuration_post IntegrationConfigurationPost

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Integration Configuration response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Integration key not found -
409 Status conflict -
429 Rate limited -

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

delete_integration_configuration

delete_integration_configuration(integration_configuration_id)

Delete integration configuration

Delete an integration configuration by ID. (Excludes persistent store and flag import configurations.)

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.IntegrationsBetaApi(api_client)
    integration_configuration_id = 'integration_configuration_id_example' # str | The ID of the integration configuration to be deleted

    try:
        # Delete integration configuration
        api_instance.delete_integration_configuration(integration_configuration_id)
    except Exception as e:
        print("Exception when calling IntegrationsBetaApi->delete_integration_configuration: %s\n" % e)

Parameters

Name Type Description Notes
integration_configuration_id str The ID of the integration configuration to be deleted

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_all_integration_configurations

IntegrationConfigurationCollectionRep get_all_integration_configurations(integration_key)

Get all configurations for the integration

Get all integration configurations with the specified integration key. (Excludes persistent store and flag import configurations.).

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.integration_configuration_collection_rep import IntegrationConfigurationCollectionRep
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.IntegrationsBetaApi(api_client)
    integration_key = 'integration_key_example' # str | Integration key

    try:
        # Get all configurations for the integration
        api_response = api_instance.get_all_integration_configurations(integration_key)
        print("The response of IntegrationsBetaApi->get_all_integration_configurations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IntegrationsBetaApi->get_all_integration_configurations: %s\n" % e)

Parameters

Name Type Description Notes
integration_key str Integration key

Return type

IntegrationConfigurationCollectionRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 List of Integration Configurations -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Integration key not found -
429 Rate limited -

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

get_integration_configuration

IntegrationConfigurationsRep get_integration_configuration(integration_configuration_id)

Get an integration configuration

Get integration configuration with the specified ID. (Excludes persistent store and flag import configurations.)

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.integration_configurations_rep import IntegrationConfigurationsRep
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.IntegrationsBetaApi(api_client)
    integration_configuration_id = 'integration_configuration_id_example' # str | Integration configuration ID

    try:
        # Get an integration configuration
        api_response = api_instance.get_integration_configuration(integration_configuration_id)
        print("The response of IntegrationsBetaApi->get_integration_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IntegrationsBetaApi->get_integration_configuration: %s\n" % e)

Parameters

Name Type Description Notes
integration_configuration_id str Integration configuration ID

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Integration Configuration response -
400 Invalid request -
401 Invalid access token -
403 Forbidden -
404 Integration ID not found -
429 Rate limited -

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

update_integration_configuration

IntegrationConfigurationsRep update_integration_configuration(integration_configuration_id, patch_operation)

Update integration configuration

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

Example

  • Api Key Authentication (ApiKey):
import launchdarkly_api
from launchdarkly_api.models.integration_configurations_rep import IntegrationConfigurationsRep
from launchdarkly_api.models.patch_operation import PatchOperation
from launchdarkly_api.rest import ApiException
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'] = os.environ["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 = launchdarkly_api.IntegrationsBetaApi(api_client)
    integration_configuration_id = 'integration_configuration_id_example' # str | The ID of the integration configuration
    patch_operation = [{"op":"replace","path":"/on","value":false}] # List[PatchOperation] | 

    try:
        # Update integration configuration
        api_response = api_instance.update_integration_configuration(integration_configuration_id, patch_operation)
        print("The response of IntegrationsBetaApi->update_integration_configuration:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IntegrationsBetaApi->update_integration_configuration: %s\n" % e)

Parameters

Name Type Description Notes
integration_configuration_id str The ID of the integration configuration
patch_operation List[PatchOperation]

Return type

IntegrationConfigurationsRep

Authorization

ApiKey

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Integration configuration response -
400 Invalid request -
403 Forbidden -
404 Invalid resource identifier -
409 Status conflict -
429 Rate limited -

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