Domínios

Alterar domínio

Alterar as configurações de um domínio

Todos os parâmetros no body são opcionais, porém pelo menos um deve ser adicionado.

PUT /v1/domain/{dominio}

CURLPHP

$ curl -i https://api.gocache.com.br/v1/domain/seudominio.com.br \
        -X PUT \
        -H 'GoCache-Token:seu_token' \
    -d 'cache_ttl=86400' \
    -d 'waf_status=true'

<?php

$ch = curl_init("https://api.gocache.com.br/v1/domain/seudominio.com.br");

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

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

$urls = array(
        "cache_ttl=86400",
        "waf_status=true"
        );

curl_setopt($ch, CURLOPT_POSTFIELDS, implode("&", $urls));

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

curl_close($ch);
?>

Parâmetros

Campo	Opcional	Tipo	Descrição
cache_ttl	✓	Number	Tempo de expiração padrão Valor padrão: 86400 Valores permitidos: 10, 30, 60, 300, 600, 900, 1800, 3600, 7200, 14400, 43200, 86400, 172800, 604800, 1296000
deploy_mode	✓	Boolean	Modo de desenvolvimento Valor padrão: false Valores permitidos: true, false
smart_status	✓	Boolean	Status do SmartCache Valor padrão: false Valores permitidos: true, false
smart_tpl	✓	String	Status Do SmartCache Valor padrão: custom Valores permitidos: custom, wordpress, magento, joomla
smart_ttl	✓	Number	Tempo de expiração de cache do SmartCache Valor padrão: 14400 Valores permitidos: 10, 30, 60, 300, 600, 900, 1800, 3600,7200, 14400, 43200, 86400, 172800, 604800, 1296000
cdn_mode	✓	String	Modo de atuação da CDN Valor padrão: ns Valores permitidos: "ns", "cname"
gzip_status	✓	Boolean	Compressão GZIP Valor padrão: true Valores permitidos: true, false
brotli_status	✓	Boolean	Compressão Brotli Valor padrão: false Valores permitidos: true, false
expires_ttl	✓	Number	Tempo de expiração dos objetos no cache do navegador Valor padrão: 14400 Valores permitidos: -1, 3600, 7200, 14400, 43200, 86400, 172800, 345600, 604800, 1296000, 2592000, 15552000, 3153600
ignore_vary	✓	Boolean	Ignora cabeçalho Vary Valor padrão: true Valores permitidos: true, false
ignore_cache_control	✓	Boolean	Ignora cabeçalho Cache-Control Valor padrão: true Valores permitidos: true, false
ignore_expires	✓	Boolean	Ignora cabeçalho Expires Valor padrão: true Valores permitidos: true, false
ssl_mode	✓	String	Modo de atuação em requisições SSL Valor padrão: full Valores permitidos: "full", "partial"
cache_301	✓	Boolean	Cache de requisições com status code 301 Valor padrão: false Valores permitidos: false, true
cache_302	✓	Boolean	Cache de requisições com status code 302 Valor padrão: false Valores permitidos: false, true
cache_404	✓	Boolean	Cache de requisições com status code 404 Valor padrão: false Valores permitidos: false, true
header_device_type	✓	Boolean	Envio de cabeçalho GoCache-Device-Type com o tipo de dispositivo Valor padrão: false Valores permitidos: true, false
header_geoip_continent	✓	Boolean	Envio de cabeçalho GoCache-GeoIP-Continent contendo o continente na notação ISO-ALPHA-2. Valor padrão: false Valores permitidos: true, false
header_geoip_country	✓	Boolean	Envio de cabeçalho GoCache-GeoIP-Country contendo o país de origem na notação ISO-ALPHA-2. Valor padrão: false Valores permitidos: true, false
header_geoip_org	✓	Boolean	Envio de cabeçalho GoCache-GeoIP-Org contendo o número do AS (Autonomous System) e o nome da organização responsável pelo IP de acesso. Valor padrão: false Valores permitidos: true, false
caching_behavior	✓	String	Comportamento de cache Valor padrão: default Valores permitidos: default, ignore
waf_status	✓	Boolean	Status do WAF Valor padrão:false Valores permitidos:true, false
waf_level	✓	String	Nível de bloqueio do WAF Valor padrão:high Valores permitidos: "low", "medium", "high"
waf_mode	✓	String	Modo de atuação do WAF Valor padrão:simulate Valores permitidos: "simulate", "challenge", "block"
expire_bypass_sec	✓	Number	Validade do captcha Valor padrão: -1 Valores permitidos: -1, 3600, 7200, 14400, 43200, 86400, 172800, 345600, 604800, 1296000, 2592000, 15552000, 3153600
tls10	✓	Boolean	Protocolo SSL TLS 1.0 ativado Valor padrão:true Valores permitidos: true, false
tls11	✓	Boolean	Protocolo SSL TLS 1.1 ativado Valor padrão:true Valores permitidos: true, false
image_optimize	✓	Boolean	Ativa ou desativa a otimização de imagens Valor padrão:false Valores permitidos: true, false
image_optimize_webp	✓	Boolean	Conversão de imagens para WEBP Valor padrão:false Valores permitidos: true, false
image_optimize_progressive	✓	Boolean	Conversão de imagens JPEG para o formato progressivo Valor padrão:false Valores permitidos: true, false
image_optimize_metadata	✓	Boolean	Remoção de metadados Valor padrão:false Valores permitidos: true, false
image_optimize_level	✓	Number	Nível de otimização de imagem. Utilize 0 para manter o nível original, 90 para nível baixo, 75 para nível médio e 65 para nível alto. Valor padrão:0 Faixa de Tamanho: 0-100
rate_limit_status	✓	Boolean	Ativa ou desativa o Rate Limit Valor padrão:false Valores permitidos: true, false CUSTOM
rate_limit_ignore_known_bots	✓	Boolean	Ignora bots considerados legítimos nas regras de Rate Limit Valor padrão:true Valores permitidos: true, false CUSTOM
rate_limit_ignore_static_content	✓	Boolean	Ignora conteúdo estático nas regras de Rate Limit Valor padrão:true Valores permitidos: true, false CUSTOM
bot_mitigation_status	✓	Boolean	Status do Bot Mitigation Valor padrão:false Valores permitidos:true, false

