> 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/cortex-cloud-api/cloud-workload-protection/models.md).

# Models

## The FilterObject object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"FilterObject":{"oneOf":[{"$ref":"#/components/schemas/ConnectorNode"},{"$ref":"#/components/schemas/TerminalNode"}],"title":"Asset Scope Filter","description":"Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied."},"ConnectorNode":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndConnectorNode"},{"$ref":"#/components/schemas/OrConnectorNode"}],"description":""},"AndConnectorNode":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}},"OrConnectorNode":{"type":"object","properties":{"OR":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}}}}}
```

## The ConnectorNode object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"ConnectorNode":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndConnectorNode"},{"$ref":"#/components/schemas/OrConnectorNode"}],"description":""},"AndConnectorNode":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"FilterObject":{"oneOf":[{"$ref":"#/components/schemas/ConnectorNode"},{"$ref":"#/components/schemas/TerminalNode"}],"title":"Asset Scope Filter","description":"Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied."},"OrConnectorNode":{"type":"object","properties":{"OR":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}}}}}
```

## The AndConnectorNode object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"AndConnectorNode":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"FilterObject":{"oneOf":[{"$ref":"#/components/schemas/ConnectorNode"},{"$ref":"#/components/schemas/TerminalNode"}],"title":"Asset Scope Filter","description":"Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied."},"ConnectorNode":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndConnectorNode"},{"$ref":"#/components/schemas/OrConnectorNode"}],"description":""},"OrConnectorNode":{"type":"object","properties":{"OR":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}}}}}
```

## The OrConnectorNode object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"OrConnectorNode":{"type":"object","properties":{"OR":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"FilterObject":{"oneOf":[{"$ref":"#/components/schemas/ConnectorNode"},{"$ref":"#/components/schemas/TerminalNode"}],"title":"Asset Scope Filter","description":"Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied."},"ConnectorNode":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndConnectorNode"},{"$ref":"#/components/schemas/OrConnectorNode"}],"description":""},"AndConnectorNode":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}}}}}
```

## The TerminalNode object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}}}}}
```

## The VendorSpecificConfig object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"VendorSpecificConfig":{"type":"object","description":"Vendor specific configuration options for scanning.","oneOf":[{"$ref":"#/components/schemas/GitlabSpecificConfig"},{"$ref":"#/components/schemas/DockerhubSpecificConfig"},{"$ref":"#/components/schemas/OpenShiftSpecificConfig"}],"title":""},"GitlabSpecificConfig":{"type":"object","description":"Properties of a GitLab connector.","properties":{"group_ids":{"type":"string","description":"*Optional*. The group IDs to scan."},"project_ids":{"type":"string","description":"*Optional*. The project IDs to scan."},"api_domain_name":{"type":"string","description":"*Optional*. The API domain name to use for the scan."}},"title":"GitLab"},"DockerhubSpecificConfig":{"type":"object","description":"Properties of a Dockerhub connector.","properties":{"repository":{"type":"string","description":"*Optional*. The Docker Hub repository to scan."}},"title":"DockerHub"},"OpenShiftSpecificConfig":{"type":"object","description":"Properties of an OpenShift connector.","properties":{"cluster_id":{"type":"string","description":"The unique identifier of the OpenShift cluster."},"cluster_name":{"type":"string","description":"The name of the OpenShift cluster."},"cluster_asset_id":{"type":"string","description":"The asset ID associated with the cluster."},"cluster_asset_type_id":{"type":"string","description":"The asset type ID of the cluster."},"cluster_realm":{"type":"string","description":"The realm or environment in which the cluster resides."}},"title":"OpenShift"}}}}
```

## The OpenShiftSpecificConfig object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"OpenShiftSpecificConfig":{"type":"object","description":"Properties of an OpenShift connector.","properties":{"cluster_id":{"type":"string","description":"The unique identifier of the OpenShift cluster."},"cluster_name":{"type":"string","description":"The name of the OpenShift cluster."},"cluster_asset_id":{"type":"string","description":"The asset ID associated with the cluster."},"cluster_asset_type_id":{"type":"string","description":"The asset type ID of the cluster."},"cluster_realm":{"type":"string","description":"The realm or environment in which the cluster resides."}},"title":"OpenShift"}}}}
```

## The DockerhubSpecificConfig object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"DockerhubSpecificConfig":{"type":"object","description":"Properties of a Dockerhub connector.","properties":{"repository":{"type":"string","description":"*Optional*. The Docker Hub repository to scan."}},"title":"DockerHub"}}}}
```

