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

Cache Settings

Edite no GitHub

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

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

1. Obter lista de Cache Settings

Retorna uma lista de Cache Settings.

GET /edge_applications/:edge_application_id:/cache_settings

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

Exemplo de Resposta

{
  "count": 3,
  "total_pages": 1,
  "schema_version": 3,
  "links": {
      "previous": null,
      "next": null
  },
  "results": [
      {
          "id": 6734,
          "name": "Default Cache Settings",
          "browser_cache_settings": "honor",
          "browser_cache_settings_maximum_ttl": 0,
          "cdn_cache_settings": "honor",
          "cdn_cache_settings_maximum_ttl": 0,
          "cache_by_query_string": "all",
          "query_string_fields": null,
          "enable_query_string_sort": false,
          "cache_by_cookies": "all",
          "cookie_names": [""],
          "adaptive_delivery_action": "ignore",
          "device_group": [],
          "enable_caching_for_post": false,
          "l2_caching_enabled": false,
          "is_slice_configuration_enabled": false,
          "is_slice_edge_caching_enabled": false,
          "is_slice_l2_caching_enabled": false,
          "slice_configuration_range": 1024
      }
  ]
}

2. Obter dados de Cache Settings

Fornece detalhes de Cache Settings. As informações que são retornadas por este comando se referem as cache settings de uma Edge Application.

GET /edge_applications/:edge_application_id:/cache_settings/:cache_settings_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 Cache Settings que se pretende consultar. path number

Exemplo de Requisição

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

Exemplo de Resposta

{
  "count": 3,
  "total_pages": 1,
  "schema_version": 3,
  "links": {
      "previous": null,
      "next": null
  },
  "results": [
      {
          "id": 6734,
          "name": "Default Cache Settings",
          "browser_cache_settings": "honor",
          "browser_cache_settings_maximum_ttl": 0,
          "cdn_cache_settings": "honor",
          "cdn_cache_settings_maximum_ttl": 0,
          "cache_by_query_string": "all",
          "query_string_fields": null,
          "enable_query_string_sort": false,
          "cache_by_cookies": "all",
          "cookie_names": [""],
          "adaptive_delivery_action": "ignore",
          "device_group": [],
          "enable_caching_for_post": false,
          "l2_caching_enabled": false,
          "is_slice_configuration_enabled": false,
          "is_slice_edge_caching_enabled": false,
          "is_slice_l2_caching_enabled": false,
          "slice_configuration_range": 1024
      }
  ]
}

3. Deletar Cache Settings

Remove um Cache Setting. A 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 Cache Settings 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:/cache_settings/:cache_settings_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 Cache Settings que se pretende excluir. path number

Exemplo de Requisição

DELETE /edge_applications/3790128/cache_settings/1528990724
Accept: application/json; version=3
Authorization: token 2909f3932069047f4736dc87e72baaddd19c9f75

Exemplo de Resposta

HTTP/2 204

4. Criar novo Cache Settings

Possibilita a criação de um novo Cache Settings.

POST /edge_applications/:edge_application_id:/cache_settings

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/:edge_application_id:/cache_settings
Accept: application/json; version=3
Authorization: token cf2078926f91a6e638af3f4a6977b505edfe5941
Content-Type: application/json
{
      "name": "Cache Settings",
      "browser_cache_settings": "honor",
      "browser_cache_settings_maximum_ttl": 0,
      "cdn_cache_settings": "honor",
      "cdn_cache_settings_maximum_ttl": 60,
      "cache_by_query_string": "all",
      "query_string_fields": null,
      "enable_query_string_sort": false,
      "cache_by_cookies": "all",
      "cookie_names": null,
      "device_group": [],
      "enable_caching_for_post": false,
      "l2_caching_enabled": false,
      "is_slice_configuration_enabled": true,
      "is_slice_edge_caching_enabled": true,
      "is_slice_l2_caching_enabled": false,
      "slice_configuration_range": null
}

Exemplo de Resposta

