Insights Accounts

Returns a combined view of IaC-managed stacks and discovered stacks.

Request Parameters

• orgName string path required
  The organization name

Request Body

• startRow integer optional
  The start row
• endRow integer optional
  The end row
• rowGroupCols array[AngularGridColumn] required
  List of row group cols
• ↳ id string required
  The unique identifier
• ↳ displayName string required
  The display name
• ↳ field string optional
  The field
• ↳ aggFunc string optional
  The agg func
• valueCols array[AngularGridColumn] required
  List of value cols
• ↳ id string required
  The unique identifier
• ↳ displayName string required
  The display name
• ↳ field string optional
  The field
• ↳ aggFunc string optional
  The agg func
• groupKeys array[string] required
  List of group keys
• filterModel AngularGridAdvancedFilterModel required
  The filter model
• ↳ type string required
  The type
• ↳ conditions array[AngularGridFilterModel] required
  List of conditions
• sortModel array[AngularGridSortModelItem] required
  List of sort model
• ↳ colId string required
  Column Id to apply the sort to.
• ↳ sort string required
  Sort direction

Responses

Returns a summary of Insights scan usage for an organization, grouped by the specified time granularity.

Request Parameters

• orgName string path required
  The organization name
• granularity string query optional
  Time granularity for grouping usage data. Valid values: ‘hourly’, ‘daily’, ‘weekly’, ‘monthly’, ‘yearly’. Hourly granularity is limited to a 2-day lookback.
• lookbackDays integer query optional
  Number of days to look back for usage data. Mutually exclusive with lookbackStart; exactly one must be provided.
• lookbackStart integer query optional
  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.

Responses

Lists Insights accounts available to the authenticated user within the specified organization.

Request Parameters

• orgName string path required
  The organization name
• continuationToken string query optional
  Continuation token for paginated results
• count integer query optional
  Number of results to return (default: 100, max: 1000)
• parent string query optional
  Filter results to child accounts of the specified parent account name (e.g., an AWS organization management account)
• roleID string query optional
  Filter results to accounts accessible by the specified role

Responses

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.

Request Parameters

• orgName string path required
  The organization name

Request Body

• accounts array[BulkCreateInsightsAccountItem] required
  The list of accounts to create. Each item defines a single Insights account with its provider, ESC environment reference, and optional configuration. Maximum 100 accounts per request.
• ↳ name string required
  The name of the account to create. Must be unique within the organization.
• ↳ provider enum required
  The cloud provider for the account (e.g., aws, gcp, azure-native).
  Values: aws, gcp, azure-native, oci, kubernetes
• ↳ environment string required
  Reference to an ESC environment containing provider credentials, in the format ‘project/environment’ with an optional @version suffix.
• ↳ scanSchedule enum optional
  Schedule for automated discovery scans (e.g., ’none’, ‘daily’).
  Values: none, 12h, daily
• ↳ agentPoolID string optional
  The ID of the agent pool to run account discovery workflows. If not specified, discovery will use the default agent pool.
• ↳ providerConfig object optional
  Provider-specific configuration for the account.

Responses

Gets detailed information for a specific Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Creates a new Insights account. An Insights account represents a cloud provider account (e.g., AWS, Azure, OCI) configured for resource discovery.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• provider enum required
  The cloud provider for the account (e.g., aws, gcp, azure-native).
  Values: aws, gcp, azure-native, oci, kubernetes
• environment string required
  Reference to an ESC environment containing provider credentials, in the format ‘project/environment’ with an optional @version suffix.
• cron string optional
  Deprecated: Use scanSchedule instead. Cron expression for scheduling scans.
• scanSchedule enum optional
  Schedule for automated discovery scans (e.g., ’none’, ‘daily’).
  Values: none, 12h, daily
• agentPoolID string optional
  The ID of the agent pool to run account discovery workflows. If not specified, discovery will use the default agent pool.
• providerConfig object optional
  Provider-specific configuration for the account.

Responses

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.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• environment string required
  Reference to an ESC environment containing provider credentials, in the format ‘project/environment’ with an optional @version suffix.
• scanSchedule enum optional
  Schedule for automated discovery scans (e.g., ’none’, ‘daily’).
  Values: none, 12h, daily
• providerConfig object optional
  Provider-specific configuration for the account.
• agentPoolID string optional
  The ID of the agent pool to run account discovery workflows. If not specified, discovery will use the default agent pool.

Responses

