List all Projects - Edgee documentation

GET

projects

Authorizations

Authorization

string

headerrequired

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

Body

application/json

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>

default: DESC

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

organization_id

string

The organization ID.

Response

200 - application/json

object

string

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

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[]

data.object

string

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

data.id

string

Unique identifier for the project

data.organization_id

string

Unique identifier for the organization the project belongs to

data.slug

string

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

data.description

string

Description of the project

data.avatar_url

string

Avatar URL of the project

data.created_at

string

Time at which the project was created

data.updated_at

string

Time at which the project was last updated

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

integer | null

default: 6000000

The maximum size, in bytes, of the decompressed body of a request that edgee will compute at the edge.

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

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

Delete an Project Domain endpoints

API Documentation

Authorizations

Body

Response