CloudGuard

CloudGuard Onboarding API

Onboard and manage cloud accounts across AWS, Azure, GCP, Alibaba, OCI and Kubernetes - registration, credentials, missing-permission checks, data sync and organizational-unit placement. 160 operations across 133 paths.

GitHub OpenAPI

Operations 160

DELETE /v2/AlibabaCloudAccount/{id}/DeleteForce Delete Force #
GET /v2/AlibabaCloudAccount/{cloudAccountId}/account-stats Get Cloud Account Stats #
GET /v2/AlibabaCloudAccount/MissingPermissions Get Missing Permissions #
GET /v2/AlibabaCloudAccount/{id}/MissingPermissions Get Missing Permissions #
PUT /v2/AlibabaCloudAccount/{id}/MissingPermissions Update Ignorable Missing Permissions #
GET /v2/AlibabaCloudAccount/{id}/MissingPermissions/EntityType Get Missing Permissions By Entity Type #
PUT /v2/AlibabaCloudAccount/{id}/MissingPermissions/Reset Reset Missing Permissions #
PUT /v2/AlibabaCloudAccount/{id}/AccountName Update Account Name #
PUT /v2/AlibabaCloudAccount/{id}/Credentials Update Alibaba Cloud Account Credentials #
POST /v2/AlibabaCloudAccount/{id}/SyncNow Sync Now #
PUT /v2/AlibabaCloudAccount/{id}/organizationalUnit Update Organizational Id #
PUT /v2/AlibabaCloudAccount/organizationalUnit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/AlibabaCloudAccount/organizationalUnit/moveAll Move All Cloud Accounts To Organizational Unit #
POST /v2/AlibabaCloudAccount/organizationalUnit/attach Post Attach Multi #
GET /v2/AlibabaCloudAccount Get #
POST /v2/AlibabaCloudAccount Post #
GET /v2/AlibabaCloudAccount/{id} Get #
DELETE /v2/AlibabaCloudAccount/{id} Delete #
DELETE /v2/cloudaccounts/{id}/DeleteForce Delete Force #
PUT /v2/cloudaccounts/name Update Cloud Account Name #
PUT /v2/cloudaccounts/region-conf Update Cloud Account Region Conf #
PUT /v2/cloudaccounts/credentials Update Cloud Account Credentials #
GET /v2/cloudaccounts/MissingPermissions Get Missing Permissions #
GET /v2/cloudaccounts/{id}/MissingPermissions Get Missing Permissions #
PUT /v2/cloudaccounts/{id}/MissingPermissions Update Ignorable Missing Permissions #
GET /v2/cloudaccounts/{id}/MissingPermissions/EntityType Get Missing Permissions By Entity Type #
GET /v2/cloudaccounts/{id}/CloudAccountHasAssumeRolePermissionIssue Cloud Account Has Assume Role Permission Issue #
PUT /v2/cloudaccounts/{id}/MissingPermissions/Reset Reset Missing Permissions #
POST /v2/cloudaccounts/{id}/SyncNow Sync Now #
PUT /v2/cloudaccounts/{id}/organizationalUnit Update Organizational Id #
PUT /v2/cloudaccounts/organizationalUnit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/cloudaccounts/organizationalUnit/moveAll Move All Cloud Accounts To Organizational Unit #
POST /v2/cloudaccounts/organizationalUnit/attach Post Attach Multi #
GET /v2/CloudAccounts Get #
POST /v2/CloudAccounts Post #
GET /v2/CloudAccounts/{id} Get #
DELETE /v2/CloudAccounts/{id} Delete #
POST /v2/AwsUnifiedOnboarding/StackConfig Get Stack Config #
GET /v2/AwsUnifiedOnboarding/UpdateVersion/StackConfig/{onboardingId} Get Update Stack Config #
GET /v2/AwsUnifiedOnboarding/{id} Get #
DELETE /v2/AzureCloudAccount/{id}/DeleteForce Delete Force #
GET /v2/AzureCloudAccount/OnboardingExecutionPreview Get Onboarding Script For Preview #
POST /v2/AzureCloudAccount/OnboardingExecutionCommand Generate Onboarding Execution Command #
GET /v2/AzureCloudAccount/MissingPermissions Get Missing Permissions #
GET /v2/AzureCloudAccount/{id}/MissingPermissions Get Missing Permissions #
PUT /v2/AzureCloudAccount/{id}/MissingPermissions Update Ignorable Missing Permissions #
GET /v2/AzureCloudAccount/{id}/MissingPermissions/EntityType Get Missing Permissions By Entity Type #
PUT /v2/AzureCloudAccount/{id}/MissingPermissions/Reset Reset Missing Permissions #
PUT /v2/AzureCloudAccount/{id}/OperationMode Update Operation Mode #
PUT /v2/AzureCloudAccount/{id}/AccountName Update Account Name #
PUT /v2/AzureCloudAccount/{id}/Credentials Update Cloud Account Credentials #
POST /v2/AzureCloudAccount/{id}/SyncNow Sync Now #
GET /v2/AzureCloudAccount/{id}/CredentialsServicePrincipalId Get Credentials Service Principal Id #
PUT /v2/AzureCloudAccount/{id}/organizationalUnit Update Organizational Id #
PUT /v2/AzureCloudAccount/organizationalUnit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/AzureCloudAccount/organizationalUnit/moveAll Move All Cloud Accounts To Organizational Unit #
POST /v2/AzureCloudAccount/organizationalUnit/attach Post Attach Multi #
GET /v2/AzureCloudAccount/{id} Get #
DELETE /v2/AzureCloudAccount/{id} Delete #
GET /v2/AzureCloudAccount Get #
POST /v2/AzureCloudAccount Post #
DELETE /v2/GoogleCloudAccount/{id}/DeleteForce Delete Force #
PUT /v2/GoogleCloudAccount/{id}/DeleteGsuite Delete Gsuite #
GET /v2/GoogleCloudAccount/{id}/details Get Cloud Account Details #
GET /v2/GoogleCloudAccount/{cloudAccountId}/account-stats Get Cloud Account Stats #
GET /v2/GoogleCloudAccount/MissingPermissions Get Missing Permissions #
GET /v2/GoogleCloudAccount/{id}/MissingPermissions Get Missing Permissions #
PUT /v2/GoogleCloudAccount/{id}/MissingPermissions Update Ignorable Missing Permissions #
GET /v2/GoogleCloudAccount/{id}/MissingPermissions/EntityType Get Missing Permissions By Entity Type #
PUT /v2/GoogleCloudAccount/{id}/MissingPermissions/Reset Reset Missing Permissions #
PUT /v2/GoogleCloudAccount/{id}/AccountName Update Account Name #
PUT /v2/GoogleCloudAccount/{id}/Credentials/Gsuite Update Account Gsuite #
PUT /v2/GoogleCloudAccount/{id}/Credentials Update Google Cloud Account Credentials #
POST /v2/GoogleCloudAccount/{id}/SyncNow Sync Now #
PUT /v2/GoogleCloudAccount/{id}/organizationalUnit Update Organizational Id #
PUT /v2/GoogleCloudAccount/organizationalUnit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/GoogleCloudAccount/organizationalUnit/moveAll Move All Cloud Accounts To Organizational Unit #
POST /v2/GoogleCloudAccount/organizationalUnit/attach Post Attach Multi #
GET /v2/GoogleCloudAccount Get #
POST /v2/GoogleCloudAccount Post #
GET /v2/GoogleCloudAccount/{id} Get #
DELETE /v2/GoogleCloudAccount/{id} Delete #
GET /v2/kubernetes/account Get All #
POST /v2/kubernetes/account Post #
GET /v2/kubernetes/account/{id} Get #
DELETE /v2/kubernetes/account/{id} Delete #
PUT /v2/kubernetes/account/{id}/accountName Update Account Name #
PUT /v2/kubernetes/account/{id}/accountDescription Update Account Description #
POST /v2/kubernetes/account/{id}/imageAssurance/enable Enable Image Assurance #
POST /v2/kubernetes/account/{id}/imageAssurance/disable Disable Image Assurance #
POST /v2/kubernetes/account/{id}/runtimeProtection/enable Enable Runtime Protection #
POST /v2/kubernetes/account/{id}/admissionControl/enable Enable Admission Control #
POST /v2/kubernetes/account/{id}/admissionControl/disable Disable Admission Control #
GET /v2/kubernetes/account/{id}/accountSummary Get Account Summary #
GET /v2/kubernetes/account/accountAgentStatus Get Account Agent Status #
POST /v2/kubernetes/account/agentStatusReportCSV Get Csv Account Agent Status #
GET /v2/kubernetes/account/{id}/agentSummary Get Agent Summary #
POST /v2/kubernetes/account/{id}/resolveMultipleOnboarding Resolve Multiple Onboarding #
PUT /v2/kubernetes/account/{id}/organizationalUnit Update Organizational Id #
PUT /v2/kubernetes/account/organizationalUnit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/kubernetes/account/organizationalUnit/moveAll Move All Cloud Accounts To Organizational Unit #
POST /v2/kubernetes/account/organizationalUnit/attach Post Attach Multi #
GET /v2/containerRegistry/account Get All #
POST /v2/containerRegistry/account Post #
GET /v2/containerRegistry/account/{id} Get #
DELETE /v2/containerRegistry/account/{id} Delete #
PUT /v2/containerRegistry/account/{id}/accountDescription Update Account Description #
PUT /v2/containerRegistry/account/{id}/accountName/{newName} Update Account Name #
PUT /v2/containerRegistry/account/{id}/linkedScanningEnvironments Update Linked Scanning Environments #
PUT /v2/containerRegistry/account/{id}/linkedScanningEnvironment Update Linked Scanning Environment #
DELETE /v2/containerRegistry/account/{id}/linkedScanningEnvironment/{linkedEnvironmentId} Delete Linked Scanning Environment #
PUT /v2/containerRegistry/account/{id}/settings Set Environment Settings #
PATCH /v2/containerRegistry/account/{id}/settings Update Environment Settings #
GET /v2/containerRegistry/account/{id}/settings Get Environment Settings #
PUT /v2/containerRegistry/account/{id}/organizationalUnit Update Organizational Id #
PUT /v2/containerRegistry/account/organizationalUnit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/containerRegistry/account/organizationalUnit/moveAll Move All Cloud Accounts To Organizational Unit #
POST /v2/containerRegistry/account/organizationalUnit/attach Post Attach Multi #
GET /v2/containerRegistry/account/{id}/agentSummary Get Agent Summary #
GET /v2/containerRegistry/account/accountAgentStatus Get Account Agent Status #
GET /v2/containerRegistry/account/{id}/accountSummary Get Account Summary #
GET /v2/oci-cloud-account Get All Oci Cloud Accounts #
POST /v2/oci-cloud-account Add Oci Cloud Account #
DELETE /v2/oci-cloud-account Delete Oci Cloud Account #
GET /v2/oci-cloud-account/{id} Get Oci Cloud Accounts By Id #
POST /v2/oci-cloud-account/create-terraform Save Temp Data And Export Terraform Conf File #
POST /v2/oci-cloud-account/save-temp-data Save Temp Data #
DELETE /v2/oci-cloud-account/{id}/delete-force Force Delete Oci Cloud Account #
PUT /v2/oci-cloud-account/{id}/account-name Update Account Name #
PUT /v2/oci-cloud-account/{id}/credentials Update Credentials #
PUT /v2/oci-cloud-account/{id}/credentials-terraform Update Credentials Terraform #
POST /v2/oci-cloud-account/{id}/sync-now Sync Now #
GET /v2/oci-cloud-account/missing-permissions Get Missing Permissions All #
GET /v2/oci-cloud-account/{id}/missing-permissions Get Missing Permissions #
PUT /v2/oci-cloud-account/{id}/missing-permissions Update Ignorable Missing Permissions #
GET /v2/oci-cloud-account/{id}/missing-permissions/entity-type Get Missing Permissions By Entity Type #
PUT /v2/oci-cloud-account/{id}/missing-permissions/reset Reset Missing Permissions #
PUT /v2/oci-cloud-account/{id}/organizational-unit Update Organizational Unit Id #
PUT /v2/oci-cloud-account/organizational-unit/move Move Cloud Accounts To Organizational Unit #
PUT /v2/oci-cloud-account/organizational-unit/move-all Move All Cloud Accounts To Organizational Unit #
POST /v2/oci-cloud-account/organizational-unit/attach Attach Multi Organizational Unit #
POST /v2/aws-organization-management Create Organization Management #
GET /v2/aws-organization-management Get All Organization Management #
PUT /v2/aws-organization-management/{id} Update Organization Management #
GET /v2/aws-organization-management/{id} Get Organization Management By Id #
DELETE /v2/aws-organization-management/{id} Delete #
PUT /v2/aws-organization-management/{id}/stackset-arn Update Stack Set Arn #
PUT /v2/aws-organization-management/{id}/configuration Update Configuration #
PUT /v2/aws-organization-management/{id}/missing-permissions/reset Reset Missing Permissions #
GET /v2/aws-organization-management-onboarding/management-stack Get Onboarding Configuration #
GET /v2/aws-organization-management-onboarding/member-account-configuration Get Member Account Configuration #
POST /v2/azure-organization-management Create Organization Management #
GET /v2/azure-organization-management Get All Organization Management #
PUT /v2/azure-organization-management/{id} Update Organization Management #
GET /v2/azure-organization-management/{id} Get Organization Management By Id #
DELETE /v2/azure-organization-management/{id} Delete #
GET /v2/azure-organization-management/tenant/{tenantId}/management-group/{managementGroupId} Get Azure Organization Management By Tenant And Management Group #
PUT /v2/azure-organization-management/{id}/missing-permissions/reset Reset Missing Permissions #
GET /v2/gcp-organization-management/execution-command Generate Onboarding Execution Command #
GET /v2/gcp-organization-management/onboarding-execution-preview Get Onboarding Script For Preview #

