List all Projects - Edgee documentation

GET

projects

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",
      "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

Query Parameters

organization_id

string

The organization ID.

limit

integer

A limit on the number of objects to be returned.

start_key

string

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.

order_direction

enum<string>

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.

Available options:

ASC,

DESC

Response

200

application/json

A list of Projects

object

string

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

Example:

"list"

url

string

The URL where this list can be accessed.

has_more

boolean

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.

last_key

string

The last key of the list. You can use its value on the start_key parameter to fetch the next page of the list.

data

object[]

A Project is a unique identifier that you can use to manage and organize your work. Each project belongs to an organization.

data.object

string

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

Example:

"project"

data.id

string

Unique identifier for the project

data.organization_id

string

Unique identifier for the organization the project belongs to

Example:

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

data.slug

string

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

Example:

"my-project"

data.description

string

Description of the project

Example:

"This is my project"

data.avatar_url

string

Avatar URL of the project

data.created_at

string

Time at which the project was created

Example:

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

data.updated_at

string

Time at which the project was last updated

Example:

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

data.external_project_url

string

External link to a platform provider for the project

Example:

"https://my-project.com"

data.log_severity

enum<string> | null

default:INFO

The log severity of the project.

Available options:

DEBUG,

INFO,

WARNING,

ERROR

data.edgee_behind_proxy_cache

boolean | null

default:false

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

data.force_https

boolean | null

default:true

Whether the project is forcing HTTPS.

data.cache

boolean | null

default:false

Whether caching is enabled for the project.

data.override_cache

object[]

List of cache rules that override the default cache settings.

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

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.

data.proxy_only

boolean | null

default:false

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

data.inject_sdk

boolean | null

default:false

Whether Edgee should inject the SDK into the html content.

data.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.

data.trusted_ips

string[] | null

List of trusted IPs that can access the project.

data.password_protection

boolean | null

default:false

Whether the project is password protected.

data.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.

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

data.forwarded_headers

object[] | null

List of headers that are forwarded to the origin.

Was this page helpful?

Suggest edits Raise issue

Delete an Project Domain endpoints

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",
      "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": []
    }
  ]
}

API Documentation

Authorizations

Query Parameters

Response