> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/xdr-api/cloud-onboarding/manual-onboarding.md).

# Manual Onboarding

APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template.

## Create a manually provisioned cloud integration instance

> Create a cloud integration instance from manually provisioned CSP resources (the \`MANUAL\` provisioning method). To connect a pending cloud instance after you deploy a Cortex-generated template, use \`POST /public\_api/v1/cloud\_onboarding/create\_custom\_connector\` instead. Use this endpoint after you have:\
> \
> 1\. Called \`POST /public\_api/v1/cloud\_onboarding/get\_manual\_connector\_identifiers\` to obtain the identifiers file.\
> 2\. Created all required CSP resources (IAM roles, service accounts, audit-log infrastructure) using the values in the \`identifiers\` section.\
> 3\. Populated the \`manual\_details\` section of the identifiers file with the values retrieved from your CSP environment.\
> \
> Provide the same \`cloud\_provider\`, \`scope\`, \`scan\_mode\`, and capability configuration used when generating the identifiers, together with the completed \`manual\_details\` object.\
> \
> \*\*CSP support:\*\* AWS, Azure, and GCP only.\
> \
> \*\*Scan modes:\*\* \`MANAGED\` (recommended) or \`OUTPOST\`. When \`scan\_mode\` is \`OUTPOST\`, \`outpost\_id\` is required — retrieve the outpost ID from \`POST /public\_api/v1/cloud\_onboarding/get\_outposts\`.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/create_instance":{"post":{"tags":["Manual onboarding"],"summary":"Create a manually provisioned cloud integration instance","description":"Create a cloud integration instance from manually provisioned CSP resources (the `MANUAL` provisioning method). To connect a pending cloud instance after you deploy a Cortex-generated template, use `POST /public_api/v1/cloud_onboarding/create_custom_connector` instead. Use this endpoint after you have:\n\n1. Called `POST /public_api/v1/cloud_onboarding/get_manual_connector_identifiers` to obtain the identifiers file.\n2. Created all required CSP resources (IAM roles, service accounts, audit-log infrastructure) using the values in the `identifiers` section.\n3. Populated the `manual_details` section of the identifiers file with the values retrieved from your CSP environment.\n\nProvide the same `cloud_provider`, `scope`, `scan_mode`, and capability configuration used when generating the identifiers, together with the completed `manual_details` object.\n\n**CSP support:** AWS, Azure, and GCP only.\n\n**Scan modes:** `MANAGED` (recommended) or `OUTPOST`. When `scan_mode` is `OUTPOST`, `outpost_id` is required — retrieve the outpost ID from `POST /public_api/v1/cloud_onboarding/get_outposts`.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInstanceRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInstanceResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"createInstance"}}},"components":{"schemas":{"CreateInstanceRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"cloud_provider":{"type":"string","enum":["AWS","AZURE","GCP"],"description":"The cloud service provider. Valid values include:\n\n- `AWS`\n- `AZURE`\n- `GCP`"},"scope":{"type":"string","enum":["ACCOUNT","ORGANIZATION","ACCOUNT_GROUP"],"description":"Define the scope for this integration instance. Valid values include:\n\n- `ACCOUNT`\n- `ORGANIZATION`\n- `ACCOUNT_GROUP`"},"scan_mode":{"type":"string","enum":["MANAGED","OUTPOST"],"description":"Define the scan mode. Valid values include:\n\n- `MANAGED` (cloud scan): Security scanning is performed in the Cortex cloud environment.\n- `OUTPOST` (outpost scan): Security scanning is performed on infrastructure deployed to a cloud account owned by you. When set to `OUTPOST`, `outpost_id` is required."},"manual_details":{"type":"object","description":"The manually provisioned CSP resource details collected from your cloud environment. Fill in the `manual_details` section of the identifiers JSON file downloaded from the Cortex onboarding wizard (or returned by `get_manual_connector_identifiers`) with the values retrieved from your CSP — for example, Role ARN and External ID for AWS, or tenant ID and managed identity details for Azure — then pass the completed object here.","additionalProperties":true},"outpost_id":{"type":"string","description":"The ID of the outpost to use for scanning. Required when `scan_mode` is `OUTPOST`. Retrieve available outpost IDs from `POST /public_api/v1/cloud_onboarding/get_outposts`.","minLength":1},"instance_name":{"type":"string","description":"Optional display name for the integration instance. If omitted, Cortex auto-generates a name using the convention `<CSP>-<accountID>` or `<CSP>-<organizationID>`. Instance names are not required to be unique, but using a unique name per instance is strongly recommended."},"custom_resources_tags":{"type":"array","items":{"$ref":"#/components/schemas/CustomResourceTag"}},"collection_configuration":{"$ref":"#/components/schemas/InstanceCollectionConfiguration"},"scope_modifications":{"$ref":"#/components/schemas/InstanceScopeModifications"},"additional_capabilities":{"$ref":"#/components/schemas/InstanceAdditionalCapabilities"},"scan_config":{"allOf":[{"$ref":"#/components/schemas/InstanceScanConfig"}],"description":"The scan configuration for the instance. Each module block you provide sets that module's configuration; an omitted module keeps its default. Enabling `ads` or `dspm` requires the matching capability to be `true` in `additional_capabilities` in the same request (`agentless_disk_scanning` for `ads`, `data_security_posture_management` for `dspm`). Setting `enabled` to `false` doesn't require the capability."}},"required":["cloud_provider","scope","scan_mode","manual_details"],"description":"Request body for creating a manually provisioned cloud integration instance. Provide the same `cloud_provider`, `scope`, `scan_mode`, and capability configuration used when calling `get_manual_connector_identifiers`, together with the completed `manual_details` object returned from your CSP environment."}}},"CustomResourceTag":{"type":"object","properties":{"key":{"type":"string","description":"The key of the custom resource tag.","minLength":1},"value":{"type":"string","description":"The value of the custom resource tag."}}},"InstanceCollectionConfiguration":{"type":"object","description":"This field is optional when onboarding or editing Alibaba Cloud.","properties":{"audit_logs":{"$ref":"#/components/schemas/InstanceAuditLogsConfig"}}},"InstanceAuditLogsConfig":{"type":"object","description":"To maximize security coverage, include collection of logs. This may require additional cloud service provider permissions. \nFor detailed information on the permissions required, see [Cloud service provider permissions](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/reference-and-developer-docs/cloud-service-provider-permissions).","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether to enable audit log collection. If this is `false`, then the other fields in this object should not be used."},"collection_method":{"enum":["CUSTOM","AUTOMATED"],"description":"Indicates whether to use automated or custom log collection. \n**Note:** `collection_method` is only relevant for AWS or OCI. For OCI, the value of `collection_method` must be `CUSTOM` and you must include `custom_collectors` with the details of the existing buckets. In AWS, if `collection_method` is `CUSTOM`, you need to update the bucket information when you manually upload the template to AWS CloudFormation.\n"},"data_events":{"type":"boolean","description":"The `data_events` field is only relevant when `cloud_provider` is `AWS` and `collection_method` is `AUTOMATED`. Currently supports AWS Lambda and Amazon S3."},"custom_collectors":{"type":"array","description":"A list of OCI bucket configurations for collecting logs.\n**Note:** This is only relevant for OCI when `collection_method` is `CUSTOM`.","items":{"type":"object","properties":{"region":{"type":"string","description":"The geographic region where the collection bucket is located."},"bucket_name":{"type":"string","description":"The name of the storage bucket where the log collection data will be collected and stored."},"compartment_ocid":{"type":"string","description":"The unique OCID (Oracle Cloud Identifier) of the compartment that owns the specified bucket."}}}},"is_control_tower_byob":{"type":"boolean","default":false,"description":"When `true`, configures the cloud instance to use AWS Control Tower Bring Your Own Bucket (BYOB) for audit log collection. This allows Cortex to collect audit logs from an existing S3 bucket managed by AWS Control Tower, rather than creating a new one.\n\n**Requirements:**\n- Only applicable when `cloud_provider` is `AWS`.\n- Requires `collection_method` to be set to `CUSTOM`.\n- Requires the cloud instance scope to be `ORGANIZATION`.\n- The Control Tower BYOB feature must be enabled for your tenant."}}},"InstanceScopeModifications":{"type":"object","description":"Defines which accounts, regions, and organizational groupings Cortex should include in or exclude from security scanning for this cloud instance. The fields you use depend on the cloud provider:\n\n- **AWS**: Use `accounts` to filter individual AWS accounts, `organizational_units` to filter AWS organizational units, and `regions` to restrict scanning to specific AWS regions.\n- **GCP**: Use `projects` to filter individual GCP projects, `folders` to filter GCP folders, and `regions` to restrict scanning to specific GCP regions.\n- **Azure**: Use `subscriptions` to filter individual Azure subscriptions, `management_groups` to filter Azure management groups, and `regions` to restrict scanning to specific Azure regions.\n- **OCI**: Use `compartments` to filter OCI compartments and `regions` to restrict scanning to specific OCI regions.\n- **Alibaba Cloud**: Use `accounts` to filter individual Alibaba Cloud accounts and `regions` to restrict scanning to specific regions.\n\nOnly one account-level bucket (`accounts`, `projects`, `subscriptions`, or `compartments`) and one organizational-level bucket (`organizational_units`, `management_groups`, or `folders`) may be enabled at a time.\n\nSet `onboard_only_mode` to `true` to onboard the instance without turning on environment scanning.","required":["regions"],"properties":{"accounts":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual AWS accounts within the cloud instance scope. Use this to include or exclude specific account IDs from security scanning. Not applicable for Azure, GCP, OCI, Alibaba Cloud, or IBM Cloud."},"projects":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual GCP projects within the cloud instance scope. Use this to include or exclude specific GCP project IDs from security scanning. Not applicable for AWS, Azure, OCI, Alibaba Cloud, or IBM Cloud."},"subscriptions":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual Azure subscriptions within the cloud instance scope. Use this to include or exclude specific Azure subscription IDs from security scanning. Not applicable for AWS, GCP, OCI, Alibaba Cloud, or IBM Cloud."},"compartments":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters OCI compartments within the cloud instance scope. Use this to include or exclude specific OCI compartment IDs from security scanning. Not applicable for AWS, GCP, Azure, Alibaba Cloud, or IBM Cloud."},"organizational_units":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters AWS organizational units (OUs) within the cloud instance scope. Use this to include or exclude entire OUs — and all accounts within them — from security scanning. Only valid for AWS with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"management_groups":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters Azure management groups within the cloud instance scope. Use this to include or exclude entire management groups — and all subscriptions within them — from security scanning. Only valid for Azure with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"folders":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters GCP folders within the cloud instance scope. Use this to include or exclude entire GCP folders — and all projects within them — from security scanning. Only valid for GCP with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"regions":{"$ref":"#/components/schemas/InstanceRegionsConfig","description":"Restricts security scanning to specific geographic regions within the cloud provider. When `enabled` is `true`, Cortex scans only the regions listed (if `type` is `INCLUDE`) or scans all regions except those listed (if `type` is `EXCLUDE`). This field is required."},"onboard_only_mode":{"type":"boolean","default":false,"description":"When `true`, onboards the cloud instance without turning on environment scanning. Cortex provisions the instance, but it doesn't discover the accounts in scope, and every security capability is disabled. Use this mode to stagger scanning: onboard the instance first, and start scanning later.\n\nTo start scanning, call `POST /public_api/v1/cloud_onboarding/edit_instance` with `onboard_only_mode` set to `false`. Cortex then enables the instance accounts, runs account discovery with the account and organizational filters in the same request, and runs a permission check.\n\n- Omitting the field is the same as setting it to `false`. Because `edit_instance` requires `scope_modifications`, include `\"onboard_only_mode\": true` in every edit of an onboard-only instance that should stay in onboard-only mode.\n- After scanning starts, you can't set `onboard_only_mode` back to `true`. The request returns an error.\n- If onboard-only mode isn't enabled for your tenant, setting it to `true` returns a validation error."}}},"InstanceAccountsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable (`true`) or disable (`false`)  this scope modification."},"type":{"type":"string","description":"Define whether the account IDs/project IDs/subscription IDs specified should be included in the scope or excluded from the scope. Valid values include:\n\n- `INCLUDE`\n- `EXCLUDE`","nullable":true},"account_ids":{"type":"array","description":"The list of account IDs to include or exclude (for AWS).","nullable":true,"items":{"type":"string","minLength":1}},"project_ids":{"type":"array","description":"The list of account IDs to include or exclude (for GCP).","nullable":true,"items":{"type":"string","minLength":1}},"subscription_ids":{"type":"array","description":"The list of account IDs to include or exclude (for Azure).","nullable":true,"items":{"type":"string","minLength":1}},"compartment_ids":{"type":"array","nullable":true,"description":"The list of compartment IDs to include or exclude (for OCI).","items":{"type":"string"}}}},"InstanceOUConfig":{"type":"object","description":"Configuration for filtering an organizational grouping within a cloud instance scope. Organizational groupings let you include or exclude entire subtrees of your cloud hierarchy — such as all accounts under an AWS organizational unit, all subscriptions under an Azure management group, or all projects under a GCP folder — rather than listing individual account IDs.\n\nProvide the IDs that match your cloud provider:\n- **AWS**: Use `organizational_unit_ids`\n- **Azure**: Use `management_group_ids`\n- **GCP**: Use `folder_ids`\n\nOnly one ID list may be populated at a time. When `enabled` is `false`, no other fields should be set.","properties":{"enabled":{"type":"boolean","description":"Whether to activate this organizational-level scope filter. When `true`, Cortex applies the `type` and the corresponding ID list to determine which organizational groupings to include or exclude. When `false`, no organizational filtering is applied and no other fields in this object should be set."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Determines how the provided ID list is applied to the scope. Required when `enabled` is `true`. Valid values include:\n\n- `INCLUDE`: Cortex scans only the organizational groupings listed in the ID list, and all accounts, subscriptions, or projects that belong to them.\n- `EXCLUDE`: Cortex scans all organizational groupings except those listed in the ID list."},"organizational_unit_ids":{"type":"array","nullable":true,"description":"A list of AWS organizational unit (OU) IDs to include in or exclude from security scanning. Each OU ID must be a non-empty string in the format `ou-xxxx-xxxxxxxx`. All AWS accounts that are members of the specified OUs are affected. Use only when the cloud provider is `AWS`.","items":{"type":"string","minLength":1}},"management_group_ids":{"type":"array","nullable":true,"description":"A list of Azure management group IDs to include in or exclude from security scanning. Each management group ID must be a non-empty string. All Azure subscriptions that belong to the specified management groups are affected. Use only when the cloud provider is `AZURE`.","items":{"type":"string","minLength":1}},"folder_ids":{"type":"array","nullable":true,"description":"A list of GCP folder IDs to include in or exclude from security scanning. Each folder ID must be a non-empty string (numeric GCP folder ID). All GCP projects that reside under the specified folders are affected. Use only when the cloud provider is `GCP`.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"InstanceRegionsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag to enable or disable region configuration"},"type":{"type":"string","nullable":true,"description":"Type of region configuration (e.g., INCLUDE, EXCLUDE)"},"regions":{"type":"array","nullable":true,"description":"List of regions to include or exclude","items":{"type":"string","minLength":1}}}},"InstanceAdditionalCapabilities":{"type":"object","description":"Define which security capabilities you want to benefit from. All fields default to `false` and are optional. This field is optional when `cloud_provider` is `ALIBABA_CLOUD` or `IBM_CLOUD`; for all other providers it is required. IBM Cloud doesn't support additional security capabilities, so all values must be `false` or omitted.\n\n**Azure least-privilege deployment:** For Azure `ORGANIZATION` and `ACCOUNT_GROUP` scopes, Cortex deploys the per-subscription Azure Policy (`deployIfNotExists`), its managed identity, and the per-subscription resource group that the policy creates only when at least one of `agentless_disk_scanning`, `data_security_posture_management`, `kubernetes_security`, or `asset_discovery_key_vault` is `true`. If you select none of these, the policy, its managed identity, and the resource group aren't deployed. They are never deployed for Microsoft Entra ID-only onboarding.\n\n**Note:** Adding a security capability typically requires additional cloud provider permissions. For detailed information on the permissions required, see [Cloud service provider permissions](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/reference-and-developer-docs/cloud-service-provider-permissions).","properties":{"xsiam_analytics":{"type":"boolean","description":"Whether to enable XSIAM analytics to analyze your endpoint data to develop a baseline and raise Analytics and Analytics BIOC alerts when anomalies and malicious behaviors are detected."},"data_security_posture_management":{"type":"boolean","description":"Whether to enable data security posture management, an agentless data security scanner that discovers, classifies, protects, and governs sensitive data.","nullable":true},"registry_scanning":{"type":"boolean","description":"Whether to enable registry scanning, a container registry scanner that scans registry images for vulnerabilities, malware, and secrets."},"registry_scanning_options":{"$ref":"#/components/schemas/RegistryScanningOptions"},"serverless_scanning":{"type":"boolean","description":"Whether to enable serverless scanning to detect and remediate vulnerabilities within serverless functions during the development lifecycle. Seamless integration into CI/CD pipelines enables automated security scans for a continuously secure pre-production environment."},"agentless_disk_scanning":{"type":"boolean","description":"Whether to enable agentless disk scanning to remotely detect and remediate vulnerabilities during the development lifecycle."},"upload_files_to_wildfire":{"type":"boolean","description":"Whether to enable uploading files extracted from registry images to WildFire for malware analysis. If WildFire identifies a file as malicious, the associated registry image is re-evaluated and a malware finding is created."},"kubernetes_security":{"type":"boolean","default":false,"description":"Whether to enable Kubernetes security."},"asset_discovery_key_vault":{"type":"boolean","default":false,"description":"Azure only. Secret Security Posture and Correlation in the Cortex UI. Whether to grant Cortex read access to Azure Key Vault keys, certificates, and key rotation policies for asset discovery. For Azure `ORGANIZATION` and `ACCOUNT_GROUP` scopes, enabling this capability also deploys the per-subscription Azure Policy, its managed identity, and the per-subscription resource group. Azure cloud instances onboarded before this field was introduced keep their Key Vault access and have this field set to `true`."},"automation":{"type":"boolean","default":false,"description":"Whether to enable automation."},"automation_log_level":{"description":"Automation log level","enum":["OFF","Debug","Verbose"],"nullable":true}}},"RegistryScanningOptions":{"type":"object","properties":{"type":{"type":"string","description":"Type of registry scanning."},"last_days":{"type":"integer","description":"Number of days to scan back.","nullable":true}}},"InstanceScanConfig":{"type":"object","description":"Instance-level scan configuration, used in request bodies. Each module block you provide replaces that module's configuration. An omitted module is left untouched. Only `ads` and `dspm` can be sent. Sending `kspm` or `registry` returns a validation error. Enabling `ads` or `dspm` requires the matching capability to be `true` in `additional_capabilities` in the same request (`agentless_disk_scanning` for `ads`, `data_security_posture_management` for `dspm`). The capability stored on the instance isn't checked, so if you omit `additional_capabilities`, a request that sets `enabled` to `true` is rejected even when the capability is already active on the instance. Setting `enabled` to `false` doesn't require the capability.\n\nFor the shape returned by `POST /public_api/v1/cloud_onboarding/get_edit_instance_details`, see `InstanceScanConfigResponse`.","properties":{"ads":{"type":"object","nullable":true,"description":"Agentless Disk Scanning configuration for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Agentless Disk Scanning is active."},"entities_scope":{"allOf":[{"$ref":"#/components/schemas/ScanConfigEntitiesScope"}],"nullable":true,"description":"Narrows Agentless Disk Scanning to a subset of cloud entities."},"tags":{"allOf":[{"$ref":"#/components/schemas/ScanConfigTags"}],"nullable":true,"description":"Narrows which hosts Agentless Disk Scanning scans, using tag rules."}},"required":["enabled"]},"dspm":{"type":"object","nullable":true,"description":"Data Security Posture Management configuration for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Data Security Posture Management scanning is active."},"entities_scope":{"allOf":[{"$ref":"#/components/schemas/ScanConfigEntitiesScope"}],"nullable":true,"description":"Narrows Data Security Posture Management scanning to a subset of cloud entities."},"regions":{"allOf":[{"$ref":"#/components/schemas/ScanConfigRegions"}],"nullable":true,"description":"Narrows Data Security Posture Management scanning to a subset of regions."}},"required":["enabled"]}}},"ScanConfigEntitiesScope":{"type":"object","description":"Narrows a module to a subset of cloud entities. When `enabled` is `true`, `type` is required. Only the identifier lists valid for the instance's cloud service provider may be sent:\n\n- `AWS` — `account_ids`, `organizational_unit_ids`\n- `AZURE` — `subscription_ids`, `management_group_ids`\n- `GCP` — `project_ids`, `folder_ids`\n- `OCI` — `compartment_ids`\n- `ALIBABA_CLOUD`, `IBM_CLOUD` — None. Alibaba Cloud and IBM Cloud don't support identifier lists in `entities_scope`, and any identifier list returns a validation error.","properties":{"enabled":{"type":"boolean","description":"Whether the entity scope is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed entities are included in or excluded from scanning. Required when `enabled` is `true`."},"account_ids":{"type":"array","nullable":true,"description":"Cloud account IDs. Valid for AWS only.","items":{"type":"string","minLength":1}},"organizational_unit_ids":{"type":"array","nullable":true,"description":"Organizational unit IDs. Valid for AWS.","items":{"type":"string","minLength":1}},"subscription_ids":{"type":"array","nullable":true,"description":"Subscription IDs. Valid for Azure.","items":{"type":"string","minLength":1}},"management_group_ids":{"type":"array","nullable":true,"description":"Management group IDs. Valid for Azure.","items":{"type":"string","minLength":1}},"project_ids":{"type":"array","nullable":true,"description":"Project IDs. Valid for GCP.","items":{"type":"string","minLength":1}},"folder_ids":{"type":"array","nullable":true,"description":"Folder IDs. Valid for GCP.","items":{"type":"string","minLength":1}},"compartment_ids":{"type":"array","nullable":true,"description":"Compartment IDs. Valid for OCI.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"ScanConfigTags":{"type":"object","description":"A tag-based scan filter. When `enabled` is `true`, `type` is required.","properties":{"enabled":{"type":"boolean","description":"Whether the tag filter is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed tags are included in or excluded from scanning. Required when `enabled` is `true`."},"values":{"type":"array","nullable":true,"description":"The tags to match.","items":{"$ref":"#/components/schemas/ScanConfigTagEntry"}}},"required":["enabled"]},"ScanConfigTagEntry":{"type":"object","description":"A single key/value tag used by a tag-based scan filter.","properties":{"key":{"type":"string","description":"The tag key.","minLength":1},"value":{"type":"string","description":"The tag value."},"deletable":{"type":"boolean","nullable":true,"description":"Whether this tag entry can be removed."}},"required":["key","value"]},"ScanConfigRegions":{"type":"object","description":"A region-based scan filter. When `enabled` is `true`, `type` is required and each value must be a valid region for the cloud service provider.","properties":{"enabled":{"type":"boolean","description":"Whether the region filter is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed regions are included in or excluded from scanning. Required when `enabled` is `true`."},"values":{"type":"array","nullable":true,"description":"The region identifiers to match. Each value is validated against the region list of the cloud service provider and partition.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"CreateInstanceResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The main payload of the response, containing instance information data. It includes a link to download the template file from your tenant.\nIf you use automated upload (only for AWS), the link will take you directly to AWS CloudFormation to create the stack.\nOtherwise, download the template and upload it in your CSP and follow the instructions to manually upload the template:\n- [AWS](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/configure-cortex-xdr/cortex-xdr-data-sources/cloud-service-provider-csp-onboarding/amazon-web-services-cloud-onboarding/deploy-the-cloudformation-template-in-aws)\n- [GCP](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/configure-cortex-xdr/cortex-xdr-data-sources/cloud-service-provider-csp-onboarding/google-cloud-platform-cloud-onboarding/onboard-google-cloud-platform)\n- [Azure](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/configure-cortex-xdr/cortex-xdr-data-sources/cloud-service-provider-csp-onboarding/microsoft-azure-cloud-onboarding/finalize-microsoft-azure-onboarding-by-executing-the-authentication-template)"}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Delete the specified integration instance template

> Delete the specified integration instance template by its template ID. Templates are generated when you call the onboarding or edit endpoints and are used to deploy CSP resources. A single pending instance can produce multiple templates.\
> \
> Deleting a template does not delete the cloud instance itself, nor does it remove any resources already deployed in your CSP. To remove the cloud instance, use \`POST /public\_api/v1/cloud\_onboarding/delete\_instance\`.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/delete_instance_template":{"post":{"tags":["Manual onboarding"],"summary":"Delete the specified integration instance template","description":"Delete the specified integration instance template by its template ID. Templates are generated when you call the onboarding or edit endpoints and are used to deploy CSP resources. A single pending instance can produce multiple templates.\n\nDeleting a template does not delete the cloud instance itself, nor does it remove any resources already deployed in your CSP. To remove the cloud instance, use `POST /public_api/v1/cloud_onboarding/delete_instance`.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteInstanceTemplateRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"deleteInstanceTemplate"}}},"components":{"schemas":{"DeleteInstanceTemplateRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"template_id":{"type":"string","description":"The ID of the integration instance template to delete.","minLength":1}},"required":["template_id"],"description":"Request body for deleting an integration instance template. Templates are generated when you call the onboarding or edit endpoints. Deleting a template does not delete the cloud instance or any deployed CSP resources."}}},"BaseResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The main payload of the response, containing operation-specific data."}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Edit a manually provisioned cloud integration instance

> Edit an existing manually-onboarded cloud integration instance. Provide the connector ID together with the updated configuration and the refreshed \`manual\_details\`.\
> \
> \*\*Immutable fields:\*\* \`scope\`, \`scan\_mode\`, and \`manual\_details.account\_id\` (or equivalent root account identifier) cannot be changed after onboarding. To change these, delete the instance and create a new one.\
> \
> \*\*Mutable fields:\*\* security capabilities (\`additional\_capabilities\`), scope filters (\`scope\_modifications\`), audit log configuration (\`collection\_configuration\`), instance name, and custom resource tags.\
> \
> After editing, Cortex regenerates the authentication template. Re-deploy the updated template in your CSP to apply the changes. Until the template is re-deployed, the instance remains in a pending-update state.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/edit_manual_instance":{"post":{"tags":["Manual onboarding"],"summary":"Edit a manually provisioned cloud integration instance","description":"Edit an existing manually-onboarded cloud integration instance. Provide the connector ID together with the updated configuration and the refreshed `manual_details`.\n\n**Immutable fields:** `scope`, `scan_mode`, and `manual_details.account_id` (or equivalent root account identifier) cannot be changed after onboarding. To change these, delete the instance and create a new one.\n\n**Mutable fields:** security capabilities (`additional_capabilities`), scope filters (`scope_modifications`), audit log configuration (`collection_configuration`), instance name, and custom resource tags.\n\nAfter editing, Cortex regenerates the authentication template. Re-deploy the updated template in your CSP to apply the changes. Until the template is re-deployed, the instance remains in a pending-update state.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditManualConnectorInstanceRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"editManualInstance"}}},"components":{"schemas":{"EditManualConnectorInstanceRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the connector instance to edit.","minLength":1},"cloud_provider":{"type":"string","enum":["AWS","AZURE","GCP"],"description":"The cloud service provider. Only AWS, AZURE, and GCP are supported."},"scope":{"type":"string","enum":["ACCOUNT","ORGANIZATION","ACCOUNT_GROUP"],"description":"The connector scope. Cannot be changed; must match the value used at creation."},"scan_mode":{"type":"string","enum":["MANAGED","OUTPOST"],"description":"The scan mode. Cannot be changed; must match the value used at creation. When OUTPOST, outpost_id is required."},"manual_details":{"type":"object","description":"Updated provider-specific manual details. account_id cannot be changed and must be provided exactly as it was at creation.","additionalProperties":true},"outpost_id":{"type":"string","description":"The ID of the outpost. Required when scan_mode is OUTPOST.","minLength":1},"instance_name":{"type":"string","description":"Optional display name for the integration instance."},"cloud_partition":{"type":"string","enum":["COMMERCIAL","GOV"],"description":"The cloud partition. Defaults to COMMERCIAL. `GOV` is supported for AWS, Azure, and GCP (Assured Workloads) on FedRAMP-certified tenants only.","default":"COMMERCIAL"},"custom_resources_tags":{"type":"array","items":{"$ref":"#/components/schemas/CustomResourceTag"}},"additional_capabilities":{"$ref":"#/components/schemas/InstanceAdditionalCapabilities"},"scan_config":{"allOf":[{"$ref":"#/components/schemas/InstanceScanConfig"}],"description":"The scan configuration for the instance. Each module block you provide replaces that module's configuration; an omitted module is left untouched. Enabling `ads` or `dspm` requires the matching capability to be `true` in `additional_capabilities` in the same request (`agentless_disk_scanning` for `ads`, `data_security_posture_management` for `dspm`). The capability stored on the instance isn't checked, so if you omit `additional_capabilities`, a request that sets `enabled` to `true` is rejected even when the capability is already active on the instance. Setting `enabled` to `false` doesn't require the capability."},"collection_configuration":{"$ref":"#/components/schemas/InstanceCollectionConfiguration"},"scope_modifications":{"$ref":"#/components/schemas/InstanceScopeModifications"}},"required":["id","cloud_provider","scope","scan_mode","manual_details","additional_capabilities"]}},"description":"Request body for editing a manually-onboarded cloud integration instance. Immutable fields (`scope`, `scan_mode`, root account identifier) cannot be changed — delete and re-create the instance to change these. After editing, re-deploy the updated authentication template in your CSP to apply the changes."},"CustomResourceTag":{"type":"object","properties":{"key":{"type":"string","description":"The key of the custom resource tag.","minLength":1},"value":{"type":"string","description":"The value of the custom resource tag."}}},"InstanceAdditionalCapabilities":{"type":"object","description":"Define which security capabilities you want to benefit from. All fields default to `false` and are optional. This field is optional when `cloud_provider` is `ALIBABA_CLOUD` or `IBM_CLOUD`; for all other providers it is required. IBM Cloud doesn't support additional security capabilities, so all values must be `false` or omitted.\n\n**Azure least-privilege deployment:** For Azure `ORGANIZATION` and `ACCOUNT_GROUP` scopes, Cortex deploys the per-subscription Azure Policy (`deployIfNotExists`), its managed identity, and the per-subscription resource group that the policy creates only when at least one of `agentless_disk_scanning`, `data_security_posture_management`, `kubernetes_security`, or `asset_discovery_key_vault` is `true`. If you select none of these, the policy, its managed identity, and the resource group aren't deployed. They are never deployed for Microsoft Entra ID-only onboarding.\n\n**Note:** Adding a security capability typically requires additional cloud provider permissions. For detailed information on the permissions required, see [Cloud service provider permissions](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/reference-and-developer-docs/cloud-service-provider-permissions).","properties":{"xsiam_analytics":{"type":"boolean","description":"Whether to enable XSIAM analytics to analyze your endpoint data to develop a baseline and raise Analytics and Analytics BIOC alerts when anomalies and malicious behaviors are detected."},"data_security_posture_management":{"type":"boolean","description":"Whether to enable data security posture management, an agentless data security scanner that discovers, classifies, protects, and governs sensitive data.","nullable":true},"registry_scanning":{"type":"boolean","description":"Whether to enable registry scanning, a container registry scanner that scans registry images for vulnerabilities, malware, and secrets."},"registry_scanning_options":{"$ref":"#/components/schemas/RegistryScanningOptions"},"serverless_scanning":{"type":"boolean","description":"Whether to enable serverless scanning to detect and remediate vulnerabilities within serverless functions during the development lifecycle. Seamless integration into CI/CD pipelines enables automated security scans for a continuously secure pre-production environment."},"agentless_disk_scanning":{"type":"boolean","description":"Whether to enable agentless disk scanning to remotely detect and remediate vulnerabilities during the development lifecycle."},"upload_files_to_wildfire":{"type":"boolean","description":"Whether to enable uploading files extracted from registry images to WildFire for malware analysis. If WildFire identifies a file as malicious, the associated registry image is re-evaluated and a malware finding is created."},"kubernetes_security":{"type":"boolean","default":false,"description":"Whether to enable Kubernetes security."},"asset_discovery_key_vault":{"type":"boolean","default":false,"description":"Azure only. Secret Security Posture and Correlation in the Cortex UI. Whether to grant Cortex read access to Azure Key Vault keys, certificates, and key rotation policies for asset discovery. For Azure `ORGANIZATION` and `ACCOUNT_GROUP` scopes, enabling this capability also deploys the per-subscription Azure Policy, its managed identity, and the per-subscription resource group. Azure cloud instances onboarded before this field was introduced keep their Key Vault access and have this field set to `true`."},"automation":{"type":"boolean","default":false,"description":"Whether to enable automation."},"automation_log_level":{"description":"Automation log level","enum":["OFF","Debug","Verbose"],"nullable":true}}},"RegistryScanningOptions":{"type":"object","properties":{"type":{"type":"string","description":"Type of registry scanning."},"last_days":{"type":"integer","description":"Number of days to scan back.","nullable":true}}},"InstanceScanConfig":{"type":"object","description":"Instance-level scan configuration, used in request bodies. Each module block you provide replaces that module's configuration. An omitted module is left untouched. Only `ads` and `dspm` can be sent. Sending `kspm` or `registry` returns a validation error. Enabling `ads` or `dspm` requires the matching capability to be `true` in `additional_capabilities` in the same request (`agentless_disk_scanning` for `ads`, `data_security_posture_management` for `dspm`). The capability stored on the instance isn't checked, so if you omit `additional_capabilities`, a request that sets `enabled` to `true` is rejected even when the capability is already active on the instance. Setting `enabled` to `false` doesn't require the capability.\n\nFor the shape returned by `POST /public_api/v1/cloud_onboarding/get_edit_instance_details`, see `InstanceScanConfigResponse`.","properties":{"ads":{"type":"object","nullable":true,"description":"Agentless Disk Scanning configuration for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Agentless Disk Scanning is active."},"entities_scope":{"allOf":[{"$ref":"#/components/schemas/ScanConfigEntitiesScope"}],"nullable":true,"description":"Narrows Agentless Disk Scanning to a subset of cloud entities."},"tags":{"allOf":[{"$ref":"#/components/schemas/ScanConfigTags"}],"nullable":true,"description":"Narrows which hosts Agentless Disk Scanning scans, using tag rules."}},"required":["enabled"]},"dspm":{"type":"object","nullable":true,"description":"Data Security Posture Management configuration for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Data Security Posture Management scanning is active."},"entities_scope":{"allOf":[{"$ref":"#/components/schemas/ScanConfigEntitiesScope"}],"nullable":true,"description":"Narrows Data Security Posture Management scanning to a subset of cloud entities."},"regions":{"allOf":[{"$ref":"#/components/schemas/ScanConfigRegions"}],"nullable":true,"description":"Narrows Data Security Posture Management scanning to a subset of regions."}},"required":["enabled"]}}},"ScanConfigEntitiesScope":{"type":"object","description":"Narrows a module to a subset of cloud entities. When `enabled` is `true`, `type` is required. Only the identifier lists valid for the instance's cloud service provider may be sent:\n\n- `AWS` — `account_ids`, `organizational_unit_ids`\n- `AZURE` — `subscription_ids`, `management_group_ids`\n- `GCP` — `project_ids`, `folder_ids`\n- `OCI` — `compartment_ids`\n- `ALIBABA_CLOUD`, `IBM_CLOUD` — None. Alibaba Cloud and IBM Cloud don't support identifier lists in `entities_scope`, and any identifier list returns a validation error.","properties":{"enabled":{"type":"boolean","description":"Whether the entity scope is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed entities are included in or excluded from scanning. Required when `enabled` is `true`."},"account_ids":{"type":"array","nullable":true,"description":"Cloud account IDs. Valid for AWS only.","items":{"type":"string","minLength":1}},"organizational_unit_ids":{"type":"array","nullable":true,"description":"Organizational unit IDs. Valid for AWS.","items":{"type":"string","minLength":1}},"subscription_ids":{"type":"array","nullable":true,"description":"Subscription IDs. Valid for Azure.","items":{"type":"string","minLength":1}},"management_group_ids":{"type":"array","nullable":true,"description":"Management group IDs. Valid for Azure.","items":{"type":"string","minLength":1}},"project_ids":{"type":"array","nullable":true,"description":"Project IDs. Valid for GCP.","items":{"type":"string","minLength":1}},"folder_ids":{"type":"array","nullable":true,"description":"Folder IDs. Valid for GCP.","items":{"type":"string","minLength":1}},"compartment_ids":{"type":"array","nullable":true,"description":"Compartment IDs. Valid for OCI.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"ScanConfigTags":{"type":"object","description":"A tag-based scan filter. When `enabled` is `true`, `type` is required.","properties":{"enabled":{"type":"boolean","description":"Whether the tag filter is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed tags are included in or excluded from scanning. Required when `enabled` is `true`."},"values":{"type":"array","nullable":true,"description":"The tags to match.","items":{"$ref":"#/components/schemas/ScanConfigTagEntry"}}},"required":["enabled"]},"ScanConfigTagEntry":{"type":"object","description":"A single key/value tag used by a tag-based scan filter.","properties":{"key":{"type":"string","description":"The tag key.","minLength":1},"value":{"type":"string","description":"The tag value."},"deletable":{"type":"boolean","nullable":true,"description":"Whether this tag entry can be removed."}},"required":["key","value"]},"ScanConfigRegions":{"type":"object","description":"A region-based scan filter. When `enabled` is `true`, `type` is required and each value must be a valid region for the cloud service provider.","properties":{"enabled":{"type":"boolean","description":"Whether the region filter is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed regions are included in or excluded from scanning. Required when `enabled` is `true`."},"values":{"type":"array","nullable":true,"description":"The region identifiers to match. Each value is validated against the region list of the cloud service provider and partition.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"InstanceCollectionConfiguration":{"type":"object","description":"This field is optional when onboarding or editing Alibaba Cloud.","properties":{"audit_logs":{"$ref":"#/components/schemas/InstanceAuditLogsConfig"}}},"InstanceAuditLogsConfig":{"type":"object","description":"To maximize security coverage, include collection of logs. This may require additional cloud service provider permissions. \nFor detailed information on the permissions required, see [Cloud service provider permissions](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/reference-and-developer-docs/cloud-service-provider-permissions).","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether to enable audit log collection. If this is `false`, then the other fields in this object should not be used."},"collection_method":{"enum":["CUSTOM","AUTOMATED"],"description":"Indicates whether to use automated or custom log collection. \n**Note:** `collection_method` is only relevant for AWS or OCI. For OCI, the value of `collection_method` must be `CUSTOM` and you must include `custom_collectors` with the details of the existing buckets. In AWS, if `collection_method` is `CUSTOM`, you need to update the bucket information when you manually upload the template to AWS CloudFormation.\n"},"data_events":{"type":"boolean","description":"The `data_events` field is only relevant when `cloud_provider` is `AWS` and `collection_method` is `AUTOMATED`. Currently supports AWS Lambda and Amazon S3."},"custom_collectors":{"type":"array","description":"A list of OCI bucket configurations for collecting logs.\n**Note:** This is only relevant for OCI when `collection_method` is `CUSTOM`.","items":{"type":"object","properties":{"region":{"type":"string","description":"The geographic region where the collection bucket is located."},"bucket_name":{"type":"string","description":"The name of the storage bucket where the log collection data will be collected and stored."},"compartment_ocid":{"type":"string","description":"The unique OCID (Oracle Cloud Identifier) of the compartment that owns the specified bucket."}}}},"is_control_tower_byob":{"type":"boolean","default":false,"description":"When `true`, configures the cloud instance to use AWS Control Tower Bring Your Own Bucket (BYOB) for audit log collection. This allows Cortex to collect audit logs from an existing S3 bucket managed by AWS Control Tower, rather than creating a new one.\n\n**Requirements:**\n- Only applicable when `cloud_provider` is `AWS`.\n- Requires `collection_method` to be set to `CUSTOM`.\n- Requires the cloud instance scope to be `ORGANIZATION`.\n- The Control Tower BYOB feature must be enabled for your tenant."}}},"InstanceScopeModifications":{"type":"object","description":"Defines which accounts, regions, and organizational groupings Cortex should include in or exclude from security scanning for this cloud instance. The fields you use depend on the cloud provider:\n\n- **AWS**: Use `accounts` to filter individual AWS accounts, `organizational_units` to filter AWS organizational units, and `regions` to restrict scanning to specific AWS regions.\n- **GCP**: Use `projects` to filter individual GCP projects, `folders` to filter GCP folders, and `regions` to restrict scanning to specific GCP regions.\n- **Azure**: Use `subscriptions` to filter individual Azure subscriptions, `management_groups` to filter Azure management groups, and `regions` to restrict scanning to specific Azure regions.\n- **OCI**: Use `compartments` to filter OCI compartments and `regions` to restrict scanning to specific OCI regions.\n- **Alibaba Cloud**: Use `accounts` to filter individual Alibaba Cloud accounts and `regions` to restrict scanning to specific regions.\n\nOnly one account-level bucket (`accounts`, `projects`, `subscriptions`, or `compartments`) and one organizational-level bucket (`organizational_units`, `management_groups`, or `folders`) may be enabled at a time.\n\nSet `onboard_only_mode` to `true` to onboard the instance without turning on environment scanning.","required":["regions"],"properties":{"accounts":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual AWS accounts within the cloud instance scope. Use this to include or exclude specific account IDs from security scanning. Not applicable for Azure, GCP, OCI, Alibaba Cloud, or IBM Cloud."},"projects":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual GCP projects within the cloud instance scope. Use this to include or exclude specific GCP project IDs from security scanning. Not applicable for AWS, Azure, OCI, Alibaba Cloud, or IBM Cloud."},"subscriptions":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual Azure subscriptions within the cloud instance scope. Use this to include or exclude specific Azure subscription IDs from security scanning. Not applicable for AWS, GCP, OCI, Alibaba Cloud, or IBM Cloud."},"compartments":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters OCI compartments within the cloud instance scope. Use this to include or exclude specific OCI compartment IDs from security scanning. Not applicable for AWS, GCP, Azure, Alibaba Cloud, or IBM Cloud."},"organizational_units":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters AWS organizational units (OUs) within the cloud instance scope. Use this to include or exclude entire OUs — and all accounts within them — from security scanning. Only valid for AWS with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"management_groups":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters Azure management groups within the cloud instance scope. Use this to include or exclude entire management groups — and all subscriptions within them — from security scanning. Only valid for Azure with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"folders":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters GCP folders within the cloud instance scope. Use this to include or exclude entire GCP folders — and all projects within them — from security scanning. Only valid for GCP with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"regions":{"$ref":"#/components/schemas/InstanceRegionsConfig","description":"Restricts security scanning to specific geographic regions within the cloud provider. When `enabled` is `true`, Cortex scans only the regions listed (if `type` is `INCLUDE`) or scans all regions except those listed (if `type` is `EXCLUDE`). This field is required."},"onboard_only_mode":{"type":"boolean","default":false,"description":"When `true`, onboards the cloud instance without turning on environment scanning. Cortex provisions the instance, but it doesn't discover the accounts in scope, and every security capability is disabled. Use this mode to stagger scanning: onboard the instance first, and start scanning later.\n\nTo start scanning, call `POST /public_api/v1/cloud_onboarding/edit_instance` with `onboard_only_mode` set to `false`. Cortex then enables the instance accounts, runs account discovery with the account and organizational filters in the same request, and runs a permission check.\n\n- Omitting the field is the same as setting it to `false`. Because `edit_instance` requires `scope_modifications`, include `\"onboard_only_mode\": true` in every edit of an onboard-only instance that should stay in onboard-only mode.\n- After scanning starts, you can't set `onboard_only_mode` back to `true`. The request returns an error.\n- If onboard-only mode isn't enabled for your tenant, setting it to `true` returns a validation error."}}},"InstanceAccountsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable (`true`) or disable (`false`)  this scope modification."},"type":{"type":"string","description":"Define whether the account IDs/project IDs/subscription IDs specified should be included in the scope or excluded from the scope. Valid values include:\n\n- `INCLUDE`\n- `EXCLUDE`","nullable":true},"account_ids":{"type":"array","description":"The list of account IDs to include or exclude (for AWS).","nullable":true,"items":{"type":"string","minLength":1}},"project_ids":{"type":"array","description":"The list of account IDs to include or exclude (for GCP).","nullable":true,"items":{"type":"string","minLength":1}},"subscription_ids":{"type":"array","description":"The list of account IDs to include or exclude (for Azure).","nullable":true,"items":{"type":"string","minLength":1}},"compartment_ids":{"type":"array","nullable":true,"description":"The list of compartment IDs to include or exclude (for OCI).","items":{"type":"string"}}}},"InstanceOUConfig":{"type":"object","description":"Configuration for filtering an organizational grouping within a cloud instance scope. Organizational groupings let you include or exclude entire subtrees of your cloud hierarchy — such as all accounts under an AWS organizational unit, all subscriptions under an Azure management group, or all projects under a GCP folder — rather than listing individual account IDs.\n\nProvide the IDs that match your cloud provider:\n- **AWS**: Use `organizational_unit_ids`\n- **Azure**: Use `management_group_ids`\n- **GCP**: Use `folder_ids`\n\nOnly one ID list may be populated at a time. When `enabled` is `false`, no other fields should be set.","properties":{"enabled":{"type":"boolean","description":"Whether to activate this organizational-level scope filter. When `true`, Cortex applies the `type` and the corresponding ID list to determine which organizational groupings to include or exclude. When `false`, no organizational filtering is applied and no other fields in this object should be set."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Determines how the provided ID list is applied to the scope. Required when `enabled` is `true`. Valid values include:\n\n- `INCLUDE`: Cortex scans only the organizational groupings listed in the ID list, and all accounts, subscriptions, or projects that belong to them.\n- `EXCLUDE`: Cortex scans all organizational groupings except those listed in the ID list."},"organizational_unit_ids":{"type":"array","nullable":true,"description":"A list of AWS organizational unit (OU) IDs to include in or exclude from security scanning. Each OU ID must be a non-empty string in the format `ou-xxxx-xxxxxxxx`. All AWS accounts that are members of the specified OUs are affected. Use only when the cloud provider is `AWS`.","items":{"type":"string","minLength":1}},"management_group_ids":{"type":"array","nullable":true,"description":"A list of Azure management group IDs to include in or exclude from security scanning. Each management group ID must be a non-empty string. All Azure subscriptions that belong to the specified management groups are affected. Use only when the cloud provider is `AZURE`.","items":{"type":"string","minLength":1}},"folder_ids":{"type":"array","nullable":true,"description":"A list of GCP folder IDs to include in or exclude from security scanning. Each folder ID must be a non-empty string (numeric GCP folder ID). All GCP projects that reside under the specified folders are affected. Use only when the cloud provider is `GCP`.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"InstanceRegionsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag to enable or disable region configuration"},"type":{"type":"string","nullable":true,"description":"Type of region configuration (e.g., INCLUDE, EXCLUDE)"},"regions":{"type":"array","nullable":true,"description":"List of regions to include or exclude","items":{"type":"string","minLength":1}}}},"BaseResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The main payload of the response, containing operation-specific data."}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Get the specified integration instance edit details

