1 of 20
2 of 20
3 of 20
4 of 20
5 of 20
6 of 20
7 of 20
8 of 20
9 of 20
10 of 20
11 of 20
12 of 20
13 of 20
14 of 20
15 of 20
16 of 20
17 of 20
18 of 20
19 of 20
20 of 20

site

doc

blog

success stories

Edge Functions

Edite no GitHub

Através da API do Edge Functions, você pode consultar, remover ou atualizar suas configurações existentes, bem como criar novas configurações.

  1. Obter lista de Edge Functions
  2. Obter dados de uma Edge Function
  3. Deletar uma Edge Function
  4. Criar uma nova Edge Function
  5. Sobrescrever uma Edge Function existente
  6. Atualizar os campos de uma Edge Function
  7. Documentação de suporte

1. Obter lista de Edge Functions

Retorna a lista de Edge Functions.

GET /edge_functions

Permissão necessária: View Edge Functions

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
Settings code (string): campo obrigatório em que o código de uma Edge Function será inserido.

name (string): campo obrigatório que define o nome para uma Edge Function.
language (string): campo obrigatório que define qual linguagem será usada na Function.

initiator_type (string): campo obrigatório que define qual Edge Function será usada.

active (boolean): campo obrigatório que objetiva mostrar se a Edge Function está ativa ou não.


json_args (json scheme): campo opcional com o propósito de declarar argumentos sem a necessidade de atualizar o código.
body json

Exemplo de Requisição

GET /edge_functions
Accept: application/json; version=3
Authorization: token a5abb58290608193a5771a4b3494821a177b8a3c

Exemplo de Resposta

{
    "count": 6,
    "total_pages": 1,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": null
    },
 
            },
            "function_to_run": "create_body",
            "initiator_type": "edge_application",
            "active": true,
            "last_editor": "Azion",
            "modified": "2021-01-18T16:38:41.996139Z",
            "reference_count": 1
        },
        {
            "id": 3878,
            "name": "Fauna Database",
            "language": "javascript",
        
            "json_args": {},
            "function_to_run": "handleRequest",
            "initiator_type": "edge_application",
            "active": true,
            "last_editor": "api@azion.com.br",
            "modified": "2021-06-17T18:40:29.514576Z",
            "reference_count": 0
        },
        {
            "id": 4071,
            "name": "js-test",
            "language": "javascript",
            "code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
            "json_args": {
                "key": "value"
            },
            "function_to_run": "js-test",
            "initiator_type": "edge_application",
            "active": true,
            "last_editor": "api@azion.com.br",
            "modified": "2021-09-17T17:57:36.265615Z",
            "reference_count": 0
        },
        {
            "id": 4079,
            "name": "Function Test API",
            "language": "javascript",
            "code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
            "json_args": {
                "key": "value"
            },
            "function_to_run": "js-test",
            "initiator_type": "edge_application",
            "active": true,
            "last_editor": "api@azion.com.br",
            "modified": "2021-09-30T19:43:06.326579Z",
            "reference_count": 0
        }

2. Obter dados de uma Edge Function

Retorna detalhes de uma Edge Function. As informações que são retornadas nessa chamada se referem às main settings de uma função.

GET /edge_functions/:id

Permissão necessária: View Edge Functions

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
:id
*obrigatório
O id da edge function que se pretende consultar. path number
Settings code (string): campo obrigatório em que o código de uma Edge Function será inserido.

name (string): campo obrigatório que define o nome para uma Edge Function.
language (string): campo obrigatório que define qual linguagem será usada na Function.

initiator_type (string): campo obrigatório que define qual Edge Function será usada.

active (boolean): campo obrigatório que objetiva mostrar se a Edge Function está ativa ou não.


json_args (json scheme): campo opcional com o propósito de declarar argumentos sem a necessidade de atualizar o código.
body json

Exemplo de Requisição

GET /edge_functions/1528990724
Accept: application/json; version=3
Authorization: token a5abb58290608193a5771a4b3494821a177b8a3c

Exemplo de Resposta

{
    "results": {
        "code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
        "name": "js-test",
        "language": "javascript",
        "modified": "2021-09-14T14:22:16.234852Z",
        "initiator_type": "edge_application",
        "reference_count": 0,
        "function_to_run": "js-test",
        "active": true,
        "last_editor": "api@azion.com.br",
        "id": 4067,
        "json_args": {"key": "value"}"
    },
    "schema_version": 3
}

3. Deletar uma Edge Function

Remove uma Edge Function. Essa operação é definitiva. Ou seja, não existe nenhuma forma de se realizar rollback dessas informações após a confirmação pelo usuário.

Todas as informações associadas a essa function também serão removidas.

A API não exige confirmação para a execução dessa ação.

DELETE /edge_functions/:id

Permissão necessária: Edit Edge Functions

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
:id
*obrigatório
O id da edge function que se pretende excluir. path number

Exemplo de Requisição

DELETE /edge_functions/1548170897
Accept: application/json; version=3
Authorization: token a5abb58290608193a5771a4b3494821a177b8a3c

Exemplo de Resposta

HTTP/2 204

4. Criar uma nova Edge Function

Possibilita a criação de uma nova Edge Function.

POST /edge_functions

Permissão necessária: Edit Edge Functions

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão. header string;
application/json;version=3
Content-Type
*obrigatório
O tipo de codificação utilizada no Body (application/json).

