{"revision":"0ed62d2c742f8e20","language":"it","entry":{"id":"rate-limit","kind":"endpoint","group":"developer","title":"Controlla la quota di una chiave API","method":"GET","path":"/v1/rate-limit","paths":[],"summary":"Leggi le quote attuali di titolare e chiave senza consumare la quota principale.","response":"owner, metadati key, quota, rate, resource e retryAfter. quota distingue richieste condivise, verifiche, eventuale quota giornaliera ed eventuale limite della chiave. Gli orari usano secondi Unix.","parameters":[],"sample":"/v1/rate-limit","access":"api-key","base":"directory","notes":["La risposta è privata e usa Cache-Control no-store.","Anche le richieste pubbliche autenticate con Bearer restituiscono X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset e X-RateLimit-Resource. Sono intestazioni per client locali o server; il CORS pubblico espone Date, ETag e Retry-After."],"errors":["401 invalid_api_key","403 api_key_scope","403 api_key_suspended","403 developer_suspended","429 rate_limited","500 internal_error","503 busy"],"related":["api-keys"],"sections":[{"kind":"code","language":"shell","code":"curl -fsS -H \"Authorization: Bearer $VEIL_API_KEY\" \\\n  \"https://veil.rip/v1/rate-limit\""}],"live":false,"responses":[{"status":200,"contentType":"application/json","description":"owner, metadati key, quota, rate, resource e `retryAfter`. quota distingue richieste condivise, verifiche, eventuale quota giornaliera ed eventuale limite della chiave. Gli orari usano secondi Unix.","fields":[{"name":"owner","type":"integer","description":"Numero permanente della scheda titolare."},{"name":"key","type":"ApiKey","description":"Metadati della chiave autenticata, mai il segreto."},{"name":"quota","type":"Quota","description":"Quote condivise di richieste e verifiche, più eventuali limiti giornalieri e della chiave. Questa lettura non consuma la quota principale."},{"name":"rate","type":"Bucket","description":"Quota descritta dalle intestazioni del limite nella risposta."},{"name":"resource","type":"string","description":"Risorsa descritta da rate."},{"name":"retryAfter","type":"integer","description":"Secondi prima che una richiesta possa essere ammessa; può essere positivo anche se questa lettura restituisce 200."}],"example":{"language":"json","code":"{\n  \"owner\": 1,\n  \"key\": {\n    \"id\": \"0123456789abcdef0123456789abcdef\",\n    \"owner\": 1,\n    \"label\": \"Website backend\",\n    \"prefix\": \"veil_live_01234567…\",\n    \"scopes\": [\n      \"read\",\n      \"verify\"\n    ],\n    \"state\": \"active\",\n    \"createdAt\": \"2026-10-27T00:00:00Z\",\n    \"expiresAt\": \"2027-01-25T00:00:00Z\",\n    \"revokedAt\": null,\n    \"suspended\": false,\n    \"requestsPerMinute\": null,\n    \"lastUsedAt\": null,\n    \"requests\": 0\n  },\n  \"quota\": {\n    \"requests\": {\n      \"limit\": 600,\n      \"remaining\": 600,\n      \"resetAt\": 1793059200\n    },\n    \"verification\": {\n      \"limit\": 120,\n      \"remaining\": 120,\n      \"resetAt\": 1793059200\n    },\n    \"daily\": null,\n    \"key\": null\n  },\n  \"rate\": {\n    \"limit\": 600,\n    \"remaining\": 600,\n    \"resetAt\": 1793059200\n  },\n  \"resource\": \"requests\",\n  \"retryAfter\": 0\n}"}}],"responseObjects":[{"id":"api-key","title":"Metadati della chiave API","fields":[{"name":"id","type":"string","description":"ID pubblico di gestione della chiave, non il segreto Bearer."},{"name":"owner","type":"integer","description":"Numero permanente della scheda titolare."},{"name":"label","type":"string","description":"Etichetta dell’integrazione scelta dal titolare."},{"name":"prefix","type":"string","description":"Prefisso visualizzato non segreto."},{"name":"scopes","type":"array<string>","description":"read e/o verify."},{"name":"state","type":"string","description":"active, expired, suspended o revoked. La sospensione dell’account è indicata separatamente."},{"name":"createdAt","type":"string","description":"Data e ora di creazione in ISO 8601 UTC."},{"name":"expiresAt","type":"string","description":"Scadenza in ISO 8601 UTC."},{"name":"revokedAt","type":"string | null","description":"Data e ora della revoca permanente."},{"name":"suspended","type":"boolean","description":"Indica se questa chiave è sospesa."},{"name":"requestsPerMinute","type":"integer | null","description":"Limite aggiuntivo della chiave, oppure null."},{"name":"lastUsedAt","type":"string | null","description":"Ultimo uso ammesso, oppure null se mai usata."},{"name":"requests","type":"integer","description":"Richieste ammesse durante la vita della chiave."}],"typeName":"ApiKey"},{"id":"quota","title":"Quote condivise e aggiuntive","fields":[{"name":"requests","type":"Bucket","description":"Quota di richieste condivisa dal titolare."},{"name":"verification","type":"Bucket","description":"Quota di verifica condivisa aggiuntiva. Una verifica consuma entrambe le quote."},{"name":"daily","type":"Bucket | null","description":"Limite giornaliero aggiuntivo, se impostato."},{"name":"key","type":"Bucket | null","description":"Limite aggiuntivo della singola chiave, se impostato."}],"typeName":"Quota"},{"id":"bucket","title":"Quota","fields":[{"name":"limit","type":"integer","description":"Capacità della quota, oppure limite del giorno UTC per la quota giornaliera."},{"name":"remaining","type":"integer","description":"Richieste intere disponibili al momento."},{"name":"resetAt","type":"integer","description":"Secondi Unix in cui la quota sarà piena, oppure la prossima mezzanotte UTC per il limite giornaliero."}],"typeName":"Bucket"}],"errorFormat":"json","errorDetails":[{"status":401,"code":"invalid_api_key","description":"La credenziale Bearer è malformata, sconosciuta, scaduta o revocata.","action":"Usa una chiave attiva. Per l’accesso pubblico anonimo, rimuovi del tutto `Authorization`. Credenziali non valide non attivano automaticamente l’accesso anonimo.","scope":"endpoint"},{"status":403,"code":"api_key_scope","description":"La chiave API non ha il permesso read o verify, oppure l’endpoint non accetta chiavi Bearer.","action":"Usa il permesso corretto. Le modifiche alle schede e la gestione delle chiavi richiedono una firma del dispositivo.","scope":"endpoint"},{"status":403,"code":"api_key_suspended","description":"Questa chiave API è sospesa.","action":"Chiedi allo staff di ripristinarla; un’altra chiave non rimuove la sospensione dell’account.","scope":"endpoint"},{"status":403,"code":"developer_suspended","description":"L’account API del titolare è sospeso oppure la scheda titolare non è disponibile.","action":"Controlla l’account titolare e le restrizioni dello staff. Creare un’altra chiave non aggira la sospensione.","scope":"endpoint"},{"status":429,"code":"rate_limited","description":"È stato superato un limite anonimo, delle richieste firmate o della chiave API.","action":"Attendi almeno i secondi indicati da `Retry-After`. Condividi coda e budget dei tentativi tra i tuoi processi.","scope":"common"},{"status":500,"code":"internal_error","description":"Si è verificato un errore imprevisto del server. I dettagli interni non vengono restituiti.","action":"Riprova le letture con attese crescenti e un limite. Controlla l’esito delle scritture prima di inviare una nuova operazione firmata.","scope":"common"},{"status":503,"code":"busy","description":"L’applicazione ha raggiunto un limite temporaneo di concorrenza o del database.","action":"Attendi i secondi indicati da `Retry-After` e riprova con attese crescenti e un limite.","scope":"common"}],"responseHeaders":[{"name":"Content-Type","value":"application/json","description":"Usa il tipo dichiarato per scegliere come leggere il corpo."},{"name":"Date","value":"HTTP date","description":"Ora del server. Confrontala con il tuo orologio per firmare le richieste."},{"name":"Cache-Control","value":"no-store","description":"Non conservare le risposte private o temporanee in una cache condivisa."},{"name":"Retry-After","value":"integer seconds, on rate_limited or busy","description":"Attendi almeno questo intervallo prima di riprovare. Altri codici 429/503 non lo includono necessariamente."},{"name":"X-RateLimit-Limit","value":"integer","description":"Capacità della quota indicata."},{"name":"X-RateLimit-Remaining","value":"integer","description":"Richieste intere rimaste nella quota."},{"name":"X-RateLimit-Reset","value":"Unix seconds","description":"Istante in cui la quota sarà piena, non il confine di una finestra fissa al minuto."},{"name":"X-RateLimit-Resource","value":"requests | verification | key | daily","description":"Quota rappresentata dalle intestazioni. Gli altri saldi sono in quota."}],"documentationUrl":"https://veil.rip/docs/rate-limit?lang=it","supportsBrowserFetch":false,"browserMode":"local-or-server"}}