{
  "results": {
      "id": 8908,
      "name": "Cache Settings",
      "browser_cache_settings": "honor",
      "browser_cache_settings_maximum_ttl": 0,
      "cdn_cache_settings": "honor",
      "cdn_cache_settings_maximum_ttl": 60,
      "cache_by_query_string": "all",
      "query_string_fields": null,
      "enable_query_string_sort": false,
      "cache_by_cookies": "all",
      "cookie_names": null,
      "adaptive_delivery_action": "ignore",
      "device_group": [],
      "enable_caching_for_post": false,
      "l2_caching_enabled": false,
      "is_slice_configuration_enabled": true,
      "is_slice_edge_caching_enabled": true,
      "is_slice_l2_caching_enabled": false,
      "slice_configuration_range": null
  },
  "schema_version": 3
}

5. Sobrescrever Cache Settings existente

Sobrescreve todos os campos de Cache Settings, preservando o id.

Se você 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/:edge_application_id:/cache_settings/:cache_settings_id:

Permissão necessária: Edit Edge Applications

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 Cache Settings a ser sobrescrito. path number

Exemplo de Requisição

PUT /edge_applications/3790128/cache_settings/1528990724
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
      "name": "Cache Settings - Overwrite",
      "browser_cache_settings": "honor",
      "browser_cache_settings_maximum_ttl": 0,
      "cdn_cache_settings": "honor",
      "cdn_cache_settings_maximum_ttl": 60,
      "cache_by_query_string": "all",
      "query_string_fields": null,
      "enable_query_string_sort": false,
      "cache_by_cookies": "all",
      "cookie_names": null,
      "device_group": [],
      "enable_caching_for_post": false,
      "l2_caching_enabled": false,
      "is_slice_configuration_enabled": true,
      "is_slice_edge_caching_enabled": true,
      "is_slice_l2_caching_enabled": false,
      "slice_configuration_range": null
}

Exemplo de Resposta

{
  "results": {
      "id": 8907,
      "name": "Cache Settings - Overwrite",
      "browser_cache_settings": "honor",
      "browser_cache_settings_maximum_ttl": 0,
      "cdn_cache_settings": "honor",
      "cdn_cache_settings_maximum_ttl": 60,
      "cache_by_query_string": "all",
      "query_string_fields": null,
      "enable_query_string_sort": false,
      "cache_by_cookies": "all",
      "cookie_names": null,
      "device_group": [],
      "enable_caching_for_post": false,
      "l2_caching_enabled": false,
      "is_slice_configuration_enabled": true,
      "is_slice_edge_caching_enabled": true,
      "is_slice_l2_caching_enabled": false,
      "slice_configuration_range": null
  },
  "schema_version": 3
}

6. Atualizar campos de Cache Settings

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

PATCH /edge_applications/:edge_application_id:/cache_settings/:cache_settings_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 da Cache Settings a ser sobrescrita. path number

Exemplo de Requisição

PATCH /edge_applications/3790128/cache_settings/1528990724
Accept: application/json; version=3
Authorization: token ec6aabdc0b6bbeed826a36d8731630e36b6e3f24
Content-Type: application/json
{
      "browser_cache_settings_maximum_ttl": 0,
      "cdn_cache_settings": "honor",
      "cdn_cache_settings_maximum_ttl": 60,
      "cache_by_query_string": "all",
      "query_string_fields": null
}

Exemplo de Resposta

{
  "results": {
      "id": 8907,
      "name": "Cache Settings - Update",
      "browser_cache_settings": "honor",
      "browser_cache_settings_maximum_ttl": 0,
      "cdn_cache_settings": "honor",
      "cdn_cache_settings_maximum_ttl": 60,
      "cache_by_query_string": "all",
      "query_string_fields": null,
      "enable_query_string_sort": false,
      "cache_by_cookies": "all",
      "cookie_names": null,
      "device_group": [],
      "enable_caching_for_post": false,
      "l2_caching_enabled": false,
      "is_slice_configuration_enabled": true,
      "is_slice_edge_caching_enabled": true,
      "is_slice_l2_caching_enabled": false,
      "slice_configuration_range": null
  },
  "schema_version": 3
}

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