openapi: 3.2.0 info: title: CoreStack External Resource API version: 1.0.0 termsOfService: http://corestack.io/ license: name: CoreStack Inc License url: http://corestack.io/licenses/LICENSE-2.0.html description: Resource Pillar servers: - url: / tags: - name: Resource description: Resource Pillar paths: /resource/inventory/{tenant_id}/cloud_account: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/RediscoverResponse' summary: Getting the resources cloud account details based on the tenant description: Getting the resources cloud account details based on the tenant operationId: FilterCloudAccount parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: Cloud Service Name in: query x-cs-enum-type: CloudServiceName required: true name: service_name schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS security: - auth_token: [] tags: - Resource /resource/inventory/{tenant_id}/count: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CategoryCountResponse' summary: Get Inventory Count description: Get inventory category count based on the cloud and cloud account will list categories & Get inventory resource count based on the cloud and cloud account will list all resources with resource_category, resource_type, resource and will list only the count on number of resources available in particular category operationId: GetInventoryCount parameters: - name: tenant_id in: path required: true description: Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/CategoryCountRequest' required: true /resource/inventory/{tenant_id}/filters: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InventoryResponse' summary: List Inventory Filters description: 'Get all the available filters for the corresponding cloud.Listing filter attributes will help us in getting resource details with the filters listed can be applied on the resource details call and this api is only to list filtersfor ex: AWS will have regions and tags as filters available and Azure will have resource groups and tags as filters' operationId: ListInventoryFilters parameters: - name: tenant_id in: path required: true description: Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string - description: Name of the cloud in: query x-cs-enum-type: CloudServiceName required: true name: service_name schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryFilterRequest' required: true /resource/inventory/{tenant_id}/resource_listing: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/ResourceListingResponse' summary: Get Resource Listing description: Listing the Resource details operationId: GetResourceList parameters: - name: tenant_id in: path required: true description: Specify the tenant ID for the Resource. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceListingRequest' required: true /resource/inventory/{tenant_id}/resources: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InventoryResourceDetailsResponse' summary: Get Inventory Details description: 'Get resource details based on the cloud accounts, category, component, resource and filters can be applied based on the cloud and cloud account for ex: AWS will have regions in filters and Azure will have resource group as filters for listing resources.' operationId: GetInventoryDetails parameters: - name: tenant_id in: path required: true description: Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/InventoryResourceDetailsRequest' required: true /resource/locks/{tenant_id}/list_config_rules: parameters: - name: tenant_id in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListLockConfigRuleResponse' summary: List Resource Lock Config Rules description: Resource posture dashboard operationId: ListConfigRules parameters: - description: to filter locks by tenant or cloud account wise required: true name: scope in: query schema: type: string enum: - cloud_account - tenant security: - auth_token: [] tags: - Resource /resource/locks/{tenant_id}/lock_config_rule: delete: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Removed content: application/json: schema: type: boolean summary: Delete Resource Lock Config Rule description: Delete a lock config rule under a CoreStack operationId: DeleteLockConfigRule parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/DeleteLockConfigRuleRequest' required: true post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateLockConfigRuleResponse' summary: Create Resource Lock Config Rule description: Creates a new lock config rule under a CoreStack operationId: createLockConfigRule parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateResourceLockRequest' required: true /resource/posture/account_or_tenant/visibility: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResourceVisibilityResponse' summary: List Resource Visibility Count description: Resource visibility dashboard operationId: ListVisibilityCount parameters: - description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. name: tenant_id in: query schema: type: string - description: to filter resource data count by region, resource or account required: true name: sub_category in: query schema: type: string enum: - resource_type - application - account - region - resource_group - resource_category - description: filter data by cloud in: query x-cs-enum-type: CloudServiceName required: true name: cloud schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS - description: filter data by cloud account.Invalid if sub_Category by value is account name: cloud_account_id in: query schema: type: string security: - auth_token: [] tags: - Resource /resource/posture/account_or_tenant/visibility/resources_without_locks_or_tags: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResourceVisibilityListResponse' summary: List Resource Visibility Details description: Resource Visibility dashboard operationId: ListResourceVisibility parameters: - description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. required: true name: tenant_id in: query schema: type: string - description: filter data by cloud in: query x-cs-enum-type: CloudServiceName required: true name: cloud schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS - description: filter data by cloud account name: cloud_account_id in: query schema: type: string - description: to list resource data without tags, locks required: true name: filter_by in: query schema: type: string enum: - tags - locks - description: Number of records to display name: limit in: query schema: type: integer - description: Page number name: page in: query schema: type: integer security: - auth_token: [] tags: - Resource /resource/posture/list: get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResourcePostureResponse' summary: List Resource Posture Details description: Resource posture dashboard operationId: ListResourcePosture parameters: - description: to filter data by cloud provider or cloud account wise.By default tenant wise data displayed name: sub_category in: query schema: type: string enum: - cloud_account - cloud_provider - description: Specify the tenant ID as comma separated. This is a unique ID and can be retrieved using the List Tenants API. required: true name: tenant_ids in: query schema: type: string - description: Select one from the supported services to display summary for that particular service in: query x-cs-enum-type: CloudServiceName required: false name: service_name schema: type: string enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter default: AWS - description: Search by account_name wise name: search in: query schema: type: string - description: Number of records to display name: limit in: query schema: type: integer - description: Page number name: page in: query schema: type: integer security: - auth_token: [] tags: - Resource /resource/{tenant_id}/locks/{cloud}/get_filters: parameters: - name: tenant_id in: path required: true schema: type: string - name: cloud in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ScopeFilter' summary: List Resource Lock Config Rule Filters description: Resource lock operationId: ListConfigRuleFilters parameters: - description: to get tags keys of cloud account name: tags in: query schema: type: boolean - description: get resource filters of cloud account name: resources in: query schema: type: boolean - description: get filters for tags of cloud account name: is_tag_wise in: query schema: type: boolean - description: to list of regions of cloud account name: region in: query schema: type: boolean - description: to list resource groups of cloud account name: resource_group in: query schema: type: boolean - description: to list zone of cloud account name: zone in: query schema: type: boolean - description: to list applicability filters of cloud account name: applicability_by in: query schema: type: boolean - description: cloud account id name: service_account_id in: query schema: type: string - description: scope name: scope in: query schema: type: string enum: - cloud_account - tenant security: - auth_token: [] tags: - Resource /v1/resource/alert_actions/{service_account_id}/disable: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Alert Rule Disabled content: application/json: schema: type: boolean summary: Disable Alert Rule description: Disable Alert Rule. operationId: DisableAlerts parameters: - name: service_account_id in: path required: true description: Specify the Service Account Id. This is a unique ID for each service account schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertActionRequest' required: true /v1/resource/alert_actions/{service_account_id}/enable: post: responses: '500': description: lInternal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Alert Rule Enabled content: application/json: schema: type: boolean summary: Enable Alert Rule description: Enable the Azure Alert Rule. operationId: EnableAlerts parameters: - name: service_account_id in: path required: true description: Specify the Service Account Id. This is a unique ID for each service account schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/AlertActionRequest' required: true /v1/resource/dashboard/detail: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfraResourceDetailResponse' summary: Retrieves resource detail view (overview and configuration) description: Retrieves detail view of a single infrastructure resource including identity, lifecycle metadata, and canonical configuration. operationId: InfraResourceDetail security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/InfraResourceDetailRequest' required: true /v1/resource/dashboard/detail/activity: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfraResourceActivityResponse' summary: Retrieves resource activity timeline or event attribute details description: 'Retrieves activity timeline or event details for a single infrastructure resource. Mode 1 (no event_ids): paginated timeline. Mode 2 (with event_ids): changed attribute details for diff.' operationId: InfraResourceActivity security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/InfraResourceActivityRequest' required: true /v1/resource/dashboard/trend/list: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/InfraResourceTrendResourceResponse' summary: List of infra resource details captured for given summary filters description: List of infra resource IDs captured for given trend summary. operationId: ListInfraResourceTrendSummary security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/InfraResourceTrendSummaryListRequest' required: true /v1/resource/dashboard/trend/summary: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/InfraResourceTrendSummary' summary: Retrieves trend summary of infrastructure resources description: Retrieves trend summary of infrastructure resources operationId: InfraResourceTrendSummary security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/InfraResourceTrendSummaryRequest' required: true /v1/resource/gcp/sku_details_for_resource: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/GcpResourceSkuDetailsResponse' summary: Get GCP sku details for the given resource description: Fetch sku details for the given GCP account operationId: GcpSkuDetailsForResource security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/GcpResourceSkuDetailsRequest' required: true /v1/resource/inventory/item/{corestack_resource_id}: parameters: - name: corestack_resource_id in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ServiceResourceInventoryDetails' summary: Get ServiceResourceInventory Details description: Get resource details from the ServiceResourceInventory operationId: get_get_service_resource_inventory security: - auth_token: [] tags: - Resource /v1/resource/inventory/lookup: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceResourceInventoryLookup' summary: Lookup ServiceResourceInventory Service Accounts description: List resource Service Account from ServiceResourceInventory operationId: post_service_resource_inventory_lookup security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceResourceInventoryLookupRequest' required: true /v1/resource/log_analytics/list_workspaces: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: type: array description: list of log analytic workspaces at the tenant level items: $ref: '#/components/schemas/WorkspaceDataForServiceAccount' summary: List of Log Analytics Workspaces at Tenant Level description: List Log Analytics Workspaces operationId: ListLogAnalyticsWorkspaces security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ListLogAnalyticsWorkspaceRequest' required: true /v1/resource/smallest_sku_region: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResourceUnitPriceCheapestSkuResponse' summary: Get unit price of smallest sku for a specific region description: Fetch unit price of smallest sku for a specific region operationId: SmallestSkuRegion security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceUnitPriceCheapestSkuRequest' required: true /v1/resource/tags/bulk_remediation: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BulkTagRemediationResponse' summary: Create Bulk Resource Tag Remediation description: Create Bulk Tag Remediation operationId: CreateBulkTagRemediation security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkTagRemediationRequest' required: true /v1/resource/tags/bulk_remediation_status: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/BulkTagRemediationStatusResponse' summary: Return bulk Resource Tag Remediation Status description: Bulk Tag Remediation Status operationId: CheckBulkTagRemediationStatus security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkTagRemediationStatusRequest' required: true /v1/resource/tags/remediation/{tenant_id}: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '201': description: Created content: application/json: schema: $ref: '#/components/schemas/CreateRemediationResponse' summary: Create Resource Tag Remediation description: Create Tag Remediation operationId: createRemediation parameters: - name: tenant_id in: path required: true description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. schema: type: string security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/TagRemediationRequest' required: true /v1/resource/unit_price: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ResourceUnitPriceResponse' summary: Get unit price for list of resources description: Fetch unit price for list of resources operationId: UnitPriceForResources security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceUnitPriceRequest' required: true /v1/resource/virtual_machine_agents/batch: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched successfully content: application/json: schema: $ref: '#/components/schemas/VirtualMachineAgentsBatchResponse' summary: Batch VM Agents Details description: Batch VM Agents Details. operationId: BatchVirtualMachineAgentsDetails security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/BatchRequest' required: true /v1/resource/virtual_machine_agents/list: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Listed successfully content: application/json: schema: $ref: '#/components/schemas/ListResponse' summary: List VM Agents Details description: List VM Agents Details. operationId: ListVirtualMachineAgentsDetails security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/VirtualMachineAgentsListRequest' required: true /v2/resource_inventory/batch: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: $ref: '#/components/schemas/ServiceResourceBatchResponse' summary: Batch Service Resource Details description: Retrieve the Service Resource details for the specified ids operationId: BatchServiceResource security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectIdBatchRequest' required: true /v2/resource_inventory/list: post: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Fetched content: application/json: schema: $ref: '#/components/schemas/ServiceResourceListResponse' summary: List Service Resources description: Retrieve the ids of service resources matching the filtering criteria operationId: ListServiceResources security: - auth_token: [] tags: - Resource requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceResourceListRequest' required: true /v2/resources/{inventory_id}/dependent_resources: parameters: - name: inventory_id in: path required: true schema: type: string get: responses: '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ModelError' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ModelError' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ModelError' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ModelError' '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DependentResourcesListResponse' summary: Fetch all dependent resources description: Fetch all Dependent Resources. operationId: CloudDependentResources security: - auth_token: [] tags: - Resource components: schemas: PostureResourceModel: required: - billable - count - non_billable - resource properties: resource: type: string description: resource name count: type: integer description: total count details billable: type: integer description: billable count details non_billable: type: integer description: non_billable count details type: object VirtualMachineAgentsBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/VirtualMachineAgentSummary' type: object ServiceResourceInventoryLookup: required: - corestack_resource_id - service_account_id properties: corestack_resource_id: type: string description: ID of the resource x-cs-type: ObjectId service_account_id: type: string description: ID of the service account x-cs-type: ObjectId type: object CreateRemediationResponse: properties: resource_enforce_tag_id: type: string description: Tag Remediation ID type: object InventoryData: required: - data - type properties: data: type: array description: Filters available in inventory items: type: object type: type: string description: Type of the data available in models list type: object InfraResourceTrendListBaseFilters: allOf: - $ref: '#/components/schemas/InfraResourceTrendSummaryBaseFilters' - properties: search: type: string description: Search based on resource category, resource type,resource name or resource ID. type: object GcpResourceSkuDetailsResponse: properties: sku_list: type: array description: SKU list items: type: string type: object ScopeResourceGroup: properties: name: type: string description: Name for resource id: type: string description: Id for resource type: object ResourceListingResponse: properties: id: type: string description: Id of the resources name: type: string description: Name of the resource type: object BulkTagRemediationRequest: required: - remediation_inputs - service_account_id properties: service_account_id: type: string description: Service Account Id x-cs-type: ObjectId remediation_inputs: type: array items: $ref: '#/components/schemas/TagsRemediation' type: object VirtualMachineAgentsSummarySortCriteria: required: - column properties: column: type: string example: resource_name enum: - resource_name x-cs-enum-type: VirtualMachineAgentsSummarySortColumn ascending: type: boolean type: object CountDetailsDataModel: required: - cloud_account - service properties: cloud_account: type: array description: Id's for the cloud account items: $ref: '#/components/schemas/CloudAccountDetail' service: type: string description: Cloud service name example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName default_value: type: boolean description: "Default value [by default: false]\nIf default = true, displays count only for that particular default_resource/default_category \nIf default = false, displays count for all the category/resource except that mentioned in default_resource/default_category." default: false category: type: string description: "Category value [by default: Compute]\n Give this value if the value of identifier is resource.\nDisplays all the resources for the particular category provided." default_resource: type: string description: 'Default resource [by default: based upon Category] Give this value if the value of identifier is resource. Displays count for resource.' default_category: type: string description: "Default category [by default: Compute]\n Give this value if the value of identifier is category.\nDisplays count for category." type: object DeleteLockConfigRuleRequest: properties: config_rule_id: type: string description: Config rule id, it can be fetched from List Resource Lock Config Rules API type: object FilterData: required: - regions - resource_groups properties: regions: type: array description: Displays the list of regions items: $ref: '#/components/schemas/ResourceFilterModel' resource_groups: type: array description: Displays the list of resource groups items: $ref: '#/components/schemas/ResourceFilterModel' type: object InfraResourceActivityRequest: required: - resource - resource_category - resource_id - resource_type - tenant_id properties: tenant_id: type: string description: Tenant ID. Can be fetched from the List Tenants API. x-cs-type: ObjectId resource_id: type: string description: Unique provider resource identifier. resource_category: type: string description: Category of the resource (e.g. Compute, Storage, Network). resource_type: type: string description: Type of the resource. resource: type: string description: Resources of the cloud provider (e.g. Instances, SecurityGroups). start_date: type: string format: date-time description: Start of retention window. Defaults to now minus 90 days. end_date: type: string format: date-time description: End of retention window. Defaults to today. change_type_filter: type: array items: type: string description: Filter timeline by InfraResourceChangeStatus values (e.g. new, modified, deleted). example: added enum: - added - unchanged - modified - deleted x-cs-enum-type: InfraResourceChangeStatus event_ids: type: array description: If provided (1-2 IDs), returns attribute details for these events (Mode 2). If absent, returns paginated timeline (Mode 1). items: type: string list_context: description: Pagination context. Used in Mode 1 only. Default batch_size=25. $ref: '#/components/schemas/ListContext' type: object PostureResourceListModel: required: - category - cloud_account_name - component - region_resourceGroup - resource - resource_id properties: cloud_account_name: type: string description: region name category: type: string description: category name component: type: string description: component name resource: type: string description: resource name resource_id: type: string description: resource id name region_resourceGroup: type: string description: region/ resource group name type: object InfraResourceDetailRequest: required: - resource - resource_category - resource_id - resource_type - tenant_id properties: tenant_id: type: string description: Tenant ID. Can be fetched from the List Tenants API. x-cs-type: ObjectId resource_id: type: string description: Unique provider resource identifier. service_account_id: type: string description: Cloud account ID to scope the lookup. x-cs-type: ObjectId resource_category: type: string description: Category of the resource (e.g. Compute, Storage, Network). resource_type: type: string description: Type of the resource. resource: type: string description: Resources of the cloud provider (e.g. Instances, SecurityGroups). type: object QueryOperator: required: - __type properties: {} discriminator: propertyName: __type type: object x-cs-subtypes: - subtype_model: QueryOperatorTrue subtype_name: QueryOperatorTrue - subtype_model: QueryOperatorFalse subtype_name: QueryOperatorFalse - subtype_model: QueryOperatorBinary subtype_name: QueryOperatorBinary - subtype_model: QueryOperatorBinaryLogic subtype_name: QueryOperatorBinaryLogic - subtype_model: QueryOperatorNary subtype_name: QueryOperatorNary - subtype_model: QueryOperatorNaryLogic subtype_name: QueryOperatorNaryLogic - subtype_model: QueryOperatorComparator subtype_name: QueryOperatorComparator - subtype_model: QueryOperatorComparatorLogic subtype_name: QueryOperatorComparatorLogic - subtype_model: QueryOperatorUnary subtype_name: QueryOperatorUnary - subtype_model: QueryOperatorUnaryNot subtype_name: QueryOperatorUnaryNot - subtype_model: QueryOperatorBinaryForGraph subtype_name: QueryOperatorBinaryForGraph - subtype_model: QueryOperatorBinaryLogicForGraph subtype_name: QueryOperatorBinaryLogicForGraph - subtype_model: QueryOperatorNaryForGraph subtype_name: QueryOperatorNaryForGraph - subtype_model: QueryOperatorNaryLogicForGraph subtype_name: QueryOperatorNaryLogicForGraph - subtype_model: QueryOperatorUnaryForGraph subtype_name: QueryOperatorUnaryForGraph - subtype_model: QueryOperatorUnaryNotForGraph subtype_name: QueryOperatorUnaryNotForGraph - subtype_model: ServiceAccountQueryOperator subtype_name: ServiceAccountQueryOperator - subtype_model: TenantQueryOperator subtype_name: TenantQueryOperator - subtype_model: DescendantServiceAccountQueryOperator subtype_name: DescendantServiceAccountQueryOperator - subtype_model: DescendantServiceAccountInTenantQueryOperator subtype_name: DescendantServiceAccountInTenantQueryOperator - subtype_model: TenantTagKeyQueryOperator subtype_name: TenantTagKeyQueryOperator - subtype_model: TenantTagKeyValueQueryOperator subtype_name: TenantTagKeyValueQueryOperator - subtype_model: LocationQueryOperator subtype_name: LocationQueryOperator - subtype_model: AvailabilityZoneQueryOperator subtype_name: AvailabilityZoneQueryOperator - subtype_model: BillingSourceQueryOperator subtype_name: BillingSourceQueryOperator - subtype_model: CurrencyQueryOperator subtype_name: CurrencyQueryOperator - subtype_model: ProductCategoryQueryOperator subtype_name: ProductCategoryQueryOperator - subtype_model: ProductFamilyQueryOperator subtype_name: ProductFamilyQueryOperator - subtype_model: ProductServiceCodeQueryOperator subtype_name: ProductServiceCodeQueryOperator - subtype_model: ProductSkuQueryOperator subtype_name: ProductSkuQueryOperator - subtype_model: PublisherQueryOperator subtype_name: PublisherQueryOperator - subtype_model: ResourceCategoryQueryOperator subtype_name: ResourceCategoryQueryOperator - subtype_model: ResourceIdQueryOperator subtype_name: ResourceIdQueryOperator - subtype_model: ResourceGroupQueryOperator subtype_name: ResourceGroupQueryOperator - subtype_model: ResourceNameQueryOperator subtype_name: ResourceNameQueryOperator - subtype_model: ResourceOperationQueryOperator subtype_name: ResourceOperationQueryOperator - subtype_model: ResourceQueryExtraPresence subtype_name: ResourceQueryExtraPresence - subtype_model: ResourceQueryExtraKey subtype_name: ResourceQueryExtraKey - subtype_model: ScopeContainsTenantQueryOperator subtype_name: ScopeContainsTenantQueryOperator - subtype_model: ScopeContainsServiceAccountQueryOperator subtype_name: ScopeContainsServiceAccountQueryOperator - subtype_model: ScopeIsQueryOperator subtype_name: ScopeIsQueryOperator - subtype_model: ServiceCategoryQueryOperator subtype_name: ServiceCategoryQueryOperator - subtype_model: ServiceTypeQueryOperator subtype_name: ServiceTypeQueryOperator - subtype_model: CompartmentNameQueryOperator subtype_name: CompartmentNameQueryOperator - subtype_model: ResourceQueryExtraKeyValue subtype_name: ResourceQueryExtraKeyValue - subtype_model: WorkFlowIdQueryOperator subtype_name: WorkFlowIdQueryOperator - subtype_model: RecommendationSubClassificationQueryOperator subtype_name: RecommendationSubClassificationQueryOperator - subtype_model: ServiceNowCmdbQuerySyncLogResourceId subtype_name: ServiceNowCmdbQuerySyncLogResourceId - subtype_model: ServiceNowCmdbQuerySyncLogResourceType subtype_name: ServiceNowCmdbQuerySyncLogResourceType - subtype_model: ServiceNowCmdbQuerySyncLogAction subtype_name: ServiceNowCmdbQuerySyncLogAction - subtype_model: ServiceNowCmdbQuerySyncLogStatus subtype_name: ServiceNowCmdbQuerySyncLogStatus - subtype_model: ServiceNowCmdbQuerySyncLogService subtype_name: ServiceNowCmdbQuerySyncLogService - subtype_model: ServiceAccountNativeDetailsQueryOperator subtype_name: ServiceAccountNativeDetailsQueryOperator - subtype_model: ServiceAccountStatusQueryOperator subtype_name: ServiceAccountStatusQueryOperator - subtype_model: ServiceAccountTagKeyQueryOperator subtype_name: ServiceAccountTagKeyQueryOperator - subtype_model: ServiceAccountTagKeyRegexQueryOperator subtype_name: ServiceAccountTagKeyRegexQueryOperator - subtype_model: ServiceAccountTagKeyValueQueryOperator subtype_name: ServiceAccountTagKeyValueQueryOperator - subtype_model: ApplicableHealthMetricsQueryOperator subtype_name: ApplicableHealthMetricsQueryOperator - subtype_model: EpssScoreRangeQueryOperator subtype_name: EpssScoreRangeQueryOperator - subtype_model: CvssMetricScoreRangeQueryOperator subtype_name: CvssMetricScoreRangeQueryOperator - subtype_model: GraphionScoreRangeQueryOperator subtype_name: GraphionScoreRangeQueryOperator - subtype_model: AppSecopsApplicationIdQueryOperator subtype_name: AppSecopsApplicationIdQueryOperator - subtype_model: AppSecopsPortfolioIdQueryOperator subtype_name: AppSecopsPortfolioIdQueryOperator - subtype_model: AppSecopsProjectIdQueryOperator subtype_name: AppSecopsProjectIdQueryOperator - subtype_model: AppSecopsSbomComponentIdQueryOperator subtype_name: AppSecopsSbomComponentIdQueryOperator - subtype_model: AppSecopsSbomVersionIdQueryOperator subtype_name: AppSecopsSbomVersionIdQueryOperator - subtype_model: AppSecopsComponentProductQueryOperator subtype_name: AppSecopsComponentProductQueryOperator - subtype_model: AppSecopsSbomComponentTypeQueryOperator subtype_name: AppSecopsSbomComponentTypeQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedByQueryOperator subtype_name: AppSecopsSbomVersionSubmittedByQueryOperator - subtype_model: AppSecopsSbomVersionSubmittedDateQueryOperator subtype_name: AppSecopsSbomVersionSubmittedDateQueryOperator - subtype_model: AppSecopsSbomVersionBuildIdQueryOperator subtype_name: AppSecopsSbomVersionBuildIdQueryOperator - subtype_model: AppSecopsSbomNameQueryOperator subtype_name: AppSecopsSbomNameQueryOperator - subtype_model: AppSecopsCveIdQueryOperator subtype_name: AppSecopsCveIdQueryOperator - subtype_model: AppSecopsEpssScoreQueryOperator subtype_name: AppSecopsEpssScoreQueryOperator - subtype_model: AppSecopsCvssScoreQueryOperator subtype_name: AppSecopsCvssScoreQueryOperator - subtype_model: AppSecopsGraphionScoreQueryOperator subtype_name: AppSecopsGraphionScoreQueryOperator - subtype_model: SecopsVulnerabilitySeverityQueryOperator subtype_name: SecopsVulnerabilitySeverityQueryOperator - subtype_model: AppSecopsIsKnownExploitedVulnerabilityQueryOperator subtype_name: AppSecopsIsKnownExploitedVulnerabilityQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator - subtype_model: AppSecopsFixAvailableQueryOperator subtype_name: AppSecopsFixAvailableQueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator - subtype_model: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator subtype_name: AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator - subtype_model: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator subtype_name: AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator - subtype_model: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator subtype_name: AppSecopsContainerFindingsSBOMVersionIdsQueryOperator - subtype_model: AppSecopsContainerFindingsCategoryQueryOperator subtype_name: AppSecopsContainerFindingsCategoryQueryOperator - subtype_model: AppSecopsContainerFindingsExecutionPhaseQueryOperator subtype_name: AppSecopsContainerFindingsExecutionPhaseQueryOperator - subtype_model: AppSecopsContainerFindingsSeverityQueryOperator subtype_name: AppSecopsContainerFindingsSeverityQueryOperator - subtype_model: AppSecopsContainerFindingsStatusQueryOperator subtype_name: AppSecopsContainerFindingsStatusQueryOperator - subtype_model: DimensionSourceQueryOperator subtype_name: DimensionSourceQueryOperator - subtype_model: DimensionQueryOperator subtype_name: DimensionQueryOperator - subtype_model: ResourceTypeQueryOperator subtype_name: ResourceTypeQueryOperator - subtype_model: PodIdRegexQueryOperator subtype_name: PodIdRegexQueryOperator - subtype_model: PodNameRegexQueryOperator subtype_name: PodNameRegexQueryOperator - subtype_model: ContainerIdRegexQueryOperator subtype_name: ContainerIdRegexQueryOperator - subtype_model: PodNamesQueryOperator subtype_name: PodNamesQueryOperator - subtype_model: PodIdsQueryOperator subtype_name: PodIdsQueryOperator - subtype_model: UtilizationTypeQueryOperator subtype_name: UtilizationTypeQueryOperator - subtype_model: ResourceIdRegexQueryOperator subtype_name: ResourceIdRegexQueryOperator - subtype_model: ResourceNameRegexQueryOperator subtype_name: ResourceNameRegexQueryOperator - subtype_model: ExtrasValueRegexQueryOperator subtype_name: ExtrasValueRegexQueryOperator - subtype_model: TagKeyValueRegexQueryOperator subtype_name: TagKeyValueRegexQueryOperator - subtype_model: ResourceQueryTagKeyKind subtype_name: ResourceQueryTagKeyKind - subtype_model: ResourceQueryTagKeyValuesKind subtype_name: ResourceQueryTagKeyValuesKind - subtype_model: TagKeyStringValueRegexQueryOperator subtype_name: TagKeyStringValueRegexQueryOperator - subtype_model: TagKindStringKeyRegexQueryOperator subtype_name: TagKindStringKeyRegexQueryOperator - subtype_model: ServiceAccountNameRegexQueryOperator subtype_name: ServiceAccountNameRegexQueryOperator - subtype_model: TenantNameRegexQueryOperator subtype_name: TenantNameRegexQueryOperator - subtype_model: PlatFormAccountQueryOperator subtype_name: PlatFormAccountQueryOperator - subtype_model: BillingLineItemTypeQueryOperator subtype_name: BillingLineItemTypeQueryOperator - subtype_model: BillingEntityQueryOperator subtype_name: BillingEntityQueryOperator - subtype_model: LineItemDescriptionQueryOperator subtype_name: LineItemDescriptionQueryOperator - subtype_model: LineItemDescriptionRegexQueryOperator subtype_name: LineItemDescriptionRegexQueryOperator - subtype_model: MeterSubCategoryQueryOperator subtype_name: MeterSubCategoryQueryOperator - subtype_model: PricingCategoryQueryOperator subtype_name: PricingCategoryQueryOperator - subtype_model: PricingPurchaseOptionQueryOperator subtype_name: PricingPurchaseOptionQueryOperator - subtype_model: TagKeyRegexQueryOperator subtype_name: TagKeyRegexQueryOperator - subtype_model: BillingLineItemTypeRegexQueryOperator subtype_name: BillingLineItemTypeRegexQueryOperator - subtype_model: ResourceGroupRegexQueryOperator subtype_name: ResourceGroupRegexQueryOperator - subtype_model: ResourceCategoryRegexQueryOperator subtype_name: ResourceCategoryRegexQueryOperator - subtype_model: ProductCategoryRegexQueryOperator subtype_name: ProductCategoryRegexQueryOperator - subtype_model: BillingEntityRegexQueryOperator subtype_name: BillingEntityRegexQueryOperator - subtype_model: ResourceOperationRegexQueryOperator subtype_name: ResourceOperationRegexQueryOperator - subtype_model: ResourceQueryFieldPresence subtype_name: ResourceQueryFieldPresence - subtype_model: AssessmentRunReportDetailQuerySection subtype_name: AssessmentRunReportDetailQuerySection - subtype_model: AssessmentRunReportSummaryQuerySection subtype_name: AssessmentRunReportSummaryQuerySection - subtype_model: AssessmentQueryAssessmentName subtype_name: AssessmentQueryAssessmentName - subtype_model: AssessmentQueryAssessmentOwner subtype_name: AssessmentQueryAssessmentOwner - subtype_model: AssessmentQueryAssessmentApprover subtype_name: AssessmentQueryAssessmentApprover - subtype_model: AssessmentQueryWorkload subtype_name: AssessmentQueryWorkload - subtype_model: AssessmentQueryFramework subtype_name: AssessmentQueryFramework - subtype_model: AssessmentQueryPillar subtype_name: AssessmentQueryPillar - subtype_model: AssessmentViewQueryNature subtype_name: AssessmentViewQueryNature - subtype_model: AssessmentViewQueryQuestionRisk subtype_name: AssessmentViewQueryQuestionRisk - subtype_model: AssessmentViewQueryBestPracticeRisk subtype_name: AssessmentViewQueryBestPracticeRisk - subtype_model: AssessmentViewQueryQuestionStatus subtype_name: AssessmentViewQueryQuestionStatus - subtype_model: AssessmentViewQueryBestPracticeStatus subtype_name: AssessmentViewQueryBestPracticeStatus - subtype_model: AssessmentViewQueryOwner subtype_name: AssessmentViewQueryOwner - subtype_model: AssessmentViewQueryAssignedTo subtype_name: AssessmentViewQueryAssignedTo - subtype_model: AssessmentViewQueryComment subtype_name: AssessmentViewQueryComment - subtype_model: AssessmentReportQueryAssessmentName subtype_name: AssessmentReportQueryAssessmentName - subtype_model: AssessmentReportQueryFramework subtype_name: AssessmentReportQueryFramework - subtype_model: AssessmentReportQueryReportType subtype_name: AssessmentReportQueryReportType - subtype_model: AssessmentReportQueryWorkloadId subtype_name: AssessmentReportQueryWorkloadId - subtype_model: ScheduleQueryName subtype_name: ScheduleQueryName - subtype_model: ScheduleQueryCreatedBy subtype_name: ScheduleQueryCreatedBy - subtype_model: ScheduleQueryEmailRecipients subtype_name: ScheduleQueryEmailRecipients - subtype_model: ScheduleQueryRecurrence subtype_name: ScheduleQueryRecurrence - subtype_model: ScheduleQueryReportType subtype_name: ScheduleQueryReportType - subtype_model: ScheduleQueryNextGenReportType subtype_name: ScheduleQueryNextGenReportType - subtype_model: ScheduleQueryAssessmentAgentReportType subtype_name: ScheduleQueryAssessmentAgentReportType - subtype_model: AutomationTemplateQueryEngineType subtype_name: AutomationTemplateQueryEngineType - subtype_model: AutomationTemplateQueryRepoType subtype_name: AutomationTemplateQueryRepoType - subtype_model: AutomationTemplateQueryService subtype_name: AutomationTemplateQueryService - subtype_model: AutomationTemplateQueryTenant subtype_name: AutomationTemplateQueryTenant - subtype_model: AwsSecurityHubFindingQueryLocation subtype_name: AwsSecurityHubFindingQueryLocation - subtype_model: AwsSecurityHubFindingQuerySeverity subtype_name: AwsSecurityHubFindingQuerySeverity - subtype_model: AwsSecurityHubFindingQueryProductName subtype_name: AwsSecurityHubFindingQueryProductName - subtype_model: AwsSecurityHubFindingQueryResource subtype_name: AwsSecurityHubFindingQueryResource - subtype_model: AwsSecurityHubFindingQueryCloudAccount subtype_name: AwsSecurityHubFindingQueryCloudAccount - subtype_model: AwsSecurityHubFindingQueryRecordState subtype_name: AwsSecurityHubFindingQueryRecordState - subtype_model: AwsSsmDocumentQueryCloudAccount subtype_name: AwsSsmDocumentQueryCloudAccount - subtype_model: AwsSsmDocumentQueryRegion subtype_name: AwsSsmDocumentQueryRegion - subtype_model: AwsSsmDocumentQueryOwner subtype_name: AwsSsmDocumentQueryOwner - subtype_model: AwsSsmDocumentQueryCategory subtype_name: AwsSsmDocumentQueryCategory - subtype_model: AwsSsmDocumentQueryStatus subtype_name: AwsSsmDocumentQueryStatus - subtype_model: AwsSsmDocumentQueryName subtype_name: AwsSsmDocumentQueryName - subtype_model: AwsSsmDocumentQueryExecutedBy subtype_name: AwsSsmDocumentQueryExecutedBy - subtype_model: ComplianceURIQueryOperator subtype_name: ComplianceURIQueryOperator - subtype_model: DurationInMonthsQueryOperator subtype_name: DurationInMonthsQueryOperator - subtype_model: UniqueIdQueryOperator subtype_name: UniqueIdQueryOperator - subtype_model: ThreatVulnerabilityStatusQueryOperator subtype_name: ThreatVulnerabilityStatusQueryOperator - subtype_model: ThreatVulnerabilitySeverityQueryOperator subtype_name: ThreatVulnerabilitySeverityQueryOperator - subtype_model: ThreatVulnerabilityIssueTypeQueryOperator subtype_name: ThreatVulnerabilityIssueTypeQueryOperator - subtype_model: ThreatIntentQueryOperator subtype_name: ThreatIntentQueryOperator - subtype_model: VulnerabilityReferenceIdQueryOperator subtype_name: VulnerabilityReferenceIdQueryOperator - subtype_model: CostAnomalyStatusQueryOperator subtype_name: CostAnomalyStatusQueryOperator - subtype_model: CurrencyExchangeConfigurationQuerySourceCurrency subtype_name: CurrencyExchangeConfigurationQuerySourceCurrency - subtype_model: CurrencyExchangeConfigurationQueryTargetCurrency subtype_name: CurrencyExchangeConfigurationQueryTargetCurrency - subtype_model: CurrencyExchangeConfigurationQueryScope subtype_name: CurrencyExchangeConfigurationQueryScope - subtype_model: MetricValuesOperator subtype_name: MetricValuesOperator - subtype_model: PatchReadinessStatusQueryOperator subtype_name: PatchReadinessStatusQueryOperator - subtype_model: MasterAccountBillingQueryMasterAccounts subtype_name: MasterAccountBillingQueryMasterAccounts - subtype_model: MasterAccountBillingQueryTenants subtype_name: MasterAccountBillingQueryTenants - subtype_model: MasterAccountBillingQueryUsers subtype_name: MasterAccountBillingQueryUsers - subtype_model: MasterAccountBillingQueryConversations subtype_name: MasterAccountBillingQueryConversations - subtype_model: MasterAccountBillingQueryTransactionType subtype_name: MasterAccountBillingQueryTransactionType - subtype_model: PolicyResourceRecommendationStatusQueryOperator subtype_name: PolicyResourceRecommendationStatusQueryOperator - subtype_model: PolicyResourceRecommendationPolicyIdsQueryOperator subtype_name: PolicyResourceRecommendationPolicyIdsQueryOperator - subtype_model: PolicyResourceRecommendationSeverityQueryOperator subtype_name: PolicyResourceRecommendationSeverityQueryOperator - subtype_model: PolicyRecommendationClassificationQueryOperator subtype_name: PolicyRecommendationClassificationQueryOperator - subtype_model: InfraResourceTrendResourceChangeStatusQueryOperator subtype_name: InfraResourceTrendResourceChangeStatusQueryOperator - subtype_model: VmAgentsQueryOsTypes subtype_name: VmAgentsQueryOsTypes - subtype_model: VmAgentsQueryInstantState subtype_name: VmAgentsQueryInstantState - subtype_model: VmAgentsQueryQualysStatus subtype_name: VmAgentsQueryQualysStatus - subtype_model: VmAgentsQueryCrowdStrikeStatus subtype_name: VmAgentsQueryCrowdStrikeStatus - subtype_model: VmAgentsQuerySplunkStatus subtype_name: VmAgentsQuerySplunkStatus - subtype_model: StacksMarketplaceStackQueryArchived subtype_name: StacksMarketplaceStackQueryArchived - subtype_model: StacksMarketplaceStackQueryAutoApproved subtype_name: StacksMarketplaceStackQueryAutoApproved - subtype_model: StacksMarketplaceStackQueryOwner subtype_name: StacksMarketplaceStackQueryOwner - subtype_model: StacksMarketplaceStackQueryName subtype_name: StacksMarketplaceStackQueryName - subtype_model: StacksMarketplaceStackQueryProduct subtype_name: StacksMarketplaceStackQueryProduct - subtype_model: StacksMarketplaceDeploymentQueryName subtype_name: StacksMarketplaceDeploymentQueryName - subtype_model: StacksMarketplaceDeploymentQueryStack subtype_name: StacksMarketplaceDeploymentQueryStack - subtype_model: StacksMarketplaceDeploymentQueryAccount subtype_name: StacksMarketplaceDeploymentQueryAccount - subtype_model: StacksMarketplaceDeploymentQueryRegion subtype_name: StacksMarketplaceDeploymentQueryRegion - subtype_model: StacksMarketplaceStackDeploymentQueryExecutionStatus subtype_name: StacksMarketplaceStackDeploymentQueryExecutionStatus - subtype_model: MetricNameQueryOperator subtype_name: MetricNameQueryOperator - subtype_model: ResourceQueryCategory subtype_name: ResourceQueryCategory - subtype_model: ResourceQueryLocation subtype_name: ResourceQueryLocation - subtype_model: ResourceQueryResource subtype_name: ResourceQueryResource - subtype_model: ResourceQueryResourceGroup subtype_name: ResourceQueryResourceGroup - subtype_model: ResourceQueryResourceName subtype_name: ResourceQueryResourceName - subtype_model: ResourceQueryResourceType subtype_name: ResourceQueryResourceType - subtype_model: ResourceQueryTagPresence subtype_name: ResourceQueryTagPresence - subtype_model: ResourceQueryTagKey subtype_name: ResourceQueryTagKey - subtype_model: ResourceQueryTagKeyValue subtype_name: ResourceQueryTagKeyValue - subtype_model: WorkloadQueryWorkloadName subtype_name: WorkloadQueryWorkloadName - subtype_model: WorkloadQueryWorkloadOwner subtype_name: WorkloadQueryWorkloadOwner - subtype_model: WorkloadQueryCloud subtype_name: WorkloadQueryCloud - subtype_model: WorkloadQueryCloudAccount subtype_name: WorkloadQueryCloudAccount - subtype_model: WorkloadQueryWorkloadType subtype_name: WorkloadQueryWorkloadType - subtype_model: WorkloadQueryWorkloadId subtype_name: WorkloadQueryWorkloadId InventoryResponse: required: - filters properties: filters: type: array description: Filters available in inventory items: $ref: '#/components/schemas/InventoryData' type: object ListResponse: properties: results: type: array description: List of result identifiers items: type: string next_list_context: description: List context $ref: '#/components/schemas/ListContext' type: object ServiceResourceInventoryDetails: required: - corestack_resource_id - service_account_id properties: corestack_resource_id: type: string description: ID of the resource x-cs-type: ObjectId service_account_id: type: string description: ID of the service account x-cs-type: ObjectId check_resource_element: type: string description: Unique id of the resource component: type: string description: Component of the resource location: type: string description: Location of the resource resource_group: type: string description: Resource group name specific to Azure resource summary_details_name: type: string description: Resource name specific to Azure type: object InventoryResourceDetailsResponse: required: - count - resource_details properties: count: type: string description: Inventory summary details resource_details: type: array description: Inventory summary details items: $ref: '#/components/schemas/InventoryResourceDetailsModelList' type: object InfraResourceTrendSummaryListRequest: allOf: - $ref: '#/components/schemas/InfraResourceTrendRequestBase' - properties: filters: description: Filters applied to the trend data. $ref: '#/components/schemas/InfraResourceTrendListBaseFilters' list_context: description: Optional list context $ref: '#/components/schemas/ListContext' type: object InventoryFilterRequest: required: - cloud_account properties: cloud_account: type: array description: Cloud accounts items: $ref: '#/components/schemas/InventoryFilterRequestDataModel' type: object BulkTagRemediationResponse: properties: resource_enforce_tag_ids: type: array description: Tag Remediation Ids items: type: string type: object InventoryFilterRequestDataModel: required: - id - name - preferred_regions properties: name: type: string description: Name of the cloud account id: type: string description: ID of the cloud account preferred_regions: type: array description: Preferred region of AWS account items: type: string type: object ScopeFilterZone: properties: name: type: string description: Name for zone id: type: string description: Id for zone zone_id: type: string description: Zone_id for zone region: type: string description: Region for zone type: object ServiceResourceListRequest: properties: list_context: description: Optional list context $ref: '#/components/schemas/ListContext' filters: description: Filters for the request $ref: '#/components/schemas/ServiceResourceFilter' type: object InfraResourceActivityEvent: properties: history_id: type: string description: Unique change event identifier. changed_at: type: string format: date-time description: Timestamp when the change was detected. change_type: type: string description: 'Type of change: new, modified, discovered' changed_attributes: type: object description: Post-change attribute values. Present only in Mode 2 (when event_ids are provided). Removed attributes appear as null. type: object PostureCloudDataModel: required: - cloud_account_id - cloud_account_name properties: cloud_account_name: type: string description: cloud account name cloud_account_id: type: string description: cloud account id tenant_name: type: string description: Name of the tenant resource_wo_tag: type: integer description: resource without tag count total_resources: type: integer description: total resources resource_wo_naming_std: type: string description: resource without naming std billable_resources: type: integer description: billable resources new_resources: type: integer description: new resources increase_percentage: type: number description: increase percentage resource_wo_lock: type: integer description: resources without lock cloud: type: string description: cloud name deleted_resources: type: integer description: deleted resources last_discovery: type: string description: DateTime when the user was created type: object InfraResourceTrendResource: properties: cloud_account_id: type: string description: ID of the cloud account x-cs-type: ObjectId inventory_id: type: string description: Internal inventory identifier for the resource. x-cs-type: ObjectId cloud_provider: type: string description: Cloud Provider to select example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName region: type: string description: Region of the resource resource_category: type: string description: Category of the resource resource_type: type: string description: Type of the resource resource: type: string description: 'Specific resource name or instance identifier ' resource_id: type: string description: Unique ID of the resource resource_name: type: string description: Name of the resource belongs_to_canonical_resource: type: string description: Canonical resource IRI linked from the workload resource via belongsToCanonicalResource. tags: type: array description: Resource tags as key/value pairs. items: $ref: '#/components/schemas/InfraResourceTrendResourceTag' added_at: type: string format: date-time description: Timestamp when the resource was added changed_at: type: string format: date-time description: Timestamp when the resource change was detected deleted_at: type: string format: date-time description: Timestamp when the resource was deleted type: object InfraResourceTrendRequestBase: required: - start_date properties: start_date: type: string format: date-time description: Start date of the trend analysis period. end_date: type: string format: date-time description: End date of the trend analysis period. type: object VirtualMachineAgentsFilter: required: - cloud properties: cloud: type: string description: Cloud Provider to select example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName tenant_ids: type: array description: Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. items: type: string x-cs-type: ObjectId agents: type: array items: type: string description: Type of the agents used. example: CloudWatch enum: - CloudWatch - Qualys - Microsoft_Defender - CrowdStrike - Cribl - Splunk x-cs-enum-type: VirtualMachineAgentsType service_account_ids: type: array description: Specify the Service Account IDs. items: type: string x-cs-type: ObjectId text_query: type: string description: Text query to filter agents. type: object WorkspaceDetails: properties: resource_id: type: string description: resource id of the workspace workspace_id: type: string description: id of the workspace type: object PostureCloudModel: properties: total_resources: type: integer description: total resources cloud: type: string description: cloud name type: object AlertActionRequest: properties: alert_ids: type: array description: Inventory Ids of the Alert Rules items: type: string type: object ResourceVisibilityListResponse: required: - resource_list_data - total_count properties: total_count: type: integer description: count details resource_list_data: type: array description: List of account wise count data items: $ref: '#/components/schemas/PostureResourceListModel' type: object VirtualMachineAgent: properties: name: type: string description: Type of the agents used. example: CloudWatch enum: - CloudWatch - Qualys - Microsoft_Defender - CrowdStrike - Cribl - Splunk x-cs-enum-type: VirtualMachineAgentsType is_installed: type: boolean description: Installation status of the VM Agent type: object InfraResourceTrendSummaryBaseFilters: required: - tenant_id properties: tenant_id: type: string description: Tenant ID to filter the resources. This can be fetched from the List Tenants API call. x-cs-type: ObjectId query: description: Query based on Cloud Providers, Cloud Account Ids, Statuses, Severities, ResourceCategories, ResourceTypes, Resources, Resource ID(s) $ref: '#/components/schemas/QueryOperator' type: object InventoryResourceDetailsModelList: required: - cloud - cloud_account_id - cloud_account_name - corestack_resource_id - resource - resource_category - resource_type - summary_details - tags - tenant_id properties: tenant_id: type: string description: tenant_id of the resource inventory cloud: type: string description: Name of the cloud cloud_account_id: type: string description: Id of the cloud account cloud_account_name: type: string description: Inventory summary details resource_category: type: string description: Name of the category resource_type: type: string description: Name of the component resource: type: string description: Name of the resource corestack_resource_id: type: string description: Unique element for the resource tags: type: object description: Tags associated with the resource summary_details: type: object description: Inventory summary details type: object CreateResourceLockRequest: required: - cloud - cloud_account_id - cloud_account_name - scope - tenant_ids properties: cloud_account_id: type: string description: cloud_acccount_id cloud_account_name: type: string description: cloud_account_name cloud: type: string description: The category will be either service or resource tenant_ids: type: array description: Displays the list of tenant ids items: type: string scope: type: string description: Account Scope - For account scope,user can apply lock to particular cloud account,Tenant Scope - Users with tenant can apply lock for multiple tenants., allowed values are tenant, cloud_account filters: type: array description: filters for cloud _account_scope items: $ref: '#/components/schemas/CreateLockFilterRequest' lock_type: type: string description: lock type config_rule_id: type: string description: config rule id to enable/disable config rule action: type: string description: action to enable/disable config rule. allowed values are enable or diable type: object ResourceVisibilityResponse: required: - account_wise_count - category_wise_count - last_sync_time - region_wise_count - resource_group_wise_count - resource_wise_count properties: last_sync_time: type: string description: last sync time account_wise_count: type: array description: List of account wise count data items: $ref: '#/components/schemas/PostureAccountModel' resource_wise_count: type: array description: List of resource wise count data items: $ref: '#/components/schemas/PostureResourceModel' region_wise_count: type: array description: List of region wise count data items: $ref: '#/components/schemas/PostureRegionModel' resource_group_wise_count: type: array description: List of resource group wise data items: $ref: '#/components/schemas/PostureResourceGroupModel' category_wise_count: type: array description: List of category wise data items: $ref: '#/components/schemas/PostureCategoryModel' type: object InfraResourceTrendResourceTag: properties: key: type: string description: Tag key value: type: string description: Tag value type: object TagRemediationStatus: required: - created_at - status properties: status: type: string description: Status of Tag Remediation tags: type: array description: List of tag key/value pairs items: $ref: '#/components/schemas/KeyValuePair' created_at: type: string format: date-time description: Created datetime for the Tags type: object BatchRequest: properties: ids: type: array description: Identifiers to fetch items: type: string type: object WorkspaceDataForServiceAccount: properties: service_account_id: type: string description: Id of the service account of the workspace x-cs-type: ObjectId workspace_details: type: array description: list of all workspaces details associated with the service account items: $ref: '#/components/schemas/WorkspaceDetails' type: object InfraResourceActivityResponse: properties: events: type: array description: List of activity events. items: $ref: '#/components/schemas/InfraResourceActivityEvent' next_list_context: description: Pagination context for next page. Present only in Mode 1. $ref: '#/components/schemas/ListContext' type: object TagRemediationRequest: allOf: - $ref: '#/components/schemas/TagsRemediation' - required: - service_account_id properties: service_account_id: type: string description: service_account_id x-cs-type: ObjectId type: object ScopeFilter: properties: scope: type: array description: ID of resource filter items: type: string applicability_by: type: array description: List applicability filters of cloud account items: type: string tag_keys: type: array description: Get tags keys of cloud account items: type: string regions: type: array description: List of regions of cloud account items: $ref: '#/components/schemas/ScopeFilterRegion' resources: type: array description: Get resource filters of cloud account items: type: string resource_groups: type: array description: List of resource groups of cloud account items: $ref: '#/components/schemas/ScopeResourceGroup' zone: type: array description: List zone of cloud account items: $ref: '#/components/schemas/ScopeFilterZone' type: object CreateLockFilterRequest: properties: regions: type: array description: Displays the list of regions items: $ref: '#/components/schemas/ScopeFilterRegion' resources: type: array description: Displays the list of resources items: type: string resource_groups: type: array description: Displays the list of resource groups items: $ref: '#/components/schemas/ScopeResourceGroup' tags: type: array description: applied tags for lock items: type: object zone: type: array description: List zone of cloud account items: $ref: '#/components/schemas/ScopeFilterZone' type: object ListLockRuleModel: required: - applicability_by - cloud - config_rule_id - is_active - lock_type - tenant_id - tenant_name properties: tenant_name: type: string description: cloud_account_name tenant_id: type: string description: cloud_account_name cloud_account_id: type: string description: cloud_acccount_id cloud_account_name: type: string description: cloud_account_name cloud: type: string description: cloud name applicability_by: description: filters for cloud _account_scope $ref: '#/components/schemas/FilterData' lock_type: type: string description: lock type config_rule_id: type: string description: cloud_acccount_id is_active: type: boolean description: Flag to identify config rule is active or not type: object RediscoverResponse: required: - cloud_account properties: cloud_account: type: array description: Cloud Account Details items: type: object type: object CategoryCountResponse: properties: category_details: description: Inventory category count details $ref: '#/components/schemas/CategoryCountResponseModelList' resource_details: type: object description: Inventory resource count details type: object LocationDetailsBase: required: - type properties: location_id: type: string description: Unique Id name: type: string description: Display Name description: type: string description: Description discriminator: propertyName: type type: object x-cs-subtypes: - subtype_model: LocationDetailsForAws subtype_name: LocationDetailsForAws - subtype_model: LocationDetailsForAzure subtype_name: LocationDetailsForAzure - subtype_model: LocationDetailsForGcp subtype_name: LocationDetailsForGcp - subtype_model: LocationDetailsForOci subtype_name: LocationDetailsForOci - subtype_model: LocationDetailsForOpenstack subtype_name: LocationDetailsForOpenstack InfraResourceTrendSummaryRequest: allOf: - $ref: '#/components/schemas/InfraResourceTrendRequestBase' - required: - granularity - group_by properties: filters: description: Filters applied to the trend data. $ref: '#/components/schemas/InfraResourceTrendSummaryBaseFilters' granularity: type: string description: Granularity for aggregating resource trend data example: day enum: - day - month x-cs-enum-type: InfraIssuesTrendGranularity group_by: type: string description: Grouping criteria for the trend data. example: category enum: - category - change_status x-cs-enum-type: InfraResourceTrendGroupBy type: object ResourceUnitPriceCheapestSkuRequest: properties: service_account_id: type: string description: ID of the service account x-cs-type: ObjectId resource_id: type: string description: Id of the resource currency: type: string description: currency of the cost. Example 'currency':'USD' example: AED enum: - AED - ALL - ARS - AUD - BAM - BDT - BGN - BHD - BRL - CAD - CHF - CLP - CNY - COP - CRC - CZK - DKK - EGP - EUR - GBP - HKD - HRK - HUF - IDR - ILS - INR - ISK - JPY - KES - KRW - KWD - KZT - MOP - MVR - MXN - MYR - NOK - NZD - OMR - PEN - PHP - PKR - PLN - QAR - RON - RSD - RUB - SAR - SEK - SGD - THB - TRY - TWD - USD - VND - ZAR x-cs-enum-type: Currency type: object ListLogAnalyticsWorkspaceRequest: required: - tenant_ids properties: tenant_ids: type: array description: list of all tenant ids for which log analytics workspace details are required items: type: string x-cs-type: ObjectId service_account_ids: type: array description: list of service account ids for which log analytics workspace details are required items: type: string x-cs-type: ObjectId type: object ModelError: required: - message properties: message: type: string description: Error response message. type: object CategoryCountResponseModelList: properties: count: type: string description: Inventory category count details resource_category: type: string description: Name of the category type: object KeyValuePair: properties: key: type: string description: Key of the pair value: type: string description: Value of the pair type: object ResourcePostureResponse: required: - cloud_account_data - cloud_data - tenants - total_count properties: total_count: type: integer description: count details tenants: type: array description: List of tenant data items: $ref: '#/components/schemas/PostureTenantModel' cloud_data: type: array description: List of cloud data items: $ref: '#/components/schemas/PostureCloudModel' cloud_account_data: type: array description: List of cloud account data items: $ref: '#/components/schemas/PostureCloudDataModel' type: object PostureAccountModel: required: - billable - cloud_account_name - count - non_billable properties: cloud_account_name: type: string description: cloud account name count: type: integer description: total count details billable: type: integer description: billable count details non_billable: type: integer description: non_billable count details type: object ServiceResourceFilter: properties: service_account_ids: type: array description: Filter by service account IDs items: type: string x-cs-type: ObjectId location: type: string description: Filter by region/location/zone tags: type: array description: Resource tags as key-value pairs items: $ref: '#/components/schemas/KeyValuePair' operation_id: type: string description: Filter by operation ID resource_filter: type: string description: Filter by resource filter, also known as resource group in Azure category: type: string description: Filter by resource category component: type: string description: Filter by resource component tenant_ids: type: array description: Filter by tenant IDs items: type: string x-cs-type: ObjectId resource: type: string description: Filter by resource check_resource_element: type: string description: Filter by unique ID of the resource check_resource_parent_id: type: string description: Filter by parent unique ID of the resource type: object ListLockConfigRuleResponse: properties: lock_rules: type: array items: $ref: '#/components/schemas/ListLockRuleModel' type: object ResourceUnitPriceCheapestSkuResponse: properties: daily_cost: type: number description: Daily cost value type: object InventoryResourceDetailsDataModel: required: - category - cloud_account - component - resource - service properties: cloud_account: type: array description: Id of the cloud account items: $ref: '#/components/schemas/CloudAccountDetail' service: type: string description: Cloud service name example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName category: type: string description: Name of the resource category. It can be fetched from the Get Inventory Count Api component: type: string description: Name of the resource type. It can be fetched from the Get Inventory Count Api resource: type: string description: Name of the resource. It can be fetched from the Get Inventory Count Api operation_id: type: string description: Specify the Operation ID. It can be fetched from the Get Inventory Count Api fetch_live_status: type: boolean description: Specify to fetch the live ping status of the AWS SSM enabled instance. type: object ServiceResourceListResponse: properties: results: type: array description: List of result identifiers items: type: string x-cs-type: ObjectId next_list_context: description: List context $ref: '#/components/schemas/ListContext' type: object VirtualMachineAgentSummary: properties: sys_id: type: string description: Resource Id x-cs-type: ObjectId service_account_id: type: string description: Corestack service account id x-cs-type: ObjectId service_resource_inventory_id: type: string x-cs-type: ObjectId instance_id: type: string description: Virtual machine id resource_name: type: string description: Virtual machine name vm_agents_status: type: array description: List of VM agent statuses items: $ref: '#/components/schemas/VirtualMachineAgent' instance_type: type: string description: Virtual machine type instance_state: type: string description: Virtual machine state region: type: string description: Virtual machine region launch_time: type: string format: date-time description: Virtual machine launch time os_type: type: string description: Virtual Machine OS Type tags: type: string description: Virtual machine tags host_name: type: string description: Private dns name ssm_ping_successful: type: boolean description: ssm ping status type: object ScopeFilterRegion: properties: type: type: string description: Type for region key: type: string description: Key for region name: type: string description: Name for region id: type: string description: Id for region type: object ServiceResourceBatchResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/ServiceResourceDetails' type: object VirtualMachineAgentsListRequest: properties: list_context: description: Optional list context $ref: '#/components/schemas/ListContext' sort: type: array description: Sort criteria items: $ref: '#/components/schemas/VirtualMachineAgentsSummarySortCriteria' filters: description: Filters for the request $ref: '#/components/schemas/VirtualMachineAgentsFilter' type: object CreateLockConfigRuleResponse: required: - config_rule_id properties: config_rule_id: type: string description: Config rule id type: object ResourceUnitPriceResponse: properties: key: type: string description: Id of the resource price: type: number description: Price for the resource unit: type: string description: Unit value for the resource type: object BulkTagRemediationStatusRequest: required: - resource_ids - service_account_id properties: service_account_id: type: string description: Service Account Id x-cs-type: ObjectId resource_ids: type: array description: Tag Remediation Resource Ids items: type: string type: object DependentResourcesListResponse: properties: resource_name: type: string description: Resource name for which associated resources are captured. dependent_resources: type: object description: Associated resources type: object ServiceResourceDetails: properties: check_resource_element: type: string description: Unique ID of the resource element operation_id: type: string description: Operation ID for resource discovery resource_filter: type: string description: Resource filter criteria used service_account_id: type: string description: Service account ID x-cs-type: ObjectId category: type: string description: Resource category component: type: string description: Resource component created_at: type: string format: date-time description: Creation timestamp location: type: string description: Resource region/location/zone resource: type: string description: Resources of the cloud provider resource_type: type: string description: Type of the resource summary_details: type: object description: Detailed resource information from cloud provider tags: type: array description: Resource tags as key-value pairs items: $ref: '#/components/schemas/KeyValuePair' updated_at: type: string format: date-time description: Last update timestamp type: object ObjectIdBatchRequest: properties: ids: type: array items: type: string x-cs-type: ObjectId type: object GcpResourceSkuDetailsRequest: properties: service_account_id: type: string description: ID of the service account x-cs-type: ObjectId resource_id: type: string description: Id of the resource resource_type: type: string description: Type of the resource resource_category: type: string description: Category of the resource resource: type: string description: Name of the resource region: description: Optional region details $ref: '#/components/schemas/LocationDetailsBase' type: object ResourceUnitPriceRequest: properties: service_account_id: type: string description: ID of the service account x-cs-type: ObjectId resource_id: type: string description: Id of the resource resource_type: type: string description: Type of the resource type: object InfraResourceTrendResourceResponse: properties: resources: type: array description: List of resources matching the trend criteria. items: $ref: '#/components/schemas/InfraResourceTrendResource' next_list_context: description: List context $ref: '#/components/schemas/ListContext' type: object BulkTagRemediationStatusResponse: properties: results: type: object description: Map from identifier to response model additionalProperties: $ref: '#/components/schemas/TagRemediationStatus' type: object CategoryCountRequest: required: - filters - identifier properties: identifier: type: string description: Category/Resource based count for the cloud default: category example: category enum: - category - resource x-cs-enum-type: InventorySelector filters: description: Resource filters detail $ref: '#/components/schemas/CountDetailsDataModel' type: object ListContext: properties: batch_size: type: integer description: Max number of ids in the response batch_offset: type: integer description: Offset of batches into the results. First batch is 0 total: type: integer description: Total number of results type: object PostureResourceGroupModel: required: - billable - count - non_billable - resource_group properties: resource_group: type: string description: resource group name count: type: integer description: total count details billable: type: integer description: billable count details non_billable: type: integer description: non_billable count details type: object PostureCategoryModel: required: - billable - category - count - non_billable properties: category: type: string description: category name count: type: integer description: total count details billable: type: integer description: billable count details non_billable: type: integer description: non_billable count details type: object InventoryResourceDetailsRequest: required: - filters properties: filters: description: Filter resource details $ref: '#/components/schemas/InventoryResourceDetailsDataModel' type: object InfraResourceDetailResponse: properties: canonical_type: type: string description: Canonical resource type (e.g. ComputeInstance, VirtualNetwork). created_at: type: string format: date-time description: Timestamp when the resource was first discovered. attributes: type: object description: All canonical properties for this resource type. Keys vary by canonical_type (e.g. instanceType, vCpus for ComputeInstance; addressSpace for VirtualNetwork). type: object PostureRegionModel: required: - billable - count - non_billable - region properties: region: type: string description: region name count: type: integer description: total count details billable: type: integer description: billable count details non_billable: type: integer description: non_billable count details type: object ResourceFilterModel: required: - id - name properties: id: type: string description: ID of resource filter name: type: string description: Name of resource filter type: object ServiceResourceInventoryLookupRequest: properties: corestack_resource_ids: type: array description: Id of the resource items: type: string x-cs-type: ObjectId type: object PostureTenantModel: required: - tenant_id - tenant_name properties: tenant_name: type: string description: Name of the tenant tenant_id: type: string description: Name of the tenant resource_wo_tag: type: integer description: resource without tag count total_resources: type: integer description: total resources resource_wo_naming_std: type: string description: resource without naming std billable_resources: type: integer description: billable resources new_resources: type: integer description: new resources increase_percentage: type: number description: increase percentage resource_wo_lock: type: integer description: resources without lock deleted_resources: type: integer description: deleted resources type: object ResourceListingRequest: required: - action - cloud - cloud_account_id - cloud_type properties: cloud_type: type: string description: Service Type like cloud cloud: type: string description: Type of cloud from cloud provider like AWS/Azure example: AWS enum: - AWS - Azure - AzureStack - Azure_CSP - Azure_CSP-Direct - Azure_EA - Azure_MCA - Cloudstack - GCP - MS_VMM - OCI - Openstack - PrivateCloud - Rackspace - VMware - VMware_VCD - vCenter x-cs-enum-type: CloudServiceName region: type: string description: The region of the cloud account where it needs to be executed mandatory for AWS cloud_account_id: type: string description: Specify the Cloud account ID. This is a unique ID and can be retrieved from the List Cloud Account API. resource_group: type: string description: Resource groups preferred by the user in that particular Azure account. location: type: string description: Provide the location. Based on the action action: type: string description: 'Provide the action name. Example: virtual_network.list_virtual_network' type: object TagsRemediation: required: - resource - resource_category - resource_filter - resource_id - resource_type properties: resource_category: type: string description: resource_category (it can be fetched from the tag posture resource based on input filters api resource_type: type: string description: resource_type (it can be fetched from the tag posture resource based on input filters api) resource: type: string description: resource (it can be fetched from the tag posture resource based on input filters api) resource_filter: type: string description: resource_filter will be region, resource group or zone name. It can be fetched from the list resource visibility count api resource_id: type: string description: resource_id (it can be fetched from the tag posture resource based on input filters api) tags: type: array description: List of tag key/value pairs items: $ref: '#/components/schemas/KeyValuePair' type: object CloudAccountDetail: required: - id - name properties: name: type: string description: Cloud account name id: type: string description: Cloud Account ID preferred_regions: type: array description: Preferred regions of AWS items: type: string type: object InfraResourceTrendSummary: properties: date: type: string format: date description: Date of the trend data point. category: type: string description: Resource category change_status: type: string description: Change status of the infrastructure resource example: added enum: - added - unchanged - modified - deleted x-cs-enum-type: InfraResourceChangeStatus count: type: integer description: Count of resources for the given date and category. type: object securitySchemes: auth_token: type: apiKey in: header name: X-Auth-Token