POST
/
v1
/
projects
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

Body

application/json
slug
string

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

description
string

Description of the project

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.

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.

max_compressed_body_size
integer | null
default: 3000000

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

cookie_name
string | null
default: edgee

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

trusted_ips
string[] | null

List of trusted IPs that can access the project.

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

Response

200 - application/json
object
string

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

id
string

Unique identifier for the project

organization_id
string

Unique identifier for the organization the project belongs to

slug
string

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

description
string

Description of the project

avatar_url
string

Avatar URL of the project

created_at
string

Time at which the project was created

updated_at
string

Time at which the project was last updated

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.

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.

max_compressed_body_size
integer | null
default: 3000000

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

cookie_name
string | null
default: edgee

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

trusted_ips
string[] | null

List of trusted IPs that can access the project.

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

Create a ProjectRetrieve a Project