Como esta referência é gerada
Essas páginas são geradas a partir das especificações OpenAPI que os serviços são construídos e verificados, não escritos à mão ao lado deles. Uma operação aparece aqui porque ela existe, com as formas de solicitação e resposta que o serviço realmente implementa, incluindo as respostas de erro, que são documentadas em vez de serem deixadas para serem descobertas.Convenções
Versioning. Cada caminho é prefixado com/v1.
Identificadores. As respostas de recursos expõem identidades canônicas. Os caminhos de recursos UUID usam o id retornado; campos de referência de solicitação aceitam apenas os tipos declarados por sua operação. Consulte References para nomes com escopo, CRNs aninhados, versões de imagem, filtros de lista exata e busca de um recurso por qualquer referência. CRNs com escopo organizacional exigem o contexto organizacional autenticado.
Errors. As falhas retornam um corpo JSON com um código estável e legível por máquina. Combine o código, não a mensagem legível por humanos, que pode mudar.
Falhas. Recursos que executam trabalho em segundo plano sempre incluem faults: um array de observações ativas, ou [] quando nenhuma permanece. Veja Resource faults para o array, a ordem, a recuperação e como a gravidade mapeia para o status.
Idempotência e trabalho assíncrono. Operações que entregam a um fluxo de trabalho em segundo plano respondem 202 Accepted em vez de fingir que o trabalho foi feito. Sonda o recurso até que ele atinja um estado terminal; um 202 seguido de uma leitura que ainda mostra o estado antigo é o contrato funcionando, não um bug.
Paginação. Lista de operações da página. Siga os campos de paginação na resposta em vez de assumir que você tem tudo.
Começando a usar
Autenticação
Tokens de portador, sessões de função de conta e origem das credenciais.
Regiões e endpoints
Em qual host cada serviço responde e quais são globais.
Início rápido
Uma solicitação autenticada em funcionamento, de ponta a ponta.
CLI
Use as APIs a partir do seu terminal.