Domains

Edite no GitHub

Por meio da API de Domains você pode consultar, criar, remover ou atualizar Domains utilizados pelos Edge Applications

  1. Consulta lista de domains
  2. Consulta dados de um domain pelo id
  3. Consulta dados de um domain pelo nome
  4. Deletar um domain
  5. Criar um novo domain
  6. Sobrescrever um domain
  7. Atualizar campos de um domain

1. Consulta lista de domains

Retorna a lista de domains de uma conta.

GET /domains

Permissão necessária: View Domains

Parâmetros obrigatórios

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado através do endpoint de Criação de Token endpoint 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 /domains
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

{
    "count": 2,
    "total_pages": 1,
    "schema_version": 3,
    "links": {
        "previous": null,
        "next": null
    },
    "results": [
        {
            "id": 1536580019,
            "name": "Domain HLS Test",
            "cnames": [
                "www.getthiscname.com"
            ],
            "cname_access_only": false,
            "digital_certificate_id": 14,
            "edge_application_id": 1536580781,
            "is_active": true,
            "domain_name": "101918m.ha.azioncdn.net"
        },
        {
            "id": 1541690041,
            "name": "oh hai",
            "cnames": [
                "test.com"
            ],
            "cname_access_only": false,
            "digital_certificate_id": null,
            "edge_application_id": 1542500853,
            "is_active": true,
            "domain_name": "111918m.ha.azioncdn.net"
        },
    ]
}

2. Consulta dados de um domain por meio do ID

Retorna detalhes de uma domain utilizando o método GET como consulta por meio do ID do Domain.

GET /domains/:domain_id

Permissão necessária: View Domains

Parâmetros obrigatórios

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado através do endpoint de Criação de Token endpoint header string
Accept (obrigatório) Informações sobre o tipo de retorno e versão header string;
application/json;version=3
:domain_id (obrigatório) O id do domain que se pretende consultar. URI Integer

Exemplo de Requisição

GET /domains/1536580019
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

{
    "results": {
        "id": 1536580019,
        "name": "Domain HLS Test",
        "cnames": [
            "www.getthiscname.com"
        ],
        "cname_access_only": false,
        "digital_certificate_id": null,
        "edge_application_id": 1536580781,
        "is_active": true,
        "domain_name": "101918m.ha.azioncdn.net"
    },
    "schema_version": 3
}

3. Consulta dados de um domain pelo Nome

Retorna detalhes de um domain utilizando o método GET como consulta por meio do Nome do Domain.

Atenção, este endpoint utiliza lógica de Filtering, ou seja, caso sua consulta não obtiver um match, será retornado uma lista vazia.

GET /domains/?name=DomaiName

Permissão necessária: View Domains

Parâmetros obrigatórios

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado por meio do endpoint de Criação de Token endpoint header string
Accept (obrigatório) Informações sobre o tipo de retorno e versão header string;
application/json;version=3
:domain_name (obrigatório) O nome do domain que se pretende consultar. path string

Exemplo de Requisição

GET /domains/?name=Domain HLS Test
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

{
    "results": {
        "id": 1536580019,
        "name": "Domain HLS Test",
        "cnames": [
            "www.getthiscname.com"
        ],
        "cname_access_only": false,
        "digital_certificate_id": null,
        "edge_application_id": 1536580781,
        "is_active": true,
        "domain_name": "101918m.ha.azioncdn.net"
    },
    "schema_version": 3
}

4. Deletar um domain

Exclui o domain de uma conta.

DELETE /domains/:domain_id

Permissão necessária: Edit Domains

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado através do endpoint de Criação de Token endpoint header string
Accept (obrigatório) Informações sobre o tipo de retorno e versão header string;
application/json;version=3
:domain_id (obrigatório) O id do domain que se pretende deletar URI Integer

Exemplo de Requisição

DELETE /domains/1538600025
Accept: application/json; version=3
Authorization: token 661afbb34e714f657b8a4db7b7a7068a318a65f7
Content-Type: application/json

Exemplo de Resposta

HTTP/2 204

5. Criar um novo domain

Incluir um novo domain em uma conta.

POST /domains

Permissão necessária: Edit Domains

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado através do endpoint de Criação de Token endpoint 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
body A Configuration que se deseja criar deve ser enviada codificada no formato json com os seguintes campos:
name (string): o nome da configuração que se quer criar.
cnames (array of strings): a lista de domínios do site (CNAMEs). O valor default é vazio.
cname_access_only(boolean): define se a entrega do conteúdo deve ser realizada apenas pelos domínios listados no campo “cname” ou se o domínio da azion (azioncdn.net) também será utilizado. O valor default é false.
digital_certificate (number):o id do certificado SSL, previamente cadastrado na plataforma como Custom Certificate, que deve ser utilizado em caso de entrega através de https. O valor default é null, representando que o certificado SSL compartilhado da Azion será utilizado.
edge_application_id (number): o id do Edge Application que deve ser associado ao domínio. Consulte a lista de Edge Applications.
is_active (boolean): define se o domain deve ser cadastrado com ativo (em produção) ou inativo.
body json

