Docs Menu
Docs Home
/
MongoDB Ops Manager
/
API
/
Ops Manager 관리 API 리소스
/
프로그래밍 방식 API 키
/
글로벌 프로그래밍 방식 API 키

1개의 글로벌 API 키 삭제

이 페이지의 내용

  • Resource
  • 필수 역할
  • 요청 매개변수
  • 요청 경로 매개변수
  • 요청 쿼리 매개변수
  • 요청 본문 매개변수
  • 응답
  • 요청 예시
  • 응답 예시
  • 응답 헤더
  • 응답 본문

해당 키에 대한 고유 식별자를 사용하여 Ops Manager에서 하나의 글로벌 API 키를 삭제합니다.

기본 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

DELETE /admin/apiKeys/{API-KEY-ID}

필수 역할

이 엔드포인트를 호출하는 API 키에 Global Owner 역할 이 있어야 합니다.

요청 매개변수

요청 경로 매개변수

모든 요청 경로 매개변수는 필수입니다.

이름
유형
설명
API-KEY-ID
문자열
삭제하려는 API 키의 고유 식별자입니다. /admin/apiKeys 엔드포인트를 사용하여 인증된 사용자가 액세스할 수 있는 모든 API 키를 조회합니다.

요청 쿼리 매개변수

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

이름
유형
필요성
설명
기본값
pretty
부울
옵션
응답 본문이 프리티프린트 에 있어야 하는지 여부를 나타내는 플래그입니다. 형식.
false
envelope
부울
옵션

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

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

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

이름
설명
상태
HTTP 응답 코드
envelope
예상되는 응답 본문
false

요청 본문 매개변수

이 엔드포인트는 HTTP 요청 본문 매개변수를 사용하지 않습니다.

응답

이 엔드포인트에는 응답 요소가 없습니다.

요청 예시

1curl --user "{USERNAME}:{APIKEY}" --digest \
2 --header "Accept: application/json" \
3 --header "Content-Type: application/json" \
4 --include \
5 --request DELETE "https://<OpsManagerHost>:<Port>/api/public/v1.0/admin/apiKeys/{API-KEY-ID}?pretty=true"

응답 예시

응답 헤더

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 204 No Content
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}

응답 본문

이 엔드포인트는 응답 본문을 반환하지 않습니다.

돌아가기

1개의 글로벌 API 키 업데이트

다음

글로벌 프로그래밍 방식 API 키 액세스 목록