Pulumi InsightsAccounts API

The InsightsAccounts API from Pulumi — 35 operation(s) for insightsaccounts.

OpenAPI Specification

pulumi-insightsaccounts-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  description: APIs and Definitions for the Pulumi Cloud product.
  title: Pulumi APIs AccessTokens InsightsAccounts API
  version: 1.0.0
tags:
- name: InsightsAccounts
paths:
  /api/console/orgs/{orgName}/stacks/search:
    post:
      description: Returns a combined view of IaC-managed stacks and discovered stacks.
      operationId: SearchStacks
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AngularGridGetRowsRequest'
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationProjectsResponsev3'
          description: OK
        '400':
          description: Invalid request parameters
      summary: SearchStacks
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/orgs/{orgName}/insights-scans/summary:
    get:
      description: Returns a summary of Insights scan usage for an organization, grouped by the specified time granularity.
      operationId: GetUsageSummaryInsightsScans
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: 'Time granularity for grouping usage data. Valid values: ''hourly'', ''daily'', ''weekly'', ''monthly'', ''yearly''. Hourly granularity is limited to a 2-day lookback.'
        in: query
        name: granularity
        schema:
          type: string
      - description: Number of days to look back for usage data. Mutually exclusive with lookbackStart; exactly one must be provided.
        in: query
        name: lookbackDays
        schema:
          format: int64
          type: integer
      - description: Start of the lookback period as a Unix timestamp (seconds since epoch). Must be within the last year and in the past. Mutually exclusive with lookbackDays; exactly one must be provided.
        in: query
        name: lookbackStart
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetResourceCountSummaryResponse'
          description: OK
        '204':
          description: No Content
      summary: GetUsageSummaryInsightsScans
      tags:
      - InsightsAccounts
  /api/preview/insights/{orgName}/accounts:
    get:
      description: Lists Insights accounts available to the authenticated user within the specified organization.
      operationId: ListAccounts
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: Continuation token for paginated results
        in: query
        name: continuationToken
        schema:
          type: string
      - description: 'Number of results to return (default: 100, max: 1000)'
        in: query
        name: count
        schema:
          format: int64
          type: integer
      - description: Filter results to child accounts of the specified parent account name (e.g., an AWS organization management account)
        in: query
        name: parent
        schema:
          type: string
      - description: Filter results to accounts accessible by the specified role
        in: query
        name: roleID
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsAccountsResponse'
          description: successful operation
        '400':
          description: count must be in the range [1, 1000]
        '404':
          description: Organization or parent account not found
      summary: ListAccounts
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    post:
      description: Creates multiple Insights accounts in a single operation. Each account is created independently, so a failure to create one account does not prevent other accounts from being created. Returns the list of successfully created accounts and details about any failures. Accounts are created with the same permissions as the single CreateAccount endpoint. For AWS accounts, regional child accounts are created automatically based on the provider configuration.
      operationId: BulkCreateAccounts
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateInsightsAccountsRequest'
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkCreateInsightsAccountsResponse'
          description: OK
        '400':
          description: Invalid request body or empty accounts list
        '404':
          description: Organization not found
      summary: BulkCreateAccounts
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}:
    delete:
      description: Deletes an Insights account and its associated configuration. This operation is irreversible.
      operationId: DeleteAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '404':
          description: Account
      summary: DeleteAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    get:
      description: Gets detailed information for a specific Insights account.
      operationId: ReadAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadInsightsAccountResponse'
          description: successful operation
        '404':
          description: Account
      summary: ReadAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    head:
      description: Checks whether an Insights account exists. Returns 204 if found, 404 otherwise.
      operationId: HeadAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '404':
          description: Account
      summary: HeadAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    patch:
      description: Updates an existing Insights account. Supports partial updates to the ESC environment reference, scan schedule ('none' or 'daily'), and provider-specific configuration such as the list of regions to scan. All request body fields are optional; only provided fields are updated.
      operationId: UpdateAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInsightsAccountRequest'
        x-originalParamName: body
      responses:
        '204':
          description: No Content
        '400':
          description: invalid provider config
        '404':
          description: Account or environment not found
      summary: UpdateAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    post:
      description: Creates a new Insights account. An Insights account represents a cloud provider account (e.g., AWS, Azure, OCI) configured for resource discovery.
      operationId: CreateAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInsightsAccountRequest'
        x-originalParamName: body
      responses:
        '204':
          description: No Content
        '400':
          description: invalid account name
        '404':
          description: Organization or environment not found
      summary: CreateAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/policy/packs:
    get:
      description: Returns the policy packs configured to analyze resources in the specified Insights account.
      operationId: ListPolicyPacksForAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: Continuation token for paginated results
        in: query
        name: continuationToken
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPolicyPacksForInsightsAccountResponse'
          description: successful operation
        '400':
          description: invalid continuation token
        '404':
          description: Account
      summary: ListPolicyPacksForAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources:
    post:
      description: Creates or updates discovered resources in an Insights account. Used by scanners to report resource state.
      operationId: UpsertResources
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertInsightsResourcesRequest'
        x-originalParamName: body
      responses:
        '204':
          description: No Content
        '404':
          description: Account
      summary: UpsertResources
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/references:
    post:
      description: Returns discovered resources along with their referenced resources for a batch of resource identifiers.
      operationId: ListResourcesWithReferences
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListResourcesWithReferencesRequest'
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/InsightsResourceWithReferences'
                type: array
          description: successful operation
        '404':
          description: Account or Resource Identifier
      summary: ListResourcesWithReferences
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}:
    get:
      description: Returns a discovered resource with its current version details.
      operationId: ReadResource
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightsResourceWithVersion'
          description: successful operation
        '400':
          description: invalid resource version
        '404':
          description: Account
      summary: ReadResource
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/edges:
    get:
      description: Returns the relationships (edges) between a discovered resource and other resources in the account.
      operationId: ListResourceVersionEdges
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      - description: Continuation token for paginated results
        in: query
        name: continuationToken
        schema:
          type: string
      - description: 'Number of results to return (default: 100, max: 500)'
        in: query
        name: count
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsResourceVersionEdgesResponse'
          description: successful operation
        '400':
          description: count must be in the range [1, 500]
        '404':
          description: Account
      summary: ListResourceVersionEdges
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/references:
    get:
      description: Returns a discovered resource along with its referenced (related) resources.
      operationId: ReadResourceWithReferences
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightsResourceWithReferences'
          description: successful operation
      summary: ReadResourceWithReferences
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/stack_edges:
    get:
      description: Returns the Pulumi stacks that manage the specified discovered resource.
      operationId: ListResourceStackEdges
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id' (e.g., 'aws:ec2/instance:Instance::i-1234567890abcdef0')
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsResourceStackEdgesResponse'
          description: successful operation
        '404':
          description: Account
      summary: ListResourceStackEdges
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/versions:
    get:
      description: Returns the version history for a discovered resource, showing how its configuration has changed over time.
      operationId: ListResourceVersions
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      - description: Continuation token for paginated results
        in: query
        name: continuationToken
        schema:
          type: string
      - description: 'Number of results to return (default: 100, max: 500)'
        in: query
        name: count
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsResourceVersionsResponse'
          description: successful operation
        '400':
          description: count must be in the range [1, 500]
        '404':
          description: Account
      summary: ListResourceVersions
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/versions/{resourceVersion}:
    get:
      description: Returns a discovered resource with its current or specified version details.
      operationId: ReadResource_versions
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      - description: The specific version number of the discovered resource to retrieve
        in: path
        name: resourceVersion
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InsightsResourceWithVersion'
          description: successful operation
        '400':
          description: invalid resource version
        '404':
          description: Account
      summary: ReadResource
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/versions/{resourceVersion}/edges:
    get:
      description: Returns the relationships (edges) between a discovered resource and other resources in the account.
      operationId: ListResourceVersionEdges_versions
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      - description: The specific version number of the resource to list edges for
        in: path
        name: resourceVersion
        required: true
        schema:
          format: int64
          type: integer
      - description: Continuation token for paginated results
        in: query
        name: continuationToken
        schema:
          type: string
      - description: 'Number of results to return (default: 100, max: 500)'
        in: query
        name: count
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListInsightsResourceVersionEdgesResponse'
          description: successful operation
        '400':
          description: count must be in the range [1, 500]
        '404':
          description: Account
      summary: ListResourceVersionEdges
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  ? /api/preview/insights/{orgName}/accounts/{accountName}/resources/{resourceTypeAndId}/versions/{resourceVersion}/policy/results
  : put:
      description: Updates the policy evaluation results for a specific version of a discovered resource.
      operationId: UpdateResourceVersionPolicyResults
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: The resource type and cloud provider ID, double-URL-encoded, in the format 'type::id'
        in: path
        name: resourceTypeAndId
        required: true
        schema:
          type: string
      - description: The specific version number of the discovered resource to update policy results for
        in: path
        name: resourceVersion
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateInsightsResourceVersionPolicyResultsRequest'
        x-originalParamName: body
      responses:
        '204':
          description: No Content
        '400':
          description: invalid resource version
        '404':
          description: Account or Resource Version
      summary: UpdateResourceVersionPolicyResults
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/scan:
    get:
      description: Returns the status of the most recent scan for an Insights account.
      operationId: ReadScanStatus
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanStatusResponse'
          description: successful operation
        '404':
          description: Scan for account
      summary: ReadScanStatus
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    post:
      description: Starts a resource discovery scan for an Insights account. For parent accounts, triggers scans across all child accounts.
      operationId: ScanAccount
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanInsightsAccountRequest'
        x-originalParamName: body
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowRun'
          description: OK. Returns the WorkflowRun representing the scan.
        '204':
          description: No Content. When scanning parent accounts.
        '400':
          description: Invalid request or scan already in progress
        '404':
          description: WorkflowRun
      summary: ScanAccount
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/scan/cancel:
    post:
      description: Cancels a running resource discovery scan for an Insights account.
      operationId: CancelScan
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '404':
          description: Account
      summary: CancelScan
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/scan/pause:
    post:
      description: PauseScheduledScans pauses execution of future scheduled scans for an Insights account.
      operationId: PauseScheduledScans
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      summary: PauseScheduledScans
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/scan/resume:
    post:
      description: ResumeScheduledScans resumes execution of future scheduled scans for an Insights account.
      operationId: ResumeScheduledScans
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      summary: ResumeScheduledScans
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/scan/settings:
    get:
      description: Returns the scheduled scan configuration for an Insights account, including scan frequency and schedule details.
      operationId: ReadScheduledScanSettings
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduledInsightsScanSettingsResponse'
          description: successful operation
        '404':
          description: Scheduled scan for account
      summary: ReadScheduledScanSettings
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
    put:
      description: Updates the scheduled scan configuration for an Insights account, such as scan frequency and schedule.
      operationId: UpdateScheduledScanSettings
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduledInsightsScanSettingsRequest'
        x-originalParamName: body
      responses:
        '204':
          description: No Content
        '400':
          description: Invalid scan schedule
      summary: UpdateScheduledScanSettings
      tags:
      - InsightsAccounts
      x-pulumi-route-property:
        Visibility: Preview
  /api/preview/insights/{orgName}/accounts/{accountName}/scans:
    get:
      description: Returns the scan history for an Insights account, including child accounts for parent accounts.
      operationId: ListScanStatus
      parameters:
      - description: The organization name
        in: path
        name: orgName
        required: true
        schema:
          type: string
      - description: The Insights account name
        in: path
        name: accountName
        required: true
        schema:
          type: string
      - description: Continuation token for paginated results
        in: query
        name: continuationToken
        schema:
          type: string
      - description: 'Number of results per page (default: 100, max: 1000)'
        in: query
        name: pageSize
        schema:
          format: int64
          type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListScanStatusResponse'
          description: successful operation
        '400':
          description: Invalid query params
        '404':
          description: Account
      summary: L

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