mods

Quarantine a mod file version

Marks a mod file version as quarantined, so it can no longer be downloaded.

Restricted to authorised moderation services: only a client_credentials service token carrying the mod_file:quarantine scope is accepted. Requests with no token, a user token or an API key receive 401; a service token without the scope receives 403. Idempotent: quarantining an already-quarantined file succeeds and reports already_quarantined: true.

A file manually verified by staff is never overridden (409 is returned instead) — staff re-verification is also the route for reversing a quarantine.

post/mod-file-versions/{id}/quarantine

Request

  • Base URL: https://api.nexusmods.com/v3
  • URL: https://api.nexusmods.com/v3/mod-file-versions/{id}/quarantine
  • Auth: HTTP bearer

Path parameters

idstring required

The unique identifier for the mod file version.

Request body

reasonstring required

Why the file is being quarantined (recorded in service logs).

Response

The file is quarantined.

Changes

No recorded changes to this operation across all 1 revision of this API.