Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.

Obter uma chave API

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

GET /orgs/{ORG-ID}/apiKeys/{API-KEY-ID}
Nome
Tipo
Descrição

ORG-ID

string

O identificador exclusivo da organização cujas chaves de API você deseja recuperar. Use o endpoint /orgs para recuperar todas as organizações às quais o usuário autenticado tem acesso.

API-KEY-ID

string

Identificador único para a chave de API que você deseja recuperar. Solicitação ao ponto de extremidade /orgs/{ORG-ID}/apiKeys para recuperar todas as chaves API para a organização especificada à qual o usuário autenticado tem acesso.

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 ser retornado em um formato prettyprint.

false

envelope

booleano

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, configure "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

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

none

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

Se você definir o elemento de query envelope como true, a resposta será envolvida pelo objeto content .

A resposta HTTP retorna um JSON document que inclui os seguintes objeto:

Nome
Tipo
Descrição

id

string

Identificador exclusivo para a chave API

links

string

Um array de documentos, representando um link para um ou mais sub-recursos ou recursos relacionados, como paginação de lista. Consulte Vinculação para obter mais informações.

desc

string

Descrição da chave API

privateKey

string

Chave privada editada para a chave de API

publicKey

string

Chave pública para a chave de API

roles

array de objetos

Funções que a chave API tem

roles.{ENTITY-ID}

string

O {ENTITY-ID} representa a organização ou projeto ao qual esta função se aplica. Os valores possíveis são: orgId ou groupId.

roles.roleName

string

O nome da função. O recurso users retorna todos os papéis que o usuário tem no MongoDB Atlas ou Cloud Manager. Os valores possíveis são:

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/orgs/{ORG-ID}/apiKeys/{API-KEY-ID}?pretty=true"
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=ISO-8859-1Date: {dateInUnixFormat}WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=falseContent-Length: {requestLengthInBytes}Connection: keep-alive
HTTP/1.1 200 OKVary: Accept-EncodingContent-Type: application/jsonStrict-Transport-Security: max-age=300Date: {dateInUnixFormat}Connection: keep-aliveContent-Length: {requestLengthInBytes}X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
{ "desc" : "Test Docs Service User", "id" : "5c47503880eef5662e1cce8d", "links" : [ { "href" : "https://cloud.mongodb.com/api/public/v1.0/orgs/5980cfc70b6d98229d82e3f6/apiKeys/5c47503880eef5662e1cce8d", "rel" : "self" } ], "privateKey" : "********-****-****-db2c132ca78d", "publicKey" : "ewmaqvdo", "roles" : [ { "orgId" : "5980cfc70b6d97029d82e3f6", "roleName" : "ORG_MEMBER" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_READ_ONLY" }, { "groupId" : "{PROJECT-ID}", "roleName" : "GROUP_OWNER" } ]}