Menu Docs
Página inicial do Docs
/
MongoDB Ops Manager
/
API
/
Recursos
/
Chaves de API programáticas
/
Listas de acesso da organização

Excluir uma entrada da lista de acesso para uma chave de API

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

Todas as solicitações para esse endpoint devem ser originadas de um IP endereço na MongoDB Ops Manager API lista de acesso à do usuário do . Para obter a documentação completa sobre a configuração de listas de acesso à API, consulte Exigir uma lista de acesso à API para sua organização.

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

Exclua um endereço especificado na lista de acesso a partir da chave de API especificada.

Resource

DELETE /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/{ACCESS-LIST-ENTRY}

Parâmetros do caminho da solicitação

Nome
Tipo
Descrição

ORG-ID

string

Identificador único da organização à qual pertence a chave deAPI destino. Solicite ao endpoint /orgs que recupere todas as organizações às quais o usuário autenticado tem acesso.

API-KEY-ID

string

Identificador exclusivo da chave de API para a qual você deseja recuperar entradas da lista de acesso. Solicite ao endpoint /orgs/{ORG-ID}/apiKeys que recupere todas as chaves de API da organização especificada à qual o usuário autenticado tem acesso.

ACCESS-LIST-ENTRY

string

O endereço IP ou CIDR . Se a entrada incluir uma máscara de sub-rede, como 192.0.2.0/24, use o valor codificado em URL %2F para a barra /.

Solicitar parâmetros de query

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

Nome
Tipo
Descrição
Default

pageNum

inteiro

Número da página (com base em índice 1).

1

itemsPerPage

inteiro

Número de itens a serem devolvidos por página, até um máximo de 500.

100

pretty

booleano

Indica se o corpo da resposta deve estar em um prettyprint formato.

false

envelope

booleano

Indica se deseja ou não 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, configure "envelope" : true na query.

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

Status
Código de resposta HTTP

envelope

Corpo de resposta esperado

Para endpoints que retornam uma lista de resultados, o objeto results é um envelope. O Ops Manager adiciona o campo status ao corpo da resposta.

none

Parâmetros do corpo da solicitação

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

Resposta

Este endpoint retorna um JSON document vazio.

Exemplo de solicitação

1curl --user "{USERNAME}:{APIKEY}" --digest \
2  --header "Accept: application/json" \
3  --header "Content-Type: application/json" \
4  --request DELETE "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}/accessList/192.0.2.0%2F24"

Exemplo de resposta

HTTP/1.1 204 No Content

Voltar

Criar entradas

Próximo

Chaves API em projetos