콘텐츠로 이동

GET /banlist

엔드포인트: GET /v1/pdapi/banlist

인증: Bearer 토큰

필요 권한: REST.Banlist.Read

용도

차단 목록에서 기록을 조회합니다. 차단 데이터는 Config.json이 아니라 Banlist.json에 저장됩니다.

경로 매개변수

없습니다.

쿼리 매개변수

  • active: true, false 또는 1로 활성 여부를 필터링합니다.
  • entryType: 차단 항목 유형으로 필터링합니다.
  • userId: 사용자 ID로 필터링합니다.
  • ip 또는 userIP: IP 주소로 필터링합니다.
  • issuerType, issuerName, issuerIP: 제재를 적용한 주체의 메타데이터로 필터링합니다.
  • reason: 사유 텍스트로 필터링합니다.
  • q: 일반 텍스트 검색입니다.

요청 본문

요청 본문은 없습니다.

응답 스키마

200 응답 스키마

필드 자료형 설명
Banlist 객체 쿼리 필터를 적용한 차단 목록 데이터입니다.

Banlist 객체 스키마:

필드 자료형 설명
Version 정수 차단 목록 파일 형식 버전입니다.
BannedMessage 문자열 차단된 플레이어에게 표시할 메시지입니다.
UserEntries 객체 배열 지정한 필터와 일치하는 사용자 차단 항목입니다.
IPEntries 객체 배열 지정한 필터와 일치하는 IP 차단 항목입니다.

UserEntries[] 항목 스키마:

필드 자료형 설명
UserId 문자열 차단된 사용자 ID입니다.
Active 불리언 차단이 현재 활성 상태인지 나타냅니다.
BannedBy 객체 차단을 적용한 주체의 정보입니다.
UnbannedBy 객체 차단 해제 주체의 정보입니다. 있는 경우에만 포함됩니다.

IPEntries[] 항목 스키마:

필드 자료형 설명
IP 문자열 차단된 IP 주소입니다.
Active 불리언 차단이 현재 활성 상태인지 나타냅니다.
BannedBy 객체 차단을 적용한 주체의 정보입니다.
UnbannedBy 객체 차단 해제 주체의 정보입니다. 있는 경우에만 포함됩니다.

Issuer 객체 스키마:

필드 자료형 설명
Type 문자열 제재 주체 유형입니다. 예: rest, player, system.
NameValue 문자열 제재 주체의 이름, 사용자 ID, 토큰 또는 대체값으로 사용하는 유형입니다.
IP 문자열 제재 주체의 IP 주소 메타데이터입니다.
Reason 문자열 작업에 기록된 사유입니다.
Timestamp 객체 작업 시각의 UTC 구성 요소입니다.

Timestamp 객체 스키마:

필드 자료형 설명
UTC 정수 초 단위 Unix 타임스탬프입니다.
Year 정수 UTC 연도입니다.
Month 정수 UTC 월입니다.
Day 정수 UTC 일입니다.
Hour 정수 UTC 시입니다.
Min 정수 UTC 분입니다.
Sec 정수 UTC 초입니다.
Msec 정수 밀리초 부분입니다.

오류 응답

오류 응답 본문은 다음 형식을 사용합니다:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "사람이 읽을 수 있는 오류 메시지",
        "Details": {}
    }
}
HTTP 오류 코드 발생 조건
401 INVALID_TOKEN Authorization 헤더가 없거나 형식이 잘못되었거나, 설정된 Bearer 토큰과 일치하지 않습니다.
403 MISSING_PERMISSION 토큰은 유효하지만 이 엔드포인트에 필요한 권한이 없습니다.

예제

모든 차단 기록 조회

GET /v1/pdapi/banlist

Steam 사용자의 활성 차단 기록 검색

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

IP로 기록 검색

GET /v1/pdapi/banlist?ip=203.0.113.42

활용 사례

  • 플레이어나 IP가 현재 차단되어 있는지 확인합니다.
  • 차단을 해제하기 전에 사유 또는 제재 주체로 검색합니다.
  • API를 통해 Banlist.json을 조회하는 제재 관리 대시보드를 만듭니다.

관련 문서