Exemplo de sucesso (CURL)Exemplo de sucesso (PHP)

HTTP/1.1 200 OK
{
    "response": {
        "cache_ttl": "86400",
        "deploy_mode": "false",
        "smart_tpl": "custom",
        "ssl_mode": "partial",
        "smart_status": "false",
        "gzip_status": "true",
        "brotli_status": "false",
        "cache_302": "true",
        "cache_404": "true",
        "cache_301": "true",
        "caching_behavior": "default",
        "smart_ttl": "604800",
        "expires_ttl": "1296000",
        "cdn_mode": "ns",
        "ignore_vary": "true",
        "ignore_expires": "true",
        "ignore_cache_control": "true",
        "expires_status": "true",
        "expire_bypass_sec": "-1",
        "waf_status": "true",
        "waf_level": "high",
        "waf_mode": "simulate",
        "header_geoip_country": "true",
        "header_device_type": "false"
    },
    "status_code": 1
}

<?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Resultado: status_code: " . $obj->status_code . "\n");
}
?>

Consultar domínio

Carrega as propriedades de um domínio

GET /v1/domain/{dominio}

CURLPHP

$ curl -i https://api.gocache.com.br/v1/domain/seudominio.com.br \
-X GET \
-H 'GoCache-Token:seu_token'

<?php

$ch = curl_init("https://api.gocache.com.br/v1/domain/seudominio.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);
?>

Exemplos de sucesso

Exemplo de sucesso (CURL)Exemplo de sucesso (PHP)

    HTTP/1.1 200 OK
{
    "response": {
        "cache_ttl": "604800",
        "deploy_mode": "false",
        "smart_tpl": "custom",
        "ssl_mode": "partial",
        "smart_status": "false",
        "gzip_status": "true",
        "brotli_status": "false",
        "cache_302": "true",
        "cache_404": "true",
        "cache_301": "true",
        "caching_behavior": "default",
        "smart_ttl": "604800",
        "expires_ttl": "1296000",
        "cdn_mode": "ns",
        "ignore_vary": "true",
        "ignore_expires": "true",
        "ignore_cache_control": "true",
        "expires_status": "true",
        "expire_bypass_sec": "-1",
        "waf_status": "true",
        "waf_level": "high",
        "waf_mode": "simulate",
        "header_geoip_country": "true",
        "header_device_type": "false"
    },
    "status_code": 1
}

    <?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Dados do dominio:\n");
    foreach($obj->response as $key => $value) {
        echo("$key=$value\n");
    }

}
?>

