메인 컨텐츠로 건너뛰기

API에 대한 도움말

이 문서에는 AdGuard DNS API에 대한 문서가 포함되어 있습니다. 전체 AdGuard DNS API 변경 로그는 이 페이지를 방문하시기 바랍니다.

현재 버전: 1.9​

/oapi/v1/account/limits​

GET​

요약​

계정 제한 가져오기

응답​
코드설명
200계정 제한 정보

/oapi/v1/dedicated_addresses/ipv4​

GET​

요약​

전용 IPv4 주소 목록

응답​
코드설명
200전용 IPv4 주소 목록

POST​

요약​

새로운 IPv4를 할당합니다.

응답​
코드설명
200새 IPv4가 성공적으로 할당됨
429전용 IPv4 수가 제한에 도달함

/oapi/v1/devices​

가져오기​

요약​

기기 목록

응답​
코드설명
200기기 목록

POST​

요약​

새 기기 생성

응답​
코드설명
200기기 생성 완료
400유효성 검사 실패
429기기 수가 제한에 도달함

/oapi/v1/devices/{device_id}​

DELETE​

요약​

기기를 제거합니다.

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200기기 삭제됨
404기기를 찾을 수 없음

가져오기​

요약​

ID로 기존 기기 가져오기

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200기기 정보
404기기를 찾을 수 없음

PUT​

요약​

기기 업데이트

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200기기 업데이트 완료
400유효성 검사 실패
404기기를 찾을 수 없음

/oapi/v1/devices/{device_id}/dedicated_addresses​

GET​

요약​

기기를 위한 전용 IPv4 및 IPv6 주소 목록

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200전용 IPv4 및 IPv6

/oapi/v1/devices/{device_id}/dedicated_addresses/ipv4​

DELETE​

요약​

기기에서 전용 IPv4 연결 해제

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200전용 IPv4가 기기에서 성공적으로 연결 해제됨
404기기 또는 주소를 찾을 수 없음

POST​

요약​

기기에 전용 IPv4 연결

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200전용 IPv4가 기기에 성공적으로 연결됨
400유효성 검사 실패
404기기 또는 주소를 찾을 수 없음
429전용 IPv4 수가 제한에 도달함

/oapi/v1/devices/{device_id}/doh.mobileconfig​

GET​

요약​

DNS-over-HTTPS .mobileconfig 파일을 가져옵니다.

매개변수​
이름위치설명필수스키마
device_id경로네문자열
exclude_wifi_networks쿼리SSID에 따라 AdGuard DNS 사용하지 않을 Wi-Fi 네트워크를 나열합니다.아니오[ string ]
exclude_domain쿼리기본 DNS 서버 대신 사용할 도메인 목록아니오[ string ]
응답​
코드설명
200DNS-over-HTTPS .plist 파일
404기기를 찾을 수 없음

/oapi/v1/devices/{device_id}/doh_password/reset​

PUT​

요약​

새 DNS-over-HTTPS 비밀번호 생성 및 설정

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200DNS-over-HTTPS 비밀번호가 성공적으로 재설정됨
404기기를 찾을 수 없음

/oapi/v1/devices/{device_id}/dot.mobileconfig​

GET​

요약​

DNS-over-TLS .mobileconfig 파일을 가져옵니다.

매개변수​
이름위치설명필수스키마
device_id경로네문자열
exclude_wifi_networks쿼리SSID에 따라 AdGuard DNS 사용하지 않을 Wi-Fi 네트워크를 나열합니다.아니오[ string ]
exclude_domain쿼리기본 DNS 서버 대신 사용할 도메인 목록아니오[ string ]
응답​
코드설명
200DNS-over-HTTPS .plist 파일
404기기를 찾을 수 없음

/oapi/v1/devices/{device_id}/settings​

PUT​

요약​

기기 설정을 업데이트합니다.

매개변수​
이름위치설명필수스키마
device_id경로네문자열
응답​
코드설명
200기기 설정이 업데이트되었습니다.
400유효성 검사 실패
404기기를 찾을 수 없음

/oapi/v1/dns_servers​

GET​

요약​

사용자에게 속한 DNS 서버를 나열합니다.

설명​

사용자에게 속한 DNS 서버를 나열합니다. 기본적으로 최소한 하나의 기본 서버가 있습니다.

응답​
코드설명
200DNS 서버 목록

POST​

요약​

새로운 DNS 서버를 생성합니다.

설명​

새 DNS 서버를 생성합니다. 사용자 정의 설정을 추가할 수 있으며, 그렇지 않으면 기본 설정으로 DNS 서버를 생성합니다.

