DDoS Protection

Exibir estado do produto

Exibe o estado atual da proteção de ataques da ferramenta em um domínio.

GET /v1/ddos-protection/{domínio}

cURL

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

Exemplo de Sucesso

Exemplo de sucesso (CURL):

HTTP/1.1 200 OK

{ "status_code": 1, "response": { "status": true } }

Controlar estado do produto

Permite ligar ou desligar a proteção de ataques do DDoS Protection em um domínio.

PUT /v1/ddos-protection/{domínio}

CURL

$ curl -i https://api.gocache.com.br/v1/ddos-protection/seudominio.com.br \
    -X PUT -d 'enable=false' \
    -H 'GoCache-Token:seu_token'

Parâmetros

Campo	Opcional	Tipo	Descrição
enable		Boolean	Define se a proteção do protudo estará ligada ou desligada

Exemplo de sucesso (CURL):

HTTP/1.1 200 OK

{ "status_code": 1, "response": { "status": false } }

Listar Exceções

Lista as exceções do DDoS Protection de um domínio.

GET /v1/rules/ddos-protection/{domínio}

CURL

$ curl -i https://api.gocache.com.br/v1/rules/ddos-protection/seudominio.com.br \
    -H 'GoCache-Token:seu_token'

Exemplo de sucesso (CURL):

HTTP/1.1 200 OK
{
  "response": {
  "rules": [
    {
      "action": {
        "ddos_block_mode": "disable"
      },
      "id": "ktzxdrqwmycfsvgy",
      "metadata": {
        "created_on": "1733248281",
        "name": "IP do Cluster",
        "status": "false",
        "notes": "IP do Cluster principal que realiza diversas requisições"
      },
      "match": {
        "remote_plain_address": "203.0.113.23"
      }}
    ]
  }
}

Criar Exceção

Cria uma exceção de DDoS Protection em um domínio.

POST /v1/rules/ddos-protection/{domínio}

CURL

$ curl -i https://api.gocache.com.br/v1/rules/ddos-protection/seudominio.com.br \
-X POST \
-H 'GoCache-Token:seu_token' \
-d 'match[remote_plain_address]=192.168.0.1' \
-d 'action[ddos_block_mode]=disable'
-d 'metadata[status]=false'
-d 'metadata[title]=Minha Regra'
-d 'metadata[notes]=Regra de teste'

Parâmetros

Campo	Opcional	Tipo	Descrição
metadata		Object
status	✓	Boolean	Indica se a exceção está ativa ou inativa Valor padrão: true Valores permitidos: true, false
notes	✓	String	Descrição da exceção
title	✓	String	Nome da exceção
match		Object	Critério da exceção
remote_plain_address		String	O IP que deve ser ignorado na proteção de DDoS (sem máscara de rede)
action		Object	Ação
ddos_block_mode		String	Indica que o DDoS Protection deve ignorar o IP na proteção de ataques. Valor disponível: disable

Exemplo de sucesso (CURL):

HTTP/1.1 200 OK
{
    "response": {
        "id": "itlzfvzxiagdfsia"
    }
}

Alterar Exceção

Altera uma exceção de DDoS Protection existente em um domínio.

PUT /v1/rules/ddos-protection/{domínio}/{id}

CURL

$ curl -i https://api.gocache.com.br/v1/rules/ddos-protection/seudominio.com.br/aabbccddeeffgghh \
-X PUT \
-H 'GoCache-Token:seu_token' \
-d 'match[remote_plain_address]=192.168.0.1' \
-d 'action[ddos_block_mode]=disable'
-d 'metadata[status]=false'

Parâmetros

Campo	Opcional	Tipo	Descrição
metadata		Object
status	✓	Boolean	Indica se a exceção está ativa ou inativa Valor padrão: true Valores permitidos: true, false
notes	✓	String	Descrição da exceção
title	✓	String	Nome da exceção
match		Object	Critério da exceção
remote_plain_address		String	O IP que deve ser ignorado na proteção de DDoS (sem máscara de rede)
action		Object	Ação
ddos_block_mode		String	Indica que o DDoS Protection deve ignorar o IP na proteção de ataques. Valor disponível: disable

Exemplo de sucesso (CURL):

HTTP/1.1 200 OK
{
    "response": {
        "msg": "Success"
    }
}

Remover Exceção

Remove uma exceção de DDoS Protection de um domínio.

DELETE /v1/rules/ddos-protection/{domínio}/{id}

CURL

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

Exemplo de sucesso (CURL):

  HTTP/1.1 200 OK
  {
      "response": {
          "msg": "Success"
      }
  }