## The GitlabSpecificConfig object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"GitlabSpecificConfig":{"type":"object","description":"Properties of a GitLab connector.","properties":{"group_ids":{"type":"string","description":"*Optional*. The group IDs to scan."},"project_ids":{"type":"string","description":"*Optional*. The project IDs to scan."},"api_domain_name":{"type":"string","description":"*Optional*. The API domain name to use for the scan."}},"title":"GitLab"}}}}
```

## The InitialScanConfiguration object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"InitialScanConfiguration":{"type":"object","title":"Initial Scan Configuration","properties":{"mode":{"type":"string","description":"Specifies the initial scan configuration mode.\n \n* `ALL` — Scans all container images, including every tag, in all discovered repositories.\n* `LATEST_TAG` — Scans only images tagged as `latest` in all discovered repositories.\n* `TAGS_MODIFIED_DAYS` — Scans images in each repository modified within the last *X* days, where *X* is set via an argument. You can select a range of up to 90 days for the scan.\n","enum":["ALL","LATEST_TAG","TAGS_MODIFIED_DAYS"],"default":"ALL"},"numDays":{"type":"integer","description":"Number of days for the scan mode `lastNDays`"}}}}}}
```

## The Vendor object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"Vendor":{"type":"string","enum":["DOCKER","JFROG","SONATYPE","DOCKER_HUB","HARBOR","GITLAB_CONTAINER_REGISTRY","OPENSHIFT"],"description":"Name of the registry vendor.","title":"Vendor"}}}}
```

## The ScanningMode object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"ScanningMode":{"type":"string","enum":["CLOUD","OUTPOST","BROKER","NOT_APPLICABLE","KAPI"],"description":"The scanning mode used by the connector"}}}}
```

## The Provider object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"Provider":{"type":"string","enum":["AWS","GCP","AZURE"],"description":"Specifies the cloud provider for the Cortex environment to use for registry scanning."}}}}
```

## The RegistryType object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"RegistryType":{"type":"string","enum":["CLOUD_HOSTED","SELF_HOSTED"],"description":"The type of registry."}}}}
```

## The BrokerType object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"BrokerType":{"type":"string","enum":["BROKER_VM","BROKER_CLUSTER"],"description":"Indicates the Broker VM type used by the Outpost."}}}}
```

## The FilterType object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"FilterType":{"type":"string","enum":["INCLUDE","EXCLUDE"]}}}}
```

## The PublicAPIErrorMetadata object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PublicAPIErrorMetadata":{"type":"object","description":"Details for the PublicAPIError","properties":{"code":{"$ref":"#/components/schemas/Code"}},"required":["code"]},"Code":{"type":"string","description":"A short, programmatically safe string indicating the error code reported","enum":["BAD_REQUEST","INTERNAL_ERROR","NOT_FOUND","FORBIDDEN"]}}}}
```

## The PublicAPIErrorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PublicAPIErrorResponse":{"type":"object","required":["err_msg","metadata"],"properties":{"err_msg":{"type":"string","description":"The error message"},"metadata":{"$ref":"#/components/schemas/PublicAPIErrorMetadata"}}},"PublicAPIErrorMetadata":{"type":"object","description":"Details for the PublicAPIError","properties":{"code":{"$ref":"#/components/schemas/Code"}},"required":["code"]},"Code":{"type":"string","description":"A short, programmatically safe string indicating the error code reported","enum":["BAD_REQUEST","INTERNAL_ERROR","NOT_FOUND","FORBIDDEN"]}}}}
```

