Domains

Información de un dominio

Este es el endpoint principal, donde se comprueba si un dominio está o no en la base de datos. Si la petición se hace con una clave de acceso, este responderá con más información.

Obtener información sobre un dominio en la base de datos

get

Obtener información sobre un dominio en la base de datos dado su nombre

Parámetros de consulta

domainstringRequerido

Nombre del dominio a obtener

Respuestas

200

Dominio aprobado obtenido

application/json

207

Dominio obtenido con una clave de acceso

application/json

400

Petición incorrecta o vacía

application/json

403

El usuario está en la lista negra

application/json

404

Dominio no encontrado

application/json

500

Error interno del servidor

application/json

get

HTTPcURLJavaScriptPython

GET /api/domain HTTP/1.1
Host: phishing.lacabra.app
Accept: */*

{
  "status": "text",
  "data": {
    "domain": "text",
    "category": "text",
    "priority": 1,
    "notes": "text",
    "submitted_by": "text",
    "submitted_at": "text"
  }
}

Añadir un dominio

Añadir un dominio a la base de datos, que luego será revisado por un moderador del servicio para posteriormente ser aprobado o denegado. Si es aprobado, el dominio estará disponible en el endpoint principal.

Añadir un dominio a la base de datos (pendiente de aprobación)

post

Añadir un dominio a la base de datos para que sea aprobado por un moderador

Cuerpo

domainstringRequerido

Dominio

categorystringOpcional

Categoría del dominio

priorityintegerOpcional

Prioridad del dominio, en base a como de peligroso puede ser para un usuario normal

notesstringOpcional

Notas sobre el dominio

submitted_bystringRequerido

Nombre del usuario que ha añadido el dominio

reasonstringRequerido

Razón dada por el usuario por la que se ha añadido el dominio

Respuestas

200

Dominio añadido

application/json

400

Petición incorrecta o vacía

application/json

403

El usuario está en la lista negra

application/json

404

Dominio no encontrado

application/json

409

Dominio ya existente

application/json

500

Error interno del servidor

application/json

post

HTTPcURLJavaScriptPython

POST /api/domain HTTP/1.1
Host: phishing.lacabra.app
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "domain": "text",
  "category": "text",
  "priority": 1,
  "notes": "text",
  "submitted_by": "text",
  "reason": "text"
}

{
  "status": "text",
  "data": {
    "domain": "text",
    "category": "text",
    "priority": 1,
    "notes": "text",
    "submitted_by": "text",
    "submitted_at": "text"
  }
}

Modificar un dominio

Hacer modificaciones a un dominio en la base de datos. Todos los campos son opcionales y se puede hacer una petición solo con los campos a cambiar.

Este endpoint solo puede ser usado por moderadores con una clave de acceso valida.

Modificar un dominio de la base de datos

patch

Modificar un dominio de la base de datos con su ID de dominio

Autorizaciones

Parámetros de ruta

idintegerRequerido

ID del dominio a modificar

Cuerpo

categorystringOpcional

Categoría del dominio

priorityintegerOpcional

Prioridad del dominio, en base a como de peligroso puede ser para un usuario normal

public_notesstringOpcional

Notas públicas sobre el dominio

submitted_bystringOpcional

Nombre del usuario que ha añadido el dominio

submitted_reasonstringOpcional

Razón dada por el usuario por la que se ha añadido el dominio

approved_bystring | nuloOpcional

Nombre del usuario que ha aprobado el dominio

notesstringOpcional

Notas sobre el dominio

times_consultedintegerOpcional

Veces que se ha consultado el dominio

Respuestas

200

Dominio modificado

application/json

400

Petición incorrecta o vacía

application/json

401

No autorizado

application/json

403

El usuario está en la lista negra

application/json

404

Dominio no encontrado

application/json

500

Error interno del servidor

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/domain HTTP/1.1
Host: phishing.lacabra.app
Authorization: Bearer UUID
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "category": "text",
  "priority": 1,
  "public_notes": "text",
  "submitted_by": "text",
  "submitted_reason": "text",
  "approved_by": "text",
  "notes": "text",
  "times_consulted": 1
}

{
  "status": "text",
  "data": {
    "category": "text",
    "priority": 1,
    "public_notes": "text",
    "submitted_by": "text",
    "submitted_reason": "text",
    "approved_by": "text",
    "approved_at": "text",
    "approved_key": "text",
    "notes": "text",
    "times_consulted": 1
  }
}

Eliminar un dominio

Borrar un dominio de la base de datos de manera permanente.

Este endpoint solo puede ser usado por moderadores con una clave de acceso valida.

Eliminar un dominio de la base de datos

delete

Eliminar un dominio de la base de datos con su ID de dominio

Autorizaciones

Parámetros de ruta

idintegerRequerido

ID del dominio a eliminar

Respuestas

200

Dominio eliminado

application/json

401

No autorizado

application/json

403

El usuario está en la lista negra

application/json

404

Dominio no encontrado

application/json

500

Error interno del servidor

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/domain HTTP/1.1
Host: phishing.lacabra.app
Authorization: Bearer UUID
Accept: */*

{
  "status": "text",
  "data": {
    "id": 1,
    "domain": "text",
    "category": "text",
    "priority": 1,
    "public_notes": "text",
    "submitted_by": "text",
    "submitted_at": "text",
    "submitted_reason": "text",
    "approved_by": "text",
    "approved_at": "text",
    "notes": "text",
    "times_consulted": 1
  }
}