Edge Functions

Get Edge Functions

get

Get all Edge Functions in a configuration

Path parameters

configstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/edge-functions'

200

200

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

Edge Functions retrieved successfully

Modify Edge Functions

put

Update an existing set of Edge Functions for a configuration

Path parameters

configstringrequired

Body

codestringrequired

Edge Function Code

descriptionany of · default: ""optional

idstringrequired

Unique id

Pattern: ^[A-Za-z0-9_]*$

namestringrequired

phasestring · enumrequired

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/edge-functions' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "code": "text",
      "description": "text",
      "id": "text",
      "name": "text",
      "phase": "request"
    }
  ]'

200

422

200

{
  "message": "Successfully updated entry"
}

Edge Functions updated successfully

Create Edge Functions

post

Create a complete set of Edge Functions for a configuration

Path parameters

configstringrequired

Body

codestringrequired

Edge Function Code

descriptionany of · default: ""optional

idstringrequired

Unique id

Pattern: ^[A-Za-z0-9_]*$

namestringrequired

phasestring · enumrequired

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/edge-functions' \
  --header 'Content-Type: application/json' \
  --data '[
    {
      "code": "text",
      "description": "text",
      "id": "text",
      "name": "text",
      "phase": "request"
    }
  ]'

201

422

201

{
  "message": "Successfully created entry"
}

Edge Functions created successfully

Delete Edge Functions

delete

Delete all Edge Functions in a configuration

Path parameters

configstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/edge-functions'

200

422

200

{
  "message": "Successfully deleted entry"
}

Edge Functions deleted successfully

Get specific Edge Function

get

Get an Edge Function from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/edge-functions/{entry_id}'

200

422

200

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

Edge Function retrieved successfully

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 of · default: ""optional

idstringrequired

Unique id

Pattern: ^[A-Za-z0-9_]*$

namestringrequired

phasestring · enumrequired

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/edge-functions/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "text",
    "description": "text",
    "id": "text",
    "name": "text",
    "phase": "request"
  }'

200

422

200

{
  "message": "Successfully updated entry"
}

Edge Function updated successfully

Create single Edge Function

post

Create an individual Edge Function within a configuration

Path parameters

configstringrequired

entry_idstringrequired

Body

codestringrequired

Edge Function Code

descriptionany of · default: ""optional

idstringrequired

Unique id

Pattern: ^[A-Za-z0-9_]*$

namestringrequired

phasestring · enumrequired

Available options:

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v4.0/conf/{config}/edge-functions/{entry_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "text",
    "description": "text",
    "id": "text",
    "name": "text",
    "phase": "request"
  }'

201

422

201

{
  "message": "Successfully created entry"
}

Edge Function created successfully

Delete single Edge Function

delete

Delete an individual Edge Function from the specified configuration

Path parameters

configstringrequired

entry_idstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/api/v4.0/conf/{config}/edge-functions/{entry_id}'

200

422

200

{
  "message": "Successfully deleted entry"
}

Edge Function deleted successfully

Get Edge Functions version list

get

Get list of versions of Edge Functions in a configuration

Path parameters

configstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/edge-functions/versions'

200

422

200

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2025-04-03T05:34:52.246Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Edge Functions version list retrieved successfully

Get version of Edge Function

get

Get a specific version of an Edge Function

Path parameters

configstringrequired

versionstringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/api/v4.0/conf/{config}/edge-functions/versions/{version}'

200

422

200

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

Edge Function retrieved successfully

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/api/v4.0/conf/{config}/edge-functions/versions/{version}/revert'

200

422

200

{
  "message": "Successfully updated entry"
}

Edge Function reversion was successful