CloudGuard Administration API

Tenant administration - users, roles, IAM Safe entities, delivery integrations, and the Continuous Compliance Notification surface that routes findings to webhooks, SNS, Slack, Teams, ticketing systems and cloud security hubs. 77 operations across 50 paths.

Operations 77

GET /v2/AccountTrust/assumable-roles Get Assumable Roles #
GET /v2/AccountTrust Get #
POST /v2/AccountTrust Post #
PUT /v2/AccountTrust/{id} Put #
DELETE /v2/AccountTrust/{id} Delete #
GET /v2/audit/event-types Get Event Types #
GET /v2/audit/awsgroup/{groupId} Get Audit Events For Aws Sec Group #
GET /v2/audit/export Get Export #
GET /v2/audit/row-data-api Get Row Data Api #
GET /v2/audit/row-data-system Get Row Data System #
GET /v2/audit/data-count Get Row Data Count #
GET /v2/Audit Get #
GET /v2/Audit/{id} Get Audit Event Metadata #
GET /v2/BillableAssets Get #
GET /v2/billableAssetsReport/dailyUsage Get Daily Usage Billable Assets Report #
GET /v2/BillableAssetsReport Get Billable Assets Report #
GET /v2/CloudInfraUser Get #
POST /v2/CloudInfraUser Post #
GET /v2/Compliance/ContinuousComplianceNotification/{id} Get #
PUT /v2/Compliance/ContinuousComplianceNotification/{id} Put #
DELETE /v2/Compliance/ContinuousComplianceNotification/{id} Delete #
GET /v2/Compliance/ContinuousComplianceNotification Get #
POST /v2/Compliance/ContinuousComplianceNotification Post #
GET /v2/Compliance/ContinuousComplianceNotification/get-by-name Get By Name #
POST /v2/Compliance/ContinuousComplianceNotification/PublishOpenedFindings/{id} Publish Opened Findings By Policy Id #
GET /v2/Compliance/ContinuousComplianceNotification/webhookJiraTokens Webhook Jira Tokens #
GET /v2/Compliance/ContinuousComplianceNotification/CircuitBreaker Get All Circuit Breaker #
GET /v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id} Get Circuit Breaker #
DELETE /v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}/{integrationType} Delete Circuit Breaker #
GET /v2/GlobalSearch Get #
PUT /{id}/external Put Role By External Account Id #
GET /v2/Role Get #
POST /v2/Role Post #
GET /v2/Role/{id} Get #
PUT /v2/Role/{id} Put #
DELETE /v2/Role/{id} Delete #
POST /v2/service-account/update Update Service Account #
GET /v2/service-account/{id} Get #
DELETE /v2/service-account/{serviceAccountId} Delete Service Account #
POST /v2/service-account/generate-key Generate Secret For Service Account #
GET /v2/service-account Get Service Accounts #
POST /v2/service-account Post Service Account #
DELETE /v2/service-account Delete All Service Accounts For User #
PUT /v2/settings/lease-time Update Lease Time #
PUT /v2/settings/email-notifications Update Email Notifications #
PUT /v2/settings/Sns Update Sns Integration #
POST /v2/settings/Sns Add Sns Integration #
DELETE /v2/settings/Sns Delete Sns Integration #
GET /v2/settings/email-notification-filters/cloudAccounts Get Email Notification Filters #
PUT /v2/settings/email-notification-filters/cloudAccounts Update Email Notification Filters #
DELETE /v2/settings/email-notification-filters/cloudAccounts Delete Email Notification Filters #
GET /v2/Settings Get #
PATCH /v2/Settings Update Settings #
POST /v2/TenableAccount/{id}/Validate Validate Permissions #
POST /v2/TenableAccount/Sync Sync Vulnerabilities #
GET /v2/TenableAccount Get #
POST /v2/TenableAccount Post #
DELETE /v2/TenableAccount Delete #
GET /v2/user/{id} Get #
PUT /v2/user/{id} Put #
DELETE /v2/user/{id} Delete #
PUT /v2/user/{id}/unlock Unlock User #
PUT /v2/user/{id}/iam-safe/accounts/{accountId}/iamEntities Put Iam Safe Account Iam Entities #
POST /v2/user/{id}/iam-safe/accounts/{cloudAccountId}/iamEntities Post Iam Safe Account Iam Entities #
POST /v2/user/{id}/iam-safe/accounts/{accountId}/deleteIamEntities Delete Iam Safe Entities For User #
GET /v2/user Get #
POST /v2/user Post #
POST /v2/integration Create Integration #
GET /v2/integration Get All Integrations #
PUT /v2/integration Update Integration #
GET /v2/integration/{id} Get Integration By Id #
DELETE /v2/integration/{id} Delete Integration #
GET /v2/notification/{id} Get #
DELETE /v2/notification/{id} Delete #
GET /v2/notification Get All #
POST /v2/notification Create #
PUT /v2/notification Update #

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-notifications-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.

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

