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

Get applications

GET
/api/v2/applications

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.

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Query Parameters

filter?string

Accepts filter by key, name, kind, and autoAdded. To learn more about the filter syntax, read Filtering applications and application versions.

Formatstring
limit?integer

The number of applications to return. Defaults to 10.

Formatint64
offset?integer

Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Formatint64
sort?string

Accepts sorting order and fields. Fields can be comma separated. Possible fields are creationDate, name. Examples: sort=name sort by names ascending, sort=-name,creationDate sort by names descending and creationDate ascending.

Formatstring
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"
{  "_links": {    "property1": {      "href": "string",      "type": "string"    },    "property2": {      "href": "string",      "type": "string"    }  },  "items": [    {      "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"    }  ],  "totalCount": 1}

Reset Relay Proxy configuration key POST

Reset a Relay Proxy configuration's secret key with an optional expiry time for the old key.

Get application by key GET

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.