For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs.
Skip to content

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

post

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.

Body
Responses
200

Successful Response

application/json
replyobjectOptional

The main payload of the response, containing instance information data. It includes a link to download the template file from your tenant. If you use automated upload (only for AWS), the link will take you directly to AWS CloudFormation to create the stack. Otherwise, download the template and upload it in your CSP and follow the instructions to manually upload the template:

post/public_api/v1/cloud_onboarding/create_instance
POST /public_api/v1/cloud_onboarding/create_instance HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 1015

{
  "request_data": {
    "cloud_provider": "AWS",
    "scope": "ACCOUNT",
    "scan_mode": "MANAGED",
    "instance_name": "AWS Account Instance",
    "manual_details": {
      "organization_id": "r-d03p",
      "account_id": "783764590904",
      "account_name": "my-aws-account",
      "role_arn": "arn:aws:iam::783764590904:role/CortexPlatformRole-m-a-9994395176702",
      "external_id": "320ee22d-a0dc-4104-a4ed-6b3b93e2b543",
      "cloudtrail_role": "arn:aws:iam::783764590904:role/cortex-logs-ingestion-access-m-a-9994395176702",
      "sqs_url": "https://sqs.us-east-1.amazonaws.com/783764590904/cortex-ct-logs-queue-783764590904-m-a-9994395176702"
    },
    "additional_capabilities": {
      "xsiam_analytics": false,
      "data_security_posture_management": false,
      "registry_scanning": false,
      "serverless_scanning": false,
      "automation": false,
      "agentless_disk_scanning": false,
      "kubernetes_security": false
    },
    "collection_configuration": {
      "audit_logs": {
        "enabled": true,
        "data_events": false,
        "collection_method": "AUTOMATED"
      }
    },
    "scope_modifications": {
      "regions": {
        "enabled": false
      }
    },
    "custom_resources_tags": [
      {
        "key": "env",
        "value": "prod"
      }
    ]
  }
}
{
  "reply": {
    "automated": {
      "link": "string",
      "tracking_guid": "string"
    },
    "manual": {
      "TF/ARM": "string"
    }
  }
}

Delete the specified integration instance template

post

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.

Body
Responses
200

Successful Response

application/json
replyobjectOptional

The main payload of the response, containing operation-specific data.

post/public_api/v1/cloud_onboarding/delete_instance_template
POST /public_api/v1/cloud_onboarding/delete_instance_template HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "request_data": {
    "template_id": "5396d8d68fd3464790afbbbbb25cce9b"
  }
}
{
  "reply": {}
}

Edit a manually provisioned cloud integration instance

post

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.

Body

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.

Responses
200

Successful Response

application/json
replyobjectOptional

The main payload of the response, containing operation-specific data.

post/public_api/v1/cloud_onboarding/edit_manual_instance
POST /public_api/v1/cloud_onboarding/edit_manual_instance HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 1176

{
  "request_data": {
    "id": "150401c7f0254616a6db08127e0f479e",
    "cloud_provider": "AWS",
    "scope": "ACCOUNT",
    "scan_mode": "MANAGED",
    "manual_details": {
      "organization_id": "r-d03p",
      "account_id": "783764590904",
      "account_name": "my-aws-account",
      "role_arn": "arn:aws:iam::783764590904:role/CortexPlatformRole-m-a-9994395176702",
      "outpost_scanner_role_arn": "arn:aws:iam::783764590904:role/CortexPlatformScannerRole-m-a-9994395176702",
      "external_id": "320ee22d-a0dc-4104-a4ed-6b3b93e2b543",
      "cloudtrail_role": "arn:aws:iam::783764590904:role/cortex-logs-ingestion-access-m-a-9994395176702",
      "sqs_url": "https://sqs.us-east-1.amazonaws.com/783764590904/cortex-ct-logs-queue-783764590904-m-a-9994395176702"
    },
    "additional_capabilities": {
      "automation": true,
      "xsiam_analytics": true,
      "registry_scanning": true,
      "kubernetes_security": true,
      "serverless_scanning": true,
      "automation_log_level": "OFF",
      "agentless_disk_scanning": true,
      "upload_files_to_wildfire": false,
      "registry_scanning_options": {
        "type": "ALL"
      }
    },
    "collection_configuration": {
      "audit_logs": {
        "enabled": true,
        "data_events": false,
        "collection_method": "CUSTOM"
      }
    },
    "scope_modifications": {
      "regions": {
        "enabled": false
      }
    },
    "custom_resources_tags": [
      {
        "key": "edit",
        "value": "edit"
      }
    ]
  }
}
{
  "reply": {}
}

Get the specified integration instance edit details

post

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.

Body
Responses
200

Successful Response

application/json

Response containing the current editable configuration of the integration instance and any pending (not-yet-applied) changes.

