Skip to content

Latest commit

 

History

History
244 lines (172 loc) · 9.65 KB

InsightsDeploymentsBetaApi.md

File metadata and controls

244 lines (172 loc) · 9.65 KB

LaunchDarklyApi.InsightsDeploymentsBetaApi

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

Method HTTP request Description
createDeploymentEvent POST /api/v2/engineering-insights/deployment-events Create deployment event
getDeployment GET /api/v2/engineering-insights/deployments/{deploymentID} Get deployment
getDeployments GET /api/v2/engineering-insights/deployments List deployments
updateDeployment PATCH /api/v2/engineering-insights/deployments/{deploymentID} Update deployment

createDeploymentEvent

createDeploymentEvent(postDeploymentEventInput)

Create deployment event

Create deployment event

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.InsightsDeploymentsBetaApi();
let postDeploymentEventInput = new LaunchDarklyApi.PostDeploymentEventInput(); // PostDeploymentEventInput | 
apiInstance.createDeploymentEvent(postDeploymentEventInput, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});

Parameters

Name Type Description Notes
postDeploymentEventInput PostDeploymentEventInput

Return type

null (empty response body)

Authorization

ApiKey

HTTP request headers

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

getDeployment

DeploymentRep getDeployment(deploymentID, opts)

Get deployment

Get a deployment by ID. The deployment ID is returned as part of the List deployments response. It is the `id` field of each element in the `items` array. ### Expanding the deployment response LaunchDarkly supports expanding the deployment response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is not included in the response.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.InsightsDeploymentsBetaApi();
let deploymentID = "deploymentID_example"; // String | The deployment ID
let opts = {
  'expand': "expand_example" // String | Expand properties in response. Options: `pullRequests`, `flagReferences`
};
apiInstance.getDeployment(deploymentID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
deploymentID String The deployment ID
expand String Expand properties in response. Options: `pullRequests`, `flagReferences` [optional]

Return type

DeploymentRep

Authorization

ApiKey

HTTP request headers

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

getDeployments

DeploymentCollectionRep getDeployments(projectKey, environmentKey, opts)

List deployments

Get a list of deployments ### Expanding the deployment collection response LaunchDarkly supports expanding the deployment collection response to include additional fields. To expand the response, append the `expand` query parameter and include the following: * `pullRequests` includes details on all of the pull requests associated with each deployment * `flagReferences` includes details on all of the references to flags in each deployment For example, use `?expand=pullRequests` to include the `pullRequests` field in the response. By default, this field is not included in the response.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.InsightsDeploymentsBetaApi();
let projectKey = "projectKey_example"; // String | The project key
let environmentKey = "environmentKey_example"; // String | The environment key
let opts = {
  'applicationKey': "applicationKey_example", // String | Comma separated list of application keys
  'limit': 789, // Number | The number of deployments to return. Default is 20. Maximum allowed is 100.
  'expand': "expand_example", // String | Expand properties in response. Options: `pullRequests`, `flagReferences`
  'from': 789, // Number | Unix timestamp in milliseconds. Default value is 7 days ago.
  'to': 789, // Number | Unix timestamp in milliseconds. Default value is now.
  'after': "after_example", // String | Identifier used for pagination
  'before': "before_example", // String | Identifier used for pagination
  'kind': "kind_example", // String | The deployment kind
  'status': "status_example" // String | The deployment status
};
apiInstance.getDeployments(projectKey, environmentKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
projectKey String The project key
environmentKey String The environment key
applicationKey String Comma separated list of application keys [optional]
limit Number The number of deployments to return. Default is 20. Maximum allowed is 100. [optional]
expand String Expand properties in response. Options: `pullRequests`, `flagReferences` [optional]
from Number Unix timestamp in milliseconds. Default value is 7 days ago. [optional]
to Number Unix timestamp in milliseconds. Default value is now. [optional]
after String Identifier used for pagination [optional]
before String Identifier used for pagination [optional]
kind String The deployment kind [optional]
status String The deployment status [optional]

Return type

DeploymentCollectionRep

Authorization

ApiKey

HTTP request headers

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

updateDeployment

DeploymentRep updateDeployment(deploymentID, patchOperation)

Update deployment

Update a deployment by ID. Updating a deployment uses a JSON patch representation of the desired changes. To learn more, read Updates.<br/><br/>The deployment ID is returned as part of the List deployments response. It is the `id` field of each element in the `items` array.

Example

import LaunchDarklyApi from 'launchdarkly-api';
let defaultClient = LaunchDarklyApi.ApiClient.instance;
// Configure API key authorization: ApiKey
let ApiKey = defaultClient.authentications['ApiKey'];
ApiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKey.apiKeyPrefix = 'Token';

let apiInstance = new LaunchDarklyApi.InsightsDeploymentsBetaApi();
let deploymentID = "deploymentID_example"; // String | The deployment ID
let patchOperation = [{"op":"replace","path":"/status","value":"finished"}]; // [PatchOperation] | 
apiInstance.updateDeployment(deploymentID, patchOperation, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
deploymentID String The deployment ID
patchOperation [PatchOperation]

Return type

DeploymentRep

Authorization

ApiKey

HTTP request headers

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