Menu Docs
Página inicial do Docs
/
MongoDB Cloud Manager
/
API
/
Recursos da API de administração do Cloud Manager
/
Agentes

Remover uma chave de API do agente

Nesta página

  • Resource
  • Parâmetros do caminho da solicitação
  • Solicitar parâmetros de query
  • Parâmetros do corpo da solicitação
  • Resposta
  • Exemplo de solicitação
  • Exemplo de resposta
  • Cabeçalho de resposta
  • Corpo de resposta

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

Resource

DELETE /groups/{PROJECT-ID}/agentapikeys/{API-AGENT-KEY-ID}

Este endpoint é restrito a usuários com a função Project Owner .

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição
ID do projeto
string
Identificador exclusivo do projeto que possui a chave de API do agente.
API-AGENT-KEY-ID
string
Identificador exclusivo da chave de API do agente.

Solicitar parâmetros de query

Os seguintes parâmetros de query são opcionais:

Nome
Tipo
necessidade
Descrição
Default
pretty
booleano
Opcional
false
envelope
booleano
Opcional

Sinalizador que indica se deseja ou não envolver a resposta em um envelope.

Alguns clientes da API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query.

Para endpoints que retornam um resultado, o corpo da resposta inclui:

Nome
Descrição
status
Código de resposta HTTP
content
Corpo de resposta esperado
false

Parâmetros do corpo da solicitação

Este endpoint não usa parâmetros do corpo da solicitação HTTP.

Resposta

Este endpoint não tem elementos de resposta.

Exemplo de solicitação

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/agentapikeys/{API-AGENT-KEY-ID}?pretty=true"

Exemplo de resposta

Cabeçalho de resposta

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}

Corpo de resposta

Este endpoint não retorna um corpo de resposta.

Voltar

Obtenha todas as chaves de API do agente para um projeto