## The UnmanagedRegistryConnectorPublicAPIObject object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"UnmanagedRegistryConnectorPublicAPIObject":{"type":"object","required":["vendor","name","url","username","password","auth_token","scanning_mode","region","insecure_pull","initial_scan_configuration"],"properties":{"connector_id":{"type":"string","description":"The connector ID."},"vendor":{"$ref":"#/components/schemas/Vendor"},"name":{"type":"string","description":"Name of the registry connector."},"enabled":{"type":"boolean","description":"Indicates whether the connector is enabled.","default":true},"url":{"type":"string","description":"The URL of the registry."},"username":{"type":"string","description":"The username for authentication."},"password":{"type":"string","description":"The password for authentication."},"auth_token":{"type":"string","description":"Token to authenticate the request."},"scanning_mode":{"$ref":"#/components/schemas/ScanningMode"},"cloud_provider":{"$ref":"#/components/schemas/Provider"},"outpost_id":{"type":"string","description":"The outpost ID."},"region":{"type":"string","description":"Specifies the region to use for registry scanning. As a best practice, choose the region closest to your registry deployment to achieve the best scanning throughput and potentially reduce cloud costs."},"insecure_pull":{"type":"boolean","description":"When set to `true`, allows image pulls from insecure registries."},"ca_certificate":{"type":"string","description":"*Optional*. The CA certificate used for authentication."},"repository":{"type":"string","description":"*Optional*. The repository used for image discovery."},"initial_scan_configuration":{"$ref":"#/components/schemas/InitialScanConfiguration"},"allow_static_ips":{"type":"boolean","description":"*Optional*. Indicates whether static IP addresses are allowed."},"ip_identifier":{"type":"string","description":"*Optional*. The identifier associated with the IP address."},"asset_scope_filters":{"$ref":"#/components/schemas/FilterObject"},"registry_type":{"$ref":"#/components/schemas/RegistryType"},"tenant_id":{"type":"string","description":"The tenant ID"},"broker_type":{"allOf":[{"$ref":"#/components/schemas/BrokerType"}]},"broker_id":{"type":"string","description":"The broker ID."},"filter_type":{"allOf":[{"$ref":"#/components/schemas/FilterType"}],"description":"Controls whether `asset_scope_filters` act as an inclusion or exclusion filter.","default":"INCLUDE"},"vendor_specific_configuration":{"$ref":"#/components/schemas/VendorSpecificConfig"}}},"Vendor":{"type":"string","enum":["DOCKER","JFROG","SONATYPE","DOCKER_HUB","HARBOR","GITLAB_CONTAINER_REGISTRY","OPENSHIFT"],"description":"Name of the registry vendor.","title":"Vendor"},"ScanningMode":{"type":"string","enum":["CLOUD","OUTPOST","BROKER","NOT_APPLICABLE","KAPI"],"description":"The scanning mode used by the connector"},"Provider":{"type":"string","enum":["AWS","GCP","AZURE"],"description":"Specifies the cloud provider for the Cortex environment to use for registry scanning."},"InitialScanConfiguration":{"type":"object","title":"Initial Scan Configuration","properties":{"mode":{"type":"string","description":"Specifies the initial scan configuration mode.\n \n* `ALL` — Scans all container images, including every tag, in all discovered repositories.\n* `LATEST_TAG` — Scans only images tagged as `latest` in all discovered repositories.\n* `TAGS_MODIFIED_DAYS` — Scans images in each repository modified within the last *X* days, where *X* is set via an argument. You can select a range of up to 90 days for the scan.\n","enum":["ALL","LATEST_TAG","TAGS_MODIFIED_DAYS"],"default":"ALL"},"numDays":{"type":"integer","description":"Number of days for the scan mode `lastNDays`"}}},"FilterObject":{"oneOf":[{"$ref":"#/components/schemas/ConnectorNode"},{"$ref":"#/components/schemas/TerminalNode"}],"title":"Asset Scope Filter","description":"Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied."},"ConnectorNode":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndConnectorNode"},{"$ref":"#/components/schemas/OrConnectorNode"}],"description":""},"AndConnectorNode":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"OrConnectorNode":{"type":"object","properties":{"OR":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}},"RegistryType":{"type":"string","enum":["CLOUD_HOSTED","SELF_HOSTED"],"description":"The type of registry."},"BrokerType":{"type":"string","enum":["BROKER_VM","BROKER_CLUSTER"],"description":"Indicates the Broker VM type used by the Outpost."},"FilterType":{"type":"string","enum":["INCLUDE","EXCLUDE"]},"VendorSpecificConfig":{"type":"object","description":"Vendor specific configuration options for scanning.","oneOf":[{"$ref":"#/components/schemas/GitlabSpecificConfig"},{"$ref":"#/components/schemas/DockerhubSpecificConfig"},{"$ref":"#/components/schemas/OpenShiftSpecificConfig"}],"title":""},"GitlabSpecificConfig":{"type":"object","description":"Properties of a GitLab connector.","properties":{"group_ids":{"type":"string","description":"*Optional*. The group IDs to scan."},"project_ids":{"type":"string","description":"*Optional*. The project IDs to scan."},"api_domain_name":{"type":"string","description":"*Optional*. The API domain name to use for the scan."}},"title":"GitLab"},"DockerhubSpecificConfig":{"type":"object","description":"Properties of a Dockerhub connector.","properties":{"repository":{"type":"string","description":"*Optional*. The Docker Hub repository to scan."}},"title":"DockerHub"},"OpenShiftSpecificConfig":{"type":"object","description":"Properties of an OpenShift connector.","properties":{"cluster_id":{"type":"string","description":"The unique identifier of the OpenShift cluster."},"cluster_name":{"type":"string","description":"The name of the OpenShift cluster."},"cluster_asset_id":{"type":"string","description":"The asset ID associated with the cluster."},"cluster_asset_type_id":{"type":"string","description":"The asset type ID of the cluster."},"cluster_realm":{"type":"string","description":"The realm or environment in which the cluster resides."}},"title":"OpenShift"}}}}
```

## The GetUnmanagedRegistryConnectorResponse object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"GetUnmanagedRegistryConnectorResponse":{"type":"object","properties":{"connector_id":{"type":"string","description":"The connector ID."},"vendor":{"$ref":"#/components/schemas/Vendor"},"name":{"type":"string","description":"The name of the registry connector."},"enabled":{"type":"boolean","description":"Indicates whether the connector is enabled.","default":true},"url":{"type":"string","description":"The URL of the registry."},"username":{"type":"string","description":"The username for authentication."},"password":{"type":"string","description":"The password for authentication."},"auth_token":{"type":"string","description":"Authentication token used to authorize requests to the API."},"scanning_mode":{"$ref":"#/components/schemas/ScanningMode"},"cloud_provider":{"$ref":"#/components/schemas/Provider"},"outpost_id":{"type":"string","description":"The outpost ID."},"region":{"type":"string","description":"The region of the connector."},"insecure_pull":{"type":"boolean","description":"When set to `true`, allows image pulls from insecure registries."},"ca_certificate":{"type":"string","description":"*Optional*. The CA certificate used for authentication."},"repository":{"type":"string","description":"*Optional*. The repository used for image discovery."},"initial_scan_configuration":{"$ref":"#/components/schemas/InitialScanConfiguration"},"allow_static_ips":{"type":"boolean","description":"*Optional*. Indicates whether static IP addresses are allowed."},"ip_identifier":{"type":"string","description":"*Optional*. The identifier associated with the IP address."},"asset_scope_filters":{"$ref":"#/components/schemas/FilterObject"},"registry_type":{"$ref":"#/components/schemas/RegistryType"},"tenant_id":{"type":"string","description":"The tenant ID"},"broker_type":{"allOf":[{"$ref":"#/components/schemas/BrokerType"}]},"broker_id":{"type":"string","description":"The broker ID."},"filter_type":{"allOf":[{"$ref":"#/components/schemas/FilterType"}],"description":"Controls whether `asset_scope_filters` act as an inclusion or exclusion filter.","default":"INCLUDE"},"vendor_specific_configuration":{"$ref":"#/components/schemas/VendorSpecificConfig"}}},"Vendor":{"type":"string","enum":["DOCKER","JFROG","SONATYPE","DOCKER_HUB","HARBOR","GITLAB_CONTAINER_REGISTRY","OPENSHIFT"],"description":"Name of the registry vendor.","title":"Vendor"},"ScanningMode":{"type":"string","enum":["CLOUD","OUTPOST","BROKER","NOT_APPLICABLE","KAPI"],"description":"The scanning mode used by the connector"},"Provider":{"type":"string","enum":["AWS","GCP","AZURE"],"description":"Specifies the cloud provider for the Cortex environment to use for registry scanning."},"InitialScanConfiguration":{"type":"object","title":"Initial Scan Configuration","properties":{"mode":{"type":"string","description":"Specifies the initial scan configuration mode.\n \n* `ALL` — Scans all container images, including every tag, in all discovered repositories.\n* `LATEST_TAG` — Scans only images tagged as `latest` in all discovered repositories.\n* `TAGS_MODIFIED_DAYS` — Scans images in each repository modified within the last *X* days, where *X* is set via an argument. You can select a range of up to 90 days for the scan.\n","enum":["ALL","LATEST_TAG","TAGS_MODIFIED_DAYS"],"default":"ALL"},"numDays":{"type":"integer","description":"Number of days for the scan mode `lastNDays`"}}},"FilterObject":{"oneOf":[{"$ref":"#/components/schemas/ConnectorNode"},{"$ref":"#/components/schemas/TerminalNode"}],"title":"Asset Scope Filter","description":"Defines the type of assets to be filtered (the scope). You can combine multiple conditions to create complex rules for when the asset filter should be applied."},"ConnectorNode":{"type":"object","oneOf":[{"$ref":"#/components/schemas/AndConnectorNode"},{"$ref":"#/components/schemas/OrConnectorNode"}],"description":""},"AndConnectorNode":{"type":"object","properties":{"AND":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"OrConnectorNode":{"type":"object","properties":{"OR":{"type":"array","items":{"$ref":"#/components/schemas/FilterObject"}}}},"TerminalNode":{"type":"object","properties":{"SEARCH_FIELD":{"type":"string","description":"Defines the Field to be searched."},"SEARCH_TYPE":{"type":"string","description":"Defines the comparison operator to use for this filter. "},"SEARCH_VALUE":{"type":"string","description":"Defines the value to be searched."}}},"RegistryType":{"type":"string","enum":["CLOUD_HOSTED","SELF_HOSTED"],"description":"The type of registry."},"BrokerType":{"type":"string","enum":["BROKER_VM","BROKER_CLUSTER"],"description":"Indicates the Broker VM type used by the Outpost."},"FilterType":{"type":"string","enum":["INCLUDE","EXCLUDE"]},"VendorSpecificConfig":{"type":"object","description":"Vendor specific configuration options for scanning.","oneOf":[{"$ref":"#/components/schemas/GitlabSpecificConfig"},{"$ref":"#/components/schemas/DockerhubSpecificConfig"},{"$ref":"#/components/schemas/OpenShiftSpecificConfig"}],"title":""},"GitlabSpecificConfig":{"type":"object","description":"Properties of a GitLab connector.","properties":{"group_ids":{"type":"string","description":"*Optional*. The group IDs to scan."},"project_ids":{"type":"string","description":"*Optional*. The project IDs to scan."},"api_domain_name":{"type":"string","description":"*Optional*. The API domain name to use for the scan."}},"title":"GitLab"},"DockerhubSpecificConfig":{"type":"object","description":"Properties of a Dockerhub connector.","properties":{"repository":{"type":"string","description":"*Optional*. The Docker Hub repository to scan."}},"title":"DockerHub"},"OpenShiftSpecificConfig":{"type":"object","description":"Properties of an OpenShift connector.","properties":{"cluster_id":{"type":"string","description":"The unique identifier of the OpenShift cluster."},"cluster_name":{"type":"string","description":"The name of the OpenShift cluster."},"cluster_asset_id":{"type":"string","description":"The asset ID associated with the cluster."},"cluster_asset_type_id":{"type":"string","description":"The asset type ID of the cluster."},"cluster_realm":{"type":"string","description":"The realm or environment in which the cluster resides."}},"title":"OpenShift"}}}}
```