post/public_api/v1/cloud_onboarding/get_edit_instance_details
POST /public_api/v1/cloud_onboarding/get_edit_instance_details HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "request_data": {
    "id": "2674a4092ed74f9aae604e296dcedc15"
  }
}
{
  "reply": {
    "fields": {
      "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "instance_name": "instance-1",
      "cloud_provider": "AZURE",
      "scan_config": {
        "ads": {
          "enabled": true,
          "entities_scope": {
            "enabled": true,
            "type": "INCLUDE",
            "subscription_ids": [
              "11111111-2222-3333-4444-555555555555"
            ]
          },
          "tags": {
            "enabled": false
          }
        },
        "dspm": {
          "enabled": false,
          "regions": {
            "type": "EXCLUDE",
            "values": []
          }
        },
        "kspm": {
          "enabled": true
        },
        "registry": {
          "enabled": false
        }
      }
    },
    "pending_changes": {}
  }
}

Get identifiers for manual integration instance provisioning

post

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.

Body
Responses
200

Successful Response

application/json

Response containing the generated identifiers file. The reply object has two sections:

  • 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:

    • OutpostRoleArn: The Cortex principal to trust in the Cortex Platform role. Always returned.
    • ScannerRoleArn: The Cortex principals to trust in the scanner role. Returned when registry scanning, serverless scanning, or data security posture management is enabled.
    • OutpostAccountId and KmsAccountADS: Returned when agentless disk scanning is enabled.
    • MTKmsAccountDSPM: Returned when data security posture management is enabled.
    • 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.

    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).

    The response doesn't include an external ID or the names of the roles and buckets to create. You choose those values.

  • 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:

    • 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.
    • 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.
    • 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.
post/public_api/v1/cloud_onboarding/get_manual_connector_identifiers
POST /public_api/v1/cloud_onboarding/get_manual_connector_identifiers HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 519

{
  "request_data": {
    "cloud_partition": "COMMERCIAL",
    "cloud_provider": "AWS",
    "scope": "ORGANIZATION",
    "scan_mode": "MANAGED",
    "additional_capabilities": {
      "xsiam_analytics": true,
      "data_security_posture_management": true,
      "registry_scanning": true,
      "registry_scanning_options": {
        "type": "ALL"
      },
      "serverless_scanning": true,
      "automation": true,
      "automation_log_level": "OFF",
      "agentless_disk_scanning": true,
      "kubernetes_security": true
    },
    "collection_configuration": {
      "audit_logs": {
        "enabled": true,
        "data_events": false,
        "collection_method": "AUTOMATED"
      }
    }
  }
}
{
  "reply": {
    "identifiers": {
      "OutpostRoleArn": "arn:aws:iam::123456789012:role/gcp_saas_role"
    },
    "manual_details": {
      "organization_id": "",
      "account_id": "",
      "account_name": "",
      "role_arn": "",
      "external_id": ""
    }
  }
}

Mark a manual connector as updated/resolved

post

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.

Body
Responses
200

Successful Response

application/json
replyobjectOptional

The main payload of the response, containing operation-specific data.

post/public_api/v1/cloud_onboarding/manual_update_and_resolve
POST /public_api/v1/cloud_onboarding/manual_update_and_resolve HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "request_data": {
    "instance_id": "150401c7f0254616a6db08127e0f479e"
  }
}
{
  "reply": {}
}

Resolve the relevant additional security capabilities for a connector

post

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.

Body
Responses
200

Successful Response

application/json
post/public_api/v1/cloud_onboarding/resolve_connector_security_capabilities
POST /public_api/v1/cloud_onboarding/resolve_connector_security_capabilities HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "request_data": {
    "cloud_provider": "AWS",
    "scope": "ORGANIZATION",
    "cloud_partition": "COMMERCIAL"
  }
}
{
  "reply": {
    "additional_capabilities": [
      "agentless_disk_scanning",
      "data_security_posture_management",
      "registry_scanning",
      "serverless_scanning",
      "automation",
      "kubernetes_security"
    ],
    "collection_configuration": [
      "audit_logs"
    ]
  }
}

Get the fields required to connect a deployed template

post

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.

Body
Responses
200

Successful Response

application/json
post/public_api/v1/cloud_onboarding/get_custom_template_fields
POST /public_api/v1/cloud_onboarding/get_custom_template_fields HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "request_data": {
    "template_id": "8f3c2a91d4e64b7f9a1c5e2d7b0f4a63"
  }
}
{
  "reply": {
    "fields": [
      {
        "name": "provisioning_method",
        "pretty_name": "Authentication Method",
        "value": null,
        "editable": true,
        "options": [
          {
            "name": "CF",
            "pretty_name": "CloudFormation"
          }
        ]
      },
      {
        "name": "organization_id",
        "pretty_name": "Organization Id",
        "value": null,
        "editable": true
      },
      {
        "name": "account_id",
        "pretty_name": "Account Id",
        "value": null,
        "editable": true
      },
      {
        "name": "role_arn",
        "pretty_name": "Role Arn",
        "scope": "credentials",
        "value": null,
        "editable": true
      },
      {
        "name": "external_id",
        "pretty_name": "External Id",
        "scope": "credentials",
        "value": null,
        "editable": true
      },
      {
        "name": "sqs_url",
        "pretty_name": "Audit Logs Sqs Url",
        "value": "",
        "scope": "resources_data.audit_logs_without_cloud_trail",
        "editable": true
      },
      {
        "name": "role_arn",
        "pretty_name": "Audit Logs Role Arn",
        "value": "",
        "scope": "resources_data.audit_logs_without_cloud_trail",
        "editable": true
      },
      {
        "name": "outpost_scanner_role_arn",
        "pretty_name": "Outpost Scanner Role Arn",
        "value": "",
        "scope": "resources_data.outpost_scanner",
        "editable": true
      }
    ]
  }
}

