curl --request GET \
--url https://api.edgee.app/v1/projects \
--header 'Authorization: Bearer <token>'{
"object": "list",
"url": "<string>",
"has_more": true,
"last_key": "<string>",
"data": [
{
"object": "project",
"id": "<string>",
"organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"slug": "my-project",
"description": "This is my project",
"type": "proxy",
"avatar_url": "<string>",
"created_at": "2022-03-01T00:00:00Z",
"updated_at": "2022-03-01T00:00:00Z",
"external_project_url": "https://my-project.com",
"log_severity": "INFO",
"edgee_behind_proxy_cache": false,
"force_https": true,
"cache": false,
"override_cache": [
{
"path": "<string>",
"regex": true,
"ttl": 123,
"swr": 123,
"pass": true,
"rank": 123,
"conditions": {
"request_cookies": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
},
"request_headers": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
},
"request_query_params": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
},
"request_methods": [
"<string>"
],
"response_status": [
123
],
"response_headers": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
}
}
}
],
"override_cache_enabled": false,
"cookie_name": "edgee",
"cookie_domain": "<string>",
"proxy_only": false,
"proxy_only_path_regex": "<string>",
"inject_sdk": false,
"inject_sdk_position": "append",
"cookieless": false,
"autocapture": {
"pageview": false,
"spa_pageview": false,
"engagement": false,
"click": false,
"form": false,
"scroll": false
},
"enforce_no_store_policy": false,
"trusted_ips": [],
"password_protection": false,
"blocked_ips": [],
"cookie_whitelist": [],
"forwarded_headers": [],
"rate_limiting": [],
"rate_limiting_enabled": false
}
]
}List all Projects
Returns a list of your Projects. The Projects are returned sorted by creation date, with the most recent Project appearing first.
curl --request GET \
--url https://api.edgee.app/v1/projects \
--header 'Authorization: Bearer <token>'{
"object": "list",
"url": "<string>",
"has_more": true,
"last_key": "<string>",
"data": [
{
"object": "project",
"id": "<string>",
"organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"slug": "my-project",
"description": "This is my project",
"type": "proxy",
"avatar_url": "<string>",
"created_at": "2022-03-01T00:00:00Z",
"updated_at": "2022-03-01T00:00:00Z",
"external_project_url": "https://my-project.com",
"log_severity": "INFO",
"edgee_behind_proxy_cache": false,
"force_https": true,
"cache": false,
"override_cache": [
{
"path": "<string>",
"regex": true,
"ttl": 123,
"swr": 123,
"pass": true,
"rank": 123,
"conditions": {
"request_cookies": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
},
"request_headers": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
},
"request_query_params": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
},
"request_methods": [
"<string>"
],
"response_status": [
123
],
"response_headers": {
"present": [
"<string>"
],
"absent": [
"<string>"
],
"values": {}
}
}
}
],
"override_cache_enabled": false,
"cookie_name": "edgee",
"cookie_domain": "<string>",
"proxy_only": false,
"proxy_only_path_regex": "<string>",
"inject_sdk": false,
"inject_sdk_position": "append",
"cookieless": false,
"autocapture": {
"pageview": false,
"spa_pageview": false,
"engagement": false,
"click": false,
"form": false,
"scroll": false
},
"enforce_no_store_policy": false,
"trusted_ips": [],
"password_protection": false,
"blocked_ips": [],
"cookie_whitelist": [],
"forwarded_headers": [],
"rate_limiting": [],
"rate_limiting_enabled": false
}
]
}Authorizations
Query Parameters
The organization ID.
A limit on the number of objects to be returned.
A cursor for use in pagination. start_key parameter defines the place in the list for your subsequent calls. For instance, if you make a list request and receive 100 objects, the last one having ABCDE key, you can make a subsequent call with start_key=ABCDE in order to fetch the next page of the list.
The order direction of the returned list. Objects are returned sorted by creation date. By default, the order is descending, so the most recent object appears first. Possible values are ASC and DESC. Default is DESC.
ASC, DESC Response
A list of Projects
String representing the object’s type. Objects of the same type share the same value.
"list"
The URL where this list can be accessed.
Whether there are more objects beyond the ones returned. You can use it to decide whether to show the user a “load more” button, for example.
The last key of the list. You can use its value on the start_key parameter to fetch the next page of the list.
Show child attributes
Show child attributes
String representing the object's type. Objects of the same type share the same value
"project"
Unique identifier for the project
Unique identifier for the organization the project belongs to
"d290f1ee-6c54-4b01-90e6-d701748f0851"
The Name of the project, URL-friendly string that identifies the project
"my-project"
Description of the project
"This is my project"
The type of the project.
proxy, ai_analytics, mcp Avatar URL of the project
Time at which the project was created
"2022-03-01T00:00:00Z"
Time at which the project was last updated
"2022-03-01T00:00:00Z"
External link to a platform provider for the project
"https://my-project.com"
The log severity of the project.
DEBUG, INFO, WARNING, ERROR Whether the project is behind a proxy cache (or CDN).
Whether the project is forcing HTTPS.
Whether caching is enabled for the project.
List of cache rules that override the default cache settings.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Whether the cache override is enabled.
The name of the cookie that edgee will use to store the session ID.
The domain of the cookie that edgee will use to store the session ID.
Whether the Edgee will only proxy requests to the origin without any computing.
A regular expression that matches the path of the request to be proxied only.
Whether Edgee should inject the SDK into the html content.
The position of the SDK injection.
prepend, append Whether the Edgee should use a cookieless session.
Configuration for automatic event capture by the Edgee SDK.
Show child attributes
Show child attributes
Whether to automatically capture pageview events
Whether to automatically capture single page app pageview events
Whether to automatically capture engagement events
Whether to automatically capture click events
Whether to automatically capture form events
Whether to automatically capture scroll events
A boolean that indicates whether Edgee should enforce a no-store cache-control header on the responses that can be computed.
List of trusted IPs that can access the project.
Whether the project is password protected.
List of blocked IPs that can't access the project. Blocking IPs can only works is trusted_ips and password_protection are empty.
List of cookies that are allowed to be set by the project.
List of rate limiting rules for the project.
Show child attributes
Show child attributes
The rank of the rule. Rules are evaluated in order of rank (lowest first).
x >= 1Maximum requests per second within the rate window.
x >= 1Rate window for counting requests.
1s, 10s, 60s Duration to block the client if rate limit is exceeded (in seconds).
x >= 1Criteria to include in the client key for rate limiting.
ip, ua Conditions that must be met for this rule to apply.
Show child attributes
Show child attributes
Path pattern to match. Can be exact path or regex pattern.
Whether the path is a regex pattern.
HTTP methods that this rule applies to.
GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS, TRACE Continents that this rule applies to.
AF, AN, AS, EU, NA, OC, SA Countries (ISO 3166-1 alpha-2 codes) that this rule applies to.
Whether rate limiting is enabled for the project.
Was this page helpful?