Dome9

Dome9 Service Account API

CloudGuard Service Accounts

GitHub OpenAPI

Operations 7

POST /v2/service-account/update Update a Service Account (Name and Roles) #
GET /v2/service-account/{id} Get details on all service accounts in the account #
DELETE /v2/service-account/{serviceAccountId} Delete a specific Service Account by ID #
POST /v2/service-account/generate-key Generate a new access key and secret for a specific Service Account #
GET /v2/service-account Get details on all service accounts in the account #
POST /v2/service-account Create a new Service Account #
DELETE /v2/service-account Delete all Service Accounts in the account #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/dome9/refs/heads/main/openapi/dome9-service-account-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/dome9-security/workspace/dome9-api

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/dome9-service-account-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

dome9-service-account-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: v2
  title: Dome9. Service Account API
  description: CloudGuard Service Accounts
servers:
- url: https://api.dome9.com
tags:
- name: Service Account
  description: CloudGuard Service Accounts
  type: Administration
paths:
  /v2/service-account/update:
    post:
      tags:
      - Service Account
      summary: Update a Service Account (Name and Roles)
      operationId: ServiceAccount_UpdateServiceAccount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/xml:
            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
  /v2/service-account/{id}:
    get:
      tags:
      - Service Account
      summary: Get details on all service accounts in the account
      operationId: ServiceAccount_Get
      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'
            text/json:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            text/html:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            application/xml:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            text/xml:
              schema:
                $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
  /v2/service-account/{serviceAccountId}:
    delete:
      tags:
      - Service Account
      summary: Delete a specific Service Account by ID
      operationId: ServiceAccount_DeleteServiceAccount
      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
  /v2/service-account/generate-key:
    post:
      tags:
      - Service Account
      summary: Generate a new access key and secret for a specific Service Account
      operationId: ServiceAccount_GenerateSecretForServiceAccount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/xml:
            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
  /v2/service-account:
    get:
      tags:
      - Service Account
      summary: Get details on all service accounts in the account
      operationId: ServiceAccount_GetServiceAccounts
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            text/html:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountGetViewModel'
    post:
      tags:
      - Service Account
      summary: Create a new Service Account
      operationId: ServiceAccount_PostServiceAccount
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
            text/json:
              schema:
                type: object
            text/html:
              schema:
                type: object
            application/xml:
              schema:
                type: object
            text/xml:
              schema:
                type: object
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/json:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/html:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          text/xml:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dome9.Web.Api.ServiceAccountViewModel'
        description: The name of the Service Account and the role IDs to assign it.
        required: true
    delete:
      tags:
      - Service Account
      summary: Delete all Service Accounts in the account
      operationId: ServiceAccount_DeleteAllServiceAccountsForUser
      responses:
        '204':
          description: No Content
components:
  schemas:
    Dome9.Web.Api.ServiceAccountGetViewModel:
      type: object
      properties:
        name:
          maxLength: 50
          minLength: 0
          pattern: '[^/]+$'
          type: string
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        apiKeyId:
          type: string
        roleIds:
          type: array
          items:
            format: int64
            type: integer
        dateCreated:
          format: date-time
          type: string
        lastUsed:
          format: date-time
          type: string
    Dome9.Web.Api.ServiceAccountViewModel:
      type: object
      properties:
        name:
          maxLength: 50
          minLength: 0
          pattern: '[^/]+$'
          type: string
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        roleIds:
          type: array
          items:
            format: int64
            type: integer
  securitySchemes:
    API_key_V2:
      type: http
      scheme: basic