Criar domínio

Cria um domínio

POST /v1/domain/{dominio}

CURLPHP

 $ curl -i https://api.gocache.com.br/v1/domain/seudominio.com.br \
 -X POST \
 -H 'GoCache-Token:seu_token' \
 -d 'cache_ttl=86400' \
 -d 'waf_status=false'

    <?php

$ch = curl_init("https://api.gocache.com.br/v1/domain/seudominio.com.br");

curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);

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

$urls = array(
        "cache_ttl=86400",
        "waf_status=false"
        );

curl_setopt($ch, CURLOPT_POSTFIELDS, implode("&", $urls));

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

curl_close($ch);
?>

Parâmetros

Campo	Opcional	Tipo	Descrição
cache_ttl	✓	Number	Tempo de expiração padrão Valor padrão: 86400 Valores permitidos: 10, 30, 60, 300, 600, 900, 1800, 3600, 7200, 14400, 43200, 86400, 172800, 604800, 1296000
deploy_mode	✓	Boolean	Modo de desenvolvimento Valor padrão: false Valores permitidos: true, false
smart_status	✓	Boolean	Status do SmartCache Valor padrão: false Valores permitidos: true, false
smart_tpl	✓	String	Status Do SmartCache Valor padrão: custom Valores permitidos: custom, wordpress, magento, joomla
smart_ttl	✓	Number	Tempo de expiração de cache do SmartCache Valor padrão: 14400 Valores permitidos: 10, 30, 60, 300, 600, 900, 1800, 3600,7200, 14400, 43200, 86400, 172800, 604800, 1296000
cdn_mode	✓	String	Modo de atuação da CDN Valor padrão: ns Valores permitidos: "ns", "cname"
gzip_status	✓	Boolean	Compressão GZIP Valor padrão: true Valores permitidos: true, false
brotli_status	✓	Boolean	Compressão Brotli Valor padrão: false Valores permitidos: true, false
expires_ttl	✓	Number	Tempo de expiração dos objetos no cache do navegador Valor padrão: 14400 Valores permitidos: -1, 3600, 7200, 14400, 43200, 86400, 172800, 345600, 604800, 1296000, 2592000, 15552000, 3153600
ignore_vary	✓	Boolean	Ignora cabeçalho Vary Valor padrão: true Valores permitidos: true, false
ignore_cache_control	✓	Boolean	Ignora cabeçalho Cache-Control Valor padrão: true Valores permitidos: true, false
ignore_expires	✓	Boolean	Ignora cabeçalho Expires Valor padrão: true Valores permitidos: true, false
ssl_mode	✓	String	Modo de atuação em requisições SSL Valor padrão: off Valores permitidos: "full", "partial"
cache_301	✓	Boolean	Cache de requisições com status code 301 Valor padrão: false Valores permitidos: false, true
cache_302	✓	Boolean	Cache de requisições com status code 302 Valor padrão: false Valores permitidos: false, true
cache_404	✓	Boolean	Cache de requisições com status code 404 Valor padrão: false Valores permitidos: false, true
header_device_type	✓	Boolean	Envio de cabeçalho GoCache-Device-Type com o tipo de dispositivo Valor padrão: false Valores permitidos: true, false
header_geoip_continent	✓	Boolean	Envio de cabeçalho GoCache-GeoIP-Continent contendo o continente na notação ISO-ALPHA-2. Valor padrão: false Valores permitidos: true, false
header_geoip_country	✓	Boolean	Envio de cabeçalho GoCache-GeoIP-Country contendo o país de origem na notação ISO-ALPHA-2. Valor padrão: false Valores permitidos: true, false
header_geoip_org	✓	Boolean	Envio de cabeçalho GoCache-GeoIP-Org contendo o número do AS (Autonomous System) e o nome da organização responsável pelo IP de acesso. Valor padrão: false Valores permitidos: true, false
caching_behavior	✓	String	Comportamento de cache Valor padrão: default Valores permitidos: default, ignore
waf_status	✓	Boolean	Status do WAF Valor padrão:false Valores permitidos:true, false
waf_level	✓	String	Nível de bloqueio do WAF Valor padrão:high Valores permitidos: "low", "medium", "high"
waf_mode	✓	String	Modo de atuação do WAF Valor padrão:simulate Valores permitidos: "simulate", "challenge", "block"
expire_bypass_sec	✓	Number	Validade do captcha Valor padrão: -1 Valores permitidos: -1, 3600, 7200, 14400, 43200, 86400, 172800, 345600, 604800, 1296000, 2592000, 15552000, 3153600
tls10	✓	Boolean	Protocolo SSL TLS 1.0 ativado Valor padrão:true Valores permitidos: true, false
tls11	✓	Boolean	Protocolo SSL TLS 1.1 ativado Valor padrão:true Valores permitidos: true, false
image_optimize	✓	Boolean	Ativa ou desativa a otimização de imagens Valor padrão:false Valores permitidos: true, false
image_optimize_webp	✓	Boolean	Conversão de imagens para WEBP Valor padrão:false Valores permitidos: true, false
image_optimize_progressive	✓	Boolean	Conversão de imagens JPEG para o formato progressivo Valor padrão:false Valores permitidos: true, false
image_optimize_metadata	✓	Boolean	Remoção de metadados Valor padrão:false Valores permitidos: true, false
image_optimize_level	✓	Number	Nível de otimização de imagem. Utilize 0 para manter o nível original, 90 para nível baixo, 75 para nível médio e 65 para nível alto. Valor padrão:0 Faixa de Tamanho: 0-100
rate_limit_status	✓	Boolean	Ativa ou desativa o Rate Limit Valor padrão:false Valores permitidos: true, false CUSTOM
rate_limit_ignore_known_bots	✓	Boolean	Ignora bots considerados legítimos nas regras de Rate Limit Valor padrão:true Valores permitidos: true, false CUSTOM
rate_limit_ignore_static_content	✓	Boolean	Ignora conteúdo estatico nas regras de Rate Limit Valor padrão:true Valores permitidos: true, false CUSTOM
bot_mitigation_status	✓	Boolean	Status do Bot Mitigation Valor padrão:false Valores permitidos:true, false

