Log Stream

Disponível no plano CUSTOM

Cadastrar o envio de logs

O corpo da requisição varia de acordo com o serviço de armazenamento em nuvem utilizado. Para mais informações acesse a introdução do Log Stream.

Obs: Cadastrar não habilita automaticamente o envio.

POST /v1/log/{log}/{domínio}

CURL S3 (AWS)CURL Cloud Storage (GCP)CURL Blob (AZURE)

Parâmetros do body

Campo	Tipo	Descrição
type	String	s3
region	String	Região do seu bucket
secret	String	Chave de segredo de acesso do bucket
access	String	ID da chave de acesso do bucket
bucket	String	O nome de seu bucket

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X POST \
-d '{
     "type":"s3",
     "region": "região_do_seu_bucket",
     "secret": "Secret_Access_Key",
     "access": "Access_Key_ID",
     "bucket": "nome_do_seu_bucket"
    }'

Parâmetros do body

Campo	Tipo	Descrição
type	String	gcp
private_key	String	Chave privada do acesso ao bucket
client_email	String	email da conta do bucket
bucket	String	O nome de seu bucket

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X POST \
-d '{
     "type":"gcp",
     "private_key":"-----BEGIN PRIVATE KEY-----\ [Chave privada]-----END PRIVATE KEY-----\n",
     "client_email":"nome_da_conta_serviço@id_do_projeto.iam.gserviceaccount.com",
     "bucket":"nome_do_bucket"
    }'

Parâmetros do body

Campo	Tipo	Descrição
type	String	blob
accountname	String	O nome de sua conta azure
accountkey	String	A chave de acesso da conta
bucket	String	O nome de seu container blob

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X POST \
-d '{
    "type":"blob",
    "accountname":"nome_da_sua_conta",
    "accountkey":"chave",
    "bucket":"nome_do_seu_contêiner"
   }'

Parâmetros da URL

Campo	Tipo	Descrição
log	String	Possíveis valores: "access" ou "security"
domínio	String	Domínio cadastrado na GoCache

Exemplo de sucesso (CURL):

{
  "status_code": 200,
  "response": {
    "id": "abcdefghijklmnop"
  },
  "success": true
}

Listar envio de logs

GET /v1/log/{log}/{domínio}

CURL

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json"

Parâmetros da URL

Campo	Tipo	Descrição
log	String	Possíveis valores: "access" ou "security"
domínio	String	Domínio cadastrado na GoCache

Exemplo de sucesso (CURL):

{
    "status_code": 200,
    "response": [
        {
          "bucket": "nome_do_bucket",
          "access": "Access_Key_ID",
          "id": "asdfghjklqwertyu",
          "region": "us-east-1",
          "log_type": "access",
          "secret": "Secret_Access_Key",
          "type": "s3"
        },
        {
          "bucket": "nome_do_bucket",
          "private_key": "-----BEGIN PRIVATE KEY-----\ [Chave privada]-----END PRIVATE KEY-----\n",
          "id": "abcdefghijklmnop",
          "client_email": "nome_da_conta_serviço@id_do_projeto.iam.gserviceaccount.com",
          "log_type": "access",
          "type": "gcp"
        }
    ],
    "success": true
}

Consultar envio de logs específico

GET /v1/log/{log}/{domínio}/{id}

CURL

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br/asdfghjklqwertyu \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json"

Parâmetros

Campo	Opcional	Tipo	Descrição
log		String	Possíveis valores: "access" ou "security"
domínio		String	Domínio cadastrado na GoCache
id		String	ID do envio de logs que será buscado

Exemplo de sucesso (CURL):

{
    "status_code": 200,
    "response": {
        "bucket": "nome_do_bucket",
        "access": "Access_Key_ID",
        "id": "asdfghjklqwertyu",
        "region": "us-east-1",
        "log_type": "access",
        "secret": "Secret_Access_Key",
        "type": "s3"
    },
    "success": true
}

Alterar envio de logs específico

PUT /v1/log/{log}/{domínio}/{id}

CURL S3 (AWS)CURL Cloud Storage (GCP)CURL Blob (AZURE)

Parâmetros do body

Campo	Tipo	Descrição
type	String	s3
region	String	Região do seu bucket
secret	String	Chave de segredo de acesso do bucket
access	String	ID da chave de acesso do bucket
bucket	String	O nome de seu bucket

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br/asdfghjklqwertyu \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X PUT \
-d '{
     "type":"s3",
     "region":"região_do_seu_bucket",
     "secret":" Secret_Access_Key",
     "access":"Access_Key_ID",
     "bucket":"nome_do_seu_bucket"
    }'

Parâmetros do body