## The Code object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"Code":{"type":"string","description":"A short, programmatically safe string indicating the error code reported","enum":["BAD_REQUEST","INTERNAL_ERROR","NOT_FOUND","FORBIDDEN"]}}}}
```

## The err\_code object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"err_code":{"type":"string","description":"HTTP response code."}}}}
```

## The err\_msg object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"err_msg":{"type":"string","description":"Error message."}}}}
```

## The err\_extra object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"err_extra":{"type":"string","description":"Additional information describing the error."}}}}
```

## The EvaluationMode object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"}}}}
```

## The EvaluationStage object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"}}}}
```

## The GetPoliciesResponse object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"GetPoliciesResponse":{"type":"array","description":"The response you get when calling the `get policies` path","items":{"$ref":"#/components/schemas/PolicyData"}},"PolicyData":{"type":"object","description":"The schema of a policy","required":["type","name","description","evaluationStage","rulesIds","condition","assetGroupsIDs","action","severity","missingInformationAction"],"properties":{"id":{"type":"string"},"revision":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/PolicyType"},"createdBy":{"type":"string"},"disabled":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"evaluationModes":{"type":"array","items":{"$ref":"#/components/schemas/EvaluationMode"}},"evaluationStage":{"$ref":"#/components/schemas/EvaluationStage"},"rulesIds":{"type":"array","description":"The UUIDs of the rules that define the condition\nThe `rulesIds` field is only required for non-compliance policies.","items":{"type":"string"}},"condition":{"type":"string","format":"byte","description":"The `condition` field is only required for non-compliance policies."},"exception":{"type":"string","format":"byte"},"assetScope":{"type":"string","format":"byte"},"assetGroupsIDs":{"type":"array","items":{"type":"integer"}},"assetGroups":{"type":"array","items":{"type":"string"}},"action":{"$ref":"#/components/schemas/PolicyAction"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"missingInformationAction":{"$ref":"#/components/schemas/PolicyAction"},"remediationGuidance":{"type":"string"}}},"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"},"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"},"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"}}}}
```

## The PolicyAction object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```

