Através da API do Content Delivery você pode consultar, remover ou atualizar suas configurações existentes, bem como criar novas configurações de Content Delivery. Para Cache Settings, utilize os endpoints que seguem.

  1. Consulta lista de Cache Settings
  2. Consulta dados de uma Cache Setting
  3. Deletar uma Cache Setting
  4. Criar uma nova Cache Setting
  5. Sobrescrever uma Cache Setting
  6. Atualizar campos de uma Cache Setting

1. Consulta lista de Cache Settings

Retorna a lista de Cache Settings de uma configuração de Content Delivery.

GET /content_delivery/configurations/:conf_id/cache_settings

Permissão necessária: View Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
:conf_id

(obrigatório)

 Id da configuração de Content Delivery a ser consultada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
 path  number

Exemplo de Requisição

Exemplo de Resposta


2. Consulta dados de uma Cache Setting

Retorna dados de uma Cache Setting de uma configuração de Content Delivery.

GET /content_delivery/configurations/:conf_id/cache_settings/:cache_id

Permissão necessária: View Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
:conf_id

(obrigatório)

Id da configuração de Content Delivery a ser consultada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:cache_id

(obrigatório)

Id da cache setting a ser consultada.
Para obter o Id de uma origem, consulte a Lista de Cache Settings.
path number

Exemplo de Requisição

Exemplo de Resposta


3. Deletar uma Cache Setting

Remove uma Cache Setting de uma configuração de Content Delivery.

DELETE /content_delivery/configurations/:conf_id/cache_settings/:cache_id

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
:conf_id

(obrigatório)

Id da configuração de Content Delivery que possui a Cache Setting que será removida.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:cache_id

(obrigatório)

Id da Cache Setting a ser removida.
Para obter o Id de uma Cache Setting, consulte a Lista de Cache Settings.
 path number

Exemplo de Requisição

Exemplo de Resposta


4. Criar uma nova Cache Setting

Cria uma nova Cache Setting em uma configuração de Content Delivery.

POST /content_delivery/configurations/:conf_id/cache_settings

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
Content-Type

(obrigatório)

O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json

header string
:conf_id

(obrigatório)

Id da configuração de Content Delivery para a qual a Cache Setting deve ser criada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
Configuration

(obrigatório)

A Cache Setting que se deseja criar deve ser enviada codificada no formato json com os seguintes campos obrigatórios:

  • name (string): o nome da Cache Setting que se quer criar.
  • browser_cache_settings (boolean): utilize o valor false, para configurar a Azion para repassar os cabeçalhos de cache enviados por usa origem para os usuários. Utilize true, para definir um TTL para browser cache.
  • cdn_cache_settings (choice): utilize o valor “honor”, para configurar a CDN para respeitar os cabeçalhos de cache enviados por sua origem; utilize “override” para configurar um TTL manualmente; ou utilize “bypass” (requer o produto Application Acceleration), para que a CDN ignore o cache e faça proxy das requisições diretamente para sua origem.
  • cache_by_query_string (choice): utilize o valor “ignore”, caso o conteúdo entregue para seus usuários não varie pela Query String; utilize “whitelist”, caso o seu  conteúdo varie por apenas alguns campos de Query String; utilize “blacklist”, caso seu conteúdo varie por todos os campos de Query String, com exceção de alguns; utilize “all”, caso seu conteúdo varie por todos os campos de Query String, sem exceções.
  • cache_by_cookies (choice): utilize o valor “ignore”, caso o conteúdo entregue para seus usuários não varie por cookies; utilize “whitelist”, caso o seu  conteúdo varie por apenas alguns cookies; utilize “blacklist”, caso seu conteúdo varie por todos os cookies, com exceção de alguns; utilize “all”, caso seu conteúdo varie por todos os cookies, sem exceções.

E os seguintes campos opcionais:

  • browser_cache_settings_maximum_ttl (number): defina o TTL de browser cache em segundos, caso tenha utilizado o valor true no campo browser_cache_settings. Caso contrário, esse valor é ignorado.
  • cdn_cache_settings_maximum_ttl (number): defina o TTL de CDN cache em segundos, caso tenha utilizado o valor override no campo cdn_cache_settings. Caso contrário, esse valor é ignorado.
  • query_string_fields (array): caso você tenha selecionado “whitelist” ou “blacklist” no campo cache_by_query_string, liste em um array os campos de query string.
  • enable_query_string_sort (boolean): se você estiver utilizando cache_by_query_string, utilize true para ativar Query String Sort ou false, para desativar.
  • cookie_names (array): caso você tenha selecionado “whitelist” ou “blacklist” no campo cache_by_cookies, liste em um array os cookies.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
