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: docs/api.md
+6-3
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,11 @@
1
1
# How to use the Evergreen API
2
2
3
+
!!! warning
4
+
5
+
**The Evergreen API is provided free of charge - please don't abuse it**. The API is currently provided by the free tier of Cloudflare Workers which provides up to 100,000 total requests per day. The API is intended for development purposes only and not for use with distributed endpoints.
6
+
7
+
If you encounter issues or would prefer to ensure data is only sourced from the application vendor, use `Get-EvergreenApp`.
8
+
3
9
Evergreen's difference to other methods of finding and installing applications, is that Evergreen queries only official vendor sources when you use `Get-EvergreenApp`. This ensures that the information returned can be trusted because it comes from the vendor and is not crowd sourced.
4
10
5
11
Evergreen supports [an API](https://evergreen-api.stealthpuppy.com/) that returns the same application version information as `Get-EvergreenApp`. The API supports the same applications as the Evergreen module because data is sourced via the module. The API runs on Cloudflare Workers with data that is updated every 8 hours.
@@ -8,9 +14,6 @@ Full documentation for the API is available here: [evergreen-api](https://app.sw
8
14
9
15
Data that is returned by the Evergreen API can be viewed at the [Evergreen App Tracker](https://stealthpuppy.com/apptracker/).
10
16
11
-
!!! attention "Attention"
12
-
Support for the Evergreen API is provided as a best effort. The API is currently provided by the free tier of Cloudflare Workers which provides up to 100,000 requests per day. If you encounter issues or would prefer to ensure data is only sourced from the application vendor, use `Get-EvergreenApp`.
13
-
14
17
## Usage
15
18
16
19
In its current version, the API has only two endpoints that return data in JSON format - `/apps`, `/app/{appName}`. In PowerShell, the API can be queried with `Invoke-RestMethod`.
`Get-EvergreenEndpoint` can be used to simplify usage of the API, by returning all endpoints used by Evergreen in a single object. Running `Get-EvergreenEndpoint` with no parameters, will return a complete list of endpoints and ports used for all applications.
60
+
`Get-EvergreenEndpointFromApi` can be used to simplify usage of the API, by returning all endpoints used by Evergreen in a single object. Running `Get-EvergreenEndpointFromApi` with no parameters, will return a complete list of endpoints and ports used for all applications.
`Get-EvergreenEndpoint` can return endpoints for a single application or an array of with the `-Name` parameter. In the example below `Get-EvergreenEndpoint` is used to return the endpoints and ports for the Microsoft Teams and Microsoft Edge endpoints.
79
+
`Get-EvergreenEndpointFromApi` can return endpoints for a single application or an array of with the `-Name` parameter. In the example below `Get-EvergreenEndpointFromApi` is used to return the endpoints and ports for the Microsoft Teams and Microsoft Edge endpoints.
The output of `Get-EvergreenEndpoint` can be filtered to create a simple list of all unique endpoint URLs. The command below will generate an array of URLs that can then be used for an allow list of all endpoints required by Evergreen.
92
+
The output of `Get-EvergreenEndpointFromApi` can be filtered to create a simple list of all unique endpoint URLs. The command below will generate an array of URLs that can then be used for an allow list of all endpoints required by Evergreen.
The code below can be used to convert the output from `Get-EvergreenEndpoint` to a file in CSV format. The file will include the application name, endpoints URLs in a comma separated list, and ports in a comma separated list.
100
+
The code below can be used to convert the output from `Get-EvergreenEndpointFromApi` to a file in CSV format. The file will include the application name, endpoints URLs in a comma separated list, and ports in a comma separated list.
0 commit comments