Aller au contenu
Nexus TéléchargerDémarrer

Tunnels ngrok

28 routes. Chemins relatifs à https://api.nexus-engine.eu/api/v1.

GET /ngrok/connexions

Les comptes ngrok reliés à l’entreprise : indice public de la clé, capacités constatées par famille, santé datée.

RéponseNgrokConnexionDto[]
NoteLa clé d’API ne sort jamais : seul son préfixe public est rendu.
POST /ngrok/connexions Owner et Admin session de l’application seulement

Relie un compte ngrok par sa clé d’API, après un essai RÉEL en lecture (aucune écriture).

Corpslabel, cleApi, notes
RéponseNgrokConnexionDto
NoteUn authtoken collé à la place d’une clé est reconnu et refusé (ERR_NGROK_206).
PATCH /ngrok/connexions/:id Owner et Admin session de l’application seulement

Modifie un compte : nom, notes, remplacement de la clé, ACL des jetons créés, AI Gateway (clé propre, allumage).

Corpslabel, notes, cleApi, acl (bind:…), active, cleIa (ou null), iaActive
RéponseNgrokConnexionDto
NoteOn remplace une clé, on ne la consulte pas.
DELETE /ngrok/connexions/:id Owner et Admin session de l’application seulement

Déconnecte un compte de Nexus, SANS rien supprimer chez ngrok, et rend la liste de ce que Nexus y avait créé.

Réponse{ supprimee, laisseChezNgrok { jetons, ressources } }
POST /ngrok/connexions/:id/verifier

Réessaie la clé et relit les capacités (une lecture d’un élément par famille).

RéponseNgrokConnexionDto
NoteUne écriture n’est jamais tentée pour tester un droit : l’écriture reste « inconnue » tant qu’un vrai changement n’a pas réussi.
GET /ngrok/jetons

Les jetons de tunnel (authtokens) que Nexus a créés : les siens, ou tous pour une personne administratrice.

RéponseNgrokJetonDto[]
NoteJamais la valeur d’un jeton.
GET /ngrok/connexions/:id/ressources session de l’application seulement

Ce que Nexus a créé chez ngrok sur ce compte, avec l’opération qui le supprimerait : le nettoyage se propose, une personne l’exécute.

RéponseNgrokRessourceNexusDto[]
NoteRéservé à une personne administratrice. Un domaine, un certificat ou un secret d’avant Nexus n’y figure jamais.
POST /ngrok/connexions/:id/jetons session de l’application seulement

Crée un jeton de tunnel DÉDIÉ à un appareil ; la valeur est rendue une seule fois, au poste qui la range dans le coffre du système.

Corpsappareil, libelleAppareil
RéponseNgrokJetonCreeDto
NoteRéservé à une personne en session. Le backend ne garde que l’identifiant du jeton, de quoi le révoquer.
DELETE /ngrok/jetons/:id session de l’application seulement

Révoque un jeton créé par Nexus, après avoir vérifié qu’aucune session de tunnel ne l’emploie.

Requêteforce (1 : couper les sessions en cours)
RéponseNgrokJetonDto
POST /ngrok/connexions/:id/lien-jeton

Vérifie qu’un jeton de poste appartient au compte de la clé, par la métadonnée de sa session d’agent.

Corpsmetadonnee, credentialId
Réponse{ lien, session }
NoteSans session vue : INCONNU — jamais « faux ».
GET /ngrok/operations

Cherche dans le catalogue EXÉCUTABLE des opérations ngrok (spécification épinglée et datée).

Requêteq, surface (plateforme | ia), famille, heritage (1), limite
Réponse{ operations: OperationNgrokResumeDto[], total, sources }
NoteUne opération absente du catalogue n’est pas exécutable.
GET /ngrok/operations/:id

Décrit une opération : paramètres, corps attendu, risque, source.

RéponseOperationNgrokDetailDto
POST /ngrok/lire

