Integration delivery configurations (beta)

This feature is in beta

To use this feature, pass in a header including the LD-API-Version key with value set to beta. Use this header with each call. To learn more, read Beta resources.

Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible.

The integration delivery configurations API allow you to create, modify, validate, and delete delivery configurations.

Several of the endpoints require a delivery configuration ID. The delivery configuration ID is returned as part of the Create delivery configuration and List all delivery configurations responses. It is the _id field, or the _id field of each element in the items array.

List all delivery configurations

List all delivery configurations.

Responses
200

Integration delivery configuration collection response

401

Invalid access token

403

Forbidden

404

Invalid resource identifier

429

Rate limited

get/api/v2/integration-capabilities/featureStore
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}
Get delivery configurations by environment
Get delivery configurations by environment.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
environmentKey
required
string <string> 
The environment key


 
Responses 
200
Integration delivery configuration collection response


401
Invalid access token


403
Forbidden


404
Invalid resource identifier


429
Rate limited


get/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "items": [
    ]
}
Create delivery configuration
Create a delivery configuration.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
environmentKey
required
string <string> 
The environment key


 
integrationKey
required
string <string> 
The integration key


 
Request Body schema: application/json
required
on
boolean
Whether the integration configuration is active. Default value is false.


 
required
object (FormVariableConfig) 
 
tags
Array of strings
Tags to associate with the integration


 
name
string
Name to identify the integration


 
Responses 
201
Integration delivery configuration response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Invalid resource identifier


429
Rate limited


post/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}
Request samples 
application/json
{
  • "config": {
    },
  • "name": "Sample integration",
  • "on": false,
  • "tags": [
    ]
}
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "12ab3c4d5ef1a2345bcde67f",
  • "integrationKey": "example-integration-key",
  • "projectKey": "default",
  • "environmentKey": "development",
  • "config": {
    },
  • "on": true,
  • "tags": [ ],
  • "name": "Development environment configuration",
  • "version": 1,
  • "_access": {
    }
}
Get delivery configuration by ID
Get delivery configuration by ID.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
environmentKey
required
string <string> 
The environment key


 
integrationKey
required
string <string> 
The integration key


 
id
required
string <string> 
The configuration ID


 
Responses 
200
Integration delivery configuration response


404
Invalid resource identifier


429
Rate limited


get/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
Request samples 
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "12ab3c4d5ef1a2345bcde67f",
  • "integrationKey": "example-integration-key",
  • "projectKey": "default",
  • "environmentKey": "development",
  • "config": {
    },
  • "on": true,
  • "tags": [ ],
  • "name": "Development environment configuration",
  • "version": 1,
  • "_access": {
    }
}
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.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
environmentKey
required
string <string> 
The environment key


 
integrationKey
required
string <string> 
The integration key


 
id
required
string <string> 
The configuration ID


 
Request Body schema: application/json
required
 Array 
op
required
string
The type of operation to perform


 
path
required
string
A JSON Pointer string specifying the part of the document to operate on


 
value
required
any
A JSON value used in "add", "replace", and "test" operations


 
Responses 
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


patch/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "_links": {
    },
  • "_id": "12ab3c4d5ef1a2345bcde67f",
  • "integrationKey": "example-integration-key",
  • "projectKey": "default",
  • "environmentKey": "development",
  • "config": {
    },
  • "on": true,
  • "tags": [ ],
  • "name": "Development environment configuration",
  • "version": 1,
  • "_access": {
    }
}
Delete delivery configuration
Delete a delivery configuration.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
environmentKey
required
string <string> 
The environment key


 
integrationKey
required
string <string> 
The integration key


 
id
required
string <string> 
The configuration ID


 
Responses 
204
Action succeeded


400
Invalid request


401
Invalid access token


403
Forbidden


404
Invalid resource identifier


429
Rate limited


delete/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}
Request samples 
Response samples 
application/json
{
  • "code": "invalid_request",
  • "message": "Invalid request body"
}
Validate delivery configuration
Validate the saved delivery configuration, using the validationRequest in the integration's manifest.json file.


Request 
path Parameters
projectKey
required
string <string> 
The project key


 
environmentKey
required
string <string> 
The environment key


 
integrationKey
required
string <string> 
The integration key


 
id
required
string <string> 
The configuration ID


 
Responses 
200
Integration delivery configuration validation response


400
Invalid request


401
Invalid access token


403
Forbidden


404
Invalid resource identifier


429
Rate limited


post/api/v2/integration-capabilities/featureStore/{projectKey}/{environmentKey}/{integrationKey}/{id}/validate
Request samples 
Response samples 
application/json
{
  • "statusCode": 200,
  • "error": "string",
  • "timestamp": 0,
  • "responseBody": "string"
}
➔ Next to Integrations (beta)