Namespaces

Listar namespaces

Lista os namespaces existentes e quantos domínios estão associados a cada um deles.

GET /v1/namespace/

CURL

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

Exemplo de sucesso (CURL):

{
    "response": {
    "items": [
      {
        "id": "645dbe1e2fbe6740f590f3a981068639",
        "description": "Segurança apenas",
        "name": "teste",
        "domains": 6
      },
      {
        "id": "6da90fbf396e5c1f8031f5f85735cfe8",
        "description": "Configurações para WordPress",
        "name": "wordpress",
        "domains": 20
      }
    ],
    "default": "none"
    },
    "status_code": 1
}

Criar um namespace

Cria um namespace.

POST /v1/namespace/

CURL

$ curl -i https://api.gocache.com.br/v1/namespace/ \
-X POST \
-H 'Content-Type: application/json' \
-H 'GoCache-Token:seu_token' \
-d'{"name": "Nome!", "description": "Alguma descrição", "domains": ["domain1.com", "outrodominio.com"]}'

Parâmetros

Campo	Opcional	Tipo	Descrição
name	-	String	Nome único do namespace
description	✓	String	Descrição
domains	✓	String array	Lista contendo domínios a serem inseridos. É possível não passar a lista e inseri-los depois. Os domínios a serem inseridos não podem estar associados a outro namespace.

Exemplo de sucesso (CURL):

{
  "response": {
    "message": "success",
    "created": "68799454a0c847b2a3dd94c15e1149a4"
  },
  "status_code": 1
}

Sobrescreve namespace

Sobrescreve um namespace existente.

PUT /v1/namespace/{id}

CURL

$ curl -i https://api.gocache.com.br/v1/namespace/68799454a0c847b2a3dd94c15e1149a4 \
-X PUT \
-H 'Content-Type: application/json' \
-H 'GoCache-Token:seu_token' \
-d'{"description": "nova descrição", "name": "novo nome", "domains": ["novodomain1.com", "outronovodominio.com"]}'

Parâmetros

Campo	Opcional	Tipo	Descrição
name	-	String	Nome único do namespace
description	✓	String	Descrição
domains	✓	String array	Lista contendo domínios a serem inseridos. É possível não passar a lista e inseri-los depois. Os domínios a serem inseridos não podem estar associados a outro namespace.

Exemplo de sucesso (CURL):

{
  "response": {
    "message": "success",
    "updated": "645dbe1e2fbe6740f590f3a981068639"
  },
  "status_code": 1
}

Alterar domínios no namespace

Permite modificar um atributo do namespace. Podendo ser lista de domínios, nome ou descrição, todos optativos.

PATCH /v1/namespace/{id}

CURL

$ curl -i https://api.gocache.com.br/v1/namespace/68799454a0c847b2a3dd94c15e1149a4 \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'GoCache-Token:seu_token' \
-d'{"domains": {"add": ["domain1.com"], "delete": ["domain2.com"]}, "name": "novo nome", "description": "nova descrição"}'

Parâmetros

Campo	Opcional	Tipo	Descrição
name	✓	String	Nome único do namespace
description	✓	String	Descrição
domains.add	✓	String array	Lista contendo domínios a serem inseridos da lista.
domains.delete	✓	String array	Lista contendo domínios a serem removidos da lista.

Exemplo de sucesso (CURL):

{
  "response": {
    "message": "success",
    "updated": "645dbe1e2fbe6740f590f3a981068639"
  },
  "status_code": 1
}

Definir como padrão

Definir um namespace como padrão (default). Quando um domínio é adicionado, se existir um namespace definido como padrão, o domínio é automaticamente cadastrado nesse namespace.

PATCH /v1/namespace

CURL

$ curl -i https://api.gocache.com.br/v1/namespace \
-X PATCH \
-H 'Content-Type: application/json' \
-H 'GoCache-Token:seu_token' \
-d'{"default": "9370648dca8a5ba26f04dc40cf2ca743"}'

Parâmetros

Campo	Opcional	Tipo	Descrição
default	-	String	Id do namespace que deve será definido como default

Exemplo de sucesso (CURL):

{
  "response": {
    "message": "success"
  },
  "status_code": 1
}

Remover namespace

Remove um namespace.

DELETE /v1/namespace/{id}

CURL

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

Exemplo de sucesso (CURL):

{
  "response": {
    "message": "success"
  },
  "status_code": 1
}

Consultar configurações

Carrega as configurações de um namespace.

GET /v1/namespace/settings/{id}

CURL

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

Exemplo de sucesso (CURL):

{
    "status_code": 1,
    "response": {
        "bot_mitigation_block": "web-scrapper;host-discovery;vuln-scanner;hacking-utilities",
        "waf_mode": "block",
        "waf_level": "high",
        "bot_mitigation_challenge": "",
        "bot_mitigation_status": true,
        "bot_mitigation_accept": "spam-bot;proxied-origin",
        "bot_mitigation_simulate": "exploitation-tool;worm-bot",
        "waf_status": false
    }
}

Alterar configurações

Altera as configurações de um namespace.

PUT /v1/namespace/settings/{id}

CURL

$ curl -i https://api.gocache.com.br/v1/namespace/settings/68799454a0c847b2a3dd94c15e1149a4 \
-X PUT \
-H 'Content-Type: application/json' \
-H 'GoCache-Token:seu_token' \
-d '{"bot_mitigation_status":true,"waf_status": true}'

Parâmetros

Campo	Opcional	Tipo	Descrição
bot_mitigation_status	✓	Boolean	Status do bot mitigation
waf_status	✓	Boolean	Status do waf
waf_level	✓	String	Nível do waf (low,medium,high)
waf_mode	✓	String	Modo do waf (simulate,challenge,block)

Exemplo de sucesso (CURL):

{
  "status_code": 1,
  "response": {
    "bot_mitigation_block": "",
    "waf_mode": "simulate",
    "waf_level": "high",
    "bot_mitigation_challenge": "",
    "bot_mitigation_status": true,
    "bot_mitigation_accept": "",
    "bot_mitigation_simulate": "exploitation-tool;web-scrapper;spam-bot;host-discovery;vuln-scanner;proxied-origin;worm-bot;hacking-utilities",
    "waf_status": false
  }
}

Consultar recursos ativos

Carrega os recursos que estão ativos para o namespace.

GET /v1/namespace/features/{id}

CURL

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

Exemplo de sucesso (CURL):

{
  "status_code": 1,
  "response": [
    "waf",
    "bot_mitigation"
  ]
}