File の削除

パス

DELETE /api/v1/forward/files/{file_id}

ヘッダー	必須	説明
`Authorization`	はい	`Bearer <PAT または SAT>`

削除前に Template の参照を確認します。参照されていない場合、File を削除し、既定の一覧に表示されなくなります。

パラメーター	型	必須	説明
`file_id`	string	はい	File ID to delete.

パラメーター	型	必須	説明
`identity_id`	string	いいえ	Identity に属するリソースを操作する場合にのみ使用します。PAT ではクエリパラメーターとして明示的に指定でき、省略すると管理者 Scope になります。SAT の帰属は認証情報によって決まります。Admin SAT を含むすべての SAT でこのパラメーターを明示的に指定すると、空値でも HTTP 400 が返されます。詳細は Identity の帰属を参照してください。

curl -X DELETE "https://api.qoder.com/api/v1/forward/files/file_xxx" \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

{
  "id": "file_xxx",
  "type": "file_deleted",
  "deleted": true
}

HTTP	Type	発生条件
400	`invalid_request_error`	リクエストボディ、パスパラメーター、またはクエリパラメーターが不正です。SAT でクエリパラメーター `identity_id` を明示的に指定した場合（空値を含む）も該当します。
401	`authentication_error`	認証トークンがないか、無効です。
403	`permission_error`	管理者 Scope で Owner mismatch が発生したか、下流サービスがアクセスを拒否しました。
404	`not_found_error`	File が存在しない、登録されていない、または現在の Identity Scope から参照できません。PAT で指定した Identity が無効、無効化済み、削除済み、または権限範囲外の場合も該当します。
409	`conflict_error`	冪等性キーが競合している、作成リカバリーに手動対応が必要、または削除時にリソースが参照されています。
429	`rate_limit_error`	アップロード容量が不足しています。
500/502/503	`api_error`	Forward または依存サービスでエラーが発生しました。