Documentation Index Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /launchdarkly-integrations | Type: Application | PCID required: Yes
launchdarkly_integrations_create_big_segment_store_integration
Create big segment store integration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key, either redis or dynamodb configobject Yes — The config value namestring No — Name to identify the integration onboolean No — Whether the integration configuration is active. Default value is false. tagsstring[] No — Tags to associate with the integration
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key, either `redis` or `dynamodb`"
},
"config" : {
"type" : "object" ,
"description" : "The config value"
},
"name" : {
"type" : "string" ,
"description" : "Name to identify the integration"
},
"on" : {
"type" : "boolean" ,
"description" : "Whether the integration configuration is active. Default value is false."
},
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Tags to associate with the integration"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"config"
]
}
launchdarkly_integrations_create_flag_import_configuration
Create a flag import configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key integrationKeystring Yes — The integration key configobject Yes — The config value namestring No — Name to identify the configuration tagsstring[] No — Tags to associate with the configuration
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"config" : {
"type" : "object" ,
"description" : "The config value"
},
"name" : {
"type" : "string" ,
"description" : "Name to identify the configuration"
},
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Tags to associate with the configuration"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"integrationKey" ,
"config"
]
}
launchdarkly_integrations_create_integration_configuration
Create integration configuration
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — The integration key capabilityConfigobject No — Capability Config configValuesobject Yes — The unique set of fields required to configure the integration. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure. enabledboolean No — Whether the integration configuration is enabled. If omitted, defaults to true namestring Yes — The name of the integration configuration tagsstring[] No — Tags for the integration
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"capabilityConfig" : {
"type" : "object" ,
"description" : "Capability Config" ,
"properties" : {
"approvals" : {
"type" : "object" ,
"description" : "The approvals value"
},
"auditLogEventsHook" : {
"type" : "object" ,
"description" : "Audit Log Events Hook"
}
}
},
"configValues" : {
"type" : "object" ,
"description" : "The unique set of fields required to configure the integration. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure."
},
"enabled" : {
"type" : "boolean" ,
"description" : "Whether the integration configuration is enabled. If omitted, defaults to true"
},
"name" : {
"type" : "string" ,
"description" : "The name of the integration configuration"
},
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Tags for the integration"
}
},
"required" : [
"PCID" ,
"integrationKey" ,
"configValues" ,
"name"
]
}
launchdarkly_integrations_create_integration_delivery_configuration
Create delivery configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key configobject Yes — The config value namestring No — Name to identify the integration onboolean No — Whether the integration configuration is active. Default value is false. tagsstring[] No — Tags to associate with the integration
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"config" : {
"type" : "object" ,
"description" : "The config value"
},
"name" : {
"type" : "string" ,
"description" : "Name to identify the integration"
},
"on" : {
"type" : "boolean" ,
"description" : "Whether the integration configuration is active. Default value is false."
},
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "Tags to associate with the integration"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"config"
]
}
launchdarkly_integrations_create_subscription
Create audit log subscription
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — The integration key apiKeystring No — Datadog API key. Only necessary for legacy Datadog webhook integrations. configobject Yes — The unique set of fields required to configure an audit log subscription integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure. namestring Yes — A human-friendly name for your audit log subscription. onboolean No — Whether or not you want your subscription to actively send events. statementsobject[] No — The statements value tagsstring[] No — An array of tags for this subscription. urlstring No — Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"apiKey" : {
"type" : "string" ,
"description" : "Datadog API key. Only necessary for legacy Datadog webhook integrations."
},
"config" : {
"type" : "object" ,
"description" : "The unique set of fields required to configure an audit log subscription integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> at https://github.com/launchdarkly/integration-framework/tree/main/integrations for a full list of fields for the integration you wish to configure."
},
"name" : {
"type" : "string" ,
"description" : "A human-friendly name for your audit log subscription."
},
"on" : {
"type" : "boolean" ,
"description" : "Whether or not you want your subscription to actively send events."
},
"statements" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The statements value"
},
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "An array of tags for this subscription."
},
"url" : {
"type" : "string" ,
"description" : "Slack webhook receiver URL. Only necessary for legacy Slack webhook integrations."
}
},
"required" : [
"PCID" ,
"integrationKey" ,
"config" ,
"name"
]
}
launchdarkly_integrations_delete_big_segment_store_integration
Delete big segment store integration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key, either redis or dynamodb integrationIdstring Yes — The integration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key, either `redis` or `dynamodb`"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"integrationId"
]
}
launchdarkly_integrations_delete_destination
Delete Data Export destination
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key idstring Yes — The Data Export destination ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"id" : {
"type" : "string" ,
"description" : "The Data Export destination ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"id"
]
}
launchdarkly_integrations_delete_flag_import_configuration
Delete a flag import configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key integrationKeystring Yes — The integration key integrationIdstring Yes — The integration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"integrationKey" ,
"integrationId"
]
}
launchdarkly_integrations_delete_integration_configuration
Delete integration configuration
Parameters:
Parameter Type Required Default Description integrationConfigurationIdstring Yes — The ID of the integration configuration to be deleted
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationConfigurationId" : {
"type" : "string" ,
"description" : "The ID of the integration configuration to be deleted"
}
},
"required" : [
"PCID" ,
"integrationConfigurationId"
]
}
launchdarkly_integrations_delete_integration_delivery_configuration
Delete delivery configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key idstring Yes — The configuration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The configuration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"id"
]
}
launchdarkly_integrations_delete_relay_auto_config
Delete Relay Proxy config by ID
Parameters:
Parameter Type Required Default Description idstring Yes — The relay auto config id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The relay auto config id"
}
},
"required" : [
"PCID" ,
"id"
]
}
launchdarkly_integrations_delete_subscription
Delete audit log subscription
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — The integration key idstring Yes — The subscription ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The subscription ID"
}
},
"required" : [
"PCID" ,
"integrationKey" ,
"id"
]
}
launchdarkly_integrations_delete_webhook
Delete webhook
Parameters:
Parameter Type Required Default Description idstring Yes — The ID of the webhook to delete
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The ID of the webhook to delete"
}
},
"required" : [
"PCID" ,
"id"
]
}
launchdarkly_integrations_get_all_integration_configurations
Get all configurations for the integration
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — Integration key
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "Integration key"
}
},
"required" : [
"PCID" ,
"integrationKey"
]
}
launchdarkly_integrations_get_all_webhooks
List webhooks
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_get_big_segment_store_integration
Get big segment store integration by ID
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key, either redis or dynamodb integrationIdstring Yes — The integration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key, either `redis` or `dynamodb`"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"integrationId"
]
}
launchdarkly_integrations_get_big_segment_store_integrations
List all big segment store integrations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_get_destination
Get destination
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key idstring Yes — The Data Export destination ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"id" : {
"type" : "string" ,
"description" : "The Data Export destination ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"id"
]
}
launchdarkly_integrations_get_destinations
List destinations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_get_flag_import_configuration
Get a single flag import configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key integrationKeystring Yes — The integration key, for example, split integrationIdstring Yes — The integration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key, for example, `split`"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"integrationKey" ,
"integrationId"
]
}
launchdarkly_integrations_get_flag_import_configurations
List all flag import configurations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_get_integration_configuration
Get an integration configuration
Parameters:
Parameter Type Required Default Description integrationConfigurationIdstring Yes — Integration configuration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationConfigurationId" : {
"type" : "string" ,
"description" : "Integration configuration ID"
}
},
"required" : [
"PCID" ,
"integrationConfigurationId"
]
}
launchdarkly_integrations_get_integration_delivery_configuration_by_environment
Get delivery configurations by environment
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey"
]
}
launchdarkly_integrations_get_integration_delivery_configuration_by_id
Get delivery configuration by ID
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key idstring Yes — The configuration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The configuration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"id"
]
}
launchdarkly_integrations_get_integration_delivery_configurations
List all delivery configurations
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_get_relay_proxy_config
Get Relay Proxy config
Parameters:
Parameter Type Required Default Description idstring Yes — The relay auto config id
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The relay auto config id"
}
},
"required" : [
"PCID" ,
"id"
]
}
launchdarkly_integrations_get_relay_proxy_configs
List Relay Proxy configs
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_get_subscription_by_id
Get audit log subscription by ID
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — The integration key idstring Yes — The subscription ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The subscription ID"
}
},
"required" : [
"PCID" ,
"integrationKey" ,
"id"
]
}
launchdarkly_integrations_get_subscriptions
Get audit log subscriptions by integration
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — The integration key
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
}
},
"required" : [
"PCID" ,
"integrationKey"
]
}
launchdarkly_integrations_get_webhook
Get webhook
Parameters:
Parameter Type Required Default Description idstring Yes — The ID of the webhook
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The ID of the webhook"
}
},
"required" : [
"PCID" ,
"id"
]
}
launchdarkly_integrations_patch_big_segment_store_integration
Update big segment store integration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key, either redis or dynamodb integrationIdstring Yes — The integration ID bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key, either `redis` or `dynamodb`"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"integrationId" ,
"body"
]
}
launchdarkly_integrations_patch_destination
Update Data Export destination
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key idstring Yes — The Data Export destination ID bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"id" : {
"type" : "string" ,
"description" : "The Data Export destination ID"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"id" ,
"body"
]
}
launchdarkly_integrations_patch_flag_import_configuration
Update a flag import configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key integrationKeystring Yes — The integration key integrationIdstring Yes — The integration ID bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"integrationKey" ,
"integrationId" ,
"body"
]
}
launchdarkly_integrations_patch_integration_delivery_configuration
Update delivery configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key idstring Yes — The configuration ID bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The configuration ID"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"id" ,
"body"
]
}
launchdarkly_integrations_patch_relay_auto_config
Update a Relay Proxy config
Parameters:
Parameter Type Required Default Description idstring Yes — The relay auto config id commentstring No — Optional comment patchobject[] Yes — The patch value
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The relay auto config id"
},
"comment" : {
"type" : "string" ,
"description" : "Optional comment"
},
"patch" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The patch value"
}
},
"required" : [
"PCID" ,
"id" ,
"patch"
]
}
launchdarkly_integrations_patch_webhook
Update webhook
Parameters:
Parameter Type Required Default Description idstring Yes — The ID of the webhook to update bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The ID of the webhook to update"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"id" ,
"body"
]
}
launchdarkly_integrations_post_destination
Create Data Export destination
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key configobject No — An object with the configuration parameters required for the destination type kindstring No — The type of Data Export destination namestring No — A human-readable name for your Data Export destination onboolean No — Whether the export is on. Displayed as the integration status in the LaunchDarkly UI.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"config" : {
"description" : "An object with the configuration parameters required for the destination type"
},
"kind" : {
"type" : "string" ,
"description" : "The type of Data Export destination" ,
"enum" : [
"google-pubsub" ,
"kinesis" ,
"mparticle" ,
"segment" ,
"azure-event-hubs" ,
"snowflake-v2" ,
"databricks" ,
"bigquery" ,
"redshift"
]
},
"name" : {
"type" : "string" ,
"description" : "A human-readable name for your Data Export destination"
},
"on" : {
"type" : "boolean" ,
"description" : "Whether the export is on. Displayed as the integration status in the LaunchDarkly UI."
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey"
]
}
launchdarkly_integrations_post_generate_project_env_warehouse_destination_key_pair
Generate Snowflake destination key pair
Parameters:
Parameter Type Required Default Description projKeystring Yes — The project key envKeystring Yes — The environment key
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projKey" : {
"type" : "string" ,
"description" : "The project key"
},
"envKey" : {
"type" : "string" ,
"description" : "The environment key"
}
},
"required" : [
"PCID" ,
"projKey" ,
"envKey"
]
}
launchdarkly_integrations_post_generate_trust_policy
Generate trust policy
Parameters:
Parameter Type Required Default Description projKeystring Yes — The project key envKeystring Yes — The environment key
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projKey" : {
"type" : "string" ,
"description" : "The project key"
},
"envKey" : {
"type" : "string" ,
"description" : "The environment key"
}
},
"required" : [
"PCID" ,
"projKey" ,
"envKey"
]
}
launchdarkly_integrations_post_generate_warehouse_destination_key_pair
Generate Snowflake destination key pair
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
}
},
"required" : [
"PCID"
]
}
launchdarkly_integrations_post_generate_warehouse_destination_setup_script
Generate warehouse destination setup script
Parameters:
Parameter Type Required Default Description projKeystring Yes — The project key envKeystring Yes — The environment key kindstring Yes — The destination kind (snowflake-v2, redshift)
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projKey" : {
"type" : "string" ,
"description" : "The project key"
},
"envKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"kind" : {
"type" : "string" ,
"description" : "The destination kind (snowflake-v2, redshift)"
}
},
"required" : [
"PCID" ,
"projKey" ,
"envKey" ,
"kind"
]
}
launchdarkly_integrations_post_relay_auto_config
Create a new Relay Proxy config
Parameters:
Parameter Type Required Default Description namestring Yes — A human-friendly name for the Relay Proxy configuration policyobject[] Yes — A description of what environments and projects the Relay Proxy should include or exclude. To learn more, read Write an inline policy .
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"name" : {
"type" : "string" ,
"description" : "A human-friendly name for the Relay Proxy configuration"
},
"policy" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "A description of what environments and projects the Relay Proxy should include or exclude. To learn more, read [Write an inline policy](https://launchdarkly.com/docs/sdk/relay-proxy/automatic-configuration#write-an-inline-policy)."
}
},
"required" : [
"PCID" ,
"name" ,
"policy"
]
}
launchdarkly_integrations_post_webhook
Creates a webhook
Parameters:
Parameter Type Required Default Description namestring No — A human-readable name for your webhook onboolean Yes — Whether or not this webhook is enabled. secretstring No — If sign is true, and the secret attribute is omitted, LaunchDarkly automatically generates a secret for you. signboolean Yes — If sign is false, the webhook does not include a signature header, and the secret can be omitted. statementsobject[] No — The statements value tagsstring[] No — List of tags for this webhook urlstring Yes — The URL of the remote webhook
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"name" : {
"type" : "string" ,
"description" : "A human-readable name for your webhook"
},
"on" : {
"type" : "boolean" ,
"description" : "Whether or not this webhook is enabled."
},
"secret" : {
"type" : "string" ,
"description" : "If sign is true, and the secret attribute is omitted, LaunchDarkly automatically generates a secret for you."
},
"sign" : {
"type" : "boolean" ,
"description" : "If sign is false, the webhook does not include a signature header, and the secret can be omitted."
},
"statements" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "The statements value"
},
"tags" : {
"type" : "array" ,
"items" : {
"type" : "string"
},
"description" : "List of tags for this webhook"
},
"url" : {
"type" : "string" ,
"description" : "The URL of the remote webhook"
}
},
"required" : [
"PCID" ,
"on" ,
"sign" ,
"url"
]
}
launchdarkly_integrations_reset_relay_auto_config
Reset Relay Proxy configuration key
Parameters:
Parameter Type Required Default Description idstring Yes — The Relay Proxy configuration ID expiryinteger No — An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately.
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"id" : {
"type" : "string" ,
"description" : "The Relay Proxy configuration ID"
},
"expiry" : {
"type" : "integer" ,
"description" : "An expiration time for the old Relay Proxy configuration key, expressed as a Unix epoch time in milliseconds. By default, the Relay Proxy configuration will expire immediately."
}
},
"required" : [
"PCID" ,
"id"
]
}
launchdarkly_integrations_trigger_flag_import_job
Trigger a single flag import run
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key integrationKeystring Yes — The integration key integrationIdstring Yes — The integration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"integrationId" : {
"type" : "string" ,
"description" : "The integration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"integrationKey" ,
"integrationId"
]
}
launchdarkly_integrations_update_integration_configuration
Update integration configuration
Parameters:
Parameter Type Required Default Description integrationConfigurationIdstring Yes — The ID of the integration configuration bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationConfigurationId" : {
"type" : "string" ,
"description" : "The ID of the integration configuration"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"integrationConfigurationId" ,
"body"
]
}
launchdarkly_integrations_update_subscription
Update audit log subscription
Parameters:
Parameter Type Required Default Description integrationKeystring Yes — The integration key idstring Yes — The ID of the audit log subscription bodyobject[] Yes — Request body
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The ID of the audit log subscription"
},
"body" : {
"type" : "array" ,
"items" : {
"type" : "object"
},
"description" : "Request body"
}
},
"required" : [
"PCID" ,
"integrationKey" ,
"id" ,
"body"
]
}
launchdarkly_integrations_validate_integration_delivery_configuration
Validate delivery configuration
Parameters:
Parameter Type Required Default Description projectKeystring Yes — The project key environmentKeystring Yes — The environment key integrationKeystring Yes — The integration key idstring Yes — The configuration ID
{
"type" : "object" ,
"properties" : {
"PCID" : {
"type" : "string" ,
"description" : "Pink Connect ID for the authenticated connection"
},
"projectKey" : {
"type" : "string" ,
"description" : "The project key"
},
"environmentKey" : {
"type" : "string" ,
"description" : "The environment key"
},
"integrationKey" : {
"type" : "string" ,
"description" : "The integration key"
},
"id" : {
"type" : "string" ,
"description" : "The configuration ID"
}
},
"required" : [
"PCID" ,
"projectKey" ,
"environmentKey" ,
"integrationKey" ,
"id"
]
}