Prise en main

Objectif

Cette page vous fait passer de zéro à une première vérification opérationnelle :

1. se connecter et récupérer son jeton d'API ;
2. créer un hôte ;
3. lui attacher une vérification ;
4. lancer la vérification et lire son résultat.

Les exemples utilisent l'hôte fictif web-prod-01 (10.0.0.12).

1. Se connecter

Ouvrez le portail dans votre navigateur :

• Production : https://portal.secumon.secuaas.dev

Authentifiez-vous avec votre compte. Une fois connecté, vous accédez au tableau de bord de votre organisation.

Récupérer son jeton pour l'API

Toutes les requêtes API sont authentifiées par un jeton Bearer lié à votre session. Une fois connecté au portail, récupérez votre jeton de session et placez-le dans l'en-tête Authorization de chaque requête :

Authorization: Bearer <votre-jeton>

L'URL de base de l'API est :

• Production : https://api.secumon.secuaas.ovh/api/v2
• Développement : https://api.secumon.secuaas.dev/api/v2

Vérifiez que tout fonctionne en appelant l'aperçu de statut :

curl -s https://api.secumon.secuaas.ovh/api/v2/status \
  -H "Authorization: Bearer $SECUMON_TOKEN"

{
  "hosts":  { "total": 0, "active": 0 },
  "checks": { "total": 0, "enabled": 0, "failing": 0, "failing_pct": 0 },
  "active_incidents": 0,
  "active_storms": 0,
  "workers": 1
}

2. Créer votre premier hôte

Un hôte représente une cible à surveiller. Il n'effectue aucune mesure par lui-même : il sert de point d'ancrage auquel vous rattachez des vérifications.

Depuis le portail

1. Ouvrez la section Hosts.
2. Cliquez sur Ajouter un hôte.
3. Renseignez un nom (web-prod-01) et un hostname ou une IP (10.0.0.12).
4. Ajoutez éventuellement des tags (par ex. env: prod, role: web).
5. Validez.

Création réservée aux rôles owner et admin.

Via l'API

curl -s -X POST https://api.secumon.secuaas.ovh/api/v2/hosts \
  -H "Authorization: Bearer $SECUMON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "web-prod-01",
    "hostname": "10.0.0.12",
    "host_type": "server",
    "tags": { "env": "prod", "role": "web" }
  }'

{
  "id": "8f3b1c2a-2d44-4e1a-9b77-0a1b2c3d4e5f",
  "org_id": "3886d3da-3d77-4a1e-9b2c-aabbccddeeff",
  "name": "web-prod-01",
  "hostname": "10.0.0.12",
  "host_type": "server",
  "tags": { "env": "prod", "role": "web" },
  "is_active": true,
  "created_at": "2026-06-23T12:00:00Z",
  "updated_at": "2026-06-23T12:00:00Z"
}

Notez l'id retourné : il identifie l'hôte dans tous les appels suivants.

3. Ajouter une vérification

Une vérification (check) est une sonde rattachée à un hôte. Commençons par un ping : il mesure la latence et signale si l'hôte répond.

Depuis le portail

1. Ouvrez la section Checks (ou le détail de l'hôte).
2. Cliquez sur Ajouter une vérification.
3. Choisissez l'hôte web-prod-01 et le type ping.
4. Indiquez la cible dans la configuration (host: 10.0.0.12).
5. Réglez l'intervalle (par défaut 60 s) et le délai d'expiration (par défaut 30 s).
6. Validez.

Création réservée aux rôles owner et admin.

Via l'API

curl -s -X POST https://api.secumon.secuaas.ovh/api/v2/checks \
  -H "Authorization: Bearer $SECUMON_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "host_id": "8f3b1c2a-2d44-4e1a-9b77-0a1b2c3d4e5f",
    "name": "ping web-prod-01",
    "check_type": "ping",
    "config": { "host": "10.0.0.12" },
    "interval_sec": 60,
    "timeout_sec": 10
  }'

{
  "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "org_id": "3886d3da-3d77-4a1e-9b2c-aabbccddeeff",
  "host_id": "8f3b1c2a-2d44-4e1a-9b77-0a1b2c3d4e5f",
  "name": "ping web-prod-01",
  "check_type": "ping",
  "config": { "host": "10.0.0.12" },
  "interval_sec": 60,
  "timeout_sec": 10,
  "retries": 0,
  "enabled": true,
  "created_at": "2026-06-23T12:01:00Z",
  "updated_at": "2026-06-23T12:01:00Z"
}

La vérification est désormais planifiée : elle sera exécutée automatiquement toutes les 60 secondes par un worker.

4. Exécuter et lire le résultat

Lancer la vérification immédiatement

Sans attendre le prochain cycle, vous pouvez forcer une exécution :

curl -s -X POST \
  https://api.secumon.secuaas.ovh/api/v2/checks/1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/run \
  -H "Authorization: Bearer $SECUMON_TOKEN"

{
  "queued": true,
  "check_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "run_id": "c0ffee00-1234-4abc-9def-0123456789ab"
}

Lire le dernier résultat

curl -s \
  https://api.secumon.secuaas.ovh/api/v2/checks/1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d/last-result \
  -H "Authorization: Bearer $SECUMON_TOKEN"

{
  "check_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
  "host_id": "8f3b1c2a-2d44-4e1a-9b77-0a1b2c3d4e5f",
  "time": "2026-06-23T12:01:30Z",
  "status": 0,
  "latency_ms": 1.5,
  "output": "pong 1.5ms",
  "error_msg": ""
}

Le champ status suit une convention numérique commune à toutes les vérifications :

Un résultat à 0 confirme que web-prod-01 répond correctement.

Et ensuite ?

• Découvrez les 7 types de vérifications et leurs options sur la page Vérifications.
• Configurez vos notifications avec les Politiques d'alerte et les Gardes.
• Communiquez l'état de vos services avec une Page de statut.
• Référence complète des points d'accès : API.