중요
각 Atlas 관리 API에는 고유한 리소스가 있으며 초기 설정이 필요합니다.
공용 인터넷을 통해서만 Atlas Administration API 서버에 액세스할 수 있습니다. 네트워크 피어링 또는 비공개 엔드포인트를 사용하는 연결에서는 Atlas Administration API를 사용할 수 없습니다.
자세히 보려면 Atlas Programmatic Access참조합니다.
Atlas 관리 API는 REST 아키텍처 스타일의 원칙을 따라 Atlas의 관리 기능에 프로그래밍 방식으로 액세스할 수 있도록 여러 내부 리소스를 노출합니다. Atlas 관리 API 에 대해 자세히 학습하려면 Atlas 관리 API 참조를 참조하세요.
Atlas 관리 API 클러스터에 저장된 데이터에 대한 액세스 제공하지 않습니다. 데이터베이스 의 데이터를 읽거나 쓰기 (write) 적절한 읽기 또는 쓰기 (write) 역할이 있는 데이터베이스 사용자의 자격 증명 사용하여 클러스터 를 인증해야 합니다. Atlas 관리 API 사용하여 데이터베이스 사용자를 생성하고 관리 수 있습니다.
Atlas 관리 API 사용하여 Atlas 클러스터를 관리 하려면 다음 인증 방법 중 하나를 사용하여 API 요청을 인증해야 합니다.
서비스 계정 액세스 토큰(OAuth 2.0)
API 키(HTTP 다이제스트 인증)
이러한 방법에 대해 학습하려면 Atlas 관리 API 인증 방법을 참조하세요.
다음 섹션에서는 서비스 계정과 API 키를 사용하여 Atlas 조직 및 프로젝트에 대한 프로그래밍 방식의 액세스 구성하는 방법을 설명합니다.
참고
MongoDB Atlas 공동 책임 모델은 안전하고 복원력이 뛰어난 데이터 환경을 유지 관리하는 데 있어 MongoDB 와 MongoDB 고객의 보완 의무를 정의합니다. 이 프레임워크 에서 MongoDB 기본 플랫폼의 보안 및 운영 무결성을 관리하고 고객은 특정 배포의 구성, 관리 및 데이터 정책을 책임집니다. 보안 및 운영 우수성에 대한 소유권에 대한 자세한 분석은 공유 책임 모델을 참조하세요.
시작하기 전에
프로그래밍 액세스를 구성하기 전에 다음을 확인하세요.
Atlas 계정이 있습니다. 계정을 생성하려면 Atlas 계정 생성을 참조하세요.
Atlas 조직이 존재합니다. 하나를 만들려면 조직 만들기를 참조하세요.
필요한 액세스 권한
조직에 대한 서비스 계정 또는 API 키를 만들려면 해당 조직에 대한 Organization Owner 액세스 있어야 합니다.
서비스 계정에 프로젝트에 대한 액세스 부여하려면 프로젝트 소유한 조직에 대해 Organization Owner 액세스 있어야 합니다.
프로젝트에 API 키 액세스를 부여하려면 해당 프로젝트에 대한 Project Owner 액세스 있어야 합니다.
선택 사항: IP 액세스 목록 필요
Atlas UI를 사용하여 조직을 만들 때, Atlas는 Atlas Administration API에 대한 IP 액세스 목록을 요구합니다. 이렇게 하면 ` API ` 요청은 IP 액세스 목록에서 지정한 위치 기반 IP 또는 ` CIDR ` 주소만으로 제한됩니다. IP 액세스 목록 항목 없이 Atlas Administration API에 요청하면 서버는 403 상태 코드로 응답합니다.
이 기능을 비활성화하면 IP 액세스 목록이 비어 있는 경우 인터넷의 모든 주소에서 API 요청을 보낼 수 있습니다. IP 액세스 목록 항목을 추가하면 해당 IP 주소에서 시작된 요청만 가능합니다.
참고
IP 액세스 목록 은 서비스 계정 액세스 토큰을 생성하거나 해지하는 것이 아니라 사용하는 데 적용됩니다. 모든 IP 주소에서 토큰을 생성할 수 있지만, 사용자의 IP 주소가 액세스 목록에 있는 경우에만 API 호출하는 데 사용할 수 있습니다.
참고
IP 액세스 목록은 프로그래밍 API 키 및 서비스 계정에만 적용됩니다. Atlas Administration API에 대한 Atlas CLI 또는 Atlas App Connections를 통해 부여된 위임된 액세스 등 다른 유형의 액세스에는 적용되지 않습니다. 위임된 액세스에는 타사와 제휴하는 애플리케이션, MongoDB Compass와 같은 MongoDB 애플리케이션 및 Model Context 프로토콜(MCP) 클라이언트가 포함됩니다. 조직에서 모든 Atlas Administration API 트래픽이 특정 주소에서 시작되도록 요구하는 경우, 해당 조직에 대한 위임된 앱 액세스를 활성화하지 마십시오. 기존 조직에서는 제휴하다 애플리케이션 및 MCP 클라이언트에 대한 위임된 액세스 설정이 기본값 해제되어 있습니다.
조직을 만든 후 모든 Atlas Administration API 요청에 대해 IP 액세스 목록이 필요하도록 조직을 설정하려면 다음 단계를 따르세요.
Atlas 에서 Organization Settings 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
사이드바에서 Organization Settings를 클릭합니다.
조직 설정 페이지가 표시됩니다.
조직에 프로그래밍 방식 액세스 권한 부여
조직에 대한 프로그래밍 방식 액세스를 설정하려면 다음을 수행해야 합니다.
조직의 서비스 계정 만들기
다음 절차에 따라 서비스 계정을 만들고 새 클라이언트 비밀을 생성하여 조직 에 프로그래밍 방식의 액세스 부여합니다. Atlas 관리 API 의 인증 방법에 대해 자세히 학습 Atlas 관리 API 인증 방법을 참조하세요.
Atlas 에서 Applications 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
Identity & Access 섹션 아래의 사이드바에서 Applications 을 클릭합니다.
애플리케이션 페이지가 표시됩니다.
서비스 계정 정보를 입력합니다.
Name을(를) 입력합니다.
Description을(를) 입력합니다.
Client Secret Expiration 메뉴에서 기간을 선택합니다.
조직 권한 메뉴에서 서비스 계정에 대한 새 역할을 선택합니다.
이러한 역할은 이 서비스 계정에서 생성된 액세스 토큰의 권한을 결정합니다. API 요청 할 때 액세스 토큰을 사용하여 Atlas 관리 API 에 인증합니다.
서비스 계정을 만든 후 서비스 계정에 프로젝트 수준 역할을 할당할 수도 있습니다. 방법을 학습하려면 프로젝트에 기존 서비스 계정 액세스 권한 부여를 참조하세요.
서비스 계정에 대한 액세스 토큰 생성
서비스 계정을 만든 후 해당 계정에 대한 액세스 토큰을 생성할 수 있습니다. 액세스 토큰을 사용하여 API 요청을 Atlas 관리 API에 인증합니다. 예시 는 API 요청하기를 참조하세요.
서비스 계정에 대한 액세스 토큰을 생성하려면 다음 안내를 따르세요.
서비스 계정의 클라이언트 비밀을 조회합니다.
서비스 계정을 생성한 직후에 저장한 mdb_sa_sk_로 시작하는 클라이언트 비밀을 찾습니다. 오직 이 때만 전체 클라이언트 비밀을 볼 수 있습니다. 클라이언트 비밀을 저장하지 않은 경우 새 클라이언트 비밀을 생성해야 합니다.
액세스 토큰을 요청합니다.
다음 예시의 {base64Auth}를 이전 단계의 출력으로 바꾼 후 실행합니다.
1 curl --request POST \ 2 --url https://cloud.mongodb.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {base64Auth}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"{accessToken}","expires_in":3600,"token_type":"Bearer"}%
팁
서비스 계정 토큰 관리 권장사항
서비스 계정 토큰을 사용할 때 다음 권장사항을 고려하세요.
토큰 재사용: 서비스 계정 액세스 토큰의 수명은 1 시간(3600 초)이며, 이 기간 동안 토큰을 여러 번 재사용할 수 있습니다. 요청 단위로 새 토큰을 만들지 마세요.
필요한 경우 새 토큰 생성: 액세스 토큰은 새로 고침할 수 없지만 현재 토큰의 만료 시간이 임박한 경우 새 토큰을 생성 할 수 있습니다. 이는 서비스 중단을 방지하고 승인된 서비스 계정 액세스를 유지할 수 있게 합니다.
불필요한 토큰 회수: 토큰이 더 이상 필요하지 않은 경우 토큰의 액세스를 회수 하여 보안 위험을 최소화하고 활성 토큰만이 서비스 계정에 액세스할 수 있도록 합니다.
조직에 대한 프로그래밍 방식 액세스를 설정하려면 다음을 수행해야 합니다.
조직의 서비스 계정 만들기
Atlas Administration API를 사용하여 조직의 서비스 계정을 생성할 수 있습니다.
서비스 계정을 만든 후 출력에서 {CLIENT-ID} 와 {CLIENT-SECRET}를 복사하고 저장하면 다음 예시와 유사하게 표시됩니다. 오직 이 때만 전체 클라이언트를 볼 수 있는 때입니다. API를 요청할 때 이 정보가 필요합니다.
{ "createdAt" : "2024-04-23T17:47:17Z", "description" : "Service account for my organization.", "clientId" : "{CLIENT-ID}", "name" : "My Service Account", "roles" : [ "ORG_MEMBER" ], "secrets" : [ { "createdAt" : "2024-04-23T17:47:17Z", "expiresAt" : "2024-12-01T00:00:00Z", "id" : "6627f7259d39d858378c9e30", "lastUsedAt" : null, "secret" : "{CLIENT-SECRET}" } ] }%
서비스 계정에 대한 액세스 토큰 생성
서비스 계정을 만든 후 해당 계정에 대한 액세스 토큰을 생성할 수 있습니다. 액세스 토큰을 사용하여 API 요청을 Atlas 관리 API에 인증합니다. 예시 는 API 요청하기를 참조하세요.
서비스 계정에 대한 액세스 토큰을 생성하려면 다음 안내를 따르세요.
서비스 계정의 클라이언트 비밀을 조회합니다.
서비스 계정을 생성한 직후에 저장한 mdb_sa_sk_로 시작하는 클라이언트 비밀을 찾습니다. 오직 이 때만 전체 클라이언트 비밀을 볼 수 있습니다. 클라이언트 비밀을 저장하지 않은 경우 새 클라이언트 비밀을 생성해야 합니다.
액세스 토큰을 요청합니다.
다음 예시의 {base64Auth}를 이전 단계의 출력으로 바꾼 후 실행합니다.
1 curl --request POST \ 2 --url https://cloud.mongodb.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {base64Auth}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"{accessToken}","expires_in":3600,"token_type":"Bearer"}%
팁
서비스 계정 토큰 관리 권장사항
서비스 계정 토큰을 사용할 때 다음 권장사항을 고려하세요.
토큰 재사용: 서비스 계정 액세스 토큰의 수명은 1 시간(3600 초)이며, 이 기간 동안 토큰을 여러 번 재사용할 수 있습니다. 요청 단위로 새 토큰을 만들지 마세요.
필요한 경우 새 토큰 생성: 액세스 토큰은 새로 고침할 수 없지만 현재 토큰의 만료 시간이 임박한 경우 새 토큰을 생성 할 수 있습니다. 이는 서비스 중단을 방지하고 승인된 서비스 계정 액세스를 유지할 수 있게 합니다.
불필요한 토큰 회수: 토큰이 더 이상 필요하지 않은 경우 토큰의 액세스를 회수 하여 보안 위험을 최소화하고 활성 토큰만이 서비스 계정에 액세스할 수 있도록 합니다.
조직에 대한 API 키 만들기
조직에 대한 API 키 만들기
Atlas CLI를 사용하여 조직에서 API 키를 생성하려면 다음 명령을 실행하십시오.
atlas organizations apiKeys create [options]
명령 구문과 매개 변수에 관한 자세한 내용은 Atlas CLI 설명서의 Atlas 조직 apiKeys 만들기를 참조하세요.
API 키에 대한 API 액세스 목록 항목 추가
Atlas CLI를 사용하여 API 키에 대한 IP 액세스 목록 항목을 생성하려면 다음 명령을 실행하십시오.
atlas organizations apiKeys accessLists create [options]
명령 구문과 매개 변수에 관한 자세한 내용은 Atlas CLI 설명서의 Atlas 조직 apiKeys accessLists 만들기를 참조하세요.
프로젝트에 프로그래밍 방식 액세스 권한 부여
이 두 가지 인증 방법에 대해 자세히 학습하려면 Atlas 관리 API 인증 방법을 참조하세요.
API 키에 프로젝트에 대한 액세스 권한을 부여하려면, 해당 프로젝트에 대한 Project Access Manager 또는 Project Owner 액세스 권한이 있어야 합니다.
프로젝트에 기존 서비스 계정 액세스 권한 부여
조직에 대한 서비스 계정 또는 API 키를 이미 만든 경우 이를 프로젝트에 할당하여 해당 프로젝트에 Atlas 관리 API에 대한 액세스 부여할 수 있습니다.
경고
프로젝트에 조직 서비스 계정을 할당하면 Project Owner가 비밀 순환 및 IP 액세스 목록 업데이트를 포함하여 서비스 계정을 관리할 수 있습니다.
프로젝트에 기존 서비스 계정 액세스 권한 부여
Atlas Administration API를 사용하여 기존 서비스 계정에 프로젝트에 대한 액세스 권한을 부여할 수 있습니다.
기존 API 키에 프로젝트에 대한 액세스 권한 부여
조직에 대한 서비스 계정 또는 API 키를 이미 만든 경우 이를 프로젝트에 할당하여 해당 프로젝트에 Atlas 관리 API에 대한 액세스 부여할 수 있습니다.
Atlas 에서 Users 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
Identity & Access 섹션 아래의 사이드바에서 All Projects 을 클릭하고 원하는 프로젝트 선택합니다.
Security 섹션 아래의 사이드바에서 Project Identity & Access 을 클릭합니다.
사용자 페이지가 표시됩니다.
프로젝트에 API 키를 추가합니다.
필드에 공개 키를 입력하세요.
Project Permissions 메뉴에서 API 키에 대한 새 역할을 선택합니다.
기존 API 키에 프로젝트에 대한 액세스 권한 부여
조직에 대한 서비스 계정 또는 API 키를 이미 만든 경우 이를 프로젝트에 할당하여 해당 프로젝트에 Atlas 관리 API에 대한 액세스 부여할 수 있습니다.
Atlas CLI를 사용하여 프로젝트에 API 키를 할당하려면 다음 명령을 실행하십시오.
atlas projects apiKeys assign <ID> [options]
명령 구문과 매개 변수에 관한 자세한 내용은 Atlas CLI 설명서의 Atlas 프로젝트 apiKeys 할당를 참조하세요.
프로젝트에서 프로젝트 액세스 추가
조직에 대한 서비스 계정 또는 API 키를 아직 생성하지 않은 경우 프로젝트에 대해 이를 생성하여 해당 프로젝트에 Atlas Administration API에 대한 액세스 권한을 부여할 수 있습니다. 프로젝트에 대해 생성한 서비스 계정 또는 API 키는 Organization Member 권한이 있는 상위 조직에 자동으로 추가됩니다.
Atlas UI를 사용하여 프로젝트에 대한 서비스 계정을 생성하려면 다음 안내를 따르세요.
Atlas 에서 Users 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
Identity & Access 섹션 아래의 사이드바에서 All Projects 을 클릭하고 원하는 프로젝트 선택합니다.
Security 섹션 아래의 사이드바에서 Project Identity & Access 을 클릭합니다.
사용자 페이지가 표시됩니다.
서비스 계정 정보를 입력합니다.
Name을(를) 입력합니다.
Description을(를) 입력합니다.
Client Secret Expiration 메뉴에서 기간을 선택합니다.
프로젝트 권한 메뉴에서 서비스 계정에 대한 새 역할을 선택합니다.
Atlas Administration API를 사용하여 프로젝트에 대한 서비스 계정을 생성할 수 있습니다.
서비스 계정을 만든 후 출력에서 {CLIENT-ID} 와 {CLIENT-SECRET}를 복사하고 저장하면 다음 예시와 유사하게 표시됩니다. 오직 이 때만 전체 클라이언트를 볼 수 있는 때입니다. API를 요청할 때 이 정보가 필요합니다.
{ "createdAt" : "2024-04-23T17:47:17Z", "description" : "Service account for my organization.", "clientId" : "{CLIENT-ID}", "name" : "My Service Account", "roles" : [ "ORG_MEMBER" ], "secrets" : [ { "createdAt" : "2024-04-23T17:47:17Z", "expiresAt" : "2024-12-01T00:00:00Z", "id" : "6627f7259d39d858378c9e30", "lastUsedAt" : null, "secret" : "{CLIENT-SECRET}" } ] }%
Atlas CLI를 사용하여 프로젝트에 대한 API 키를 생성하려면 다음 명령어를 실행하세요.
atlas projects apiKeys create [options]
명령 구문과 매개 변수에 관한 자세한 내용은 Atlas CLI 설명서의 Atlas 프로젝트 apiKeys 만들기를 참조하세요.
프로젝트의 API 키를 생성한 후 Atlas UI를 사용하여 API 액세스 목록 항목을 추가합니다. API 액세스 목록을 설정할 때까지 프로젝트에 API 키를 사용할 수 없습니다.
참고
Atlas CLI 제한 사항
Atlas CLI를 사용하여 프로젝트 API 키에 대한 API 액세스 목록을 편집할 수 없습니다.
Atlas UI를 사용하여 API 액세스 목록 항목을 추가하려면,
Atlas UI를 사용하여 프로젝트에 대한 API 키를 생성하려면 다음 안내를 따르세요.
Atlas 에서 Users 페이지로 이동합니다.
아직 표시되지 않은 경우 다음 목록에서 원하는 조직 을 선택하세요. 탐색 표시줄의 Organizations 메뉴.
Identity & Access 섹션 아래의 사이드바에서 All Projects 을 클릭하고 원하는 프로젝트 선택합니다.
Security 섹션 아래의 사이드바에서 Project Identity & Access 을 클릭합니다.
사용자 페이지가 표시됩니다.
API Key Information을(를) 입력합니다.
Create API Key 페이지에서:
Description을(를) 입력합니다.
Project Permissions 메뉴에서 API 키에 대한 새 역할을 선택합니다.
API 요청하기
Atlas Administration API는 서비스 계정 또는 API 키라는 두 가지 인증 방법 중 하나를 사용하여 요청을 인증합니다. 다음 절차를 완료하려면 기본 인증 방법을 구성할 때 저장한 키나 암호가 필요합니다.
모든 Atlas Administration API의 기본 URL은 다음과 같습니다.
https://cloud.mongodb.com/api/atlas/<version>
중요
MongoDB는 HTTPS URL을 사용하여 보안을 강화합니다. HTTP URL을 사용하면 301 상태 코드가 반환됩니다.
서비스 계정을 사용하여 API 요청을 하려면 서비스 계정을 사용하여 액세스 토큰을 생성한 다음 요청에 액세스 토큰을 사용하세요.
서비스 계정의 클라이언트 비밀을 조회합니다.
서비스 계정을 생성한 직후에 저장한 mdb_sa_sk_로 시작하는 클라이언트 비밀을 찾습니다. 오직 이 때만 전체 클라이언트 비밀을 볼 수 있습니다. 클라이언트 비밀을 저장하지 않은 경우 새 클라이언트 비밀을 생성해야 합니다.
액세스 토큰을 요청합니다.
cloud .mongodb.com/api/oauth/token에 POST 요청 합니다. 엔드포인트를 사용하여 서비스 계정에 대한 액세스 토큰을 생성합니다.
다음 예시의 {base64Auth}를 이전 단계의 출력으로 바꾼 후 실행합니다.
1 curl --request POST \ 2 --url https://cloud.mongodb.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {base64Auth}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"{accessToken}","expires_in":3600,"token_type":"Bearer"}%
중요
액세스 토큰은 1시간(3600초) 동안 유효합니다. 액세스 토큰은 새로 고칠 수 없습니다. 이 액세스 토큰이 만료되면 이 단계를 반복하여 새 토큰을 생성하세요.
API 호출을 실행합니다.
다음 예시의 {accessToken}을 이전 단계의 출력으로 바꿉니다.
다음 샘플 GET 요청은 조직의 모든 프로젝트를 반환합니다.
curl --request GET \ --url https://cloud.mongodb.com/api/atlas/v2/groups \ --header 'Authorization: Bearer {accessToken}' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --header 'Content-Type: application/json'
다음 샘플 POST 요청은 요청 본문을 사용하여 조직에 MyProject라는 이름의 프로젝트를 생성합니다.
curl --header 'Authorization: Bearer {accessToken}' \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ --include \ --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
서비스 계정을 사용하여 API 요청을 하려면 서비스 계정을 사용하여 액세스 토큰을 생성한 다음 요청에 액세스 토큰을 사용하세요.
서비스 계정의 클라이언트 비밀을 조회합니다.
서비스 계정을 생성한 직후에 저장한 mdb_sa_sk_로 시작하는 클라이언트 비밀을 찾습니다. 오직 이 때만 전체 클라이언트 비밀을 볼 수 있습니다. 클라이언트 비밀을 저장하지 않은 경우 새 클라이언트 비밀을 생성해야 합니다.
액세스 토큰을 요청합니다.
cloud .mongodb.com/api/oauth/token에 POST 요청 합니다. 엔드포인트를 사용하여 서비스 계정에 대한 액세스 토큰을 생성합니다.
다음 예시의 {base64Auth}를 이전 단계의 출력으로 바꾼 후 실행합니다.
1 curl --request POST \ 2 --url https://cloud.mongodb.com/api/oauth/token \ 3 --header 'accept: application/json' \ 4 --header 'cache-control: no-cache' \ 5 --header 'authorization: Basic {base64Auth}' \ 6 --header 'content-type: application/x-www-form-urlencoded' \ 7 --data 'grant_type=client_credentials'
{"access_token":"{accessToken}","expires_in":3600,"token_type":"Bearer"}%
중요
액세스 토큰은 1시간(3600초) 동안 유효합니다. 액세스 토큰은 새로 고칠 수 없습니다. 이 액세스 토큰이 만료되면 이 단계를 반복하여 새 토큰을 생성하세요.
API 호출을 실행합니다.
다음 예시의 {accessToken}을 이전 단계의 출력으로 바꿉니다.
다음 샘플 GET 요청은 조직의 모든 프로젝트를 반환합니다.
curl --request GET \ --url https://cloud.mongodb.com/api/atlas/v2/groups \ --header 'Authorization: Bearer {accessToken}' \ --header 'Accept: application/vnd.atlas.2023-02-01+json' \ --header 'Content-Type: application/json'
다음 샘플 POST 요청은 요청 본문을 사용하여 조직에 MyProject라는 이름의 프로젝트를 생성합니다.
curl --header 'Authorization: Bearer {accessToken}' \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2023-02-01+json" \ --include \ --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
요청은 다음 예제와 유사해야 하며, 여기서 {PUBLIC-KEY} 은 API 공개 키이고 {PRIVATE-KEY} 는 해당 비공개 키입니다. Atlas 관리 API 통해 사용 가능한 엔드포인트를 탐색하려면 MongoDB 용 Postman 작업 공간을 사용할 수 있습니다.
다음 샘플 GET 요청은 조직의 모든 프로젝트를 반환합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v2/groups"
다음 샘플 POST 요청은 요청 본문을 사용하여 조직에 MyProject라는 이름의 프로젝트를 생성합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ --include \ --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
요청은 다음 예제와 유사해야 하며, 여기서 {PUBLIC-KEY} 은 API 공개 키이고 {PRIVATE-KEY} 는 해당 비공개 키입니다. Atlas 관리 API 통해 사용 가능한 엔드포인트를 탐색하려면 MongoDB 용 Postman 작업 공간을 사용할 수 있습니다.
다음 샘플 GET 요청은 조직의 모든 프로젝트를 반환합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v2/groups"
다음 샘플 POST 요청은 요청 본문을 사용하여 조직에 MyProject라는 이름의 프로젝트를 생성합니다.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Content-Type: application/json" \ --header "Accept: application/vnd.atlas.2024-08-05+json" \ --include \ --request POST "https://cloud.mongodb.com/api/atlas/v2/groups" \ --data ' { "name": "MyProject", "orgId": "5a0a1e7e0f2912c554080adc" }'
또한 OpenAPI v3 사양을 지원하는 모든 도구를 사용해 코드 샘플 또는 모의 서버를 생성할 수 있습니다. 예를 들어, Atlas Admin API 사양을 Postman으로 가져와서 curl 명령을 생성할 수 있습니다.
경고
Postman에서 HTTP URL을 사용하면 예상대로 301 상태 코드가 반환됩니다. 그러나 이 시나리오의 경우 Postman은 요청을 HTTPS로 자동 재시도하는 동시에 재시도 요청에서 헤더와 본문을 제거할 수 있습니다. 그러면 301 대신 401 상태 코드가 반환되어 요청이 실패한 이유를 파악하기 어려워집니다.
Postman을 사용하여 curl 명령을 생성하려면 다음을 수행하세요.
MongoDB Atlas 관리 API 문서의 탐색 모음에서 Download source를 클릭합니다.
다음 단계
Atlas 관리 API에 대해 자세히 알아보려면 Atlas 관리 API 참고 자료를 확인하세요.
Atlas 관리 API에 대한 프로그래밍 방식의 액세스를 관리하려면 다음 절차 중 하나를 참조하세요.