n8n은 API 호출 인증에 API 키를 사용합니다.

API 스코프#

엔터프라이즈 인스턴스 사용자는 스코프를 통해 키가 접근할 수 있는 리소스와 작업을 제한할 수 있습니다. API 키 스코프를 사용하면 키의 용도에 맞는 정확한 접근 수준을 지정할 수 있습니다.

엔터프라이즈가 아닌 API 키는 계정의 모든 리소스와 기능에 대한 전체 접근 권한을 가집니다.

API 키 생성#

1. n8n에 로그인합니다.
2. Settings > n8n API로 이동합니다.
3. Create an API key를 선택합니다.
4. 키의 Label을 입력하고 Expiration 시간을 설정합니다.
5. 엔터프라이즈 플랜을 사용 중인 경우, 키에 부여할 Scopes를 선택합니다.
6. My API Key를 복사하고 이 키를 사용하여 API 호출을 인증합니다.

키를 사용하여 API 호출하기#

API 호출 시 X-N8N-API-KEY라는 이름의 헤더에 API 키를 포함하여 전송합니다.

예를 들어, 모든 활성 워크플로를 가져오려는 경우 curl 요청은 다음과 같습니다:

# 셀프 호스팅 n8n 인스턴스의 경우
curl -X 'GET' \
  '<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

# n8n Cloud의 경우
curl -X 'GET' \
  '<your-cloud-instance>/api/v<version-number>/workflows?active=true' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

API 키 삭제#

1. n8n에 로그인합니다.
2. Settings > n8n API로 이동합니다.
3. 삭제하려는 키 옆의 Delete를 선택합니다.
4. Delete Forever를 선택하여 삭제를 확인합니다.