Docs Menu
Docs Home
/ /

1개의 에이전트 API 키 만들기

기본 URL: https://cloud.mongodb.com/api/public/v1.0

POST /groups/{PROJECT-ID}/agentapikeys

이 엔드포인트는 Project Owner 역할 이 있는 사용자로 제한됩니다.

이름
유형
설명

프로젝트 ID

문자열

에이전트 API 키를 소유한 프로젝트 의 고유 식별자입니다.

다음 쿼리 매개변수는 선택 사항입니다.

이름
유형
필요성
설명
기본값

pretty

부울

옵션

false

envelope

부울

옵션

응답을 엔벨로프에 래핑할지 여부를 나타내는 플래그입니다.

일부 API 클라이언트는 HTTP 응답 헤더 또는 상태 코드에 액세스할 수 없습니다. 이 문제를 해결하려면 쿼리에서 envelope=true를 설정합니다.

하나의 결과를 반환하는 엔드포인트의 경우 응답 본문에는 다음이 포함됩니다.

이름
설명

status

HTTP 응답 코드

content

예상되는 응답 본문

false

이름
유형
설명

desc

문자열

이 에이전트 API 키의 레이블입니다.

이름
유형
설명

id

문자열

이 에이전트 API 키의 고유 식별자입니다.

문자열

에이전트 API 키.

이 에이전트 API 키를 생성한 후 후속 요청은 에이전트 API 키의 마지막 4자를 반환합니다.

desc

문자열

이 에이전트 API 키의 레이블입니다. 1,000자로 제한됩니다.

createdTime

문자열

에이전트 API 키가 생성되었을 때 ISO 8601 날짜 및 시간 형식(UTC 기준)의 타임스탬프입니다.

createdUserId

문자열

이 에이전트 API 키를 생성한 사용자의 고유 식별자입니다.

createdIpAddr

문자열

이 에이전트 API 키를 생성한 IP 주소입니다.

createdBy

문자열

이 에이전트 API 키의 소스입니다. 허용되는 값은 다음과 같습니다.

  • USER

  • OLD_KEY

  • PROVISIONING

  • ATLAS

  • PUBLIC_API

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--header "Accept: application/json" \
--header "Content-Type: application/json" \
--include \
--request POST "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys?pretty=true" \
--data '
{
"desc": "Agent API Key for this project"
}'
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{
"_id" : "{AGENT-API-KEY-ID}",
"createdBy" : "PUBLIC_API",
"createdIpAddr" : "{IP-ADDRESS}",
"createdTime" : 1520458807291,
"createdUserId" : "{USER-ID}",
"desc" : "Agent API Key for this project",
"key" : "{AGENT-API-KEY}"
}

돌아가기

유형별 가져오기

이 페이지의 내용