Edge Functions

PreviousDynamic Rules NextFlow Control Policies

Last updated 5 months ago

Was this helpful?

Get Edge Functions

Get all Edge Functions in a configuration

get

/api/v4.0/conf/{config}/edge-functions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

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

Edge Functions retrieved successfully

Modify Edge Functions

Update an existing set of Edge Functions for a configuration

put

/api/v4.0/conf/{config}/edge-functions

Path parameters

configConfigrequired

Body

codeCoderequired

Edge Function Code

idIdrequired

Unique id

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

nameNamerequired

phasePhaserequired

Options: request, response

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully updated entry"
}

Edge Functions updated successfully

Create Edge Functions

Create a complete set of Edge Functions for a configuration

post

/api/v4.0/conf/{config}/edge-functions

Path parameters

configConfigrequired

Body

codeCoderequired

Edge Function Code

idIdrequired

Unique id

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

nameNamerequired

phasePhaserequired

Options: request, response

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

422

{
  "message": "Successfully created entry"
}

Edge Functions created successfully

Delete Edge Functions

Delete all Edge Functions in a configuration

delete

/api/v4.0/conf/{config}/edge-functions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Edge Functions deleted successfully

Get specific Edge Function

Get an Edge Function from the specified configuration

get

/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

configConfigrequired

entry_idEntry IDrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Edge Function retrieved successfully

Modify a single Edge Function

Update an individual Edge Function within a configuration

put

/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Body

codeCoderequired

Edge Function Code

idIdrequired

Unique id

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

nameNamerequired

phasePhaserequired

Options: request, response

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully updated entry"
}

Edge Function updated successfully

Create single Edge Function

Create an individual Edge Function within a configuration

post

/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

configConfigrequired

entry_idEntry IDrequired

Body

codeCoderequired

Edge Function Code

idIdrequired

Unique id

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

nameNamerequired

phasePhaserequired

Options: request, response

descriptionDescription

Responses

application/json

cURL

JavaScript

Python

HTTP

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

201

422

{
  "message": "Successfully created entry"
}

Edge Function created successfully

Delete single Edge Function

Delete an individual Edge Function from the specified configuration

delete

/api/v4.0/conf/{config}/edge-functions/{entry_id}

Path parameters

configConfigrequired

entry_idEntryrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully deleted entry"
}

Edge Function deleted successfully

Get Edge Functions version list

Get list of versions of Edge Functions in a configuration

get

/api/v4.0/conf/{config}/edge-functions/versions

Path parameters

configConfigrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "hello@example.com",
      "message": "text",
      "date": "2025-02-21T18:07:48.876Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

Edge Functions version list retrieved successfully

Get version of Edge Function

Get a specific version of an Edge Function

get

/api/v4.0/conf/{config}/edge-functions/versions/{version}

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

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

Edge Function retrieved successfully

Revert an Edge Function to the specified version

Set a previous Edge Function version to be the current one

put

/api/v4.0/conf/{config}/edge-functions/versions/{version}/revert

Path parameters

configConfigrequired

versionVersionrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

422

{
  "message": "Successfully updated entry"
}

Edge Function reversion was successful