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

Origins

Edite no GitHub

Com a API de Origins você pode consultar, remover ou atualizar configurações existentes, assim como criar novos ajustes.

  1. Obter lista de Origins
  2. Obter dados de Origins
  3. Deletar Origins
  4. Criar novo Origins
  5. Sobrescrever Origins existente
  6. Atualizar campos de Origins

1. Obter lista de Origins

Retorna uma lista de Origins.

GET /edge_applications/:edge_application_id:/origins

Permissão necessária: View Edge Application

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/06101992/origins 
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Exemplo de Resposta

{
    "count": 5,
    "total_pages": 1,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": null
    },
    "results": [
        {
            "origin_id": "235e8fac-8619-453d-83ef-240ffc3da70e",
            "name": "Origins test",
            "origin_type": "single_origin",
            "addresses": [
                {
                    "address": "httpbin.org",
                    "weight": null,
                    "server_role": "primary",
                    "is_active": true
                }
            ],
            "origin_protocol_policy": "http",
            "host_header": "${host}",
            "method": "",
            "origin_path": "/requests",
            "connection_timeout": 60,
            "timeout_between_bytes": 120,
            "hmac_authentication": false,
            "hmac_region_name": "",
            "hmac_access_key": "",
            "hmac_secret_key": ""
        }

2. Obter dados de Origins

Retorna detalhes de Origins de uma Edge Application.

GET /edge_applications/:edge_application_id:/origins/:origin_id:

Permissão necessária: View Edge Application

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

Exemplo de Requisição

GET /edge_applications/06101992/origins/52adb0b2-4b78-474d-93c6-25f5f4320c3d
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941

Exemplo de Resposta

{
    "results": {
        "origin_id": "52adb0b2-4b78-474d-93c6-25f5f4320c3d",
        "name": "Default Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "s3.amazonaws.com",
                "weight": null,
                "server_role": "primary",
                "is_active": true
            }
        ],
        "origin_protocol_policy": "preserve",
        "host_header": "s3.amazonaws.com",
        "method": "",
        "origin_path": "/azion-hmac-test",
        "connection_timeout": 60,
        "timeout_between_bytes": 120,
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
    },
    "schema_version": 3
}

3. Deletar Origins

Este comando remove Origins. A operação é definitiva; 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 Origin também serão removidas.

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

DELETE /edge_applications/:edge_application_id:/origins/:origin_id:

Permissão necessária: Edit Edge Application

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 de Origins que se pretende excluir. path number

Exemplo de Requisição

DELETE /edge_applications/06101992/origins/235e8fac-8619-453d-83ef-240ffc3da70e
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

HTTP/2 204

4. Criar novo Origins

Possibilita a criação de Origins.

POST /edge_applications/:edge_application_id:/origins

Permissão necessária: Edit Edge Application

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

Exemplo de Requisição

POST edge_applications/06101992/origins
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
        "name": "Create New Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "httpbin.org"
            }
        ],
        "origin_protocol_policy": "http",
        "host_header": "${host}",
        "origin_path": "/requests",
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
}

Exemplo de Resposta

{
    "results": {
        "origin_id": "1ba5d8f8-12c8-4174-b814-5a02a62a3ad9",
        "name": "Create New Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "httpbin.org",
                "weight": null,
                "server_role": "primary",
                "is_active": true
            }
        ],
        "origin_protocol_policy": "http",
        "host_header": "${host}",
        "method": "",
        "origin_path": "/requests",
        "connection_timeout": 60,
        "timeout_between_bytes": 120,
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
    },
    "schema_version": 3
}

5. Sobrescrever Origins existente

Este comando sobrescreve todos os campos de Origins, preservando o id.

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

PUT /edge_applications/:edge_application_id:/origins/:origin_id:

Permissão necessária: Edit Edge Application

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 de Origins a ser sobrescrito. path number

Exemplo de Requisição

PUT /edge_applications/06101992/origins/52adb0b2-4b78-474d-93c6-25f5f4320c3d
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
        "name": "Overwrite Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "httpbin.org"
            }
        ],
        "origin_protocol_policy": "http",
        "host_header": "${host}",
        "origin_path": "/anything",
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
}

Exemplo de Resposta

{
    "results": {
        "origin_id": "52adb0b2-4b78-474d-93c6-25f5f4320c3d",
        "name": "Overwrite Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "httpbin.org",
                "weight": null,
                "server_role": "primary",
                "is_active": true
            }
        ],
        "origin_protocol_policy": "http",
        "host_header": "${host}",
        "method": "",
        "origin_path": "/anything",
        "connection_timeout": 60,
        "timeout_between_bytes": 120,
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
    },
    "schema_version": 3
}

6. Atualizar campos de Origins

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

PATCH /edge_applications/:edge_application_id:/origins/:origin_id:

Permissão necessária: Edit Edge Application

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;
obrigatório
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 de Origins a ser sobrescrito. path number

Exemplo de Requisição

PATCH /edge_applications/06101992/origins/52adb0b2-4b78-474d-93c6-25f5f4320c3d
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
        "name": "Update Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "httpbin.org"
            }
        ],
        "origin_protocol_policy": "http",
        "host_header": "${host}",
        "origin_path": "/anything",
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
}

Exemplo de Resposta

{
    "results": {
        "origin_id": "52adb0b2-4b78-474d-93c6-25f5f4320c3d",
        "name": "Update Origin",
        "origin_type": "single_origin",
        "addresses": [
            {
                "address": "httpbin.org",
                "weight": null,
                "server_role": "primary",
                "is_active": true
            }
        ],
        "origin_protocol_policy": "http",
        "host_header": "${host}",
        "method": "",
        "origin_path": "/anything",
        "connection_timeout": 60,
        "timeout_between_bytes": 120,
        "hmac_authentication": false,
        "hmac_region_name": "",
        "hmac_access_key": "",
        "hmac_secret_key": ""
    },
    "schema_version": 3
}

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