## The PolicyData object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyData":{"type":"object","description":"The schema of a policy","required":["type","name","description","evaluationStage","rulesIds","condition","assetGroupsIDs","action","severity","missingInformationAction"],"properties":{"id":{"type":"string"},"revision":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/PolicyType"},"createdBy":{"type":"string"},"disabled":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"evaluationModes":{"type":"array","items":{"$ref":"#/components/schemas/EvaluationMode"}},"evaluationStage":{"$ref":"#/components/schemas/EvaluationStage"},"rulesIds":{"type":"array","description":"The UUIDs of the rules that define the condition\nThe `rulesIds` field is only required for non-compliance policies.","items":{"type":"string"}},"condition":{"type":"string","format":"byte","description":"The `condition` field is only required for non-compliance policies."},"exception":{"type":"string","format":"byte"},"assetScope":{"type":"string","format":"byte"},"assetGroupsIDs":{"type":"array","items":{"type":"integer"}},"assetGroups":{"type":"array","items":{"type":"string"}},"action":{"$ref":"#/components/schemas/PolicyAction"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"missingInformationAction":{"$ref":"#/components/schemas/PolicyAction"},"remediationGuidance":{"type":"string"}}},"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"},"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"},"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"}}}}
```

## The PolicySeverity object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"}}}}
```