OpenAPI Specification

cloudguard-administration-openapi.yml Raw ↑
info:
  title: Administration
  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/AccountTrust/assumable-roles:
    get:
      tags:
      - Account Trust
      summary: Get Assumable Roles
      operationId: AccountTrust_GetAssumableRoles_get_/v2/AccountTrust/assumable-roles
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Account.AccountTrustAssumableRolesViewModel'
      description: Get a list of objects that represent a trusted account and its assumebale roles
  /v2/AccountTrust:
    get:
      tags:
      - Account Trust
      summary: Get
      operationId: AccountTrust_Get_get_/v2/AccountTrust
      parameters:
      - name: trustDirection
        in: query
        description: Determines whether the accounts result list are the trusted/trustee accounts
        required: true
        schema:
          type: string
          enum:
          - MyAccountIsTarget
          - MyAccountIsSource
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Account.AccountTrustViewModel'
      description: Get a list of accounts which are trusted by or trust this account according to the given "trustDirection"
    post:
      tags:
      - Account Trust
      summary: Post
      operationId: AccountTrust_Post_post_/v2/AccountTrust
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Account.AccountTrustPostViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Account.AccountTrustPostViewModel'
        required: true
      description: Create a new account trust where this account is the target based on the given "SourceAccountId", i.e.
        this account trusts the source account
  /v2/AccountTrust/{id}:
    put:
      tags:
      - Account Trust
      summary: Put
      operationId: AccountTrust_Put_put_/v2/AccountTrust/{id}
      parameters:
      - name: id
        in: path
        description: Account trust id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Account.AccountTrustPutViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Account.AccountTrustPutViewModel'
        required: true
      description: Update the account trust description or restrictions
    delete:
      tags:
      - Account Trust
      summary: Delete
      operationId: AccountTrust_Delete_delete_/v2/AccountTrust/{id}
      parameters:
      - name: id
        in: path
        description: The trust id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete an account trust
  /v2/audit/event-types:
    get:
      tags:
      - Audit
      summary: Get Event Types
      operationId: Audit_GetEventTypes_get_/v2/audit/event-types
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      description: Get a list of available audit event types
  /v2/audit/awsgroup/{groupId}:
    get:
      tags:
      - Audit
      summary: Get Audit Events For Aws Sec Group
      operationId: Audit_GetAuditEventsForAwsSecGroup_get_/v2/audit/awsgroup/{groupId}
      parameters:
      - name: groupId
        in: path
        description: the Security Group id
        required: true
        schema:
          type: integer
          format: int64
      - name: startTimestamp
        in: query
        description: the time of the first event to be fetched
        required: false
        schema:
          type: string
          format: date-time
      - name: endTimestamp
        in: query
        description: the time of the last event to be fetched
        required: false
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Models.AuditEntryViewModel'
      description: Get audit events for a specific AWS Security Group
  /v2/audit/export:
    get:
      tags:
      - Audit
      summary: Get Export
      operationId: Audit_GetExport_get_/v2/audit/export
      parameters:
      - name: startTimestamp
        in: query
        description: the time of the first event to be exported in the report
        required: false
        schema:
          type: string
          format: date-time
      - name: endTimestamp
        in: query
        description: the time of the last event to be exported in the report
        required: false
        schema:
          type: string
          format: date-time
      - name: userNameFilter
        in: query
        description: only events for this specific user will be exported
        required: false
        schema:
          type: string
      - name: eventType
        in: query
        description: only events of this specific type will be exported
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      description: Export an audit events report in a csv format
  /v2/audit/row-data-api:
    get:
      tags:
      - Audit
      summary: Get Row Data Api
      operationId: Audit_GetRowDataApi_get_/v2/audit/row-data-api
      parameters:
      - name: startTimestamp
        in: query
        description: the time of the first event  in the report- Epoch time in milliseconds
        required: false
        schema:
          type: string
      - name: endTimestamp
        in: query
        description: the time of the last event in the report - Epoch time in milliseconds
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: qsl query filter
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Falconetix.Model.Audit.ApiAuditResult'
      description: get api events audit row data
  /v2/audit/row-data-system:
    get:
      tags:
      - Audit
      summary: Get Row Data System
      operationId: Audit_GetRowDataSystem_get_/v2/audit/row-data-system
      parameters:
      - name: startTimestamp
        in: query
        description: the time of the first event  in the report - Epoch time in milliseconds
        required: false
        schema:
          type: string
      - name: endTimestamp
        in: query
        description: the time of the last event in the report - Epoch time in milliseconds
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: qsl query filter
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Falconetix.Model.Audit.SystemAuditResult'
      description: get system events audit row data
  /v2/audit/data-count:
    get:
      tags:
      - Audit
      summary: Get Row Data Count
      operationId: Audit_GetRowDataCount_get_/v2/audit/data-count
      parameters:
      - name: startTimestamp
        in: query
        description: the time of the first event  in the report - Epoch time in milliseconds
        required: false
        schema:
          type: string
      - name: endTimestamp
        in: query
        description: the time of the last event in the report- Epoch time in milliseconds
        required: false
        schema:
          type: string
      - name: filter
        in: query
        description: qsl query filter
        required: false
        schema:
          type: string
      - name: eventType
        in: query
        description: system events or api events
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Falconetix.Model.Audit.CountAuditResult'
      description: get row data result count by type api/system
  /v2/Audit:
    get:
      tags:
      - Audit
      summary: Get
      operationId: Audit_Get_get_/v2/Audit
      parameters:
      - name: pageNum
        in: query
        description: 'page # in the sequence of audit pages'
        required: true
        schema:
          type: integer
          format: int32
      - name: eventsPerPage
        in: query
        description: no. of audit events in the page
        required: true
        schema:
          type: integer
          format: int32
      - name: startTimestamp
        in: query
        description: the time of first audit to be fetched
        required: false
        schema:
          type: string
          format: date-time
      - name: endTimestamp
        in: query
        description: the time of the last audit to be fetched
        required: false
        schema:
          type: string
          format: date-time
      - name: userName
        in: query
        description: only events for this specific user will be fetched
        required: false
        schema:
          type: string
      - name: eventType
        in: query
        description: only events of this specific type will be fetched
        required: false
        schema:
          type: string
      - name: fim
        in: query
        description: ''
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.AuditViewModel'
      description: Get audit events with optional filters
  /v2/Audit/{id}:
    get:
      tags:
      - Audit
      summary: Get Audit Event Metadata
      operationId: Audit_GetAuditEventMetadata_get_/v2/Audit/{id}
      parameters:
      - name: id
        in: path
        description: The audit event id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Models.AuditEntryViewModel'
      description: Get audit metadata
  /v2/BillableAssets:
    get:
      tags:
      - Billable Assets
      operationId: BillableAssets_Get_get_/v2/BillableAssets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.BillableAssets.AccountBillableAssetsViewModel'
      description: ''
      summary: Get
  /v2/billableAssetsReport/dailyUsage:
    get:
      tags:
      - Billable Assets Report
      summary: Get Daily Usage Billable Assets Report
      operationId: BillableAssetsReport_GetDailyUsageBillableAssetsReport_get_/v2/billableAssetsReport/dailyUsage
      parameters:
      - name: fromDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      - name: toDate
        in: query
        required: true
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      description: Get daily usage billable assets report
  /v2/BillableAssetsReport:
    get:
      tags:
      - Billable Assets Report
      summary: Get Billable Assets Report
      operationId: BillableAssetsReport_GetBillableAssetsReport_get_/v2/BillableAssetsReport
      parameters:
      - name: month
        in: query
        required: true
        schema:
          type: integer
          format: int32
      - name: year
        in: query
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      description: Get last month billable assets report
  /v2/CloudInfraUser:
    get:
      tags:
      - Cloud Infra User
      operationId: CloudInfraUser_Get_get_/v2/CloudInfraUser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Falconetix.Model.CloudInfra.CloudInfraUserViewModel'
      description: ''
      summary: Get
    post:
      tags:
      - Cloud Infra User
      operationId: CloudInfraUser_Post_post_/v2/CloudInfraUser
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.UserAndRole.CreateDome9CloudInfraUserResponseViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.UserAndRole.CreateDome9CloudInfraUserRequestViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.UserAndRole.CreateDome9CloudInfraUserRequestViewModel'
        required: true
      description: ''
      summary: Post
  /v2/Compliance/ContinuousComplianceNotification/{id}:
    get:
      tags:
      - Continuous Compliance Notification
      summary: Get
      operationId: ContinuousComplianceNotification_Get_get_/v2/Compliance/ContinuousComplianceNotification/{id}
      parameters:
      - name: id
        in: path
        description: the policy id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationGetViewModel'
      description: Get a Notification policy
    put:
      tags:
      - Continuous Compliance Notification
      summary: Put
      operationId: ContinuousComplianceNotification_Put_put_/v2/Compliance/ContinuousComplianceNotification/{id}
      parameters:
      - name: id
        in: path
        description: the policy id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationGetViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationPutViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationPutViewModel'
        description: updated details for the policy
        required: true
      description: Update a Notification policy
    delete:
      tags:
      - Continuous Compliance Notification
      summary: Delete
      operationId: ContinuousComplianceNotification_Delete_delete_/v2/Compliance/ContinuousComplianceNotification/{id}
      parameters:
      - name: id
        in: path
        description: the policy id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete a Notification policy
  /v2/Compliance/ContinuousComplianceNotification:
    get:
      tags:
      - Continuous Compliance Notification
      summary: Get
      operationId: ContinuousComplianceNotification_Get_get_/v2/Compliance/ContinuousComplianceNotification
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationGetViewModel'
      description: Get all Notification policies
    post:
      tags:
      - Continuous Compliance Notification
      summary: Post
      operationId: ContinuousComplianceNotification_Post_post_/v2/Compliance/ContinuousComplianceNotification
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationGetViewModel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationPostViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationPostViewModel'
        description: details for the policy
        required: true
      description: Create a new Notification policy
  /v2/Compliance/ContinuousComplianceNotification/get-by-name:
    get:
      tags:
      - Continuous Compliance Notification
      summary: Get By Name
      operationId: ContinuousComplianceNotification_GetByName_get_/v2/Compliance/ContinuousComplianceNotification/get-by-name
      parameters:
      - name: name
        in: query
        description: the notification name
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      description: Get a Notification policy
  /v2/Compliance/ContinuousComplianceNotification/PublishOpenedFindings/{id}:
    post:
      tags:
      - Continuous Compliance Notification
      summary: Publish Opened Findings By Policy Id
      operationId: ContinuousComplianceNotification_PublishOpenedFindingsByPolicyIdAsync_post_/v2/Compliance/ContinuousComplianceNotification/PublishOpenedFindings/{id}
      parameters:
      - name: id
        in: path
        description: The policy id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.BL.Std.Services.ContinuousAssessment.ContinuousComplianceNotificationService.PublishResult'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationSyncViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceNotificationSyncViewModel'
        description: Updated details for the policy
        required: true
      description: "Publish (notify) all findings for a specific policy.\r\nThis method is used to sync (send) all existing\
        \ findings via the designated SNS topic assigned to this notification policy.<br />\r\nIt is mostly used for testing\
        \ of automatic remediation actions (see: https://cloudbots.dome9.com/)"
  /v2/Compliance/ContinuousComplianceNotification/webhookJiraTokens:
    get:
      tags:
      - Continuous Compliance Notification
      summary: Webhook Jira Tokens
      operationId: ContinuousComplianceNotification_WebhookJiraTokens_get_/v2/Compliance/ContinuousComplianceNotification/webhookJiraTokens
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      description: Gets all the webhook Jira's tokens
  /v2/Compliance/ContinuousComplianceNotification/CircuitBreaker:
    get:
      tags:
      - Continuous Compliance Notification
      summary: Get All Circuit Breaker
      operationId: ContinuousComplianceNotification_GetAllCircuitBreakerAsync_get_/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceCircuitBreakerGetAllViewModel'
      description: Gets all the notifications that have at least one integration issue
  /v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}:
    get:
      tags:
      - Continuous Compliance Notification
      summary: Get Circuit Breaker
      operationId: ContinuousComplianceNotification_GetCircuitBreakerAsync_get_/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}
      parameters:
      - name: id
        in: path
        description: notification id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Compliance.ContinuousCompliance.ContinuousComplianceCircuitBreakerGetViewModel'
      description: Gets all the integration issues of the given notification
  /v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}/{integrationType}:
    delete:
      tags:
      - Continuous Compliance Notification
      summary: Delete Circuit Breaker
      operationId: ContinuousComplianceNotification_DeleteCircuitBreakerAsync_delete_/v2/Compliance/ContinuousComplianceNotification/CircuitBreaker/{id}/{integrationType}
      parameters:
      - name: id
        in: path
        description: notification id
        required: true
        schema:
          type: string
          format: uuid
      - name: integrationType
        in: path
        description: the integration, eg. AwsSecurityHub
        required: true
        schema:
          type: string
          enum:
          - Sns
          - EmailPerFinding
          - IndexElasticSearch
          - PagerDuty
          - AwsSecurityHub
          - GcpSecurityCommandCenter
          - Webhook
          - AzureSecurityCenter
          - Slack
          - AggregatedEmail
          - Teams
          - Eventarc
          - SlackSingleMessage
          - TeamsSingleMessage
      responses:
        '204':
          description: No Content
      description: Deletes the integration issue of the given notification and integration
  /v2/GlobalSearch:
    get:
      tags:
      - Global Search
      summary: Get
      operationId: GlobalSearch_Get_get_/v2/GlobalSearch
      parameters:
      - name: freeText
        in: query
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: object
      description: Get top results for each service
  /{id}/external:
    put:
      tags:
      - Role
      summary: Put Role By External Account Id
      operationId: Role_PutRoleByExternalAccountId_put_/{id}/external
      parameters:
      - name: id
        in: path
        description: The role id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Role.EditRoleViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Role.EditRoleViewModel'
        description: The role info
        required: true
      description: Update a role
  /v2/Role:
    get:
      tags:
      - Role
      summary: Get
      operationId: Role_Get_get_/v2/Role
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.Role.RoleGetViewModel'
      description: Get all roles for the account.
    post:
      tags:
      - Role
      summary: Post
      operationId: Role_Post_post_/v2/Role
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        $ref: '#/components/requestBodies/Dome9.Web.Api.Role.RoleViewModel'
      description: Create a new role
  /v2/Role/{id}:
    get:
      tags:
      - Role
      summary: Get
      operationId: Role_Get_get_/v2/Role/{id}
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.Role.RoleViewModel'
      description: Get the specific role with the specified id
    put:
      tags:
      - Role
      summary: Put
      operationId: Role_Put_put_/v2/Role/{id}
      parameters:
      - name: id
        in: path
        description: The role id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Role.RoleViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.Role.RoleViewModel'
        description: The role info
        required: true
      description: Update a role
    delete:
      tags:
      - Role
      summary: Delete
      operationId: Role_Delete_delete_/v2/Role/{id}
      parameters:
      - name: id
        in: path
        description: The role id to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '204':
          description: No Content
      description: Delete a role
  /v2/service-account/update:
    post:
      tags:
      - Service Account
      summary: Update Service Account
      operationId: ServiceAccount_UpdateServiceAccount_post_/v2/service-account/update
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
        description: Includes the role ID to update and the new name and role IDs to apply
        required: true
      description: Update a Service Account (Name and Roles)
  /v2/service-account/{id}:
    get:
      tags:
      - Service Account
      summary: Get
      operationId: ServiceAccount_Get_get_/v2/service-account/{id}
      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.ServiceAccountGetViewModel'
      description: Get details on all service accounts in the account
  /v2/service-account/{serviceAccountId}:
    delete:
      tags:
      - Service Account
      summary: Delete Service Account
      operationId: ServiceAccount_DeleteServiceAccount_delete_/v2/service-account/{serviceAccountId}
      parameters:
      - name: serviceAccountId
        in: path
        description: The ID of the Service Account to delete
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: No Content
      description: Delete a specific Service Account by ID
  /v2/service-account/generate-key:
    post:
      tags:
      - Service Account
      summary: Generate Secret For Service Account
      operationId: ServiceAccount_GenerateSecretForServiceAccount_post_/v2/service-account/generate-key
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
        description: Details on the Service Account. Only the ID is required
        required: true
      description: Generate a new access key and secret for a specific Service Account
  /v2/service-account:
    get:
      tags:
      - Service Account
      summary: Get Service Accounts
      operationId: ServiceAccount_GetServiceAccounts_get_/v2/service-account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
      description: Get details on all service accounts in the account
    post:
      tags:
      - Service Account
      summary: Post Service Account
      operationId: ServiceAccount_PostServiceAccount_post_/v2/service-account
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/x-www-form-url

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