LaunchDarkly REST API
LaunchDarkly DocsSign in
HomeAPI ReferenceSDKsContext Plugin
Applications (beta)

Get application by key

GET
/api/v2/applications/{applicationKey}

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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

applicationKey*string

The application key

Formatstring

Query Parameters

expand?string

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

Formatstring

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

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

Get applications GET

Get a list of applications. ### Expanding the applications response LaunchDarkly supports expanding the "Get applications" 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.

Update application PATCH

Update an application. You can update the `description` and `kind` fields. Requires a [JSON patch](https://datatracker.ietf.org/doc/html/rfc6902) representation of the desired changes to the application. To learn more, read [Updates](https://launchdarkly.com/docs/api#updates).