GET /banlist

エンドポイント: GET /v1/pdapi/banlist

認証: ベアラートークン

許可: REST.Banlist.Read

目的

禁止リストから禁止レコードを読み取ります。禁止関連のデータは、Config.json ではなく、Banlist.json に保存されます。

なし。

リクエスト本文がありません。

Field	Type	Description
`Banlist`	object	Banlist data after applying query filters.

Banlist object schema:

Field	Type	Description
`Version`	integer	Banlist file format version.
`BannedMessage`	string	Message shown to banned players.
`UserEntries`	object[]	User ban entries that match the supplied filters.
`IPEntries`	object[]	IP ban entries that match the supplied filters.

UserEntries[] item schema:

Field	Type	Description
`UserId`	string	Banned user ID.
`Active`	boolean	Whether the ban is currently active.
`BannedBy`	object	Issuer data for the ban action.
`UnbannedBy`	object	Issuer data for the unban action, when present.

IPEntries[] item schema:

Field	Type	Description
`IP`	string	Banned IP address.
`Active`	boolean	Whether the ban is currently active.
`BannedBy`	object	Issuer data for the ban action.
`UnbannedBy`	object	Issuer data for the unban action, when present.

Issuer object schema:

Field	Type	Description
`Type`	string	Issuer type, such as `rest`, `player`, or `system`.
`NameValue`	string	Issuer name, user ID, token, or type fallback.
`IP`	string	Issuer IP address metadata.
`Reason`	string	Reason recorded for the action.
`Timestamp`	object	UTC timestamp components for the action.

Timestamp object schema:

エラー本体は次の形状を使用します。

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}

HTTP	エラーコード	それが起こったとき
`401`	`INVALID_TOKEN`	`Authorization` ヘッダーが欠落しているか、形式が不正であるか、構成されたベアラートークンと一致しません。
`403`	`MISSING_PERMISSION`	トークンは有効ですが、このエンドポイント権限が含まれていません。

GET /v1/pdapi/banlist

GET /v1/pdapi/banlist?active=true&userId=steam_76561198012345678

GET /v1/pdapi/banlist?ip=203.0.113.42