Página inicial do Docs

/ /

Agentes

Página inicial do Docs

/ /

Recursos

Agentes

Página inicial do Docs

Remover uma chave de API do agente

URL base: https://{OPSMANAGER-HOST}:{PORT}/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	Sinalizador que indica se o corpo da resposta está em um formato pretty-print.	`false`
envelope	booleano	Opcional	Sinalizador que indica se deve envolver a resposta em um envelope. Alguns clientes de 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: `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://{OPSMANAGER-HOST}:{PORT}/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

Obter todas as chaves API

Medições e alertas