## The PolicyType object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"}}}}
```

## The GetPoliciesResponseV2 object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"GetPoliciesResponseV2":{"description":"The response you get when calling the `get policies V2` path","type":"array","items":{"$ref":"#/components/schemas/PolicyGetResponseDataV2"}},"PolicyGetResponseDataV2":{"type":"object","description":"The schema of a returned policy","required":["id","revision","createdAt","modifiedAt","type","createdBy","disabled","name","description","evaluationModes","evaluationStage","policyRules","condition","exception","assetScope","assetGroupsIDs","assetGroups","action","severity","remediationGuidance","usingSystemAssetGroups","gracePeriod"],"properties":{"id":{"type":"string"},"revision":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/PolicyType"},"createdBy":{"type":"string"},"disabled":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"evaluationModes":{"type":"array","items":{"$ref":"#/components/schemas/EvaluationMode"}},"evaluationStage":{"$ref":"#/components/schemas/EvaluationStage"},"policyRules":{"type":"array","description":"Array of policy_rule objects related to the policy","items":{"$ref":"#/components/schemas/PolicyRuleGetResponseData"}},"condition":{"type":"string","format":"byte"},"exception":{"type":"string","format":"byte"},"assetScope":{"type":"string","format":"byte"},"assetGroupsIDs":{"type":"array","items":{"type":"integer"}},"assetGroups":{"type":"array","items":{"type":"string"}},"action":{"$ref":"#/components/schemas/PolicyAction"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"remediationGuidance":{"type":"string"},"missingInformationAction":{"$ref":"#/components/schemas/PolicyAction"},"usingSystemAssetGroups":{"type":"boolean"},"unifiedPolicyId":{"type":"string"},"gracePeriod":{"type":"string","description":"Grace period duration string in days"}}},"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"},"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"},"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"},"PolicyRuleGetResponseData":{"type":"object","description":"The schema of policy_rule object","required":["id","rule_id","policy_id","severity","action","policy_revision","rule_name","remediation_guidance","user_remediation_guidance"],"properties":{"id":{"type":"string"},"rule_id":{"type":"string"},"policy_id":{"type":"string"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"action":{"$ref":"#/components/schemas/PolicyAction"},"policy_revision":{"type":"integer"},"rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"user_remediation_guidance":{"type":"string","description":"Additional remediation guidance that can be added to the rule’s predefined guidance."}}},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```