응답​
코드설명
200DNS 서버 생성됨
400유효성 검사 실패
429DNS 서버 수가 제한에 도달함

/oapi/v1/dns_servers/{dns_server_id}​

DELETE​

요약​

DNS 서버를 제거합니다.

설명​

DNS 서버를 제거합니다. 이 DNS 서버에 연결된 모든 기기는 기본 DNS 서버로 이동됩니다. 기본 DNS 서버를 삭제하는 것은 금지됩니다.

매개변수​
이름위치설명필수스키마
dns_server_id경로네문자열
응답​
코드설명
200DNS 서버 삭제됨
404DNS 서버 없음

GET​

요약​

ID로 기존 DNS 서버를 가져옵니다.

매개변수​
이름위치설명필수스키마
dns_server_id경로네문자열
응답​
코드설명
200DNS 서버 정보
404DNS 서버 없음

PUT​

요약​

기존 DNS 서버 업데이트

매개변수​
이름위치설명필수스키마
dns_server_id경로네문자열
응답​
코드설명
200DNS 서버 업데이트 완료
400유효성 검사 실패
404DNS 서버 없음

/oapi/v1/dns_servers/{dns_server_id}/settings​

PUT​

요약​

DNS 서버 설정 업데이트

매개변수​
이름위치설명필수스키마
dns_server_id경로네문자열
응답​
코드설명
200DNS 서버 설정이 업데이트됨
400유효성 검사 실패
404DNS 서버 없음

/oapi/v1/filter_lists​

GET​

요약​

필터 목록을 가져옵니다.

응답​
코드설명
200필터 목록

/oapi/v1/oauth_token​

POST​

요약​

액세스 및 새로 고침 토큰을 생성합니다.

응답​
코드설명
200액세스 토큰 발급됨
400필수 매개변수 누락됨
401유효하지 않은 자격 증명, MFA 토큰 또는 제공된 갱신 토큰

null

/oapi/v1/query_log​

DELETE​

요약​

쿼리 로그를 지웁니다.

응답​
코드설명
202쿼리 로그가 지워짐

GET​

요약​

쿼리 로그를 가져옵니다.

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
기업쿼리기업별 필터링아니오[ string ]
상태쿼리상태별 필터링아니오[ FilteringActionStatus ]
카테고리쿼리카테고리별 필터링아니오[ CategoryType ]
검색쿼리도메인 이름으로 필터링아니오문자열
제한쿼리반환되는 레코드 수 제한하기아니오정수
커서쿼리페이지 매김 커서. 응답에서 커서를 사용하여 페이지를 매김합니다.아니오문자열
응답​
코드설명
200쿼리 로그

/oapi/v1/revoke_token​

POST​

요약​

갱신 토큰 취소

매개변수​
이름위치설명필수스키마
refresh_token쿼리갱신 토큰네문자열
응답​
코드설명
200갱신 토큰이 취소되었습니다

null

/oapi/v1/stats/categories​

GET​

요약​

카테고리 통계 가져오기

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
응답​
코드설명
200카테고리 통계 수신됨
400유효성 검사 실패

/oapi/v1/stats/companies​

GET​

요약​

회사 통계 가져오기

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
응답​
코드설명
200기업 통계 수신됨
400유효성 검사 실패

/oapi/v1/stats/companies/detailed​

GET​

요약​

자세한 기업 통계를 가져옵니다.

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
커서쿼리페이지 매김 커서아니오문자열
응답​
코드설명
200상세 기업 통계 수신됨
400유효성 검사 실패

/oapi/v1/stats/countries​

GET​

요약​

국가별 통계를 가져옵니다.

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
응답​
코드설명
200국가 통계 수신됨
400유효성 검사 실패

/oapi/v1/stats/devices​

GET​

요약​

기기 통계를 가져옵니다.

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
응답​
코드설명
200기기 통계 수신됨
400유효성 검사 실패

/oapi/v1/stats/domains​

GET​

요약​

도메인 통계를 가져옵니다.

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
응답​
코드설명
200도메인 통계 수신됨
400유효성 검사 실패

/oapi/v1/stats/time​

GET​

요약​

시간 통계를 가져옵니다.

매개변수​
이름위치설명필수스키마
time_from_millis쿼리밀리초 단위 시간(포함)네long
time_to_millis쿼리밀리초 단위 시간(포함)네long
기기쿼리기기로 필터링아니오[ string ]
국가쿼리국가로 필터링아니오[ string ]
응답​
코드설명
200시간 통계 수신됨
400유효성 검사 실패

/oapi/v1/web_services​

GET​

요약​

웹 서비스 목록

응답​
코드설명
200웹 서비스 목록