Exemplo de Requisição

POST /domains
Accept: application/json; version=3
Authorization: token 661afbb34e714f657b8a4db7b7a7068a318a65f7
Content-Type: application/json
{
    "name": "New domain created directly by the API",
    "cnames": ["www.cname1.com", "www.cname2.com"],
    "cname_access_only": false,
    "digital_certificate_id": null,
    "edge_application_id": 1536580781,
    "is_active": true
}

Exemplo de Resposta

{
    "results": {
        "id": 1554220280,
        "name": "New domain created directly by the API",
        "cnames": [
            "www.cname1.com",
            "www.cname2.com"
        ],
        "cname_access_only": false,
        "digital_certificate_id": null,
        "edge_application_id": 1536580781,
        "is_active": true,
        "domain_name": "121918m.ha.azioncdn.net"
    },
    "schema_version": 3
}

6. Sobrescrever um domain

Sobrescreve todos os campos de um domain, preservando o id. Os campos opcionais não informados serão substituídos pelos valores default.

Para atualizar somente alguns campos de um domain, considere utilizar o método PATCH ao invés do PUT.

PUT /domains/:domain_id

Permissão necessárian: Edit Domains

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado através do endpoint de Criação de Token endpoint 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
body A Configuration que se deseja sobrescrever deve ser enviada codificada no formato json com os seguintes campos:
name (string): o nome da configuração que se quer criar.
cnames (array of strings): a lista de domínios do site (CNAMEs). O valor default é vazio.
cname_access_only(boolean): define se a entrega do conteúdo deve ser realizada apenas pelos domínios listados no campo “cname” ou se o domínio da azion (azioncdn.net) também será utilizado. O valor default é false.
digital_certificate (number):o id do certificado SSL, previamente cadastrado na plataforma como Custom Certificate, que deve ser utilizado em caso de entrega através de https. O valor default é null, representando que o certificado SSL compartilhado da Azion será utilizado.
edge_application_id (number): o id do Edge Application que deve ser associado ao domínio. Consulte a lista de Edge Applications.
is_active (boolean): define se o domain deve ser cadastrado com ativo (em produção) ou inativo.
body json

Exemplo de Requisição

PUT /domains/1554220280
Accept: application/json; version=3
Authorization: token 661afbb34e714f657b8a4db7b7a7068a318a65f7
Content-Type: application/json
{
    "name": "New name for the domain",
    "cnames": ["www.cname1.com", "www.cname2.com"],
    "cname_access_only": false,
    "digital_certificate_id": null,
    "edge_application_id": 1536580781,
    "is_active": true
}

Exemplo de Resposta

{
    "results": {
        "id": 1554220280,
        "name": "New name for the domain",
        "cnames": [
            "www.cname1.com",
            "www.cname2.com"
        ],
        "cname_access_only": false,
        "digital_certificate_id": null,
        "edge_application_id": 1536580781,
        "is_active": true,
        "domain_name": "131918m.ha.azioncdn.net"
    },
    "schema_version": 3
}

7. Atualizar campos de um domain

Atualiza um ou mais campos de um Domain, preservando o valor dos campos não informados.

PATCH /domains/:domain_id

Permissão necessária: Edit Domains

Parameter Description Type Type of Data
Authorization (obrigatório) A autenticação por Token previamente criado através do endpoint de Criação de Token endpoint 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
domain_id
(obrigatório)
Id do Domain a ser atualizado. path number
body Aqui os campos que deseja atualizar devem passar os novos valores:
name (string): o nome da configuração que se quer criar.
cnames (array of strings): a lista de domínios do site (CNAMEs). O valor default é vazio.
cname_access_only(boolean): define se a entrega do conteúdo deve ser realizada apenas pelos domínios listados no campo “cname” ou se o domínio da azion (azioncdn.net) também será utilizado. O valor default é false.
digital_certificate (number):o id do certificado SSL, previamente cadastrado na plataforma como Custom Certificate, que deve ser utilizado em caso de entrega através de https. O valor default é null, representando que o certificado SSL compartilhado da Azion será utilizado.
edge_application_id (number): o id do Edge Application que deve ser associado ao domínio. Consulte a lista de Edge Applications.
is_active (boolean): define se o domain deve ser cadastrado com ativo (em produção) ou inativo.
body json

Exemplo de Requisição

PATCH /domains/1536580019
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75
Content-Type: application/json  
{
	"name": "Name changed by API"
}

Exemplo de Resposta

{
    "results": {
        "id": 1536580019,
        "name": "Name changed by API",
        "cnames": [
            "www.getthiscname.com"
        ],
        "cname_access_only": false,
        "digital_certificate_id": null,
        "edge_application_id": 1536580781,
        "is_active": true,
        "domain_name": "101918m.ha.azioncdn.net"
    },
    "schema_version": 3
}

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