Skip to content

Histórico

Histórico - Consultar histórico

Consulta o histórico de mudanças na API GoCache

GET /v1/history/?from={from}&to={to}&type={type}&domain={domain}&section={section}&action={action}&limit={limit}&user={user}
$ curl -i "https://api.gocache.com.br/v1/history/?from=1603794319&to=1603800319&section=settings&type=cache&domain=seudominio.com.br&action=update&limit=20&offset=0&user=dev@seudominio.com.br&account=my-account@seu-dominio.com.br" \
-H 'GoCache-Token:seu_token'
<?php

$ch = curl_init("https://api.gocache.com.br/v1/history/?from=1603794319&to=1603800319&section=settings&type=cache&domain=seudominio.com.br&action=update&limit=20&offset=0&user=dev@seudominio.com.br&account=my-account@seu-dominio.com.br");

curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

curl_setopt($ch, CURLOPT_HTTPHEADER, array("GoCache-Token: seu_token"));

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

curl_close($ch);
?>

Parâmetros

Campo Opcional Tipo Descrição
domain String Domínio principal da mudança (não utilizar subdomínios como "www.", "blog.", etc).
section String Permite filtro por seção do painel.
Valores permitidos: "domain", "dns", "settings", "security", "smartrules"
type String Permite filtro por tipo de mudança.
Valores permitidos: "main", "dns", "cache", "ssl", "performance", "waf", "firewall", "ratelimit", "rewrite", "settings"
identifier String ID da configuração. Para regras e DNS, será o ID do mesmo. Para outros itens, será o nome do campo alterado ou ID do elemento. Por exemplo em smart rules, é o ID da regra alterada.
user String Email de usuário que efetuou a ação.
account String Email da conta na qual a ação foi efetuada.
action String Ação da mudança tomada, podendo ser criação (create), atualização (update), reordenação (order) ou remoção (delete).
Valores permitidos: "create", "update", "delete", "order"
from Number Horário inicial de busca de mudanças (em formato unix timestamp). O fuso está em formato UTC+0
to Number Horário final de busca de mudanças (em formato unix timestamp). O fuso está em formato UTC+0
id Number ID do registro de histórico. Permite obter uma única mudança a partir do id da mesma. Se utilizado, faz com que outros critérios sejam ignorados.
limit Number Permite limitar o número máximo de eventos retornado por chamada.
Valor padrão: 20

Faixa de tamanho: 1,100
offset Number Usado para paginar resultados. Define a posição a partir da qual será obtida entradas de histórico.
Exemplo de paginação (com limite de 10 resultdos):

Página 1: limit=10, offset=0

Página 2: limit=10, offset=10

Página 3: limit=10, offset=20

Valor padrão: 0

Exemplo de sucesso:

HTTP/1.1 200 OK
{
    "status_code": 200,
    "response": {
            "data": [
            {
                "changes": {
                    "original": {
                            "cache_302": "false"
                        },
                        "updated": {
                                "cache_302": "true"
                         }
                    },
                    "id": 143,
                    "domain": "seudominio.com.br",
                    "date": "2020-10-27 12:25:20",
                    "user": "user@seudominio.com.br",
                    "account": "my-account@seu-dominio.com.br",
                    "action": "update",
                    "identifier": "cache_302",
                    "section": "settings",
                    "type": "cache"
                 },
                {
                    "changes": {
                        "original": {
                                "cache_301": "false"
                        },
                        "updated": {
                                "cache_301": "true"
                         }
                    },
                    "id": 142,
                    "domain": "seudominio.com.br",
                    "date": "2020-10-27 12:25:19",
                    "user": "user@seudominio.com.br",
                    "account": "my-account@seu-dominio.com.br",
                    "action": "update",
                    "identifier": "cache_301",
                    "section": "settings",
                    "type": "cache"
                }
            ],
            "results": 2,
            "total": 1337,
         }
}
<?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Entradas encontradas: " . $obj->response->results);

}
?>