Edge Application

Edite no GitHub

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

  1. Consultar lista de Edge Applications
  2. Consultar dados de uma Edge Application
  3. Deletar uma Edge Application
  4. Criar uma nova Edge Application
  5. Sobrescrever uma Edge Application existente
  6. Atualizar campos de uma Edge Application

1. Consultar lista de Edge Applications

Retorna a lista de Edge Applications.

GET /edge_applications

Permissão necessária: View Security Settings

Parâmetros obrigatórios

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

Exemplo de Requisição

GET /edge_applications 
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Exemplo de Resposta

{
    "count": 36,
    "total_pages": 18,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": "https://api.azionapi.net/edge_applications?page=2&page_size=2"
    },
    "results": [
        {
            "id": 1528990724,
            "name": "Edge Cloud Storage Google",
            "active": true,
            "origins": [
                {
                    "name": "Default Origin",
                    "origin_type": "single_origin",
                    "origin_id": "c2434ff9-b9a9-4937-8721-60d58ac54976"
                }
            ]
        },
        {
            "id": 1528990725,
            "name": "Edge Application",
            "active": true,
            "origins": [
                {
                    "name": "Default Origin",
                    "origin_type": "single_origin",
                    "origin_id": "25fe91c0-1a2c-4ce1-9e3f-a109d2cd3204"
                },
                {
                    "name": "Z1",
                    "origin_type": "single_origin",
                    "origin_id": "0924c04d-b00a-4653-8575-92053e0d0e2f"
                }
            ]
        }
    ]
}

2. Consultar dados de uma Edge Application

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

GET /edge_applications/:id

Permissão necessária: View Security Settings

Parâmetros obrigatórios

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 application que se pretende consultar. path number

Exemplo de Requisição

GET /edge_applications/1528990724
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Exemplo de Resposta

{
    "results": {
        "id": 1528990724,
        "name": "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
}

3. Deletar uma Edge Application

Remove uma Edge Application. 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 edge application também serão removidas.

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

DELETE /edge_applications/:id

Permissão necessária: Edit Security Settings

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 do edge application que se pretende excluir. path number

Exemplo de Requisição

DELETE /edge_applications/1548170897
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

HTTP/2 204

4. Criar uma nova Edge Application

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

POST /edge_applications

Permissão necessária: Edit Security Settings

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).

ex.:

Content-Type: application/json
header string

Exemplo de Requisição

POST /edge_applications
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
    "name": "Nova Edge Application",
    "delivery_protocol": "http",
    "origin_type": "single_origin",
    "address": "www.new.api",
    "origin_protocol_policy": "preserve",
    "host_header": "www.new.api",
    "browser_cache_settings": "override",
    "browser_cache_settings_maximum_ttl": 20,
    "cdn_cache_settings": "honor",
    "cdn_cache_settings_maximum_ttl": 60
}

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 Application

Sobrescreve todos os campos de uma Edge Application, 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_applications/:id

Permissão necessária: Edit Security Settings

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).

ex.:

Content-Type: application/json
header string
:id (obrigatório) Id do Edge Application a ser sobrescrito. path number

Exemplo de Requisição

PUT /edge_applications/1555421177
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
	"name": "Edge application alterada pela API",
    "delivery_protocol": "http",
    "active": true,
    "application_acceleration": true,
    "caching": true,
    "device_detection": false,
    "edge_functions": false,
    "image_optimization": false,
    "load_balancer": false
}

Exemplo de Resposta

{
    "results": {
        "id": 1555421177,
        "name": "Edge application alterada pela API",
        "delivery_protocol": "http",
        "active": true,
        "application_acceleration": true,
        "caching": true,
        "device_detection": false,
        "edge_functions": false,
        "image_optimization": false,
        "load_balancer": false
    },
    "schema_version": 3
}

6. Atualizar campos de uma Edge Application

Atualiza um ou mais campos de uma Edge Application, preservando o valor dos campos não informados.

PATCH /edge_applications/:id

Permissão necessária: Edit Security Settings

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 Informações sobre o tipo de retorno e versão header string;
obrigatório
application/json;version=3
Content-Type (obrigatório) O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json
header string
:id (obrigatório) Id da Edge Application a ser sobrescrita. path number

Exemplo de Requisição

PATCH /edge_applications/1555421177 
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
    "application_acceleration": true,
    "edge_functions": true,
    "image_optimization": false
}

Exemplo de Resposta

{
    "results": {
        "id": 1555421177,
        "name": "Edge application alterada pela API",
        "delivery_protocol": "http",
        "active": true,
        "application_acceleration": true,
        "caching": true,
        "device_detection": false,
        "edge_functions": true,
        "image_optimization": false,
        "load_balancer": false
    },
    "schema_version": 3
}

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