## The PolicyGetResponseDataV2 object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyGetResponseDataV2":{"type":"object","description":"The schema of a returned policy","required":["id","revision","createdAt","modifiedAt","type","createdBy","disabled","name","description","evaluationModes","evaluationStage","policyRules","condition","exception","assetScope","assetGroupsIDs","assetGroups","action","severity","remediationGuidance","usingSystemAssetGroups","gracePeriod"],"properties":{"id":{"type":"string"},"revision":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"},"type":{"$ref":"#/components/schemas/PolicyType"},"createdBy":{"type":"string"},"disabled":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"evaluationModes":{"type":"array","items":{"$ref":"#/components/schemas/EvaluationMode"}},"evaluationStage":{"$ref":"#/components/schemas/EvaluationStage"},"policyRules":{"type":"array","description":"Array of policy_rule objects related to the policy","items":{"$ref":"#/components/schemas/PolicyRuleGetResponseData"}},"condition":{"type":"string","format":"byte"},"exception":{"type":"string","format":"byte"},"assetScope":{"type":"string","format":"byte"},"assetGroupsIDs":{"type":"array","items":{"type":"integer"}},"assetGroups":{"type":"array","items":{"type":"string"}},"action":{"$ref":"#/components/schemas/PolicyAction"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"remediationGuidance":{"type":"string"},"missingInformationAction":{"$ref":"#/components/schemas/PolicyAction"},"usingSystemAssetGroups":{"type":"boolean"},"unifiedPolicyId":{"type":"string"},"gracePeriod":{"type":"string","description":"Grace period duration string in days"}}},"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"},"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"},"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"},"PolicyRuleGetResponseData":{"type":"object","description":"The schema of policy_rule object","required":["id","rule_id","policy_id","severity","action","policy_revision","rule_name","remediation_guidance","user_remediation_guidance"],"properties":{"id":{"type":"string"},"rule_id":{"type":"string"},"policy_id":{"type":"string"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"action":{"$ref":"#/components/schemas/PolicyAction"},"policy_revision":{"type":"integer"},"rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"user_remediation_guidance":{"type":"string","description":"Additional remediation guidance that can be added to the rule’s predefined guidance."}}},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```

## The PolicyRuleGetResponseData object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyRuleGetResponseData":{"type":"object","description":"The schema of policy_rule object","required":["id","rule_id","policy_id","severity","action","policy_revision","rule_name","remediation_guidance","user_remediation_guidance"],"properties":{"id":{"type":"string"},"rule_id":{"type":"string"},"policy_id":{"type":"string"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"action":{"$ref":"#/components/schemas/PolicyAction"},"policy_revision":{"type":"integer"},"rule_name":{"type":"string"},"remediation_guidance":{"type":"string"},"user_remediation_guidance":{"type":"string","description":"Additional remediation guidance that can be added to the rule’s predefined guidance."}}},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```