Documentation

📖
Documentation
https://docs.cgn.portal.checkpoint.com/reference
📖
APIReference
https://docs.cgn.portal.checkpoint.com/reference/introduction
📖
Authentication
https://docs.cgn.portal.checkpoint.com/reference/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cloudguard/refs/heads/main/openapi/cloudguard-onboarding-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/cloudguard/refs/heads/main/overlays/cloudguard-onboarding-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/cloudguard/refs/heads/main/apis.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/cloudguard-cloudaccounts-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

cloudguard-onboarding-openapi.yml Raw ↑ 
info:
  title: Onboarding
  version: v2
openapi: 3.0.0
servers:
- url: https://api.dome9.com/
  description: US region
- url: https://api.{region}.dome9.com/
  description: Other regions
  variables:
    region:
      enum:
      - eu1
      - ap1
      - ap2
      - ap3
      - cace1
      default: eu1
paths:
  /v2/AlibabaCloudAccount/{id}/DeleteForce:
    delete:
      tags:
      - Alibaba Cloud Account
      summary: Delete Force
      operationId: AlibabaCloudAccount_DeleteForceAsync_delete_/v2/AlibabaCloudAccount/{id}/DeleteForce
      parameters:
      - name: id
        in: path
        description: the Dome9 account id for the account or the Subscription id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete an Alibaba account from a Dome9 account (the Alibaba account is not deleted from Alibaba) and linked
        entities
  /v2/AlibabaCloudAccount/{cloudAccountId}/account-stats:
    get:
      tags:
      - Alibaba Cloud Account
      summary: Get Cloud Account Stats
      operationId: AlibabaCloudAccount_GetCloudAccountStatsAsync_get_/v2/AlibabaCloudAccount/{cloudAccountId}/account-stats
      parameters:
      - name: cloudAccountId
        in: path
        description: The Id of the Alibaba cloud account
        required: true
        schema:
          type: string
          format: uuid
      - name: withData
        in: query
        description: Include raw data of networks, security groups and vms, default = false
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountStatsViewModel'
      description: Gets Cloud Account network statistics on cloud account page
  /v2/AlibabaCloudAccount/MissingPermissions:
    get:
      tags:
      - Alibaba Cloud Account
      summary: Get Missing Permissions
      operationId: AlibabaCloudAccount_GetMissingPermissions_get_/v2/AlibabaCloudAccount/MissingPermissions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel'
      description: Get a list of missing permissions (needed by Dome9 to manage the accounts) for all Alibaba accounts in
        Dome9
  /v2/AlibabaCloudAccount/{id}/MissingPermissions:
    get:
      tags:
      - Alibaba Cloud Account
      summary: Get Missing Permissions
      operationId: AlibabaCloudAccount_GetMissingPermissionsAsync_get_/v2/AlibabaCloudAccount/{id}/MissingPermissions
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: showIgnored
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel'
      description: Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage
        accounts.
    put:
      tags:
      - Alibaba Cloud Account
      summary: Update Ignorable Missing Permissions
      operationId: AlibabaCloudAccount_UpdateIgnorableMissingPermissionsAsync_put_/v2/AlibabaCloudAccount/{id}/MissingPermissions
      parameters:
      - name: id
        in: path
        description: CloudAccountId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel'
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel'
        description: List of permissions to set ignore or restore flag to
        required: true
      description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage
        accounts.
  /v2/AlibabaCloudAccount/{id}/MissingPermissions/EntityType:
    get:
      tags:
      - Alibaba Cloud Account
      summary: Get Missing Permissions By Entity Type
      operationId: AlibabaCloudAccount_GetMissingPermissionsByEntityTypeAsync_get_/v2/AlibabaCloudAccount/{id}/MissingPermissions/EntityType
      parameters:
      - name: id
        in: path
        description: The Dome9 Alibaba Cloud Account Id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityType
        in: query
        description: The entity type for which to get permission issues
        required: true
        schema:
          type: string
      - name: subType
        in: query
        description: ''
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel'
      description: Get missing permissions for a specific entity type for a specific Alibaba Cloud account
  /v2/AlibabaCloudAccount/{id}/MissingPermissions/Reset:
    put:
      tags:
      - Alibaba Cloud Account
      summary: Reset Missing Permissions
      operationId: AlibabaCloudAccount_ResetMissingPermissionsAsync_put_/v2/AlibabaCloudAccount/{id}/MissingPermissions/Reset
      parameters:
      - name: id
        in: path
        description: the account id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: "Reset (re-validate) a Alibaba Cloud account credentials in Dome9. \r\nWill cause all entities to retry\
        \ fetching from the Alibaba cloud account."
  /v2/AlibabaCloudAccount/{id}/AccountName:
    put:
      tags:
      - Alibaba Cloud Account
      summary: Update Account Name
      operationId: AlibabaCloudAccount_UpdateAccountNameAsync_put_/v2/AlibabaCloudAccount/{id}/AccountName
      parameters:
      - name: id
        in: path
        description: the account id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountNameViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountNameViewModel'
        description: the updated name as it will appear in Dome9
        required: true
      description: Update a Alibaba Cloud account name (as it appears in Dome9)
  /v2/AlibabaCloudAccount/{id}/Credentials:
    put:
      tags:
      - Alibaba Cloud Account
      operationId: AlibabaCloudAccount_UpdateAlibabaCloudAccountCredentialsAsync_put_/v2/AlibabaCloudAccount/{id}/Credentials
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewPostModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaAccountCredentialsViewPostModel'
        required: true
      description: ''
      summary: Update Alibaba Cloud Account Credentials
  /v2/AlibabaCloudAccount/{id}/SyncNow:
    post:
      tags:
      - Alibaba Cloud Account
      operationId: AlibabaCloudAccount_SyncNow_post_/v2/AlibabaCloudAccount/{id}/SyncNow
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      description: ''
      summary: Sync Now
  /v2/AlibabaCloudAccount/{id}/organizationalUnit:
    put:
      tags:
      - Alibaba Cloud Account
      summary: Update Organizational Id
      operationId: AlibabaCloudAccount_UpdateOrganizationalId_put_/v2/AlibabaCloudAccount/{id}/organizationalUnit
      parameters:
      - name: id
        in: path
        description: The Dome9 Guid ID of the Alibaba cloud account
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel'
        description: The Guid ID of the Organizational Unit to attach to. Use 'null' to attach to the root Organizational
          Unit
        required: true
      description: "Update the ID of the Organizational Unit that this cloud account will be attached to.\r\nUse 'null' for\
        \ the root organizational unit"
  /v2/AlibabaCloudAccount/organizationalUnit/move:
    put:
      tags:
      - Alibaba Cloud Account
      summary: Move Cloud Accounts To Organizational Unit
      operationId: AlibabaCloudAccount_MoveCloudAccountsToOrganizationalUnit_put_/v2/AlibabaCloudAccount/organizationalUnit/move
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel'
      description: "Detach cloud accounts from an Organizational unit and attach them to another Organizational unit.\r\n\
        Use 'null' for root organizational unit"
  /v2/AlibabaCloudAccount/organizationalUnit/moveAll:
    put:
      tags:
      - Alibaba Cloud Account
      summary: Move All Cloud Accounts To Organizational Unit
      operationId: AlibabaCloudAccount_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/AlibabaCloudAccount/organizationalUnit/moveAll
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2'
      description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default
        is to root organizational unit
  /v2/AlibabaCloudAccount/organizationalUnit/attach:
    post:
      tags:
      - Alibaba Cloud Account
      summary: Post Attach Multi
      operationId: AlibabaCloudAccount_PostAttachMulti_post_/v2/AlibabaCloudAccount/organizationalUnit/attach
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel'
      description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit
        as target
  /v2/AlibabaCloudAccount:
    get:
      tags:
      - Alibaba Cloud Account
      summary: Get
      operationId: AlibabaCloudAccount_Get_get_/v2/AlibabaCloudAccount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      description: Get a list of all Alibaba cloud accounts
    post:
      tags:
      - Alibaba Cloud Account
      summary: Post
      operationId: AlibabaCloudAccount_Post_post_/v2/AlibabaCloudAccount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountPostViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountPostViewModel'
        description: details for the new account
        required: true
      description: Add (onboard) a new Alibaba cloud account to Dome9
  /v2/AlibabaCloudAccount/{id}:
    get:
      tags:
      - Alibaba Cloud Account
      summary: Get
      operationId: AlibabaCloudAccount_Get_get_/v2/AlibabaCloudAccount/{id}
      parameters:
      - name: id
        in: path
        description: the Alibaba cloud account id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Alibaba.Accounts.AlibabaCloudAccountGetViewModel'
      description: Get details for a specific Alibaba Cloud Account
    delete:
      tags:
      - Alibaba Cloud Account
      summary: Delete
      operationId: AlibabaCloudAccount_Delete_delete_/v2/AlibabaCloudAccount/{id}
      parameters:
      - name: id
        in: path
        description: the Dome9 account id for the account or the Subscription id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete an Alibaba account from a Dome9 account (the Alibaba account is not deleted from Alibaba)
  /v2/cloudaccounts/{id}/DeleteForce:
    delete:
      tags:
      - Aws  Cloud  Account
      summary: Delete Force
      operationId: CloudAccounts_DeleteForce_delete_/v2/cloudaccounts/{id}/DeleteForce
      parameters:
      - name: id
        in: path
        description: The Dome9 AWS account id (UUID)
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete an AWS cloud account and linked entities.
  /v2/cloudaccounts/name:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Update Cloud Account Name
      operationId: CloudAccounts_UpdateCloudAccountName_put_/v2/cloudaccounts/name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_System.String_'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_System.String_'
        description: the new name for the account
        required: true
      description: Update an AWS cloud account name.
  /v2/cloudaccounts/region-conf:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Update Cloud Account Region Conf
      operationId: CloudAccounts_UpdateCloudAccountRegionConf_put_/v2/cloudaccounts/region-conf
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel_'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountRegionConfigurationViewModel_'
        description: updated Regional Configuration parameters for the account
        required: true
      description: Update an AWS cloud account region configuration.
  /v2/cloudaccounts/credentials:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Update Cloud Account Credentials
      operationId: CloudAccounts_UpdateCloudAccountCredentials_put_/v2/cloudaccounts/credentials
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountCredentialsViewModel_'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountPartialUpdateViewModel_Dome9.Web.Api.Models.CloudAccountCredentialsViewModel_'
        description: credentials block
        required: true
      description: "Update credentials for an AWS cloud account in Dome9.\r\nAt least one of the following properties must\
        \ be provided: \"cloudAccountId\", \"externalAccountNumber\""
  /v2/cloudaccounts/MissingPermissions:
    get:
      tags:
      - Aws  Cloud  Account
      summary: Get Missing Permissions
      operationId: CloudAccounts_GetMissingPermissionsAsync_get_/v2/cloudaccounts/MissingPermissions
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsViewModel'
      description: Get a list of missing permissions for all accounts. These are permissions needed by Dome9 to manage accounts.
  /v2/cloudaccounts/{id}/MissingPermissions:
    get:
      tags:
      - Aws  Cloud  Account
      summary: Get Missing Permissions
      operationId: CloudAccounts_GetMissingPermissionsAsync_get_/v2/cloudaccounts/{id}/MissingPermissions
      parameters:
      - name: id
        in: path
        description: ''
        required: true
        schema:
          type: string
          format: uuid
      - name: showIgnored
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.CloudAccountMissingPermissionsIgnorableViewModel'
      description: Get a list of missing permissions for a specific account. These permissions are needed by Dome9 to manage
        accounts.
    put:
      tags:
      - Aws  Cloud  Account
      summary: Update Ignorable Missing Permissions
      operationId: CloudAccounts_UpdateIgnorableMissingPermissionsAsync_put_/v2/cloudaccounts/{id}/MissingPermissions
      parameters:
      - name: id
        in: path
        description: CloudAccountId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel'
          application/x-www-form-urlencoded:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionsIgnorableUpdateViewModel'
        description: List of permissions to set ignore or restore flag to
        required: true
      description: Get a list of missing permissions for a specific account. These are permissions needed by Dome9 to manage
        accounts.
  /v2/cloudaccounts/{id}/MissingPermissions/EntityType:
    get:
      tags:
      - Aws  Cloud  Account
      summary: Get Missing Permissions By Entity Type
      operationId: CloudAccounts_GetMissingPermissionsByEntityTypeAsync_get_/v2/cloudaccounts/{id}/MissingPermissions/EntityType
      parameters:
      - name: id
        in: path
        description: The account id
        required: true
        schema:
          type: string
          format: uuid
      - name: entityType
        in: query
        description: The entity type
        required: true
        schema:
          type: string
      - name: subType
        in: query
        description: The entity subtype (optional)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Shared.Permissions.MissingPermissionViewModel'
      description: Get a list of missing permissions for a specific cloud entity type and cloud account
  /v2/cloudaccounts/{id}/CloudAccountHasAssumeRolePermissionIssue:
    get:
      tags:
      - Aws  Cloud  Account
      summary: Cloud Account Has Assume Role Permission Issue
      operationId: CloudAccounts_CloudAccountHasAssumeRolePermissionIssueAsync_get_/v2/cloudaccounts/{id}/CloudAccountHasAssumeRolePermissionIssue
      parameters:
      - name: id
        in: path
        description: The account id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: boolean
      description: check if the cloud account's role has permission issues or was deleted
  /v2/cloudaccounts/{id}/MissingPermissions/Reset:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Reset Missing Permissions
      operationId: CloudAccounts_ResetMissingPermissionsAsync_put_/v2/cloudaccounts/{id}/MissingPermissions/Reset
      parameters:
      - name: id
        in: path
        description: The account id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: reset (re-validate) an account
  /v2/cloudaccounts/{id}/SyncNow:
    post:
      tags:
      - Aws  Cloud  Account
      summary: Sync Now
      operationId: CloudAccounts_SyncNow_post_/v2/cloudaccounts/{id}/SyncNow
      parameters:
      - name: id
        in: path
        description: The account id.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.AwsSyncNowResultViewModel'
      description: "Send a data sync command to immediately fetch cloud account data into Dome9's system caches.\r\nThis API\
        \ is used in conjunction with EntityFetchStatus API resource to query the fetch status.\r\nRead more and see a full\
        \ example here: https://github.com/Dome9/Python_API_SDK/blob/master/implementation/runSyncAssessment.md"
  /v2/cloudaccounts/{id}/organizationalUnit:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Update Organizational Id
      operationId: CloudAccounts_UpdateOrganizationalId_put_/v2/cloudaccounts/{id}/organizationalUnit
      parameters:
      - name: id
        in: path
        description: The Dome9 Guid ID of the AWS cloud account
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel'
        description: The Guid ID of the Organizational Unit to attach to. Use 'null' to attach to the root Organizational
          Unit
        required: true
      description: "Update the ID of the Organizational Unit that this cloud account will be attached to.\r\nUse 'null' for\
        \ the root Organizational Unit"
  /v2/cloudaccounts/organizationalUnit/move:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Move Cloud Accounts To Organizational Unit
      operationId: CloudAccounts_MoveCloudAccountsToOrganizationalUnit_put_/v2/cloudaccounts/organizationalUnit/move
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.MoveOrganizationalUnitViewModel2'
      description: "Detach cloud accounts from an Organizational unit and attach them to another Organizational unit\r\nUse\
        \ 'null' for root organizational unit"
  /v2/cloudaccounts/organizationalUnit/moveAll:
    put:
      tags:
      - Aws  Cloud  Account
      summary: Move All Cloud Accounts To Organizational Unit
      operationId: CloudAccounts_MoveAllCloudAccountsToOrganizationalUnit_put_/v2/cloudaccounts/organizationalUnit/moveAll
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.UpdateIdViewModel2'
      description: Detach all cloud accounts from their current organizational unit and attach them to a new one. Default
        is to root organizational unit
  /v2/cloudaccounts/organizationalUnit/attach:
    post:
      tags:
      - Aws  Cloud  Account
      summary: Post Attach Multi
      operationId: CloudAccounts_PostAttachMulti_post_/v2/cloudaccounts/organizationalUnit/attach
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.BL.Std.Services.OrganizationalUnit.AttachCloudAccountsViewModel'
      description: Attach several cloud accounts to a specific Organizational Unit. User 'null' as root Organizational Unit
        as target
  /v2/CloudAccounts:
    get:
      tags:
      - Aws  Cloud  Account
      summary: Get
      operationId: CloudAccounts_Get_get_/v2/CloudAccounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel'
      description: Get all AWS cloud accounts
    post:
      tags:
      - Aws  Cloud  Account
      summary: Post
      operationId: CloudAccounts_Post_post_/v2/CloudAccounts
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel'
        description: The new AWS account data
        required: true
      description: "Add a new AWS cloud account to CloudGuard <br />\r\nOnboarding an AWS cloud account manually (legacy method)\
        \ requires CloudGuard to obtain permissions to access the account.<br />\r\nFor more information, see the procedure\
        \ on the onboarding with API on the Secure Knowledge center:<br /><a href=\"https://support.checkpoint.com/results/sk/sk147832\"\
        >How to onboard an AWS account to CloudGuard using the REST API</a>"
  /v2/CloudAccounts/{id}:
    get:
      tags:
      - Aws  Cloud  Account
      summary: Get
      operationId: CloudAccounts_Get_get_/v2/CloudAccounts/{id}
      parameters:
      - name: id
        in: path
        description: The Dome9 AWS account id (UUID) or the AWS external account number (12 digit number)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.CloudAccountViewModel'
      description: Fetch a specific AWS cloud account
    delete:
      tags:
      - Aws  Cloud  Account
      summary: Delete
      operationId: CloudAccounts_Delete_delete_/v2/CloudAccounts/{id}
      parameters:
      - name: id
        in: path
        description: The Dome9 AWS account id (UUID)
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete an AWS cloud account.
  /v2/AwsUnifiedOnboarding/StackConfig:
    post:
      tags:
      - Aws Unified Onboarding
      summary: Get Stack Config
      operationId: AwsUnifiedOnboarding_GetStackConfig_post_/v2/AwsUnifiedOnboarding/StackConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.ViewModel.AwsStackConfigViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.Requests.OnboardingConfigurationRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Onboarding.Requests.OnboardingConfigurationRequest'
        required: true
      description: Returns the configuration should be set to the AWS cloud formation SDK for creating the Stack for the onboarding
  /v2/AwsUnifiedOnboarding/UpdateVersion/StackConfig/{onboardingId}:
    get:
      tags:
      - Aws Unified Onboarding
      summary: Get Update Stack Config
      operationId: AwsUnifiedOnboardin

# --- truncated at 32 KB (249 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cloudguard/refs/heads/main/openapi/cloudguard-onboarding-openapi.yml