LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Insights deployments (beta)

Create deployment event

POST
/api/v2/engineering-insights/deployment-events

Create deployment event

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Request Body

application/json

projectKey*string

The project key

environmentKey*string

The environment key

applicationKey*string

The application key. This defines the granularity at which you want to view your insights metrics. Typically it is the name of one of the GitHub repositories that you use in this project.LaunchDarkly automatically creates a new application each time you send a unique application key.

applicationName?string

The application name. This defines how the application is displayed

applicationKind?string

The kind of application. Default: server

Value in

  • "server"
  • "browser"
  • "mobile"
version*string

The application version. You can set the application version to any string that includes only letters, numbers, periods (.), hyphens (-), or underscores (_).We recommend setting the application version to at least the first seven characters of the SHA or to the tag of the GitHub commit for this deployment.

versionName?string

The version name. This defines how the version is displayed

eventType*string

The event type

Value in

  • "started"
  • "failed"
  • "finished"
  • "custom"
eventTime?UnixMillis

The time, in Unix milliseconds, when the event occurred. If not included, the time will default to when the event is processed and stored in LaunchDarkly.

Formatint64
eventMetadata?

A JSON object containing metadata about the event

deploymentMetadata?

A JSON object containing metadata about the deployment

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v2/engineering-insights/deployment-events" \  -H "Content-Type: application/json" \  -d '{    "projectKey": "default",    "environmentKey": "production",    "applicationKey": "billing-service",    "version": "a90a8a2",    "eventType": "started"  }'
Empty

Get release frequency chart data GET

Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](https://launchdarkly.com/docs/home/observability/releases).

List deployments GET

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.