9
10
{
   "name": "Cache for Static Files",
   "browser_cache_settings": true,
   "browser_cache_settings_maximum_ttl": 86400,
   "cdn_cache_settings": "override",
   "cdn_cache_settings_maximum_ttl": 31536000,
   "cache_by_query_string": "ignore",
   "cache_by_cookies": "ignore"
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
   "id": 1542,
   "name": "Cache for Static Files",
   "browser_cache_settings": true,
   "browser_cache_settings_maximum_ttl": 86400,
   "cdn_cache_settings": "override",
   "cdn_cache_settings_maximum_ttl": 31536000,
   "cache_by_query_string": "ignore",
   "query_string_fields": null,
   "enable_query_string_sort": false,
   "cache_by_cookies": "ignore",
   "cookie_names": null
}
 


5. Sobrescrever uma Cache Setting

Sobrescreve todos os campos de uma Cache Setting, preservando o id. Os campos opcionais não informados serão substituídos pelos valores default. Considere utilizar o método PATCH no lugar de PUT, para atualizar somente alguns campos da configuração sem alterar o valor dos demais.

PUT /content_delivery/configurations/:conf_id/cache_settings/:cache_id

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
Content-Type

(obrigatório)

O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json

header string
:conf_id

(obrigatório)

Id da configuração de Content Delivery para a qual a Cache Setting deve ser substituída.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:cache_id

(obrigratório)

Id da Cache Setting a ser sobrescrita.
Para obter o Id de uma Origem, consulte a Lista de Cache Settings.
path number
Configuration

(obrigatório)

Os novos valores de cada campo da configuração. Os campos não preenchidos serão substituídos pelo valor default. Se você desejar alterar apenas um dos campos, utilize o método PATCH ao invés do PUT.

  • name (string): o novo nome da Cache Setting que se quer sobrescrever.
  • browser_cache_settings (boolean): utilize o valor false, para configurar a Azion para repassar os cabeçalhos de cache enviados por usa origem para os usuários. Utilize true, para definir um TTL para browser cache.
  • browser_cache_settings_maximum_ttl (number): defina o TTL de browser cache em segundos, caso tenha utilizado o valor true no campo browser_cache_settings. Caso contrário, esse valor é ignorado.
  • cdn_cache_settings (choice): utilize o valor “honor”, para configurar a CDN para respeitar os cabeçalhos de cache enviados por sua origem; utilize “override” para configurar um TTL manualmente; ou utilize “bypass” (requer o produto Application Acceleration), para que a CDN ignore o cache e faça proxy das requisições diretamente para sua origem.
  • cdn_cache_settings_maximum_ttl (number): defina o TTL de CDN cache em segundos, caso tenha utilizado o valor override no campo cdn_cache_settings. Caso contrário, esse valor é ignorado.
  • cache_by_query_string (choice): utilize o valor “ignore”, caso o conteúdo entregue para seus usuários não varie pela Query String; utilize “whitelist”, caso o seu  conteúdo varie por apenas alguns campos de Query String; utilize “blacklist”, caso seu conteúdo varie por todos os campos de Query String, com exceção de alguns; utilize “all”, caso seu conteúdo varie por todos os campos de Query String, sem exceções.
  • query_string_fields (array): caso você tenha selecionado “whitelist” ou “blacklist” no campo cache_by_query_string, liste em um array os campos de query string.
  • enable_query_string_sort (boolean): se você estiver utilizando cache_by_query_string, utilize true para ativar Query String Sort ou false, para desativar.
  • cache_by_cookies (choice): utilize o valor “ignore”, caso o conteúdo entregue para seus usuários não varie por cookies; utilize “whitelist”, caso o seu  conteúdo varie por apenas alguns cookies; utilize “blacklist”, caso seu conteúdo varie por todos os cookies, com exceção de alguns; utilize “all”, caso seu conteúdo varie por todos os cookies, sem exceções.
  • cookie_names (array): caso você tenha selecionado “whitelist” ou “blacklist” no campo cache_by_cookies, liste em um array os cookies.
body json

Exemplo de Requisição

