Aller au contenu
Bastide Connexion Créer un compte
Appuyez sur / pour chercher

preview.protection.configure

Markdownv0.3.0

Régler ce que les aperçus d'un projet demandent : rien, un mot de passe, l'appartenance au projet, ou une adresse admise.

  • APIPUT /v1/projects/{projectId}/previews/protection
  • MCPpreview_protection_configure
  • CLIbastide preview protection configure

EX-RUN-180, EX-NET-690. Vaut pour tous les aperçus, tous portent « noindex » ; le changer ferme les sessions ouvertes. Mot de passe jamais relu. Bloc d'adresses : /16 en IPv4, /48 en IPv6 au plus large. Un agent ne règle pas « public ».

PropriétéValeur
Niveauproject
Rang minimalmaintainer
Rôle transversalsecurity
Portéesproject:write
Compte de servicene la mène pas : cette écriture ne lui est pas ouverte
RéversibilitéR — réversible : exécution directe, tracée, annulable
Idempotenceune clé d'idempotence est acceptée : le rejeu rend la première réponse
Limites de débit, par jeton600 appels par 60 secondes (general), et 60 appels par 60 secondes (sensitive)

API

PUT /v1/projects/{projectId}/previews/protection — succès en 200.

ParamètreOùTypeRequisDescription
projectIdchemintexte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ouiIdentifiant de projet
Idempotency-Keyen-têtetexte, de 8 à 128 caractèresnonClé d'idempotence. Un rejeu portant la même clé retourne le résultat initial sans nouvel effet de bord, et la réponse porte alors « Idempotency-Replayed: true ». Équivaut au champ « idempotencyKey » du corps ; les deux à la fois ne sont acceptés que s'ils sont identiques.
modecorpsl'un de public, password, members, addressesouipublic : qui a l'adresse entre ; password : un mot de passe partagé ; members : les membres du projet ; addresses : une liste d'adresses IP. Toutes portent « noindex ».
passwordcorpstexte, de 8 à 128 caractèresnonLe mot de passe partagé. Absent, celui qui est posé reste.
addressescorpsliste de 100 éléments au plus — chaque élément : texte, de 2 à 49 caractères, motif ^[0-9A-Fa-f:.]+(?:\/[0-9]{1,3})?$nonLes adresses et les blocs admis. Absente, la liste posée reste.
idempotencyKeycorpstexte, de 8 à 128 caractèresnonClé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord.

La réponse :

ChampTypeDescription
model'un de public, password, members, addressespublic : qui a l'adresse entre ; password : un mot de passe partagé ; members : les membres du projet ; addresses : une liste d'adresses IP. Toutes portent « noindex ».
passwordSetbooléenUn mot de passe est posé. Il n'est jamais relu : seul ce fait l'est.
addressesliste de 100 éléments au plus — chaque élément : texte, de 2 à 49 caractères, motif ^[0-9A-Fa-f:.]+(?:\/[0-9]{1,3})?$
updatedAttexte, format date-time
undoTokennul

En-têtes de la réponse : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy, Idempotency-Replayed.

Autres réponses : 400, 401, 403, 404, 409, 429, 500, 503 — communes à toute opération.

Ligne de commande

bastide preview protection configure --project-id <valeur> --mode <valeur>

OptionTypeRequiseDéfautDescription
--project-idtexteoui—Identifiant de projet
--modetexteoui—public : qui a l'adresse entre ; password : un mot de passe partagé ; members : les membres du projet ; addresses : une liste d'adresses IP. Toutes portent « noindex ».
--passwordtextenon—Le mot de passe partagé. Absent, celui qui est posé reste.
--addresseslistenon—Les adresses et les blocs admis. Absente, la liste posée reste.
--idempotency-keytextenon—Clé d'idempotence, obligatoire. Un rejeu portant la même clé rend le résultat initial, sans nouvel effet de bord.

La commande s'exécute sans confirmation.

MCP

Outil preview_protection_configure.

PropriétéValeur
Lecture seulenon
Destructifnon
Idempotentoui
Monde ouvertnon
Confirmation en deux tempsnon
Budget de jetons du résultat500

Erreurs

CodeSurfaceCause
idempotency_key_conflictAPIDeux clés d'idempotence différentes ont été présentées, dans le corps et dans l'en-tête.

S'y ajoutent les refus communs à toute opération — entrée invalide, authentification, autorisation, cible introuvable, conflit, limite de débit, indisponibilité — que le catalogue des erreurs décrit.

Exemples

Réserver les aperçus d'un projet au réseau du bureau :

{
  "projectId": "prj_01JQ8ZK4M7NP2RSTVWXYZ34567",
  "mode": "addresses",
  "addresses": [
    "203.0.113.0/24",
    "2001:db8:42::/48"
  ],
  "idempotencyKey": "protection-des-apercus-2026-10-01"
}

Signaler une erreur sur cette page