## The PolicyPostRequestDataV2 object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyPostRequestDataV2":{"type":"object","description":"The schema of a created policy","required":["type","disabled","name","description","evaluationModes","evaluationStage","policyRules","condition","exception","assetScope","assetGroupsIDs","assetGroups","action","severity","remediationGuidance","createdBy","usingSystemAssetGroups","gracePeriod"],"properties":{"type":{"$ref":"#/components/schemas/PolicyType"},"disabled":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"evaluationModes":{"type":"array","items":{"$ref":"#/components/schemas/EvaluationMode"}},"evaluationStage":{"$ref":"#/components/schemas/EvaluationStage"},"policyRules":{"type":"array","description":"Array of policy_rule objects related to the policy","items":{"$ref":"#/components/schemas/PolicyRulePostRequestData"}},"condition":{"type":"string","format":"byte"},"exception":{"type":"string","format":"byte"},"assetScope":{"type":"string","format":"byte"},"assetGroupsIDs":{"type":"array","items":{"type":"integer"}},"assetGroups":{"type":"array","items":{"type":"string"}},"action":{"$ref":"#/components/schemas/PolicyAction"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"remediationGuidance":{"type":"string"},"createdBy":{"type":"string"},"missingInformationAction":{"$ref":"#/components/schemas/PolicyAction"},"usingSystemAssetGroups":{"type":"boolean"},"unifiedPolicyId":{"type":"string"},"gracePeriod":{"type":"string","description":"Grace period duration string in days"}}},"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"},"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"},"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"},"PolicyRulePostRequestData":{"type":"object","description":"The schema of policy_rule object","required":["rule_id","severity","action","user_remediation_guidance"],"properties":{"rule_id":{"type":"string"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"action":{"$ref":"#/components/schemas/PolicyAction"},"user_remediation_guidance":{"type":"string"}}},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```

## The PolicyRulePostRequestData object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyRulePostRequestData":{"type":"object","description":"The schema of policy_rule object","required":["rule_id","severity","action","user_remediation_guidance"],"properties":{"rule_id":{"type":"string"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"action":{"$ref":"#/components/schemas/PolicyAction"},"user_remediation_guidance":{"type":"string"}}},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```

## The PolicyPutRequestDataV2 object

```json
{"openapi":"3.0.0","info":{"title":"Cloud Workload Protection APIs","version":"Cortex Cloud"},"components":{"schemas":{"PolicyPutRequestDataV2":{"type":"object","description":"The schema of a created policy","required":["id","type","disabled","name","description","evaluationModes","evaluationStage","policyRules","condition","exception","assetScope","assetGroupsIDs","assetGroups","action","severity","remediationGuidance","usingSystemAssetGroups","gracePeriod"],"properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/PolicyType"},"disabled":{"type":"boolean"},"name":{"type":"string"},"description":{"type":"string"},"evaluationModes":{"type":"array","items":{"$ref":"#/components/schemas/EvaluationMode"}},"evaluationStage":{"$ref":"#/components/schemas/EvaluationStage"},"policyRules":{"type":"array","description":"Array of policy_rule objects related to the policy","items":{"$ref":"#/components/schemas/PolicyRulePostRequestData"}},"condition":{"type":"string","format":"byte"},"exception":{"type":"string","format":"byte"},"assetScope":{"type":"string","format":"byte"},"assetGroupsIDs":{"type":"array","items":{"type":"integer"}},"assetGroups":{"type":"array","items":{"type":"string"}},"action":{"$ref":"#/components/schemas/PolicyAction"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"remediationGuidance":{"type":"string"},"createdBy":{"type":"string"},"missingInformationAction":{"$ref":"#/components/schemas/PolicyAction"},"usingSystemAssetGroups":{"type":"boolean"},"unifiedPolicyId":{"type":"string"},"gracePeriod":{"type":"string","description":"Grace period duration string in days"}}},"PolicyType":{"type":"string","nullable":true,"enum":["COMPLIANCE","MALWARE","SECRET","TRUSTED_IMAGES"],"description":"One of the supported policy types"},"EvaluationMode":{"type":"string","nullable":true,"enum":["PERIODIC","CONTINUOUS",null],"description":"One of the supported evaluation modes"},"EvaluationStage":{"type":"string","nullable":true,"enum":["CI","RUNTIME","DEPLOY",null],"description":"One of the supported evaluation stages"},"PolicyRulePostRequestData":{"type":"object","description":"The schema of policy_rule object","required":["rule_id","severity","action","user_remediation_guidance"],"properties":{"rule_id":{"type":"string"},"severity":{"$ref":"#/components/schemas/PolicySeverity"},"action":{"$ref":"#/components/schemas/PolicyAction"},"user_remediation_guidance":{"type":"string"}}},"PolicySeverity":{"type":"string","nullable":true,"enum":["LOW","MEDIUM","HIGH","CRITICAL",null],"description":"One of the supported policy severities"},"PolicyAction":{"type":"string","nullable":true,"enum":["ISSUE","PREVENT",null],"description":"One of the supported policy actions"}}}}
```


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://cortex-docs.paloaltonetworks.com/cortex-cloud-api/cloud-workload-protection/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.