How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CloudQuery

CloudQuery onboardings API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

CloudQuery onboardings API is one of 26 APIs that CloudQuery publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboardings. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 21 operations across 21 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.cloudquery.io.

21 operations 21 paths 37 schemas 7 GET14 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cloudquery.io
Authentication
HTTP Bearer, HTTP Basic, HTTP Cookie
Contact
CloudQuery Support Team
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

CloudQuery onboardings API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP basic authentication (basicAuth). It uses HTTP cookie authentication (cookieAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 21 paths, the API surfaces 21 operations — 7 GET, 14 POST. Each is listed below with its method, path, parameters, and response codes.

onboardings 21
POST
/onboardings/aws/oidc
Create an interactive onboarding for AWS
PlatformCreateAWSOnboarding body → 201400401500
GET
/onboardings/aws/oidc/{onboarding_id}
Query an interactive onboarding for AWS
PlatformGetAWSOnboarding 1 param → 200400401404500
POST
/onboardings/aws/oidc/{onboarding_id}/notify
Update onboarding state
PlatformNotifyOnboarding 1 param body → 202400401500
GET
/onboardings/aws/oidc/{onboarding_id}/accounts
Query AWS accounts under organization root
PlatformGetAWSAccountsInRoot 1 param → 200400401404500
GET
/onboardings/aws/oidc/{onboarding_id}/accounts/{aws_orgunit_id}
Query AWS accounts under a specifc Organizational Unit
PlatformGetAWSAccountsInParent 2 params → 200400401404500
POST
/onboardings/aws/oidc/{onboarding_id}/accounts/provision
Provision onboarding configuration into the cloud account
PlatformProvisionOnboardingConfiguration 1 param body → 202400401404422500
POST
/onboardings/aws/cur
Create an interactive onboarding for AWS CUR
PlatformCreateAWSCUROnboarding → 201400401500
GET
/onboardings/aws/cur/{onboarding_id}
Query an interactive onboarding for AWS CUR
PlatformGetAWSCUROnboarding 1 param → 200400401404500
POST
/onboardings/aws/cur/{onboarding_id}/notify
Update AWS CUR onboarding state
PlatformNotifyAWSCUROnboarding 1 param body → 202400401500
POST
/onboardings/aws/cur/{onboarding_id}/verify
Trigger verification of the AWS CUR onboarding
PlatformVerifyAWSCUROnboarding 1 param → 202400401404500
POST
/onboardings/aws/unified
Create a unified composable onboarding for AWS
PlatformCreateAWSUnifiedOnboarding body → 201400401500
GET
/onboardings/aws/unified/{onboarding_id}
Query a unified AWS onboarding
PlatformGetAWSUnifiedOnboarding 1 param → 200401404500
POST
/onboardings/aws/unified/{onboarding_id}/notify
Update unified AWS onboarding state via CloudFormation callback
PlatformNotifyAWSUnifiedOnboarding 1 param body → 202400401500
GET
/onboardings/aws/unified/{onboarding_id}/accounts
Query AWS accounts under the organization root (requires assetinventory feature)
PlatformGetAWSUnifiedAccountsInRoot 1 param → 200400401404500
GET
/onboardings/aws/unified/{onboarding_id}/accounts/{aws_orgunit_id}
Query AWS accounts under a specific Organizational Unit
PlatformGetAWSUnifiedAccountsInParent 2 params → 200400401404500
POST
/onboardings/aws/unified/{onboarding_id}/accounts/provision
Provision sync roles into selected AWS accounts (requires assetinventory feature)
PlatformProvisionUnifiedOnboardingConfiguration 1 param body → 202400401500
POST
/onboardings/aws/unified/{onboarding_id}/verify-cur
Verify CUR S3 access for the unified onboarding (requires costandusage feature)
PlatformVerifyAWSUnifiedCUR 1 param → 202400401404500
POST
/onboardings/aws/unified/{onboarding_id}/test-connections
Create test connections for all enabled features in one call
PlatformCreateAWSUnifiedTestConnections 1 param body → 201400401404500
POST
/onboardings/aws/unified/{onboarding_id}/integrations
Create integrations for all enabled features using completed test connections
PlatformCreateAWSUnifiedIntegrations 1 param body → 201400401404500
POST
/aws/unified/test-connections
Create test connections for AWS unified features without an onboarding. Frontend is expected to provide a per-feature plugin spec (with ${ENVVAR} placeholders for sensitive values like externalid) pl…
PlatformCreateAWSUnifiedTestConnectionsStandalone body → 201400401500
POST
/aws/unified/integrations
Create AWS unified integrations from previously created standalone test connections (no onboarding). Like the onboarding-bound counterpart, this endpoint may create multiple syncs from a single reque…
PlatformCreateAWSUnifiedIntegrationsStandalone body → 201400401500

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are PlatformOnboardingAWSCUR (12 properties), PlatformOnboardingAWS (11 properties), PlatformOnboardingAWSUnifiedCreateResponse (10 properties), PlatformDeployedUnifiedNotification (9 properties). Each schema is shown below with its type and property counts.

PlatformBaseNotification
object
1 property 1 required
PlatformCompletedNotification
PlatformDeployedNotification
PlatformOnboardingAWSUnifiedIntegrationConfig
object
Per-feature configuration for a unified integration, containing only the test connection reference
1 property 1 required
PlatformStartedNotification
PlatformOnboardingAWSUnifiedTestConnectionsResponse
object
Response with created test connections
1 property 1 required
PlatformOnboardingAWS
object
AWS OpenID onboarding
11 properties 7 required
PlatformOnboardingAWSCURNotification
PlatformOnboardingAWSUnifiedCreateResponse
object
Response when creating a unified AWS onboarding
10 properties 8 required
PlatformOrganizationalUnitID
string
ID of an organizational unit in AWS
PlatformDeployedCURNotification
PlatformAWSUnifiedIntegrationsRequest
object
Request to create AWS unified integrations from previously created standalone test connections (no onboarding). Sub-integrations derive their names from the ba…
7 properties 2 required
PlatformOnboardingAWSUnifiedNotification
PlatformOnboardingAWSUnifiedTestConnectionsRequest
object
Request to create test connections for all enabled features
3 properties
PlatformSyncEnvCreate
object
Environment variable. Environment variables are assumed to be secret.
2 properties 1 required
PlatformOnboardingAWSCUR
object
AWS CUR onboarding
12 properties 7 required
PlatformOnboardingAWSProvision
object
Stackset provisioning configuration
3 properties 2 required
PlatformOnboardingAWSNotification
PlatformOnboardingAWSCURCreateResponse
object
AWS CUR onboarding create response
9 properties 8 required
PlatformDeployedUnifiedNotification
object
Notification sent when unified CloudFormation stack deployment completes
9 properties 2 required
PlatformOnboardingAWSUnifiedAssetInventory
object
Asset inventory feature status and details
9 properties 1 required
PlatformOnboardingAWSUnifiedCostAndUsage
object
Cost and usage feature status and details
6 properties 1 required
PlatformDisplayName
string
A human-readable display name
PlatformOnboardingAWSAccounts
object
AWS OpenID onboarding account structure
5 properties 2 required
PlatformFailedNotification
PlatformOnboardingAWSUnifiedCreateRequest
object
Request to create a unified AWS onboarding
2 properties 1 required
PlatformAWSUnifiedFeatureTestConnectionConfig
object
Per-feature plugin spec and environment variables for a standalone AWS unified test connection. The spec may contain ${ENVVAR} placeholders that resolve from t…
2 properties 1 required
PlatformRevokedNotification
PlatformFieldError
PlatformAWSUnifiedTestConnectionsRequest
object
Request to create test connections for AWS unified features without an onboarding. Each feature is enabled by including its config block. The frontend is respo…
3 properties
PlatformCompletedSingleAccountNotification
PlatformOnboardingAWSCreateResponse
object
AWS OpenID onboarding
9 properties 7 required
PlatformOnboardingAWSUnifiedIntegrationsRequest
object
Request to create integrations for all enabled features
7 properties 2 required
PlatformBasicError
object
Basic Error
2 properties 2 required
PlatformOnboardingAWSUnified
object
Unified AWS onboarding status with per-feature stages
8 properties 6 required
PlatformOnboardingID
string
ID of the cloud provider onboarding session
PlatformOnboardingAWSUnifiedIntegrationsResponse
object
Response containing the integrations created by the unified onboarding flow. Some features create multiple integrations from a single config: assetinventory cr…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cloudquery-onboardings-api-openapi.yml Raw ↑

Other APIs CloudQuery publishes across the network.

CloudQuery Platform API
AE Profile APIs.io
CloudQuery admin API
AE Profile APIs.io
CloudQuery alerts API
AE Profile APIs.io
CloudQuery api-keys API
AE Profile APIs.io
CloudQuery apps API
AE Profile APIs.io
CloudQuery audit-logs API
AE Profile APIs.io
CloudQuery chat API
AE Profile APIs.io
CloudQuery custom-columns API
AE Profile APIs.io
CloudQuery filters API
AE Profile APIs.io
CloudQuery healthcheck API
AE Profile APIs.io
CloudQuery insights API
AE Profile APIs.io
CloudQuery notifications API
AE Profile APIs.io
#Onboardings
← Back to C APIs
API Details
ID
cloudquery:cloudquery-onboardings-api
Base URL
https://api.cloudquery.io
Docs
https://platform-multi-tenant-api-docs.cloudquery.io/
Provider
CloudQuery
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cloudquery-onboardings-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cloudquery-onboardings-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of CloudQuery onboardings API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.