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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token. More info here

Path Parameters

​
id
string
required

Query Parameters

​
organization_id
string

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.

​
object
string

String representing the object's type. Objects of the same type share the same value

Example:

"project"

​
id
string

Unique identifier for the project

​
organization_id
string

Unique identifier for the organization the project belongs to

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

​
slug
string

The Name of the project, URL-friendly string that identifies the project

Example:

"my-project"

​
description
string

Description of the project

Example:

"This is my project"

​
avatar_url
string

Avatar URL of the project

​
created_at
string

Time at which the project was created

Example:

"2022-03-01T00:00:00Z"

​
updated_at
string

Time at which the project was last updated

Example:

"2022-03-01T00:00:00Z"

​
external_project_url
string

External link to a platform provider for the project

Example:

"https://my-project.com"

​
log_severity
enum<string> | null
default:INFO

The log severity of the project.

Available options:
DEBUG,
INFO,
WARNING,
ERROR
​
edgee_behind_proxy_cache
boolean | null
default:false

Whether the project is behind a proxy cache (or CDN).

​
force_https
boolean | null
default:true

Whether the project is forcing HTTPS.

​
cache
boolean | null
default:false

Whether caching is enabled for the project.

​
override_cache
object[]

List of cache rules that override the default cache settings.

A CacheRule is a rule that overrides the default cache settings.

​
cookie_name
string | null
default:edgee

The name of the cookie that edgee will use to store the session ID.

​
cookie_domain
string | null

The domain of the cookie that edgee will use to store the session ID.

​
proxy_only
boolean | null
default:false

Whether the Edgee will only proxy requests to the origin without any computing.

​
inject_sdk
boolean | null
default:false

Whether Edgee should inject the SDK into the html content.

​
enforce_no_store_policy
boolean | null
default:false

A boolean that indicates whether Edgee should enforce a no-store cache-control header on the responses that can be computed.

​
trusted_ips
string[] | null

List of trusted IPs that can access the project.

​
password_protection
boolean | null
default:false

Whether the project is password protected.

​
blocked_ips
string[] | null

List of blocked IPs that can't access the project. Blocking IPs can only works is trusted_ips and password_protection are empty.

​
cookie_whitelist
string[] | null

List of cookies that are allowed to be set by the project.

​
forwarded_headers
object[] | null

List of headers that are forwarded to the origin.

Was this page helpful?

Suggest editsRaise issue