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 organização

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

GET /orgs/{ORG-ID}
Elemento do caminho
Tipo
Descrição

ORG-ID

string

(Obrigatório.) O identificador exclusivo da organização cujas informações você deseja recuperar.

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

Nome
Tipo
Descrição
Default

pretty

booleano

Sinalizador que indica se o corpo da resposta deve estar em um formato prettyprint.

false

envelope

booleano

Sinalizador que 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

  • content: Corpo de resposta esperado

false

includeDeletedOrgs

booleano

Sinalizador que indica se o corpo da resposta contém organizações excluídas.

O Ops Manager honra o valor deste parâmetro somente se o usuário que faz a solicitação tiver uma role global.

Se configurado para true ou omitido, os usuários atribuídos a uma função global recebem projetos excluídos na resposta. Se configurado para false ou se o usuário não tiver uma função de proprietário global, a resposta não conterá organizações excluídas.

true

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

Nome
Tipo
Descrição

id

string

Identificador único da organização.

isDeleted

booleano

Indica se a organização foi excluída.

name

string

Nome da organização.

links

array de objetos

Um ou mais links para sub-recursos ou recursos relacionados. Todas as arrays links nas respostas incluem pelo menos um link chamado self. Os relacionamentos entre URLs são explicados na Especificação de links da web.

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ --header 'Accept: application/json' \ --include \ --request GET "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/orgs/{ORG-ID}/"
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}
{ "id" : "{ORG-ID}", "isDeleted": false, "links": [{ }], "name" : "Customer Application Support"}