Campo	Tipo	Descrição
type	String	gcp
private_key	String	Chave privada do acesso ao bucket
client_email	String	email da conta do bucket
bucket	String	O nome de seu bucket

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br/asdfghjklqwertyu \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X PUT \
-d '{
     "type":"gcp",
     "private_key":"-----BEGIN PRIVATE KEY-----\ [Chave privada]-----END PRIVATE KEY-----\n",
     "client_email":"nome_da_conta_serviço@id_do_projeto.iam.gserviceaccount.com",
     "bucket":"nome_do_bucket"
    }'

Parâmetros do body

Campo	Tipo	Descrição
type	String	blob
accountname	String	O nome de sua conta azure
accountkey	String	A chave de acesso da conta
bucket	String	O nome de seu container blob

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br/asdfghjklqwertyu \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X PUT \
-d '{
     "type":"blob",
     "accountname":"nome_da_sua_conta",
     "accountkey":"chave",
     "bucket":"nome_do_seu_contêiner"
    }'

Parâmetros da URL

Campo	Tipo	Descrição
log	String	Possíveis valores: "access" ou "security".
domínio	String	Domínio cadastrado na GoCache
id	String	ID do envio de logs que será alterado

Exemplo de sucesso (CURL):

{
    "status_code": 200,
    "response": {
        "msg": "success"
    },
    "success": true
}

Deletar envio de logs em específico

DELETE /v1/log/{log}/{domínio}/{id}

CURL

$ curl https://api.gocache.com.br/v1/log/access/seudominio.com.br/asdfghjklqwertyu \
-H "Gocache-Token: seu_token" \
-H "Content-Type: application/json" \
-X DELETE

Parâmetros da URL

Campo	Tipo	Descrição
log	String	Possíveis valores: "access" ou "security".
domínio	String	Domínio cadastrado na GoCache
id	String	ID do envio de logs que será deletado

Exemplo de sucesso (CURL):

{
    "status_code": 200,
    "response": {
        "msg": "success"
    },
    "success": true
}

Habilitando o envio de logs de segurança ou acesso

PUT /v1/domain/{domínio}

CURL

$ curl https://api.gocache.com.br/v1/domain/seudominio.com.br \
-H "Gocache-Token: seu_token" \
-X PUT \
-d "public_log=v1"

Parâmetros

Campo	Opcional	Tipo	Descrição
domínio		String	Domínio cadastrado na GoCache.
public_log	✓	String	Habilita o envio de logs de acesso. Valor padrão: "off" Valores permitidos: "off", "v1", "v2", "v3"
security_log	✓	String	Habilita o envio de logs de segurança. Valor padrão: "off" Valores permitidos: "off", "v3", "v4"
log_freq	✓	String	Frequência de envio dos logs de acesso em minutos. Valor padrão: "60" Valores permitidos: "1","5","10","15","30","60"
log_sec_freq	✓	String	Frequência de envio dos logs de segurança em minutos. Valor padrão: "60" Valores permitidos: "1","5","10","15","30","60"

Versões de logs

Para compreender as diferentes versões dos logs de public_log e security_log, acesse a documentação dos logs de acesso e dos logs de segurança.

Exemplo de sucesso (CURL):

{
  "status_code": 1,
  "response": {
    "ignore_expires": "true",
    "expires_ttl": "14400",
    "cache_302": "false",
    "cache_mode": "default",
    "deploy_mode": "false",
    "bq_stream": "1",
    "rate_limit_ignore_static_content": "true",
    "header_geoip_org": "false",
    "expire_bypass_sec": "-1",
    "tls10": "false",
    "smart_tpl": "custom",
    "ignore_cache_control": "true",
    "log_sec_freq": "60",
    "public_log": "v1",
    "waf_level": "high",
    "cdn_mode": "cname",
    "header_geoip_continent": "false",
    "cache_404": "false",
    "image_optimize_level": "0",
    "log_freq": "60",
    "tls11": "true",
    "ignore_vary": "true",
    "ssl_type": "auto",
    "image_optimize_progressive": "false",
    "smart_status": "false",
    "image_optimize": "false",
    "image_optimize_webp": "false",
    "cache_ttl": "86400",
    "security_log": "off",
    "image_optimize_metadata": "false",
    "rate_limit_status": "false",
    "rate_limit_ignore_known_bots": "true",
    "waf_status": "false",
    "optin_image_optimize": "true",
    "onboarding": "v1",
    "ssl_mode": "full",
    "optin_rate_limit": "false",
    "waf_mode": "simulate",
    "cache_301": "false",
    "gzip_status": "true",
    "caching_behavior": "default",
    "domain": "seudominio.com.br",
    "header_device_type": "false",
    "header_geoip_country": "false",
    "disabled_ciphers": "",
    "smart_ttl": "14400"
  }
}