> Retrieve the current editable configuration of the specified integration instance, including any pending (not-yet-applied) changes. Use this endpoint before calling \`POST /public\_api/v1/cloud\_onboarding/edit\_manual\_instance\` to inspect the current state and identify which fields can be modified.\
> \
> The response contains two objects:\
> \
> \- \`fields\` — the current live configuration of the instance.\
> \- \`pending\_changes\` — configuration changes that have been submitted but not yet applied (for example, because the updated authentication template has not been re-deployed in the CSP).\
> \
> The \`fields.scan\_config\` object reports the instance-level scan configuration for all four modules, and its shape differs from the \`scan\_config\` request body. \`kspm\` and \`registry\` are returned with their capability-derived \`enabled\` value, \`dspm\` always includes \`regions\` and can include \`data\_assets\_classification\_options\`, and \`entities\_scope\` is returned only when one is set.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/get_edit_instance_details":{"post":{"tags":["Manual onboarding"],"summary":"Get the specified integration instance edit details","description":"Retrieve the current editable configuration of the specified integration instance, including any pending (not-yet-applied) changes. Use this endpoint before calling `POST /public_api/v1/cloud_onboarding/edit_manual_instance` to inspect the current state and identify which fields can be modified.\n\nThe response contains two objects:\n\n- `fields` — the current live configuration of the instance.\n- `pending_changes` — configuration changes that have been submitted but not yet applied (for example, because the updated authentication template has not been re-deployed in the CSP).\n\nThe `fields.scan_config` object reports the instance-level scan configuration for all four modules, and its shape differs from the `scan_config` request body. `kspm` and `registry` are returned with their capability-derived `enabled` value, `dspm` always includes `regions` and can include `data_assets_classification_options`, and `entities_scope` is returned only when one is set.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInstanceRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEditInstanceDetailsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"getEditInstanceDetails"}}},"components":{"schemas":{"GetInstanceRequestData":{"type":"object","properties":{"request_data":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The ID of the cloud instance of which you want to get the details."}}}}},"GetEditInstanceDetailsResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The editable configuration of the integration instance, containing the current fields and any pending changes.","properties":{"fields":{"type":"object","description":"The current editable configuration fields of the integration instance. Includes `scan_config`, the instance-level scan configuration that per-account overrides inherit from.","properties":{"scan_config":{"allOf":[{"$ref":"#/components/schemas/InstanceScanConfigResponse"}],"description":"The instance-level scan configuration, reported for all four modules. This shape differs from the `scan_config` request body. See `InstanceScanConfigResponse`."}},"additionalProperties":true},"pending_changes":{"type":"object","description":"Pending (not-yet-applied) configuration changes for the integration instance."}}}},"description":"Response containing the current editable configuration of the integration instance and any pending (not-yet-applied) changes."},"InstanceScanConfigResponse":{"type":"object","description":"The instance-level scan configuration, as returned in `fields.scan_config` by `POST /public_api/v1/cloud_onboarding/get_edit_instance_details`. This response shape differs from the `InstanceScanConfig` request body:\n\n- All four modules (`ads`, `dspm`, `kspm`, and `registry`) are returned. `kspm` and `registry` contain only their capability-derived `enabled` value.\n- `dspm.regions` is always returned. When no region filter is set, it defaults to `{\"type\": \"EXCLUDE\", \"values\": []}` with no `enabled` key.\n- `dspm` can include `data_assets_classification_options`.\n- `entities_scope` is returned only when one is set.","properties":{"ads":{"type":"object","description":"Agentless Disk Scanning configuration for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Agentless Disk Scanning is active."},"entities_scope":{"allOf":[{"$ref":"#/components/schemas/ScanConfigEntitiesScope"}],"description":"The entity scope for Agentless Disk Scanning. Returned only when one is set."},"tags":{"allOf":[{"$ref":"#/components/schemas/ScanConfigTags"}],"description":"The tag filter for Agentless Disk Scanning. Returned only when one is set."}},"required":["enabled"]},"dspm":{"type":"object","description":"Data Security Posture Management configuration for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Data Security Posture Management scanning is active."},"entities_scope":{"allOf":[{"$ref":"#/components/schemas/ScanConfigEntitiesScope"}],"description":"The entity scope for Data Security Posture Management. Returned only when one is set."},"regions":{"$ref":"#/components/schemas/ScanConfigRegionsResponse"},"data_assets_classification_options":{"allOf":[{"$ref":"#/components/schemas/ScanConfigDataClassificationOptions"}],"description":"The data classification options. Returned only when classification options are set."}},"required":["enabled","regions"]},"kspm":{"type":"object","description":"Kubernetes Security Posture Management status for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether Kubernetes Security Posture Management is active. Derived from the `kubernetes_security` capability. Read-only."}},"required":["enabled"]},"registry":{"type":"object","description":"Registry scanning status for the instance.","properties":{"enabled":{"type":"boolean","description":"Whether registry scanning is active. Derived from the `registry_scanning` capability. Read-only."}},"required":["enabled"]}}},"ScanConfigEntitiesScope":{"type":"object","description":"Narrows a module to a subset of cloud entities. When `enabled` is `true`, `type` is required. Only the identifier lists valid for the instance's cloud service provider may be sent:\n\n- `AWS` — `account_ids`, `organizational_unit_ids`\n- `AZURE` — `subscription_ids`, `management_group_ids`\n- `GCP` — `project_ids`, `folder_ids`\n- `OCI` — `compartment_ids`\n- `ALIBABA_CLOUD`, `IBM_CLOUD` — None. Alibaba Cloud and IBM Cloud don't support identifier lists in `entities_scope`, and any identifier list returns a validation error.","properties":{"enabled":{"type":"boolean","description":"Whether the entity scope is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed entities are included in or excluded from scanning. Required when `enabled` is `true`."},"account_ids":{"type":"array","nullable":true,"description":"Cloud account IDs. Valid for AWS only.","items":{"type":"string","minLength":1}},"organizational_unit_ids":{"type":"array","nullable":true,"description":"Organizational unit IDs. Valid for AWS.","items":{"type":"string","minLength":1}},"subscription_ids":{"type":"array","nullable":true,"description":"Subscription IDs. Valid for Azure.","items":{"type":"string","minLength":1}},"management_group_ids":{"type":"array","nullable":true,"description":"Management group IDs. Valid for Azure.","items":{"type":"string","minLength":1}},"project_ids":{"type":"array","nullable":true,"description":"Project IDs. Valid for GCP.","items":{"type":"string","minLength":1}},"folder_ids":{"type":"array","nullable":true,"description":"Folder IDs. Valid for GCP.","items":{"type":"string","minLength":1}},"compartment_ids":{"type":"array","nullable":true,"description":"Compartment IDs. Valid for OCI.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"ScanConfigTags":{"type":"object","description":"A tag-based scan filter. When `enabled` is `true`, `type` is required.","properties":{"enabled":{"type":"boolean","description":"Whether the tag filter is active."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed tags are included in or excluded from scanning. Required when `enabled` is `true`."},"values":{"type":"array","nullable":true,"description":"The tags to match.","items":{"$ref":"#/components/schemas/ScanConfigTagEntry"}}},"required":["enabled"]},"ScanConfigTagEntry":{"type":"object","description":"A single key/value tag used by a tag-based scan filter.","properties":{"key":{"type":"string","description":"The tag key.","minLength":1},"value":{"type":"string","description":"The tag value."},"deletable":{"type":"boolean","nullable":true,"description":"Whether this tag entry can be removed."}},"required":["key","value"]},"ScanConfigRegionsResponse":{"type":"object","description":"The region filter for Data Security Posture Management. This object is always returned. When no region filter is set, it defaults to `{\"type\": \"EXCLUDE\", \"values\": []}` with no `enabled` key, which means no regions are excluded.","properties":{"enabled":{"type":"boolean","description":"Whether the region filter is active. Omitted when no region filter is set."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Whether the listed regions are included in or excluded from scanning."},"values":{"type":"array","nullable":true,"description":"The region identifiers to match.","items":{"type":"string"}}}},"ScanConfigDataClassificationOptions":{"type":"object","description":"The effective data classification options for Data Security Posture Management, keyed by data service. Each entry identifies the service and whether data classification is enabled for it. Returned in responses only. You can't set this field through the scan configuration endpoints.","additionalProperties":{"type":"object","properties":{"name":{"type":"string","description":"The data service name."},"enabled":{"type":"boolean","description":"Whether data classification is enabled for the service."}},"additionalProperties":true}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Get identifiers for manual integration instance provisioning

> Generate the cloud service provider identifiers and \`manual\_details\` template needed to manually provision a cloud integration instance. This call does not persist any data — it returns a customized identifiers JSON file based on the scope, scan mode, and security capabilities you specify.\
> \
> \*\*Manual onboarding workflow\*\*\
> \
> 1\. Call this endpoint to obtain the identifiers file.\
> 2\. Create the CSP resources (IAM roles, service accounts, audit-log infrastructure). Use the values in the \`identifiers\` section where the resources need a Cortex value, such as the Cortex principal to trust.\
> 3\. Fill in the \`manual\_details\` section with values from your CSP environment, such as role ARNs, the SQS URL for AWS, or service account emails for GCP.\
> 4\. Call \`POST /public\_api/v1/cloud\_onboarding/create\_instance\` with the completed \`manual\_details\` to finalize onboarding.\
> \
> \*\*AWS external ID:\*\* Cortex doesn't generate an external ID for manual onboarding, and the response doesn't include one. Create your own value (for example, a UUID), add it to the trust policy of the Cortex Platform role as an \`sts:ExternalId\` condition, and send the same value in \`manual\_details.external\_id\` when you call \`create\_instance\`.\
> \
> \*\*AWS \`OutpostRoleArn\`:\*\* The role name in this value can contain \`gcp\` (for example, \`arn:aws:iam::\<account\_id>:role/gcp\_saas\_role\`). This is expected. Use the value as returned.\
> \
> \*\*CSP support:\*\* AWS, Azure, and GCP only. OCI and Alibaba Cloud do not support manual provisioning.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/get_manual_connector_identifiers":{"post":{"tags":["Manual onboarding"],"summary":"Get identifiers for manual integration instance provisioning","description":"Generate the cloud service provider identifiers and `manual_details` template needed to manually provision a cloud integration instance. This call does not persist any data — it returns a customized identifiers JSON file based on the scope, scan mode, and security capabilities you specify.\n\n**Manual onboarding workflow**\n\n1. Call this endpoint to obtain the identifiers file.\n2. Create the CSP resources (IAM roles, service accounts, audit-log infrastructure). Use the values in the `identifiers` section where the resources need a Cortex value, such as the Cortex principal to trust.\n3. Fill in the `manual_details` section with values from your CSP environment, such as role ARNs, the SQS URL for AWS, or service account emails for GCP.\n4. Call `POST /public_api/v1/cloud_onboarding/create_instance` with the completed `manual_details` to finalize onboarding.\n\n**AWS external ID:** Cortex doesn't generate an external ID for manual onboarding, and the response doesn't include one. Create your own value (for example, a UUID), add it to the trust policy of the Cortex Platform role as an `sts:ExternalId` condition, and send the same value in `manual_details.external_id` when you call `create_instance`.\n\n**AWS `OutpostRoleArn`:** The role name in this value can contain `gcp` (for example, `arn:aws:iam::<account_id>:role/gcp_saas_role`). This is expected. Use the value as returned.\n\n**CSP support:** AWS, Azure, and GCP only. OCI and Alibaba Cloud do not support manual provisioning.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManualConnectorIdentifiersRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetManualConnectorIdentifiersResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"getManualConnectorIdentifiers"}}},"components":{"schemas":{"GetManualConnectorIdentifiersRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"cloud_provider":{"type":"string","enum":["AWS","AZURE","GCP"],"description":"The cloud service provider. Valid values include:\n\n- `AWS`\n- `AZURE`\n- `GCP`"},"scope":{"type":"string","enum":["ACCOUNT","ORGANIZATION","ACCOUNT_GROUP"],"description":"Define the scope for this integration instance. Valid values include:\n\n- `ACCOUNT`\n- `ORGANIZATION`\n- `ACCOUNT_GROUP`"},"scan_mode":{"type":"string","enum":["MANAGED","OUTPOST"],"description":"Define the scan mode. Valid values include:\n\n- `MANAGED` (cloud scan): Security scanning is performed in the Cortex cloud environment.\n- `OUTPOST` (outpost scan): Security scanning is performed on infrastructure deployed to a cloud account owned by you. When set to `OUTPOST`, `outpost_id` is required."},"outpost_id":{"type":"string","description":"The ID of the outpost. Required when scan_mode is OUTPOST.","minLength":1},"custom_resources_tags":{"type":"array","items":{"$ref":"#/components/schemas/CustomResourceTag"}},"collection_configuration":{"$ref":"#/components/schemas/InstanceCollectionConfiguration"},"scope_modifications":{"$ref":"#/components/schemas/InstanceScopeModifications"},"additional_capabilities":{"$ref":"#/components/schemas/InstanceAdditionalCapabilities"},"account_details":{"allOf":[{"$ref":"#/components/schemas/AccountDetails"}],"description":"Required for Azure only. Provide the Azure tenant ID as organization_id (for example {\"organization_id\": \"<tenant_id>\"}). The Service Principal (SP) must already exist in the tenant before calling this endpoint. Must not be sent for non-Azure providers."}},"required":["cloud_provider","scope","scan_mode"],"description":"Parameters that define the identifiers to generate. Must match the `cloud_provider`, `scope`, `scan_mode`, and capability configuration you intend to use when calling `create_instance`. Only AWS, Azure, and GCP are supported."}}},"CustomResourceTag":{"type":"object","properties":{"key":{"type":"string","description":"The key of the custom resource tag.","minLength":1},"value":{"type":"string","description":"The value of the custom resource tag."}}},"InstanceCollectionConfiguration":{"type":"object","description":"This field is optional when onboarding or editing Alibaba Cloud.","properties":{"audit_logs":{"$ref":"#/components/schemas/InstanceAuditLogsConfig"}}},"InstanceAuditLogsConfig":{"type":"object","description":"To maximize security coverage, include collection of logs. This may require additional cloud service provider permissions. \nFor detailed information on the permissions required, see [Cloud service provider permissions](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/reference-and-developer-docs/cloud-service-provider-permissions).","required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Whether to enable audit log collection. If this is `false`, then the other fields in this object should not be used."},"collection_method":{"enum":["CUSTOM","AUTOMATED"],"description":"Indicates whether to use automated or custom log collection. \n**Note:** `collection_method` is only relevant for AWS or OCI. For OCI, the value of `collection_method` must be `CUSTOM` and you must include `custom_collectors` with the details of the existing buckets. In AWS, if `collection_method` is `CUSTOM`, you need to update the bucket information when you manually upload the template to AWS CloudFormation.\n"},"data_events":{"type":"boolean","description":"The `data_events` field is only relevant when `cloud_provider` is `AWS` and `collection_method` is `AUTOMATED`. Currently supports AWS Lambda and Amazon S3."},"custom_collectors":{"type":"array","description":"A list of OCI bucket configurations for collecting logs.\n**Note:** This is only relevant for OCI when `collection_method` is `CUSTOM`.","items":{"type":"object","properties":{"region":{"type":"string","description":"The geographic region where the collection bucket is located."},"bucket_name":{"type":"string","description":"The name of the storage bucket where the log collection data will be collected and stored."},"compartment_ocid":{"type":"string","description":"The unique OCID (Oracle Cloud Identifier) of the compartment that owns the specified bucket."}}}},"is_control_tower_byob":{"type":"boolean","default":false,"description":"When `true`, configures the cloud instance to use AWS Control Tower Bring Your Own Bucket (BYOB) for audit log collection. This allows Cortex to collect audit logs from an existing S3 bucket managed by AWS Control Tower, rather than creating a new one.\n\n**Requirements:**\n- Only applicable when `cloud_provider` is `AWS`.\n- Requires `collection_method` to be set to `CUSTOM`.\n- Requires the cloud instance scope to be `ORGANIZATION`.\n- The Control Tower BYOB feature must be enabled for your tenant."}}},"InstanceScopeModifications":{"type":"object","description":"Defines which accounts, regions, and organizational groupings Cortex should include in or exclude from security scanning for this cloud instance. The fields you use depend on the cloud provider:\n\n- **AWS**: Use `accounts` to filter individual AWS accounts, `organizational_units` to filter AWS organizational units, and `regions` to restrict scanning to specific AWS regions.\n- **GCP**: Use `projects` to filter individual GCP projects, `folders` to filter GCP folders, and `regions` to restrict scanning to specific GCP regions.\n- **Azure**: Use `subscriptions` to filter individual Azure subscriptions, `management_groups` to filter Azure management groups, and `regions` to restrict scanning to specific Azure regions.\n- **OCI**: Use `compartments` to filter OCI compartments and `regions` to restrict scanning to specific OCI regions.\n- **Alibaba Cloud**: Use `accounts` to filter individual Alibaba Cloud accounts and `regions` to restrict scanning to specific regions.\n\nOnly one account-level bucket (`accounts`, `projects`, `subscriptions`, or `compartments`) and one organizational-level bucket (`organizational_units`, `management_groups`, or `folders`) may be enabled at a time.\n\nSet `onboard_only_mode` to `true` to onboard the instance without turning on environment scanning.","required":["regions"],"properties":{"accounts":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual AWS accounts within the cloud instance scope. Use this to include or exclude specific account IDs from security scanning. Not applicable for Azure, GCP, OCI, Alibaba Cloud, or IBM Cloud."},"projects":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual GCP projects within the cloud instance scope. Use this to include or exclude specific GCP project IDs from security scanning. Not applicable for AWS, Azure, OCI, Alibaba Cloud, or IBM Cloud."},"subscriptions":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters individual Azure subscriptions within the cloud instance scope. Use this to include or exclude specific Azure subscription IDs from security scanning. Not applicable for AWS, GCP, OCI, Alibaba Cloud, or IBM Cloud."},"compartments":{"$ref":"#/components/schemas/InstanceAccountsConfig","description":"Filters OCI compartments within the cloud instance scope. Use this to include or exclude specific OCI compartment IDs from security scanning. Not applicable for AWS, GCP, Azure, Alibaba Cloud, or IBM Cloud."},"organizational_units":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters AWS organizational units (OUs) within the cloud instance scope. Use this to include or exclude entire OUs — and all accounts within them — from security scanning. Only valid for AWS with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"management_groups":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters Azure management groups within the cloud instance scope. Use this to include or exclude entire management groups — and all subscriptions within them — from security scanning. Only valid for Azure with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"folders":{"$ref":"#/components/schemas/InstanceOUConfig","description":"Filters GCP folders within the cloud instance scope. Use this to include or exclude entire GCP folders — and all projects within them — from security scanning. Only valid for GCP with `ORGANIZATION` scope. Only one of `organizational_units`, `management_groups`, or `folders` may be enabled at a time."},"regions":{"$ref":"#/components/schemas/InstanceRegionsConfig","description":"Restricts security scanning to specific geographic regions within the cloud provider. When `enabled` is `true`, Cortex scans only the regions listed (if `type` is `INCLUDE`) or scans all regions except those listed (if `type` is `EXCLUDE`). This field is required."},"onboard_only_mode":{"type":"boolean","default":false,"description":"When `true`, onboards the cloud instance without turning on environment scanning. Cortex provisions the instance, but it doesn't discover the accounts in scope, and every security capability is disabled. Use this mode to stagger scanning: onboard the instance first, and start scanning later.\n\nTo start scanning, call `POST /public_api/v1/cloud_onboarding/edit_instance` with `onboard_only_mode` set to `false`. Cortex then enables the instance accounts, runs account discovery with the account and organizational filters in the same request, and runs a permission check.\n\n- Omitting the field is the same as setting it to `false`. Because `edit_instance` requires `scope_modifications`, include `\"onboard_only_mode\": true` in every edit of an onboard-only instance that should stay in onboard-only mode.\n- After scanning starts, you can't set `onboard_only_mode` back to `true`. The request returns an error.\n- If onboard-only mode isn't enabled for your tenant, setting it to `true` returns a validation error."}}},"InstanceAccountsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable (`true`) or disable (`false`)  this scope modification."},"type":{"type":"string","description":"Define whether the account IDs/project IDs/subscription IDs specified should be included in the scope or excluded from the scope. Valid values include:\n\n- `INCLUDE`\n- `EXCLUDE`","nullable":true},"account_ids":{"type":"array","description":"The list of account IDs to include or exclude (for AWS).","nullable":true,"items":{"type":"string","minLength":1}},"project_ids":{"type":"array","description":"The list of account IDs to include or exclude (for GCP).","nullable":true,"items":{"type":"string","minLength":1}},"subscription_ids":{"type":"array","description":"The list of account IDs to include or exclude (for Azure).","nullable":true,"items":{"type":"string","minLength":1}},"compartment_ids":{"type":"array","nullable":true,"description":"The list of compartment IDs to include or exclude (for OCI).","items":{"type":"string"}}}},"InstanceOUConfig":{"type":"object","description":"Configuration for filtering an organizational grouping within a cloud instance scope. Organizational groupings let you include or exclude entire subtrees of your cloud hierarchy — such as all accounts under an AWS organizational unit, all subscriptions under an Azure management group, or all projects under a GCP folder — rather than listing individual account IDs.\n\nProvide the IDs that match your cloud provider:\n- **AWS**: Use `organizational_unit_ids`\n- **Azure**: Use `management_group_ids`\n- **GCP**: Use `folder_ids`\n\nOnly one ID list may be populated at a time. When `enabled` is `false`, no other fields should be set.","properties":{"enabled":{"type":"boolean","description":"Whether to activate this organizational-level scope filter. When `true`, Cortex applies the `type` and the corresponding ID list to determine which organizational groupings to include or exclude. When `false`, no organizational filtering is applied and no other fields in this object should be set."},"type":{"type":"string","enum":["INCLUDE","EXCLUDE"],"nullable":true,"description":"Determines how the provided ID list is applied to the scope. Required when `enabled` is `true`. Valid values include:\n\n- `INCLUDE`: Cortex scans only the organizational groupings listed in the ID list, and all accounts, subscriptions, or projects that belong to them.\n- `EXCLUDE`: Cortex scans all organizational groupings except those listed in the ID list."},"organizational_unit_ids":{"type":"array","nullable":true,"description":"A list of AWS organizational unit (OU) IDs to include in or exclude from security scanning. Each OU ID must be a non-empty string in the format `ou-xxxx-xxxxxxxx`. All AWS accounts that are members of the specified OUs are affected. Use only when the cloud provider is `AWS`.","items":{"type":"string","minLength":1}},"management_group_ids":{"type":"array","nullable":true,"description":"A list of Azure management group IDs to include in or exclude from security scanning. Each management group ID must be a non-empty string. All Azure subscriptions that belong to the specified management groups are affected. Use only when the cloud provider is `AZURE`.","items":{"type":"string","minLength":1}},"folder_ids":{"type":"array","nullable":true,"description":"A list of GCP folder IDs to include in or exclude from security scanning. Each folder ID must be a non-empty string (numeric GCP folder ID). All GCP projects that reside under the specified folders are affected. Use only when the cloud provider is `GCP`.","items":{"type":"string","minLength":1}}},"required":["enabled"]},"InstanceRegionsConfig":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Flag to enable or disable region configuration"},"type":{"type":"string","nullable":true,"description":"Type of region configuration (e.g., INCLUDE, EXCLUDE)"},"regions":{"type":"array","nullable":true,"description":"List of regions to include or exclude","items":{"type":"string","minLength":1}}}},"InstanceAdditionalCapabilities":{"type":"object","description":"Define which security capabilities you want to benefit from. All fields default to `false` and are optional. This field is optional when `cloud_provider` is `ALIBABA_CLOUD` or `IBM_CLOUD`; for all other providers it is required. IBM Cloud doesn't support additional security capabilities, so all values must be `false` or omitted.\n\n**Azure least-privilege deployment:** For Azure `ORGANIZATION` and `ACCOUNT_GROUP` scopes, Cortex deploys the per-subscription Azure Policy (`deployIfNotExists`), its managed identity, and the per-subscription resource group that the policy creates only when at least one of `agentless_disk_scanning`, `data_security_posture_management`, `kubernetes_security`, or `asset_discovery_key_vault` is `true`. If you select none of these, the policy, its managed identity, and the resource group aren't deployed. They are never deployed for Microsoft Entra ID-only onboarding.\n\n**Note:** Adding a security capability typically requires additional cloud provider permissions. For detailed information on the permissions required, see [Cloud service provider permissions](https://app.gitbook.com/s/cyIgISZgANJYkmLlnwdK/reference-and-developer-docs/cloud-service-provider-permissions).","properties":{"xsiam_analytics":{"type":"boolean","description":"Whether to enable XSIAM analytics to analyze your endpoint data to develop a baseline and raise Analytics and Analytics BIOC alerts when anomalies and malicious behaviors are detected."},"data_security_posture_management":{"type":"boolean","description":"Whether to enable data security posture management, an agentless data security scanner that discovers, classifies, protects, and governs sensitive data.","nullable":true},"registry_scanning":{"type":"boolean","description":"Whether to enable registry scanning, a container registry scanner that scans registry images for vulnerabilities, malware, and secrets."},"registry_scanning_options":{"$ref":"#/components/schemas/RegistryScanningOptions"},"serverless_scanning":{"type":"boolean","description":"Whether to enable serverless scanning to detect and remediate vulnerabilities within serverless functions during the development lifecycle. Seamless integration into CI/CD pipelines enables automated security scans for a continuously secure pre-production environment."},"agentless_disk_scanning":{"type":"boolean","description":"Whether to enable agentless disk scanning to remotely detect and remediate vulnerabilities during the development lifecycle."},"upload_files_to_wildfire":{"type":"boolean","description":"Whether to enable uploading files extracted from registry images to WildFire for malware analysis. If WildFire identifies a file as malicious, the associated registry image is re-evaluated and a malware finding is created."},"kubernetes_security":{"type":"boolean","default":false,"description":"Whether to enable Kubernetes security."},"asset_discovery_key_vault":{"type":"boolean","default":false,"description":"Azure only. Secret Security Posture and Correlation in the Cortex UI. Whether to grant Cortex read access to Azure Key Vault keys, certificates, and key rotation policies for asset discovery. For Azure `ORGANIZATION` and `ACCOUNT_GROUP` scopes, enabling this capability also deploys the per-subscription Azure Policy, its managed identity, and the per-subscription resource group. Azure cloud instances onboarded before this field was introduced keep their Key Vault access and have this field set to `true`."},"automation":{"type":"boolean","default":false,"description":"Whether to enable automation."},"automation_log_level":{"description":"Automation log level","enum":["OFF","Debug","Verbose"],"nullable":true}}},"RegistryScanningOptions":{"type":"object","properties":{"type":{"type":"string","description":"Type of registry scanning."},"last_days":{"type":"integer","description":"Number of days to scan back.","nullable":true}}},"AccountDetails":{"type":"object","description":"`account_details` is required for onboarding Azure and is not used for onboarding AWS or GCP.","properties":{"organization_id":{"type":"string","description":"Azure tenant ID","minLength":1}}},"GetManualConnectorIdentifiersResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The generated identifiers file.","properties":{"identifiers":{"type":"object","additionalProperties":true,"description":"Cortex-generated values to use when you create the CSP resources. The keys depend on the CSP and on the capabilities and audit log settings in the request."},"manual_details":{"type":"object","additionalProperties":{"type":"string"},"description":"The fields to fill in with values from your CSP environment and send to `create_instance`. Every value is returned as an empty string."}},"additionalProperties":true}},"description":"Response containing the generated identifiers file. The `reply` object has two sections:\n\n- `identifiers`: Cortex-generated values to use when you create the CSP resources. The keys depend on the CSP and on the capabilities and audit log settings in the request. For AWS, `identifiers` can include:\n  - `OutpostRoleArn`: The Cortex principal to trust in the Cortex Platform role. Always returned.\n  - `ScannerRoleArn`: The Cortex principals to trust in the scanner role. Returned when registry scanning, serverless scanning, or data security posture management is enabled.\n  - `OutpostAccountId` and `KmsAccountADS`: Returned when agentless disk scanning is enabled.\n  - `MTKmsAccountDSPM`: Returned when data security posture management is enabled.\n  - `Audience` and `CollectorServiceAccountId`: The federated audience and Cortex collector service account to use in the trust policy of the CloudTrail read role. Returned when audit logs are enabled.\n\n  For GCP, `identifiers` contains the Cortex service account emails to grant roles to: `outpost_service_account_mail` (always returned), `saas_collector_service_account_mail` (when audit logs are enabled), and `dspm_scanner_service_account_email`, `registry_scanner_service_account_email`, and `serverless_scanner_service_account_email` (when the matching capability is enabled).\n\n  The response doesn't include an external ID or the names of the roles and buckets to create. You choose those values.\n- `manual_details`: The fields to fill in and send to `create_instance`. Every value is returned as an empty string. The fields depend on the CSP, the scope, and the capabilities and audit log settings in the request:\n  - **AWS:** `organization_id`, `account_id`, `account_name`, `role_arn`, and `external_id` are always returned. `account_group` is added for `ACCOUNT_GROUP` scope; `outpost_scanner_role_arn` when registry scanning, serverless scanning, or data security posture management is enabled; `cloudtrail_role` and `sqs_url` when audit logs are enabled; and `logging_account_id` for AWS Control Tower with your own CloudTrail bucket.\n  - **Azure:** `tenant_id` is always returned. `subscription_id` is added for `ACCOUNT` scope and `management_group_id` for `ACCOUNT_GROUP` scope; `resource_group_name` and `resource_group_location` when agentless disk scanning or data security posture management is enabled; `ads_image_gallery_resource_id` when agentless disk scanning is enabled; and `eventhub_name`, `eventhub_resource_group_name`, `eventhub_namespace`, `azure_audit_eventhub_consumer_group_name`, `storage_account_name`, and `eventhub_audit_client_id` when audit logs are enabled.\n  - **GCP:** `organization_id`, `account_id` (the project ID), and `service_account_email` are always returned. `account_group` is added for `ACCOUNT_GROUP` scope; `outpost_scanner_service_account_email` when registry scanning, serverless scanning, or data security posture management is enabled; and `audit_service_account_email` and `audit_pubsub_subscription_id` when audit logs are enabled."},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Mark a manual connector as updated/resolved

> Mark a manually-onboarded connector as updated and resolved by its connector ID. Call this endpoint after you have re-deployed the updated authentication template in your CSP following an edit operation. This signals to Cortex that the manual changes have been applied and clears the pending-update state on the connector.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/manual_update_and_resolve":{"post":{"tags":["Manual onboarding"],"summary":"Mark a manual connector as updated/resolved","description":"Mark a manually-onboarded connector as updated and resolved by its connector ID. Call this endpoint after you have re-deployed the updated authentication template in your CSP following an edit operation. This signals to Cortex that the manual changes have been applied and clears the pending-update state on the connector.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ManualUpdateAndResolveRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"manualUpdateAndResolve"}}},"components":{"schemas":{"ManualUpdateAndResolveRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"instance_id":{"type":"string","description":"The connector GUID. Must be exactly 32 characters.","minLength":32,"maxLength":32}},"required":["instance_id"],"description":"Identifies the manually-onboarded connector to mark as updated/resolved. Call this after re-deploying the updated authentication template in your CSP."}}},"BaseResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The main payload of the response, containing operation-specific data."}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Resolve the relevant additional security capabilities for a connector

> Resolve the additional security capabilities available for a given cloud provider, scope, and partition combination, based on your tenant's license. Use this endpoint before onboarding to determine which \`additional\_capabilities\` fields are valid for your configuration.\
> \
> The response returns two lists:\
> \
> \- \`additional\_capabilities\` — capability keys you can set to \`true\` in \`InstanceAdditionalCapabilities\` (for example \`agentless\_disk\_scanning\`, \`registry\_scanning\`).\
> \- \`collection\_configuration\` — collection-configuration keys available for the connector (for example \`audit\_logs\`).\
> \
> \*\*CSP and license constraints apply.\*\* For example, DSPM is not available for Azure in the \`GOV\` partition; OCI Standard license restricts which capabilities are allowed. See the overview for the full capability matrix.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/resolve_connector_security_capabilities":{"post":{"tags":["Manual onboarding"],"summary":"Resolve the relevant additional security capabilities for a connector","description":"Resolve the additional security capabilities available for a given cloud provider, scope, and partition combination, based on your tenant's license. Use this endpoint before onboarding to determine which `additional_capabilities` fields are valid for your configuration.\n\nThe response returns two lists:\n\n- `additional_capabilities` — capability keys you can set to `true` in `InstanceAdditionalCapabilities` (for example `agentless_disk_scanning`, `registry_scanning`).\n- `collection_configuration` — collection-configuration keys available for the connector (for example `audit_logs`).\n\n**CSP and license constraints apply.** For example, DSPM is not available for Azure in the `GOV` partition; OCI Standard license restricts which capabilities are allowed. See the overview for the full capability matrix.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRelevantAdditionalCapabilitiesRequestData"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRelevantAdditionalCapabilitiesResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"resolveConnectorSecurityCapabilities"}}},"components":{"schemas":{"GetRelevantAdditionalCapabilitiesRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"cloud_provider":{"type":"string","enum":["AWS","GCP","AZURE","OCI","ALIBABA_CLOUD","IBM_CLOUD"],"description":"The cloud service provider."},"scope":{"type":"string","enum":["ORGANIZATION","ACCOUNT_GROUP","ACCOUNT"],"description":"The connector scope."},"cloud_partition":{"type":"string","enum":["COMMERCIAL","GOV"],"description":"The cloud partition. Defaults to COMMERCIAL. `GOV` is supported for AWS, Azure, and GCP (Assured Workloads) on FedRAMP-certified tenants only.","default":"COMMERCIAL"}},"required":["cloud_provider","scope"],"description":"Parameters that define the connector configuration to resolve capabilities for. The returned capability list is filtered by your tenant's license and the CSP/partition/scope combination."}}},"GetRelevantAdditionalCapabilitiesResponse":{"type":"object","properties":{"reply":{"type":"object","description":"The available additional capabilities and collection-configuration keys for the given provider/scope, based on the tenant's license.","properties":{"additional_capabilities":{"type":"array","description":"List of available capability keys.","items":{"type":"string"}},"collection_configuration":{"type":"array","description":"List of available collection-configuration keys (for example audit_logs). Omitted when none are available.","items":{"type":"string"}}}}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Get the fields required to connect a deployed template

> Get the list of fields you must provide to \`create\_custom\_connector\` to manually connect a pending cloud instance. Use this endpoint when you deployed a Cortex-generated authentication template but its notification didn't reach Cortex, for example because your CSP environment is air-gapped or blocks outbound calls from the template.\
> \
> Manually connecting a cloud instance is part of onboarding with \`create\_instance\_template\`. It's separate from manual onboarding with the \`MANUAL\` provisioning method, where you create the CSP resources yourself.\
> \
> \*\*Workflow:\*\*\
> \
> 1\. Call \`POST /public\_api/v1/cloud\_onboarding/create\_instance\_template\` to create a pending cloud instance and download its authentication template.\
> 2\. Deploy the template in your CSP. If your environment blocks outbound calls from the template, remove the callback notification resource first.\
> 3\. Call this endpoint with the template ID to get the fields to provide.\
> 4\. Call \`POST /public\_api/v1/cloud\_onboarding/create\_custom\_connector\` with the values from the template outputs.\
> \
> The template ID is the \`id\` of the pending cloud instance. To find it, call \`POST /public\_api/v1/cloud\_onboarding/get\_instances\` and look for the instance with status \`PENDING\`.\
> \
> \*\*How to read the response:\*\*\
> \
> \- \`editable: true\` fields are required in the \`create\_custom\_connector\` request.\
> \- \`editable: false\` fields are set by Cortex. Any value you send for them is ignored.\
> \- \*\*Exceptions:\*\* \`organization\_id\`, \`resources\_data.client\_id\`, and \`resources\_data.customer\_object\_id\` are returned with \`editable: false\`, but \`create\_custom\_connector\` accepts them. If the field's \`value\` is \`null\` or empty, you must provide it. If the field has a value, Cortex uses that value and ignores the value you send.\
> \- \`scope\` shows where to place the value in the request. Fields with no \`scope\` or an empty \`scope\` go at the root of \`request\_data\`. A \`scope\` of \`credentials\` goes in the \`credentials\` object. A \`scope\` of \`resources\_data\` goes directly in the \`resources\_data\` object. A \`scope\` such as \`resources\_data.outpost\_scanner\` goes in a nested object, \`resources\_data.outpost\_scanner.\<name>\`.\
> \- The \`provisioning\_method\` field lists the allowed values for the template in \`options\`.\
> \
> The fields returned depend on the CSP, scope, and security capabilities of the template.\
> \
> \*\*CSP support:\*\* AWS, Azure, GCP, OCI, Alibaba Cloud, and IBM Cloud.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/get_custom_template_fields":{"post":{"tags":["Manual onboarding"],"summary":"Get the fields required to connect a deployed template","description":"Get the list of fields you must provide to `create_custom_connector` to manually connect a pending cloud instance. Use this endpoint when you deployed a Cortex-generated authentication template but its notification didn't reach Cortex, for example because your CSP environment is air-gapped or blocks outbound calls from the template.\n\nManually connecting a cloud instance is part of onboarding with `create_instance_template`. It's separate from manual onboarding with the `MANUAL` provisioning method, where you create the CSP resources yourself.\n\n**Workflow:**\n\n1. Call `POST /public_api/v1/cloud_onboarding/create_instance_template` to create a pending cloud instance and download its authentication template.\n2. Deploy the template in your CSP. If your environment blocks outbound calls from the template, remove the callback notification resource first.\n3. Call this endpoint with the template ID to get the fields to provide.\n4. Call `POST /public_api/v1/cloud_onboarding/create_custom_connector` with the values from the template outputs.\n\nThe template ID is the `id` of the pending cloud instance. To find it, call `POST /public_api/v1/cloud_onboarding/get_instances` and look for the instance with status `PENDING`.\n\n**How to read the response:**\n\n- `editable: true` fields are required in the `create_custom_connector` request.\n- `editable: false` fields are set by Cortex. Any value you send for them is ignored.\n- **Exceptions:** `organization_id`, `resources_data.client_id`, and `resources_data.customer_object_id` are returned with `editable: false`, but `create_custom_connector` accepts them. If the field's `value` is `null` or empty, you must provide it. If the field has a value, Cortex uses that value and ignores the value you send.\n- `scope` shows where to place the value in the request. Fields with no `scope` or an empty `scope` go at the root of `request_data`. A `scope` of `credentials` goes in the `credentials` object. A `scope` of `resources_data` goes directly in the `resources_data` object. A `scope` such as `resources_data.outpost_scanner` goes in a nested object, `resources_data.outpost_scanner.<name>`.\n- The `provisioning_method` field lists the allowed values for the template in `options`.\n\nThe fields returned depend on the CSP, scope, and security capabilities of the template.\n\n**CSP support:** AWS, Azure, GCP, OCI, Alibaba Cloud, and IBM Cloud.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomTemplateFieldsRequestData"}}},"description":"The ID of the pending cloud instance (template) whose fields to return."},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"getCustomTemplateFields"}}},"components":{"schemas":{"GetCustomTemplateFieldsRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"template_id":{"type":"string","minLength":32,"maxLength":32,"description":"The ID of the pending cloud instance (template) created by `create_instance_template`. Must be exactly 32 characters."}},"description":"Identifies the pending cloud instance whose template fields to return.","required":["template_id"],"additionalProperties":false}},"required":["request_data"]},"CustomFieldsResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"},"description":"The fields set by the authentication template, ordered by placement in the request: `provisioning_method`, root account fields, `credentials`, and then `resources_data` modules."}}}}},"CustomField":{"type":"object","description":"A field that is set by the deployed authentication template.","properties":{"name":{"type":"string","description":"The key to use for the field in the request."},"pretty_name":{"type":"string","description":"The display name of the field."},"value":{"type":"string","nullable":true,"description":"The current or Cortex-defined value of the field. `null` or an empty string means you must provide the value."},"scope":{"type":"string","description":"Where to place the field in the request. Omitted, or an empty string, for fields that go at the root of `request_data`. `credentials` means the `credentials` object. `resources_data` means directly in the `resources_data` object. `resources_data.<module>` means a nested object in `resources_data` that follows the dot-separated path."},"editable":{"type":"boolean","description":"`true` if you must provide the value. `false` if the value is set by Cortex; any value you send is ignored."},"options":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldOption"},"description":"The allowed values for the field. Returned for the `provisioning_method` field only."}}},"CustomFieldOption":{"type":"object","description":"An allowed value for the field.","properties":{"name":{"type":"string","description":"The value to send in the request."},"pretty_name":{"type":"string","description":"The display name of the value."}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Manually connect a cloud instance

> Manually connect a pending cloud instance after you deploy its Cortex-generated authentication template and the template's notification doesn't reach Cortex. Provide the values from the template outputs for every field that \`POST /public\_api/v1/cloud\_onboarding/get\_custom\_template\_fields\` returns with \`editable: true\`.\
> \
> \*\*Where to place each field:\*\*\
> \
> \- Fields with no \`scope\` or an empty \`scope\` (\`account\_id\`, \`organization\_id\`, \`account\_group\`, \`account\_name\`, \`csp\_org\_id\`) go at the root of \`request\_data\`.\
> \- Fields with a \`credentials\` scope go in the \`credentials\` object.\
> \- Fields with a \`resources\_data\` scope go directly in the \`resources\_data\` object. For example, a field named \`service\_account\_email\` with the scope \`resources\_data\` is sent as \`resources\_data.service\_account\_email\`.\
> \- Fields with a \`resources\_data.\<module>\` scope go in \`resources\_data\`, nested by the scope path. For example, a field named \`sqs\_url\` with the scope \`resources\_data.audit\_logs\_without\_cloud\_trail\` is sent as \`resources\_data.audit\_logs\_without\_cloud\_trail.sqs\_url\`. If you send a module field without its module key, the field is reported as missing.\
> \
> Values you send for fields that are not editable are ignored, with these exceptions: \`organization\_id\`, \`resources\_data.client\_id\`, and \`resources\_data.customer\_object\_id\`. If \`get\_custom\_template\_fields\` returns one of these fields with an empty \`value\`, you must provide it. If it returns a value, Cortex uses that value.\
> \
> \*\*Supported \`provisioning\_method\` values:\*\*\
> \
> \| CSP | Allowed values |\
> \|---|---|\
> \| AWS | \`CF\`, or \`TF\` for the \`ACCOUNT\` scope only |\
> \| Azure | \`TF\`, \`ARM\` |\
> \| GCP | \`TF\` |\
> \| OCI | \`TF\` |\
> \| Alibaba Cloud | \`TF\` |\
> \| IBM Cloud | \`TF\` |\
> \
> Use a value from the \`options\` list of the \`provisioning\_method\` field in the \`get\_custom\_template\_fields\` response. The \`MANUAL\` provisioning method isn't supported by this endpoint. For manual onboarding with your own CSP resources, use \`POST /public\_api/v1/cloud\_onboarding/create\_instance\`.\
> \
> \*\*Errors:\*\*\
> \
> \- \`400\` if a required field is missing (the error message lists the missing fields), the provisioning method isn't supported for the CSP and scope, or the provisioning method is \`MANUAL\`.\
> \- \`422\` if the request has unknown fields or invalid values, or the template ID doesn't exist.\
> \
> \*\*CSP support:\*\* AWS, Azure, GCP, OCI, Alibaba Cloud, and IBM Cloud.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/create_custom_connector":{"post":{"tags":["Manual onboarding"],"summary":"Manually connect a cloud instance","description":"Manually connect a pending cloud instance after you deploy its Cortex-generated authentication template and the template's notification doesn't reach Cortex. Provide the values from the template outputs for every field that `POST /public_api/v1/cloud_onboarding/get_custom_template_fields` returns with `editable: true`.\n\n**Where to place each field:**\n\n- Fields with no `scope` or an empty `scope` (`account_id`, `organization_id`, `account_group`, `account_name`, `csp_org_id`) go at the root of `request_data`.\n- Fields with a `credentials` scope go in the `credentials` object.\n- Fields with a `resources_data` scope go directly in the `resources_data` object. For example, a field named `service_account_email` with the scope `resources_data` is sent as `resources_data.service_account_email`.\n- Fields with a `resources_data.<module>` scope go in `resources_data`, nested by the scope path. For example, a field named `sqs_url` with the scope `resources_data.audit_logs_without_cloud_trail` is sent as `resources_data.audit_logs_without_cloud_trail.sqs_url`. If you send a module field without its module key, the field is reported as missing.\n\nValues you send for fields that are not editable are ignored, with these exceptions: `organization_id`, `resources_data.client_id`, and `resources_data.customer_object_id`. If `get_custom_template_fields` returns one of these fields with an empty `value`, you must provide it. If it returns a value, Cortex uses that value.\n\n**Supported `provisioning_method` values:**\n\n| CSP | Allowed values |\n|---|---|\n| AWS | `CF`, or `TF` for the `ACCOUNT` scope only |\n| Azure | `TF`, `ARM` |\n| GCP | `TF` |\n| OCI | `TF` |\n| Alibaba Cloud | `TF` |\n| IBM Cloud | `TF` |\n\nUse a value from the `options` list of the `provisioning_method` field in the `get_custom_template_fields` response. The `MANUAL` provisioning method isn't supported by this endpoint. For manual onboarding with your own CSP resources, use `POST /public_api/v1/cloud_onboarding/create_instance`.\n\n**Errors:**\n\n- `400` if a required field is missing (the error message lists the missing fields), the provisioning method isn't supported for the CSP and scope, or the provisioning method is `MANUAL`.\n- `422` if the request has unknown fields or invalid values, or the template ID doesn't exist.\n\n**CSP support:** AWS, Azure, GCP, OCI, Alibaba Cloud, and IBM Cloud.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomConnectorRequestData"}}},"description":"The template ID, provisioning method, and the values from the deployed template outputs."},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomConnectorResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"createCustomConnector"}}},"components":{"schemas":{"CreateCustomConnectorRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"template_id":{"type":"string","minLength":32,"maxLength":32,"description":"The ID of the pending cloud instance (template) that you deployed. Must be exactly 32 characters."},"provisioning_method":{"type":"string","enum":["CF","TF","ARM"],"description":"The method used to deploy the template. `CF` is CloudFormation (AWS only), `TF` is Terraform, and `ARM` is Azure Resource Manager (Azure only). On AWS, `TF` is supported for the `ACCOUNT` scope only."},"account_id":{"type":"string","description":"The CSP account ID. Required when returned as editable by `get_custom_template_fields`."},"account_name":{"type":"string","description":"The display name of the account."},"account_group":{"type":"string","description":"The ID of the account group, for example the AWS organizational unit ID. Required for the `ACCOUNT_GROUP` scope when returned as editable."},"organization_id":{"type":"string","description":"The CSP organization ID. Required for the `ORGANIZATION` scope when returned as editable."},"csp_org_id":{"type":"string","description":"The CSP organization ID when it differs from `organization_id`. If omitted, `organization_id` is used."},"credentials":{"type":"object","additionalProperties":true,"description":"Fields with a `credentials` scope, such as `role_arn` and `external_id` for AWS, or `region_name` for OCI. If the scope has more segments, such as `credentials.<name>`, nest the field by the scope path."},"resources_data":{"type":"object","additionalProperties":true,"description":"Fields with a `resources_data` or `resources_data.<module>` scope. Place `resources_data` fields directly in this object, for example `{\"service_account_email\": \"...\"}`. Nest `resources_data.<module>` fields by the scope path, for example `{\"outpost_scanner\": {\"outpost_scanner_role_arn\": \"arn:aws:iam::...\"}}`."}},"description":"The template ID, provisioning method, and the values from the deployed template outputs.","required":["template_id","provisioning_method"],"additionalProperties":false}},"required":["request_data"]},"CreateCustomConnectorResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the new cloud instance."}}}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Get the fields required to apply a pending edit