Exécute une LECTURE du catalogue ; un agent de projet ne voit que ce qui est associé à son projet.

CorpsconnexionId, projetId, operation, parametres, requete, pages
RéponseResultatLecture
NoteLes champs secrets sont retirés de la réponse.
GET /ngrok/changements

Les changements préparés, validés, appliqués ou en échec.

Requêtestatut, projetId
RéponseNgrokChangementDto[]
GET /ngrok/changements/:id

Un changement et ce que le demandeur peut en faire.

RéponseNgrokChangementDto
POST /ngrok/changements

Prépare une écriture : état lu avant, risque, coût connu ou « inconnu », identifiant. Rien n’est envoyé à ngrok.

CorpsconnexionId, projetId, operation, parametres, requete, corps, motif
RéponseNgrokChangementDto
NoteLe corps est validé strictement contre la spécification ; la même demande rend le même changement.
POST /ngrok/changements/:id/approuver Owner et Admin session de l’application seulement

Valide un changement préparé (personne administratrice).

RéponseNgrokChangementDto
NoteUn achat ne se valide pas pour un autre.
POST /ngrok/changements/:id/rejeter session de l’application seulement

Refuse un changement préparé.

RéponseNgrokChangementDto
POST /ngrok/changements/:id/executer

Exécute un changement autorisé (personne, validation, ou délégation) : verrou, relecture, envoi, constat.

Corpsconfirmation (achat : recopier l’identifiant de l’opération)
RéponseNgrokChangementDto
NoteUn résultat incertain (coupure après l’envoi) se réconcilie par une lecture ; il ne se rejoue pas.
POST /ngrok/changements/:id/compenser

Prépare la compensation réaliste d’un changement appliqué (supprimer ce qui a été créé, reposer l’état d’avant).

RéponseNgrokChangementDto
NoteUne suppression ne se compense pas : la réponse le dit.
GET /ngrok/delegations

Les délégations : ce qu’un agent peut exécuter sans validation, et où.

RéponseNgrokDelegationDto[]
POST /ngrok/delegations Owner et Admin session de l’application seulement

Pose une délégation bornée (connexion, projets, familles ou opérations, risque max, échéance).

CorpsconnexionId, projetIds ([] = tout le compte), familles, operations, risqueMax (LOW | MEDIUM | HIGH), expireLe, note
RéponseNgrokDelegationDto
NoteCRITICAL et les achats ne se délèguent jamais.
DELETE /ngrok/delegations/:id Owner et Admin session de l’application seulement

Retire une délégation.

RéponseNgrokDelegationDto
POST /ngrok/politiques/valider

Valide une Traffic Policy LOCALEMENT (forme, phases, actions, destinations extérieures, protection effective).

Corpspolitique ou modele, protocole
RéponseVerdictPolitique
Notengrok n’expose aucune validation côté serveur : ce n’est pas un « validé par ngrok ».
GET /ngrok/politiques

L’historique des politiques appliquées à un partage, sous forme montrable.

Requêtecible (partage:<clé>)
Réponse{ version, politique, creeLe }[]
GET /projects/:id/ngrok

Le compte ngrok d’un projet et ses partages en cours.

Réponse{ connexionId, label, partages: NgrokPartageDto[] }
PUT /projects/:id/ngrok Owner et Admin session de l’application seulement

Choisit le compte ngrok d’un projet quand l’entreprise en a plusieurs.

CorpsconnexionId (ou null)
Réponse{ connexionId }
PUT /projects/:id/ngrok/partages application de bureau seulement

Le poste relate un partage qu’il tient (état, adresse, protection, prises, échéance).

Corpscle, appareil, cible, url, modele, resume, etat, voulu, expireLe, prises, erreur, politique (montrable), empreintePolitique
RéponseNgrokPartageDto
NoteRéservé à l’application : une clé ferait croire à un lien qui n’existe pas.