Deletes an Insights account and its associated configuration. This operation is irreversible.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Checks whether an Insights account exists. Returns 204 if found, 404 otherwise.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Returns the policy packs configured to analyze resources in the specified Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• continuationToken string query optional
  Continuation token for paginated results

Responses

Creates or updates discovered resources in an Insights account. Used by scanners to report resource state.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• resources array[UpsertInsightsResource] required
  The list of resources to upsert.
• ↳ type string required
  The resource type.
• ↳ id string required
  The unique identifier of the resource.
• ↳ inputs object required
  The resource inputs as raw JSON.
• ↳ state object required
  The resource state as raw JSON.
• ↳ dependencies array[ResourceDependency] optional
  The chain of dependencies used to list this resource.

Responses

Returns a discovered resource with its current version details.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'

Responses

Returns the relationships (edges) between a discovered resource and other resources in the account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'
• continuationToken string query optional
  Continuation token for paginated results
• count integer query optional
  Number of results to return (default: 100, max: 500)

Responses

Returns a discovered resource along with its referenced (related) resources.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'

Responses

Returns the Pulumi stacks that manage the specified discovered resource.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id’ (e.g., ‘aws:ec2/instance:Instance::i-1234567890abcdef0’)

Responses

Returns the version history for a discovered resource, showing how its configuration has changed over time.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'
• continuationToken string query optional
  Continuation token for paginated results
• count integer query optional
  Number of results to return (default: 100, max: 500)

Responses

Returns a discovered resource with its current or specified version details.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'
• resourceVersion string path required
  The specific version number of the discovered resource to retrieve

Responses

Returns the relationships (edges) between a discovered resource and other resources in the account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'
• resourceVersion integer path required
  The specific version number of the resource to list edges for
• continuationToken string query optional
  Continuation token for paginated results
• count integer query optional
  Number of results to return (default: 100, max: 500)

Responses

Updates the policy evaluation results for a specific version of a discovered resource.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• resourceTypeAndId string path required
  The resource type and cloud provider ID, double-URL-encoded, in the format ’type::id'
• resourceVersion string path required
  The specific version number of the discovered resource to update policy results for

Request Body

• claimId string required
  The claim ID for the policy evaluation.
• results InsightsPolicyResults required
  The policy evaluation results.
• ↳ succeeded boolean required
  Whether the policy evaluation succeeded without violations
• ↳ violations array[InsightsPolicyViolation] optional
  The list of policy violations found, if any

Responses

Returns discovered resources along with their referenced resources for a batch of resource identifiers.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• resourceIdentifiers array[InsightsResourceIdentifier] required
  The resource identifiers to look up
• ↳ account string required
  The account name containing the resource
• ↳ type string required
  The resource type
• ↳ id string required
  The resource identifier
• ↳ version integer optional
  If nil, the latest version is used
• depth integer optional
  The depth of references to traverse

Responses

Returns the status of the most recent scan for an Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Starts a resource discovery scan for an Insights account. For parent accounts, triggers scans across all child accounts.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• agentPoolID string optional
  The ID of the agent pool to use for scanning. If not specified, the default agent pool will be used.
• listConcurrency integer optional
  The concurrency level for list operations during the scan.
• readConcurrency integer optional
  The concurrency level for read operations during the scan.
• batchSize integer optional
  The batch size for processing resources during the scan.
• readTimeout string optional
  The timeout duration for read operations, as a Go duration string (e.g., ’30s’, ‘5m’).

Responses

Cancels a running resource discovery scan for an Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

PauseScheduledScans pauses execution of future scheduled scans for an Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

ResumeScheduledScans resumes execution of future scheduled scans for an Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Returns the scheduled scan configuration for an Insights account, including scan frequency and schedule details.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Updates the scheduled scan configuration for an Insights account, such as scan frequency and schedule.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• listConcurrency integer optional
  The concurrency level for list operations during the scan.
• scheduleCron string optional
  The cron expression defining the scan schedule.
• paused boolean required
  Whether the scheduled scan is paused.
• readConcurrency integer optional
  The concurrency level for read operations during the scan.
• batchSize integer optional
  The batch size for processing resources during the scan.
• readTimeout string optional
  The timeout duration for read operations, as a Go duration string (e.g., ’30s’, ‘5m’).

Responses

Returns the scan history for an Insights account, including child accounts for parent accounts.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• continuationToken string query optional
  Continuation token for paginated results
• pageSize integer query optional
  Number of results per page (default: 100, max: 1000)

Responses