Listar domínios

Listar os domínios associados a uma conta

GET  /v1/domain/

CURLPHP

 $ curl -i https://api.gocache.com.br/v1/domain \
-X GET \
-H 'GoCache-Token:seu_token'

    <?php

$ch = curl_init("https://api.gocache.com.br/v1/domain");

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);
?>

Exemplos de sucesso

Exemplo de sucesso (CURL)Exemplo de sucesso (PHP)

    HTTP/1.1 200 OK
{
    "response": {
        "domains": ["seudominio1.com.br","seudominio2.com.br"]
    },
    "status_code": 1
}

    <?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Dominios encontrados:\n");
    foreach($obj->response->domains as $domain) {
        echo($domain . "\n");
    }

}
?>

Remover domínio

Remover de um domínio

DELETE /v1/domain/{dominio}

CURLPHP

$ curl -i https://api.gocache.com.br/v1/domain/seudominio.com.br \
-X DELETE \
-H 'GoCache-Token:seu_token'

    <?php

$ch = curl_init("https://api.gocache.com.br/v1/domain/seudominio.com.br");

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
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);
?>

Exemplos de sucesso

Exemplo de sucesso (CURL):Exemplo de sucesso (PHP):

    HTTP/1.1 200 OK
{
    "status_code": 1
}

    <?php

if( $statusCode == 200 ) {

    echo("Sucesso!\n");

    $obj = json_decode($response);

    echo("Resultado: status_code: " . $obj->status_code . "\n");
}
?>