CloudQuery

CloudQuery Onboardings API

The onboardings API from CloudQuery — 21 operation(s) for onboardings.

GitHub OpenAPI

Operations 31

POST /onboardings/aws/oidc Platform create AWS onboarding #
GET /onboardings/aws/oidc/{onboarding_id} Platform get AWS onboarding #
POST /onboardings/aws/oidc/{onboarding_id}/notify Platform notify onboarding #
GET /onboardings/aws/oidc/{onboarding_id}/accounts Platform get AWS accounts in root #
GET /onboardings/aws/oidc/{onboarding_id}/accounts/{aws_orgunit_id} Platform get AWS accounts in parent #
POST /onboardings/aws/oidc/{onboarding_id}/accounts/provision Platform provision onboarding configuration #
POST /onboardings/aws/cur Platform create AWSCUR onboarding #
GET /onboardings/aws/cur/{onboarding_id} Platform get AWSCUR onboarding #
POST /onboardings/aws/cur/{onboarding_id}/notify Platform notify AWSCUR onboarding #
POST /onboardings/aws/cur/{onboarding_id}/verify Platform verify AWSCUR onboarding #
POST /onboardings/aws/unified Platform create AWS unified onboarding #
GET /onboardings/aws/unified/{onboarding_id} Platform get AWS unified onboarding #
POST /onboardings/aws/unified/{onboarding_id}/notify Platform notify AWS unified onboarding #
GET /onboardings/aws/unified/{onboarding_id}/accounts Platform get AWS unified accounts in root #
GET /onboardings/aws/unified/{onboarding_id}/accounts/{aws_orgunit_id} Platform get AWS unified accounts in parent #
POST /onboardings/aws/unified/{onboarding_id}/accounts/provision Platform provision unified onboarding configuration #
POST /onboardings/aws/unified/{onboarding_id}/verify-cur Platform verify AWS unified CUR #
POST /onboardings/aws/unified/{onboarding_id}/test-connections Platform create AWS unified test connections #
POST /onboardings/aws/unified/{onboarding_id}/integrations Platform create AWS unified integrations #
POST /onboardings/gcp/wif Platform create GCPWIF onboarding #
GET /onboardings/gcp/wif/{onboarding_id} Platform get GCPWIF onboarding #
POST /onboardings/gcp/wif/{onboarding_id}/complete Platform complete GCPWIF onboarding #
POST /onboardings/gcp/wif/{onboarding_id}/verify-billing-export Platform verify GCPWIF billing export #
POST /onboardings/azure/wif Platform create azure WIF onboarding #
GET /onboardings/azure/wif/{onboarding_id} Platform get azure WIF onboarding #
POST /onboardings/azure/wif/{onboarding_id}/complete Platform complete azure WIF onboarding #
POST /onboardings/azure/wif/{onboarding_id}/verify-cost-export Platform verify azure WIF cost export #
POST /aws/unified/test-connections Platform create AWS unified test connections standalone #
POST /aws/unified/integrations Platform create AWS unified integrations standalone #
GET /aws/unified/standalone-template Platform get AWS unified standalone template #
POST /aws/organization/discover Platform discover AWS organization #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/cloudquery/openapi/cloudquery-onboardings-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cloudquery:cloudquery-onboardings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudquery-onboardings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@cloudquery.io
    name: CloudQuery Support Team
    url: https://cloudquery.io
  description: 'Welcome to the CloudQuery Platform API documentation! This API can be used to interact with the CloudQuery platform. As a user, the API allows you to search the CloudQuery asset inventory, run SQL queries against the data warehouse, save and load searches, and much more. As an administrator, it allows you to manage your teams, syncs, and other objects.

    ### Authentication

    The API is secured using bearer tokens. To get started, you can generate an API key for your Platform deployment from your platform dashboard. For a step-by-step guide, see: https://www.cloudquery.io/docs/cli/managing-cloudquery/deployments/generate-api-key.

    The base URL for the API depends on where your CloudQuery Platform is hosted. If running locally, this is usually http://localhost:3000/api. In a production deployment it should be an HTTPS URL. For purposes of illustration, we will assume the platform instance is available at https://cloudquery.mycompany.com. In this case, the base API endpoint will be https://cloudquery.mycompany.com/api.

    ### Example Request

    To test your connection to the API, we can use the `/plugins` endpoint. For example:

    `curl -v -H "Authorization: Bearer $CLOUDQUERY_API_KEY" \ https://cloudquery.mycompany.com/api/plugins`'
  license:
    name: MIT
    url: https://spdx.org/licenses/MIT
  termsOfService: https://www.cloudquery.io/terms
  title: CloudQuery Platform OpenAPI Spec Onboardings API
  version: 1.0.0
security:
- bearerAuth: []
- cookieAuth: []
tags:


# --- truncated at 32 KB (82 KB total) ---
# Full source: https://artifacts.apis.io/cloudquery/openapi/cloudquery-onboardings-api-openapi.yml