Returns details for a specific Insights scan, including its status, timestamps, and resource counts.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• scanId string path required
  The scan identifier

Responses

Returns log output for a specific Insights scan. Supports two modes: when the ‘job’ parameter is provided, returns step-level logs with job/step offsets; otherwise, uses continuationToken and count for paginated log retrieval.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• scanId string path required
  The scan identifier
• continuationToken string query optional
  Continuation token for paginated results. Used when the ‘job’ parameter is not provided.
• count integer query optional
  Number of log entries to return (must be between 1 and 500). Used when the ‘job’ parameter is not provided.
• job integer query optional
  When provided, switches to step-based log retrieval. Specifies the job number whose step logs to fetch.
• offset integer query optional
  Byte offset within the step’s log output. Used with the ‘job’ and ‘step’ parameters.
• step integer query optional
  Step number within the specified job. Used with the ‘job’ parameter.

Responses

Returns all tags for an Insights account as a key-value map.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Atomically replaces all tags for an Insights account with the provided key-value pairs. For AWS parent accounts, tag changes cascade to all child accounts.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Request Body

• tags map[string]string required
  The tags to set on the Insights account.

Responses

Returns the teams that have been granted access to an Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name

Responses

Updates the permissions that a team has on an Insights account.

Request Parameters

• orgName string path required
  The organization name
• accountName string path required
  The Insights account name
• teamName string path required
  The team name

Request Body

• permissions enum optional
  Permissions the permissions that team membership grants to the account. Will overwrite any existing permissions the team grants to the account. A nil value will remove the account from the team.
  Values: 0, 1, 2, 3

Responses

Returns details for a discovered project, including its discovered stacks. Results are paginated; use the continuationToken from the response to fetch subsequent pages.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The discovered project name
• continuationToken string query optional
  Opaque token for fetching the next page of stacks

Responses

Returns details for a single discovered stack.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The discovered project name
• stackName string path required
  The discovered stack name

Responses

Creates or updates a migration annotation on a discovered resource. The resource is identified by its URN in the request body. At least one of note or statusOverride must be non-empty; requests with both empty are rejected with 400. The statusOverride, if provided, must be Migrated or NotApplicable.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The discovered project name
• stackName string path required
  The discovered stack name

Request Body

• resourceUrn string required
  URN of the resource to annotate.
• note string optional
  Free-text note about this resource. May be empty when only setting a status override.
• statusOverride enum optional
  Override the computed migration status. Only Migrated and NotApplicable are valid values.
  Values: Migrated, PulumiOnly, Ready, Pending, Unmapped, NotApplicable
• linkedResourceUrn string optional
  URN of the resource this one was migrated as part of.

Responses

Removes a migration annotation from a discovered resource. The resource is identified by its URN passed as a query parameter.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The discovered project name
• stackName string path required
  The discovered stack name
• resourceUrn string query required
  URN of the resource to remove the annotation from

Responses

Returns the list of resources in a discovered stack, each annotated with a migrationStatus. When compareTo is provided, resource identities are matched against the target Pulumi stack.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The discovered project name
• stackName string path required
  The discovered stack name
• compareTo string query optional
  Pulumi stack to compare against in project/stack format. Must be in the same org.

Responses

Generates Pulumi code in the specified language to import discovered resources into a Pulumi stack.

Request Parameters

• orgName string path required
  The organization name

Request Body

• language string required
  The programming language for the generated import code
• urns array[string] required
  The URNs of the resources to generate import code for

Responses

Accepts Insights billing charges for the specified organization, enabling metered billing for resource discovery.

Request Parameters

• orgName string path required
  The organization name

Responses

Terminates the Insights trial for the organization and removes all associated accounts.

Request Parameters

• orgName string path required
  The organization name

Responses

Returns a summary of the organization’s Insights trial usage, including resource counts and remaining trial capacity.

Request Parameters

• orgName string path required
  The organization name

Responses

Updates the policy evaluation results for a specific stack update version.

Request Parameters

• orgName string path required
  The organization name
• projectName string path required
  The project name
• stackName string path required
  The stack name
• version integer path required
  The stack update version number identifying a specific Pulumi update operation

Request Body

• claimId string required
  The claim ID for the policy evaluation.
• results InsightsPolicyResults required
  The policy evaluation results.
• ↳ succeeded boolean required
  Whether the policy evaluation succeeded without violations
• ↳ violations array[InsightsPolicyViolation] optional
  The list of policy violations found, if any

Responses