런타임 · Clash 문서

외부 컨트롤러 설정

external-controller로 RESTful API를 활성화하고 Bearer Token으로 인증하는 방법과 로그, 트래픽, 설정, 노드, 규칙, 연결, 프록시 그룹, DNS API 경로를 설명합니다.

  • external-controller
  • RESTful API
  • Bearer Tokens
  • /proxies
  • DNS 조회
런타임

소개

외부 제어를 사용하면 HTTP RESTful API로 Clash를 관리할 수 있으며 타사 Clash GUI도 이 기능을 기반으로 합니다. external-controller에 주소를 지정해 활성화하세요.

인증

  • 외부 컨트롤러는 접근 인증에 Bearer Tokens 방식을 사용합니다.
    • 자격 증명은 Authorization: Bearer <Your Secret> 요청 헤더로 전달합니다.

RESTful API 문서

로그

  • /logs
    • 메서드: GET
      • 전체 경로: GET /logs
      • 설명: 실시간 로그 가져오기

트래픽

  • /traffic
    • 메서드: GET
      • 전체 경로: GET /traffic
      • 설명: 실시간 트래픽 데이터 가져오기

버전

  • /version
    • 메서드: GET
      • 전체 경로: GET /version
      • 설명: Clash 버전 가져오기

설정

  • /configs
    • 메서드: GET

      • 전체 경로: GET /configs
      • 설명: 기본 구성 가져오기
    • 메서드: PUT

      • 전체 경로: PUT /configs
      • 설명: 구성 파일 다시 불러오기
    • 메서드: PATCH

      • 전체 경로: PATCH /configs
      • 설명: 구성 증분 변경

노드

  • /proxies

    • 메서드: GET
      • 전체 경로: GET /proxies
      • 설명: 모든 노드 정보 가져오기
  • /proxies/:name

    • 메서드: GET

      • 전체 경로: GET /proxies/:name
      • 설명: 지정한 노드 정보 가져오기
    • 메서드: PUT

      • 전체 경로: PUT /proxies/:name
      • 설명: Selector에서 선택된 노드 전환
  • /proxies/:name/delay

    • 메서드: GET
      • 전체 경로: GET /proxies/:name/delay
      • 설명: 지정한 노드의 지연 시간 테스트 정보 가져오기

규칙

  • /rules
    • 메서드: GET
      • 전체 경로: GET /rules
      • 설명: 규칙 정보 가져오기

연결

  • /connections

    • 메서드: GET

      • 전체 경로: GET /connections
      • 설명: 연결 정보 가져오기
    • 메서드: DELETE

      • 전체 경로: DELETE /connections
      • 설명: 모든 연결 닫기
  • /connections/:id

    • 메서드: DELETE
      • 전체 경로: DELETE /connections/:id
      • 설명: 지정한 연결 닫기

프록시 집합

  • /providers/proxies

    • 메서드: GET
      • 전체 경로: GET /providers/proxies
      • 설명: 모든 프록시 집합의 프록시 정보 가져오기
  • /providers/proxies/:name

    • 메서드: GET

      • 전체 경로: GET /providers/proxies/:name
      • 설명: 지정한 프록시 집합의 프록시 정보 가져오기
    • 메서드: PUT

      • 전체 경로: PUT /providers/proxies/:name
      • 설명: 지정한 프록시 집합 전환
  • /providers/proxies/:name/healthcheck

    • 메서드: GET
      • 전체 경로: GET /providers/proxies/:name/healthcheck
      • 설명: 지정한 프록시 집합의 프록시 정보 가져오기

DNS 조회

  • /dns/query
    • 메서드: GET

    • 전체 경로: GET /dns/query?name={name}[&type={type}]

    • 설명: 지정한 도메인과 유형의 DNS 조회 데이터 가져오기

    • 매개변수:

      • name(필수): 조회할 도메인 이름
      • type(선택): 조회할 DNS 레코드 유형(예: A, MX, CNAME). 생략하면 기본값은 A입니다.
    • 예: GET /dns/query?name=example.com&type=A