Applications (beta)

Get application by key

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Retrieve an application by the application key.

Expanding the application response

LaunchDarkly supports expanding the “Get application” response to include additional fields.

To expand the response, append the expand query parameter and include the following:

flags includes details on the flags that have been evaluated by the application

For example, use ?expand=flags to include the flags field in the response. By default, this field is not included in the response.

GET

api

applications

{applicationKey}

Get application by key

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/applications/{applicationKey} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/applications/{applicationKey}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/applications/{applicationKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/applications/{applicationKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/applications/{applicationKey}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/applications/{applicationKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "autoAdded": true,
  "key": "com.launchdarkly.cafe",
  "kind": "mobile",
  "name": "LaunchDarklyCafe",
  "flags": {
    "items": [
      {
        "name": "Example flag",
        "key": "flag-key-123abc",
        "_links": {},
        "_site": {
          "href": "<string>",
          "type": "<string>"
        }
      }
    ],
    "totalCount": 1,
    "_links": {}
  },
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "_links": {},
  "_version": 123,
  "creationDate": "1654104600000",
  "description": "The LaunchDarkly Cafe app",
  "_maintainer": {
    "member": {
      "_links": {
        "self": {
          "href": "/api/v2/members/569f183514f4432160000007",
          "type": "application/json"
        }
      },
      "_id": "569f183514f4432160000007",
      "role": "admin",
      "email": "ariel@acme.com",
      "firstName": "Ariel",
      "lastName": "Flores"
    },
    "team": {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  }
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}

Authorizations

Authorization

string

header

required

Path Parameters

applicationKey

string<string>

required

The application key

Query Parameters

expand

string<string>

A comma-separated list of properties that can reveal additional information in the response. Options: flags.

Response

Application response

autoAdded

boolean

required

Whether the application was automatically created because it was included in a context when a LaunchDarkly SDK evaluated a feature flag, or was created through the LaunchDarkly UI or REST API.

Example:

true

key

string

required

The unique identifier of this application

Example:

"com.launchdarkly.cafe"

kind

enum<string>

required

To distinguish the kind of application

Available options:

browser,

mobile,

server

Example:

"mobile"

name

string

required

The name of the application

Example:

"LaunchDarklyCafe"

flags

object

Details about the flags that have been evaluated by the application

Show child attributes

_access

object

Details on the allowed and denied actions for this application

Show child attributes

_links

object

The location and content type of related resources

Show child attributes

_version

integer

Version of the application

creationDate

integer<int64>

Timestamp of when the application version was created

Example:

"1654104600000"

description

string

The application description

Example:

"The LaunchDarkly Cafe app"

_maintainer

object

Associated maintainer member or team info for the application

Show child attributes

⌘I

Get application by key

curl --request GET \
  --url https://app.launchdarkly.com/api/v2/applications/{applicationKey} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.launchdarkly.com/api/v2/applications/{applicationKey}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.launchdarkly.com/api/v2/applications/{applicationKey}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.launchdarkly.com/api/v2/applications/{applicationKey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.launchdarkly.com/api/v2/applications/{applicationKey}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.launchdarkly.com/api/v2/applications/{applicationKey}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "autoAdded": true,
  "key": "com.launchdarkly.cafe",
  "kind": "mobile",
  "name": "LaunchDarklyCafe",
  "flags": {
    "items": [
      {
        "name": "Example flag",
        "key": "flag-key-123abc",
        "_links": {},
        "_site": {
          "href": "<string>",
          "type": "<string>"
        }
      }
    ],
    "totalCount": 1,
    "_links": {}
  },
  "_access": {
    "denied": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ],
    "allowed": [
      {
        "action": "<string>",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "<string>"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "<string>"
          ],
          "role_name": "<string>"
        }
      }
    ]
  },
  "_links": {},
  "_version": 123,
  "creationDate": "1654104600000",
  "description": "The LaunchDarkly Cafe app",
  "_maintainer": {
    "member": {
      "_links": {
        "self": {
          "href": "/api/v2/members/569f183514f4432160000007",
          "type": "application/json"
        }
      },
      "_id": "569f183514f4432160000007",
      "role": "admin",
      "email": "ariel@acme.com",
      "firstName": "Ariel",
      "lastName": "Flores"
    },
    "team": {
      "customRoleKeys": [
        "access-to-test-projects"
      ],
      "key": "team-key-123abc",
      "name": "QA Team",
      "_links": {}
    }
  }
}

{
  "code": "invalid_request",
  "message": "Invalid request body"
}

{
  "code": "unauthorized",
  "message": "Invalid access token"
}

{
  "code": "forbidden",
  "message": "Forbidden. Access to the requested resource was denied."
}

{
  "code": "not_found",
  "message": "Invalid resource identifier"
}

{
  "code": "rate_limited",
  "message": "You've exceeded the API rate limit. Try again later."
}