Edge Functions

Get Edge Functions

get

Get all Edge Functions in a configuration

Path parameters
configstringRequired
Responses
200
Edge Functions retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host: 
Accept: */*
200

Edge Functions retrieved successfully

{
  "total": 1,
  "items": [
    {
      "code": "text",
      "description": "",
      "id": "text",
      "name": "text",
      "phase": "request"
    }
  ]
}

Modify Edge Functions

put

Update an existing set of Edge Functions for a configuration

Path parameters
configstringRequired
Bodyobject · EdgeFunction[]
codestringRequired

Edge Function Code

descriptionany ofOptionalDefault: ""
stringOptional
idstringRequired

Unique id

Pattern: ^[A-Za-z0-9_]*$
namestringRequired
phasestring · enumRequiredPossible values:
Responses
200
Edge Functions updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 78

[
  {
    "code": "text",
    "description": "",
    "id": "text",
    "name": "text",
    "phase": "request"
  }
]
{
  "message": "Successfully updated entry"
}

Create Edge Functions

post

Create a complete set of Edge Functions for a configuration

Path parameters
configstringRequired
Bodyobject · EdgeFunction[]
codestringRequired

Edge Function Code

descriptionany ofOptionalDefault: ""
stringOptional
idstringRequired

Unique id

Pattern: ^[A-Za-z0-9_]*$
namestringRequired
phasestring · enumRequiredPossible values:
Responses
201
Edge Functions created successfully
application/json
post
POST /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 78

[
  {
    "code": "text",
    "description": "",
    "id": "text",
    "name": "text",
    "phase": "request"
  }
]
{
  "message": "Successfully created entry"
}

Delete Edge Functions

delete

Delete all Edge Functions in a configuration

Path parameters
configstringRequired
Responses
200
Edge Functions deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/edge-functions HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get specific Edge Function

get

Get an Edge Function from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Edge Function retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "code": "text",
  "description": "",
  "id": "text",
  "name": "text",
  "phase": "request"
}

Modify a single Edge Function

put

Update an individual Edge Function within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
codestringRequired

Edge Function Code

descriptionany ofOptionalDefault: ""
stringOptional
idstringRequired

Unique id

Pattern: ^[A-Za-z0-9_]*$
namestringRequired
phasestring · enumRequiredPossible values:
Responses
200
Edge Function updated successfully
application/json
put
PUT /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "code": "text",
  "description": "",
  "id": "text",
  "name": "text",
  "phase": "request"
}
{
  "message": "Successfully updated entry"
}

Create single Edge Function

post

Create an individual Edge Function within a configuration

Path parameters
configstringRequired
entry_idstringRequired
Body
codestringRequired

Edge Function Code

descriptionany ofOptionalDefault: ""
stringOptional
idstringRequired

Unique id

Pattern: ^[A-Za-z0-9_]*$
namestringRequired
phasestring · enumRequiredPossible values:
Responses
201
Edge Function created successfully
application/json
post
POST /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 76

{
  "code": "text",
  "description": "",
  "id": "text",
  "name": "text",
  "phase": "request"
}
{
  "message": "Successfully created entry"
}

Delete single Edge Function

delete

Delete an individual Edge Function from the specified configuration

Path parameters
configstringRequired
entry_idstringRequired
Responses
200
Edge Function deleted successfully
application/json
delete
DELETE /api/v4.0/conf/{config}/edge-functions/{entry_id} HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully deleted entry"
}

Get Edge Functions version list

get

Get list of versions of Edge Functions in a configuration

Path parameters
configstringRequired
Responses
200
Edge Functions version list retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/edge-functions/versions HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[email protected]",
      "message": "text",
      "date": "2025-07-14T13:32:38.597Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Get version of Edge Function

get

Get a specific version of an Edge Function

Path parameters
configstringRequired
versionstringRequired
Responses
200
Edge Function retrieved successfully
application/json
get
GET /api/v4.0/conf/{config}/edge-functions/versions/{version} HTTP/1.1
Host: 
Accept: */*

{
  "total": 1,
  "items": [
    {
      "code": "text",
      "description": "",
      "id": "text",
      "name": "text",
      "phase": "request"
    }
  ]
}

Revert an Edge Function to the specified version

put

Set a previous Edge Function version to be the current one

Path parameters
configstringRequired
versionstringRequired
Responses
200
Edge Function reversion was successful
application/json
put
PUT /api/v4.0/conf/{config}/edge-functions/versions/{version}/revert HTTP/1.1
Host: 
Accept: */*

{
  "message": "Successfully updated entry"
}
PreviousDynamic RulesNextFlow Control Policies

Last updated

Was this helpful?