Exemplo:
Content-Type: application/json
header string
Settings code (string): campo obrigatório em que o código de uma Edge Function será inserido.

name (string): campo obrigatório que define o nome para uma Edge Function.
language (string): campo obrigatório que define qual linguagem será usada na Function.

initiator_type (string): campo obrigatório que define qual Edge Function será usada.

active (boolean): campo obrigatório que objetiva mostrar se a Edge Function está ativa ou não.


json_args (json scheme): campo opcional com o propósito de declarar argumentos sem a necessidade de atualizar o código.
body json

Exemplo de Requisição

POST /edge_functions
Accept: application/json; version=3
Authorization: token a5abb58290608193a5771a4b3494821a177b8a3c
Content-Type: application/json
{
	"name": "Function Test API",
	"function_to_run": "js-test",
	"initiator_type": "edge_application",
	"code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
	"language": "javascript",
	"json_args": {"key": "value"},
    "active": true
}

Exemplo de Resposta

{
    "results": {
        "id": 1555421179,
        "name": "Nova Edge Application",
        "delivery_protocol": "http",
        "active": true,
        "application_acceleration": false,
        "caching": true,
        "device_detection": false,
        "edge_functions": false,
        "image_optimization": false,
        "load_balancer": false
    },
    "schema_version": 3
}

5. Sobrescrever uma Edge Function

Sobrescreve todos os campos de uma Edge Function, preservando o id.

Se deseja atualizar somente alguns campos, sem alterar o valor dos demais, considere utilizar o método PATCH ao invés de PUT.

PUT /edge_functions/:id

Permissão necessária: Edit Edge Functions

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token. header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão header string;
application/json;version=3
Content-Type
*obrigatório
O tipo de codificação utilizada no Body (application/json).

Exemplo:
Content-Type: application/json
header string
:id
*obrigatório
Id do Edge Function a ser sobrescrito. path number
Settings code (string): campo obrigatório em que o código de uma Edge Function será inserido.

name (string): campo obrigatório que define o nome para uma Edge Function.
language (string): campo obrigatório que define qual linguagem será usada na Function.

initiator_type (string): campo obrigatório que define qual Edge Function será usada.

active (boolean): campo obrigatório que objetiva mostrar se a Edge Function está ativa ou não.


json_args (json scheme): campo opcional com o propósito de declarar argumentos sem a necessidade de atualizar o código.
body json

Exemplo de Requisição

PUT /edge_functions/1555421177
Accept: application/json; version=3
Authorization: token a5abb58290608193a5771a4b3494821a177b8a3c
Content-Type: application/json
{
	"name": "js-test-2",
	"code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
	"json_args": {"key": "value"},
    "active": true
}

Exemplo de Resposta

{
    "results": {
        "code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
        "name": "js-test-2",
        "language": "javascript",
        "modified": "2021-09-14T14:41:36.542092Z",
        "initiator_type": "edge_application",
        "function_to_run": "js-test",
        "active": true,
        "last_editor": "api@azion.com.br",
        "id": "4067",
        "json_args": {"key": "value"}
    },
    "schema_version": 3
}

6. Atualizar os campos de uma Edge Function

Este retorno atualiza um ou mais campos de uma function, preservando o valor dos campos não informados.

PATCH /edge_functions/:id

Permissão necessária: Edit Edge Functions

Parâmetro Descrição Tipo Tipo de Dado
Authorization
*obrigatório
A autenticação por Token previamente criado através do endpoint de Criação de Token header string
Accept
*obrigatório
Informações sobre o tipo de retorno e versão header string;
application/json;version=3
Content-Type
*obrigatório
O tipo de codificação utilizada no Body (application/json).

Exemplo:
Content-Type: application/json
header string
:id
*obrigatório
Id do Edge Function a ser atualizado. path number
Settings code (string): campo obrigatório em que o código de uma Edge Function será inserido.

name (string): campo obrigatório que define o nome para uma Edge Function.
language (string): campo obrigatório que define qual linguagem será usada na Function.

initiator_type (string): campo obrigatório que define qual Edge Function será usada.

active (boolean): campo obrigatório que objetiva mostrar se a Edge Function está ativa ou não.


json_args (json scheme): campo opcional com o propósito de declarar argumentos sem a necessidade de atualizar o código.
body json

Exemplo de Requisição

PATCH /edge_functions/1555421177
Accept: application/json; version=3
Authorization: token a5abb58290608193a5771a4b3494821a177b8a3c
Content-Type: application/json
{
	"name": "js-test-2",
	"code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
	"json_args": {"key": "value"},
    "active": true
}

Exemplo de Resposta

{
"results": {
    "code": "{\r\n    async function handleRequest(request) {\r\n        return new Response(\"Hello world in a new response\");\r\n    }\r\n\r\n    addEventListener(\"fetch\", (event) => {\r\n        event.respondWith(handleRequest(event.request));\r\n    });\r\n}",
    "name": "js-test-2",
    "language": "javascript",
    "modified": "2021-09-17T17:59:34.474349Z",
    "initiator_type": "edge_application",
    "function_to_run": "js-test",
    "active": true,
    "last_editor": "api@azion.com.br",
    "id": 4068,
    "json_args": {"key": "value"}
},
"schema_version": 3
}

7. Documentação de suporte


Não encontrou o que procurava? Abra um ticket.