Manually connect a cloud instance

post

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.

Body
Responses
200

Successful Response

application/json
post/public_api/v1/cloud_onboarding/create_custom_connector
POST /public_api/v1/cloud_onboarding/create_custom_connector HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 711

{
  "request_data": {
    "template_id": "8f3c2a91d4e64b7f9a1c5e2d7b0f4a63",
    "provisioning_method": "CF",
    "organization_id": "r-d03p",
    "account_id": "783764590904",
    "account_name": "aws-prod-org",
    "credentials": {
      "role_arn": "arn:aws:iam::783764590904:role/CortexPlatformRole-m-o-9994395176702",
      "external_id": "320ee22d-a0dc-4104-a4ed-6b3b93e2b543"
    },
    "resources_data": {
      "audit_logs_without_cloud_trail": {
        "sqs_url": "https://sqs.us-east-1.amazonaws.com/783764590904/cortex-ct-logs-queue-783764590904-m-o-9994395176702",
        "role_arn": "arn:aws:iam::783764590904:role/cortex-logs-ingestion-access-m-o-9994395176702"
      },
      "outpost_scanner": {
        "outpost_scanner_role_arn": "arn:aws:iam::783764590904:role/CortexPlatformScannerRole-m-o-9994395176702"
      }
    }
  }
}
{
  "reply": {
    "id": "c71e4b9a2f3d48e6a5b0d9f1e2c7a384"
  }
}

Get the fields required to apply a pending edit

post

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.

Body
Responses
200

Successful Response

application/json
post/public_api/v1/cloud_onboarding/get_custom_connector_fields
POST /public_api/v1/cloud_onboarding/get_custom_connector_fields HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "request_data": {
    "id": "c71e4b9a2f3d48e6a5b0d9f1e2c7a384"
  }
}
{
  "reply": {
    "fields": [
      {
        "name": "provisioning_method",
        "pretty_name": "Authentication Method",
        "value": "CF",
        "editable": false,
        "options": [
          {
            "name": "CF",
            "pretty_name": "CloudFormation"
          }
        ]
      },
      {
        "name": "organization_id",
        "pretty_name": "Organization Id",
        "value": "r-d03p",
        "editable": false
      },
      {
        "name": "account_id",
        "pretty_name": "Account Id",
        "value": "783764590904",
        "editable": false
      },
      {
        "name": "role_arn",
        "pretty_name": "Role Arn",
        "scope": "credentials",
        "value": "arn:aws:iam::783764590904:role/CortexPlatformRole-m-o-9994395176702",
        "editable": false
      },
      {
        "name": "external_id",
        "pretty_name": "External Id",
        "scope": "credentials",
        "value": "320ee22d-a0dc-4104-a4ed-6b3b93e2b543",
        "editable": false
      },
      {
        "name": "sqs_url",
        "pretty_name": "Audit Logs Sqs Url",
        "value": "https://sqs.us-east-1.amazonaws.com/783764590904/cortex-ct-logs-queue-783764590904-m-o-9994395176702",
        "scope": "resources_data.audit_logs_without_cloud_trail",
        "editable": false
      },
      {
        "name": "role_arn",
        "pretty_name": "Audit Logs Role Arn",
        "value": "arn:aws:iam::783764590904:role/cortex-logs-ingestion-access-m-o-9994395176702",
        "scope": "resources_data.audit_logs_without_cloud_trail",
        "editable": false
      },
      {
        "name": "outpost_scanner_role_arn",
        "pretty_name": "Outpost Scanner Role Arn",
        "value": "",
        "scope": "resources_data.outpost_scanner",
        "editable": true
      }
    ]
  }
}

Apply a pending edit to a manually connected cloud instance

post

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.

Body
Responses
200

Successful Response

application/json
replyobject · nullableOptional

Empty on success.

post/public_api/v1/cloud_onboarding/edit_custom_connector
POST /public_api/v1/cloud_onboarding/edit_custom_connector HTTP/1.1
Host: api-yourfqdn
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "request_data": {
    "id": "c71e4b9a2f3d48e6a5b0d9f1e2c7a384",
    "resources_data": {
      "outpost_scanner": {
        "outpost_scanner_role_arn": "arn:aws:iam::783764590904:role/CortexPlatformScannerRole-m-o-9994395176702"
      }
    }
  }
}
{
  "reply": null
}

Last updated

Was this helpful?