> Get the list of fields you must provide to \`edit\_custom\_connector\` to apply a pending edit to a manually connected cloud instance.\
> \
> \*\*Workflow:\*\*\
> \
> 1\. Call \`POST /public\_api/v1/cloud\_onboarding/edit\_instance\` to change the configuration of the cloud instance. Cortex generates an updated authentication template and marks the edit as pending.\
> 2\. Deploy the updated template in your CSP. If your environment blocks outbound calls from the template, remove the callback notification resource first.\
> 3\. Call this endpoint with the cloud instance ID to get the fields to provide.\
> 4\. Call \`POST /public\_api/v1/cloud\_onboarding/edit\_custom\_connector\` with the values from the template outputs.\
> \
> The response has the same structure as \`get\_custom\_template\_fields\`. Fields that already exist on the cloud instance are returned with their current values and \`editable: false\`. Fields added by the edit, such as the outputs of a newly enabled security capability, are returned with \`editable: true\` and must be provided.\
> \
> Returns \`422\` if the cloud instance doesn't exist or has no pending edit.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/get_custom_connector_fields":{"post":{"tags":["Manual onboarding"],"summary":"Get the fields required to apply a pending edit","description":"Get the list of fields you must provide to `edit_custom_connector` to apply a pending edit to a manually connected cloud instance.\n\n**Workflow:**\n\n1. Call `POST /public_api/v1/cloud_onboarding/edit_instance` to change the configuration of the cloud instance. Cortex generates an updated authentication template and marks the edit as pending.\n2. Deploy the updated template in your CSP. If your environment blocks outbound calls from the template, remove the callback notification resource first.\n3. Call this endpoint with the cloud instance ID to get the fields to provide.\n4. Call `POST /public_api/v1/cloud_onboarding/edit_custom_connector` with the values from the template outputs.\n\nThe response has the same structure as `get_custom_template_fields`. Fields that already exist on the cloud instance are returned with their current values and `editable: false`. Fields added by the edit, such as the outputs of a newly enabled security capability, are returned with `editable: true` and must be provided.\n\nReturns `422` if the cloud instance doesn't exist or has no pending edit.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomConnectorFieldsRequestData"}}},"description":"The ID of the cloud instance whose pending edit fields to return."},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldsResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"getCustomConnectorFields"}}},"components":{"schemas":{"GetCustomConnectorFieldsRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"The ID of the cloud instance with a pending edit."}},"description":"Identifies the cloud instance whose pending edit fields to return.","required":["id"],"additionalProperties":false}},"required":["request_data"]},"CustomFieldsResponse":{"type":"object","properties":{"reply":{"type":"object","properties":{"fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"},"description":"The fields set by the authentication template, ordered by placement in the request: `provisioning_method`, root account fields, `credentials`, and then `resources_data` modules."}}}}},"CustomField":{"type":"object","description":"A field that is set by the deployed authentication template.","properties":{"name":{"type":"string","description":"The key to use for the field in the request."},"pretty_name":{"type":"string","description":"The display name of the field."},"value":{"type":"string","nullable":true,"description":"The current or Cortex-defined value of the field. `null` or an empty string means you must provide the value."},"scope":{"type":"string","description":"Where to place the field in the request. Omitted, or an empty string, for fields that go at the root of `request_data`. `credentials` means the `credentials` object. `resources_data` means directly in the `resources_data` object. `resources_data.<module>` means a nested object in `resources_data` that follows the dot-separated path."},"editable":{"type":"boolean","description":"`true` if you must provide the value. `false` if the value is set by Cortex; any value you send is ignored."},"options":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldOption"},"description":"The allowed values for the field. Returned for the `provisioning_method` field only."}}},"CustomFieldOption":{"type":"object","description":"An allowed value for the field.","properties":{"name":{"type":"string","description":"The value to send in the request."},"pretty_name":{"type":"string","description":"The display name of the value."}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```

