Edge Functions

Get Edge Functions

Get all Edge Functions in a configuration

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

Path parameters

config*Config

Response

200

Edge Functions retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of EdgeFunction

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

Modify Edge Functions

Update an existing set of Edge Functions for a configuration

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

Path parameters

config*Config

Body

application/json

code*Code

Edge Function Code

descriptionDescription

string

id*Id

Unique id

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

name*Name

phase*Phase

requestresponse

Response

200422

Edge Functions updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "code": "text",
        "phase": "request"
      }
    ]),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create Edge Functions

Create a complete set of Edge Functions for a configuration

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

Path parameters

config*Config

Body

application/json

code*Code

Edge Function Code

descriptionDescription

string

id*Id

Unique id

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

name*Name

phase*Phase

requestresponse

Response

201422

Edge Functions created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "id": "text",
        "name": "text",
        "code": "text",
        "phase": "request"
      }
    ]),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

Delete Edge Functions

Delete all Edge Functions in a configuration

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

Path parameters

config*Config

Response

200422

Edge Functions deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

Get specific Edge Function

Get an Edge Function from the specified configuration

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

Path parameters

config*Config

entry_id*Entry ID

Response

200422

Edge Function retrieved successfully

Body

application/json

code*Code

Edge Function Code

descriptionDescription

string

id*Id

Unique id

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

name*Name

phase*Phase

requestresponse

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

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

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

config*Config

entry_id*Entry

Body

application/json

code*Code

Edge Function Code

descriptionDescription

string

id*Id

Unique id

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

name*Name

phase*Phase

requestresponse

Response

200422

Edge Function updated successfully

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "code": "text",
      "phase": "request"
    }),
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}

Create single Edge Function

Create an individual Edge Function within a configuration

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

Path parameters

config*Config

entry_id*Entry ID

Body

application/json

code*Code

Edge Function Code

descriptionDescription

string

id*Id

Unique id

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

name*Name

phase*Phase

requestresponse

Response

201422

Edge Function created successfully

Body

application/json

message*Message

Information about successful create operation

Example: "Successfully created entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "name": "text",
      "code": "text",
      "phase": "request"
    }),
});
const data = await response.json();

Response

201422

{
  "message": "Successfully created entry"
}

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

config*Config

entry_id*Entry

Response

200422

Edge Function deleted successfully

Body

application/json

message*Message

Information about successful delete operation

Example: "Successfully deleted entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/{entry_id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully deleted entry"
}

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

config*Config

Response

200422

Edge Functions version list retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of VersionEntry

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "total": 1,
  "items": [
    {
      "author": "text",
      "email": "[e-mail]",
      "message": "text",
      "date": "2024-11-21T06:29:49.155Z",
      "version": "42bcc1282349db1e5791484c3d69420b1d8a8bc1",
      "parents": [
        "f44073242093228b45bff7eb7a065559fa9b46aa"
      ]
    }
  ]
}

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

config*Config

version*Version

Response

200422

Edge Function retrieved successfully

Body

application/json

totalinteger

Example: 1

itemsarray of EdgeFunction

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/versions/{version}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

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

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

config*Config

version*Version

Response

200422

Edge Function reversion was successful

Body

application/json

message*Message

Information about successful update operation

Example: "Successfully updated entry"

Request

JavaScriptCurlPython

const response = await fetch('/api/v4.0/conf/{config}/edge-functions/versions/{version}/revert', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "message": "Successfully updated entry"
}