You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
This repository contains a client library for LaunchDarkly's REST API. This client was automatically
2
-
generated from our [OpenAPI specification](https://app.launchdarkly.com/api/v2/openapi.json) using a [code generation library](https://github.com/launchdarkly/ld-openapi). View our [sample code](#getting-started) for example usage.
2
+
generated from our [OpenAPI specification](https://app.launchdarkly.com/api/v2/openapi.json) using a [code generation library](https://github.com/launchdarkly/ld-openapi).
3
3
4
4
This REST API is for custom integrations, data export, or automating your feature flag workflows. *DO NOT* use this client library to include feature flags in your web or mobile application. To integrate feature flags with your application, read the [SDK documentation](https://docs.launchdarkly.com/sdk).
5
5
@@ -8,21 +8,21 @@ This client library is only compatible with the latest version of our REST API,
LaunchDarkly's REST API uses the HTTPS protocol with a minimum TLS version of 1.2.
18
18
19
-
All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [**Account settings**](https://app.launchdarkly.com/settings/tokens) page.
19
+
All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account/api), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [**Account settings**](https://app.launchdarkly.com/settings/tokens) page.
20
20
21
21
LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and JavaScript-based SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations such as fetching feature flag settings.
22
22
23
23
| Auth mechanism | Allowed resources | Use cases |
|[Personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens)| Can be customized on a per-token basis | Building scripts, custom integrations, data export. |
25
+
|[Personal or service access tokens](https://docs.launchdarkly.com/home/account/api)| Can be customized on a per-token basis | Building scripts, custom integrations, data export. |
26
26
| SDK keys | Can only access read-only resources specific to server-side SDKs. Restricted to a single environment. | Server-side SDKs |
27
27
| Mobile keys | Can only access read-only resources specific to mobile SDKs, and only for flags marked available to mobile keys. Restricted to a single environment. | Mobile SDKs |
28
28
| Client-side ID | Can only access read-only resources specific to JavaScript-based client-side SDKs, and only for flags marked available to client-side. Restricted to a single environment. | Client-side JavaScript |
@@ -43,7 +43,7 @@ Manage personal access tokens from the [**Account settings**](https://app.launch
43
43
44
44
For testing purposes, you can make API calls directly from your web browser. If you are logged in to the LaunchDarkly application, the API will use your existing session to authenticate calls.
45
45
46
-
If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case.
46
+
If you have a [role](https://docs.launchdarkly.com/home/account/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/account/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case.
47
47
48
48
> ### Modifying the Origin header causes an error
49
49
>
@@ -353,7 +353,7 @@ The version of LaunchDarkly that is available on domains controlled by the Unite
353
353
354
354
If you are working in the federal instance of LaunchDarkly, the base URI for each request is `https://app.launchdarkly.us`. In the \"Try it\" sandbox for each request, click the request path to view the complete resource path for the federal environment.
355
355
356
-
To learn more, read [LaunchDarkly in federal environments](https://docs.launchdarkly.com/home/advanced/federal).
356
+
To learn more, read [LaunchDarkly in federal environments](https://docs.launchdarkly.com/home/infrastructure/federal).
357
357
358
358
## Versioning
359
359
@@ -433,7 +433,7 @@ Add this dependency to your project's POM:
433
433
<dependency>
434
434
<groupId>com.launchdarkly</groupId>
435
435
<artifactId>api-client</artifactId>
436
-
<version>16.0.0</version>
436
+
<version>16.1.0</version>
437
437
<scope>compile</scope>
438
438
</dependency>
439
439
```
@@ -449,7 +449,7 @@ Add this dependency to your project's build file:
0 commit comments