## Apply a pending edit to a manually connected cloud instance

> Apply a pending edit to a cloud instance after you deploy the updated authentication template, when the template's notification doesn't reach Cortex.\
> \
> Provide a value in \`resources\_data\` for every field with \`editable: true\` and a \`resources\_data\` scope returned by \`POST /public\_api/v1/cloud\_onboarding/get\_custom\_connector\_fields\`, nested by the scope path. The provisioning method, credentials, and account details of the cloud instance don't change.\
> \
> \*\*Errors:\*\*\
> \
> \- \`400\` if a required \`resources\_data\` field is missing. The error message lists the missing fields.\
> \- \`422\` if the request has unknown fields, or the cloud instance doesn't exist or has no pending edit.\
> \
> \*\*Required license:\*\* Cortex Cloud Posture Management.

```json
{"openapi":"3.0.0","info":{"title":"Cloud Onboarding APIs","version":"Cortex XDR 6.0"},"tags":[{"name":"Manual onboarding","description":"APIs for manual onboarding, where you create the CSP resources yourself, and for manually connecting a pending cloud instance after you deploy a Cortex-generated authentication template."}],"servers":[{"url":"https://api-yourfqdn","description":""}],"paths":{"/public_api/v1/cloud_onboarding/edit_custom_connector":{"post":{"tags":["Manual onboarding"],"summary":"Apply a pending edit to a manually connected cloud instance","description":"Apply a pending edit to a cloud instance after you deploy the updated authentication template, when the template's notification doesn't reach Cortex.\n\nProvide a value in `resources_data` for every field with `editable: true` and a `resources_data` scope returned by `POST /public_api/v1/cloud_onboarding/get_custom_connector_fields`, nested by the scope path. The provisioning method, credentials, and account details of the cloud instance don't change.\n\n**Errors:**\n\n- `400` if a required `resources_data` field is missing. The error message lists the missing fields.\n- `422` if the request has unknown fields, or the cloud instance doesn't exist or has no pending edit.\n\n**Required license:** Cortex Cloud Posture Management.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditCustomConnectorRequestData"}}},"description":"The cloud instance ID and the values from the updated template outputs."},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditCustomConnectorResponse"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"422":{"$ref":"#/components/responses/ValidationError"},"500":{"$ref":"#/components/responses/InternalServerError"}},"operationId":"editCustomConnector"}}},"components":{"schemas":{"EditCustomConnectorRequestData":{"type":"object","properties":{"request_data":{"type":"object","properties":{"id":{"type":"string","minLength":1,"description":"The ID of the cloud instance with a pending edit."},"resources_data":{"type":"object","additionalProperties":true,"description":"Fields with `editable: true` and a `resources_data.<module>` scope, nested by the scope path."}},"description":"The cloud instance ID and the values from the updated template outputs.","required":["id"],"additionalProperties":false}},"required":["request_data"]},"EditCustomConnectorResponse":{"type":"object","properties":{"reply":{"type":"object","nullable":true,"description":"Empty on success."}}},"BaseError":{"type":"object","properties":{"reply":{"type":"object","properties":{"err_code":{"type":"string","description":"Error code"},"err_msg":{"type":"string","description":"Error message"},"err_extra":{"type":"string","description":"Extra information about the error"}}}}}},"responses":{"BadRequest":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"ValidationError":{"description":"Invalid Client Request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}},"InternalServerError":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseError"}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://cortex-docs.paloaltonetworks.com/xdr-api/cloud-onboarding/manual-onboarding.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