1
2
3
4
5
6
7
8
9
10
{
   "name": "Cache for Static Files",
   "browser_cache_settings": true,
   "browser_cache_settings_maximum_ttl": 0,
   "cdn_cache_settings": "override",
   "cdn_cache_settings_maximum_ttl": 31536000,
   "cache_by_query_string": "ignore",
   "cache_by_cookies": "ignore"
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
   "id": 1542,
   "name": "Cache for Static Files",
   "browser_cache_settings": true,
   "browser_cache_settings_maximum_ttl": 0,
   "cdn_cache_settings": "override",
   "cdn_cache_settings_maximum_ttl": 31536000,
   "cache_by_query_string": "ignore",
   "query_string_fields": null,
   "enable_query_string_sort": false,
   "cache_by_cookies": "ignore",
   "cookie_names": null
}
 


6. Atualizar campos de uma Cache Setting

Atualiza um ou mais campos de uma Cache Setting de uma configuração de Content Delivery, preservando o valor dos campos não informados.

PATCH /content_delivery/configurations/:conf_id/cache_settings/:cache_id

Permissão necessária: Edit Content Delivery

Parâmetro Descrição Tipo de Parâmetro Tipo de Dado
Authorization

(obrigatório)

A autenticação por Token previamente criado através do endpoint de Criação de Token.

ex.:

Authorization: Token 583f8a9ca8d6d5ff2cb50f1d3c4d35cb8939f1bf

header string
Content-Type

(obrigatório)

O tipo de codificação utilizada no Body (application/json).

ex.:

Content-Type: application/json

header string
:conf_id

(obrigatório)

Id da configuração de Content Delivery para a qual a Cache Setting deve ser atualizada.
Para obter o Id de uma configuração, consulte a Lista de Configurações.
path number
:cache_id

(obrigatório)

Id da Cache Setting a ser atualizada.
Para obter o Id de uma Cache Setting, consulte a Lista de Cache Settings.
path number
Configuration

(obrigatório)

Devem ser informados um ou mais campos a serem atualizados. Os campos não informados não terão o seu valor alterado.

  • name (string): o novo nome da Cache Setting.
  • browser_cache_settings (boolean): utilize o valor false, para configurar a Azion para repassar os cabeçalhos de cache enviados por usa origem para os usuários. Utilize true, para definir um TTL para browser cache.
  • browser_cache_settings_maximum_ttl (number): defina o TTL de browser cache em segundos, caso tenha utilizado o valor true no campo browser_cache_settings. Caso contrário, esse valor é ignorado.
  • cdn_cache_settings (choice): utilize o valor “honor”, para configurar a CDN para respeitar os cabeçalhos de cache enviados por sua origem; utilize “override” para configurar um TTL manualmente; ou utilize “bypass” (requer o produto Application Acceleration), para que a CDN ignore o cache e faça proxy das requisições diretamente para sua origem.
  • cdn_cache_settings_maximum_ttl (number): defina o TTL de CDN cache em segundos, caso tenha utilizado o valor override no campo cdn_cache_settings. Caso contrário, esse valor é ignorado.
  • cache_by_query_string (choice): utilize o valor “ignore”, caso o conteúdo entregue para seus usuários não varie pela Query String; utilize “whitelist”, caso o seu  conteúdo varie por apenas alguns campos de Query String; utilize “blacklist”, caso seu conteúdo varie por todos os campos de Query String, com exceção de alguns; utilize “all”, caso seu conteúdo varie por todos os campos de Query String, sem exceções.
  • query_string_fields (array): caso você tenha selecionado “whitelist” ou “blacklist” no campo cache_by_query_string, liste em um array os campos de query string.
  • enable_query_string_sort (boolean): se você estiver utilizando cache_by_query_string, utilize true para ativar Query String Sort ou false, para desativar.
  • cache_by_cookies (choice): utilize o valor “ignore”, caso o conteúdo entregue para seus usuários não varie por cookies; utilize “whitelist”, caso o seu  conteúdo varie por apenas alguns cookies; utilize “blacklist”, caso seu conteúdo varie por todos os cookies, com exceção de alguns; utilize “all”, caso seu conteúdo varie por todos os cookies, sem exceções.
  • cookie_names (array): caso você tenha selecionado “whitelist” ou “blacklist” no campo cache_by_cookies, liste em um array os cookies.
body json

Exemplo de Requisição

1
2
3
4
5
{
   "cache_by_query_string": "whitelist",
   "query_string_fields": ["product_id"]
}
 

Exemplo de Resposta

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
   "id": 1542,
   "name": "Cache for Static Files",
   "browser_cache_settings": true,
   "browser_cache_settings_maximum_ttl": 0,
   "cdn_cache_settings": "override",
   "cdn_cache_settings_maximum_ttl": 31536000,
   "cache_by_query_string": "whitelist",
   "query_string_fields": ["product_id"],
   "enable_query_string_sort": false,
   "cache_by_cookies": "ignore",
   "cookie_names": null
}