API Documentation
- Introduction
- Authentication
- Errors
- ApiTokens
- Organizations
- Projects
- Domains
- ProxySettings
- Components
- ProjectComponents
- Statistics
- DataCollectionEvents
- Users
- Invitations
- DataCollection (Project)
Projects
Retrieve a Project
Retrieve a Project that has previously been created.
GET
/
v1
/
projects
/
{id}
curl --request GET \
--url https://api.edgee.app/v1/projects/{id} \
--header 'Authorization: Bearer <token>'
{
"object": "project",
"id": "<string>",
"organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"slug": "my-project",
"description": "This is my project",
"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": {}
}
}
}
],
"cookie_name": "edgee",
"cookie_domain": "<string>",
"proxy_only": false,
"inject_sdk": false,
"enforce_no_store_policy": false,
"trusted_ips": [],
"password_protection": false,
"blocked_ips": [],
"cookie_whitelist": [],
"forwarded_headers": []
}
Authorizations
Path Parameters
Query Parameters
The organization ID.
Response
200
application/json
The retrieved Project
A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.
Was this page helpful?
curl --request GET \
--url https://api.edgee.app/v1/projects/{id} \
--header 'Authorization: Bearer <token>'
{
"object": "project",
"id": "<string>",
"organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"slug": "my-project",
"description": "This is my project",
"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": {}
}
}
}
],
"cookie_name": "edgee",
"cookie_domain": "<string>",
"proxy_only": false,
"inject_sdk": false,
"enforce_no_store_policy": false,
"trusted_ips": [],
"password_protection": false,
"blocked_ips": [],
"cookie_whitelist": [],
"forwarded_headers": []
}