Skip to main content

CrowdStrike clone API (v1)

Download OpenAPI specification:Download

CrowdStrike clone API. The source of truth is proto/platform/v1. REST is grpc-gateway over the same gRPC services. GET /healthz, GET /openapi.json, and GET /api/dev/manifest.json are hand-written ops routes merged into this spec after codegen.

HelloService

Fetch the sample greeting.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "source": "string"
}

ASPMService

get_integrations

query Parameters
integration_type
string
category
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

create_integration

Request Body schema: application/json
required
name
string
enabled
any

Value (not bool) so omitted vs false vs non-boolean JSON are distinguishable.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enabled": null
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CasesService

create_case

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_case_ids

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
q
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService

CloudAwsRegistrationService_TriggerHealthCheck

query Parameters
account_ids
Array of strings
organization_ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService_GetAccounts

query Parameters
ids
Array of strings
organization_ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService_DeleteAccount

query Parameters
ids
Array of strings
organization_ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService_CreateAccount

Request Body schema: application/json
required
account_id
string
account_type
string
organization_id
string
csp_events
boolean
is_master
boolean
parameters
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "account_type": "string",
  • "organization_id": "string",
  • "csp_events": true,
  • "is_master": true,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService_UpdateAccount

Request Body schema: application/json
required
account_id
string
account_type
string
organization_id
string
csp_events
boolean
is_master
boolean
parameters
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "account_type": "string",
  • "organization_id": "string",
  • "csp_events": true,
  • "is_master": true,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService_ValidateAccounts

query Parameters
account_id
string
iam_role_arn
string
organization_id
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAwsRegistrationService_QueryAccounts

query Parameters
organization_ids
Array of strings
products
Array of strings
features
Array of strings
account_status
string
limit
integer <int32>
offset
integer <int32>
group_by
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService

CloudAzureRegistrationService_GetIssueSuppressionValuesByField

query Parameters
registration_id
string
field
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetIssueValuesByField

query Parameters
registration_id
string
field
string
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetLegacyAccounts

query Parameters
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_DeleteLegacySubscription

Request Body schema: application/json
required
subscription_id
string
tenant_id
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "subscription_id": "string",
  • "tenant_id": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetSuppressions

query Parameters
registration_id
string
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_DeleteSuppressions

Request Body schema: application/json
required
suppression_ids
Array of strings
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "suppression_ids": [
    ],
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_CreateSuppressions

Request Body schema: application/json
required
registration_id
string
issue_name
string
reason
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "registration_id": "string",
  • "issue_name": "string",
  • "reason": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_UpdateSuppressions

Request Body schema: application/json
required
suppression_id
string
reason
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "suppression_id": "string",
  • "reason": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetIssues

query Parameters
registration_id
string
filter
string
sort
string
group_by
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_TriggerHealthCheck

query Parameters
tenant_ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetRegistration

query Parameters
tenant_id
string
registration_id
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_DeleteRegistration

query Parameters
tenant_ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_CreateRegistration

Request Body schema: application/json
required
tenant_id
string
account_type
string
environment
string
tenant_name
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "string",
  • "account_type": "string",
  • "environment": "string",
  • "tenant_name": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_UpdateRegistration

Request Body schema: application/json
required
tenant_id
string
account_type
string
environment
string
tenant_name
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "string",
  • "account_type": "string",
  • "environment": "string",
  • "tenant_name": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_ValidateRegistration

query Parameters
tenant_id
string
stack_name
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetScriptVersions

query Parameters
deployment_method
string
sort
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_GetScript

query Parameters
tenant_id
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudAzureRegistrationService_DownloadScript

Request Body schema: application/json
required
tenant_id
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService

CloudGoogleCloudRegistrationService_GetEntities

query Parameters
ids
Array of strings
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_TriggerHealthCheck

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_GetRegistration

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_DeleteRegistration

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_CreateRegistration

Request Body schema: application/json
required
registration_name
string
deployment_method
string
infra_project_id
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "registration_name": "string",
  • "deployment_method": "string",
  • "infra_project_id": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_PutRegistration

Request Body schema: application/json
required
registration_name
string
deployment_method
string
infra_project_id
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "registration_name": "string",
  • "deployment_method": "string",
  • "infra_project_id": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_UpdateRegistration

query Parameters
ids
Array of strings
Request Body schema: application/json
required
registration_name
string
deployment_method
string
infra_project_id
string
status
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "registration_name": "string",
  • "deployment_method": "string",
  • "infra_project_id": "string",
  • "status": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudGoogleCloudRegistrationService_PostTerraformScript

Request Body schema: application/json
required
registration_id
string
parameters
string
vars_only
boolean

Responses

Request samples

Content type
application/json
{
  • "registration_id": "string",
  • "parameters": "string",
  • "vars_only": true
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService

CloudOciRegistrationService_GetAccount

query Parameters
filter
string
sort
string
next_token
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService_RotateKey

Request Body schema: application/json
required
tenancy_ocid
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenancy_ocid": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService_ValidateTenancy

Request Body schema: application/json
required
tenancy_ocid
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenancy_ocid": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService_DeleteAccount

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService_CreateAccount

Request Body schema: application/json
required

CloudOciCreateAccountRequest is the JSON body for CreateAccount. AWS already owns CreateAccountRequest in this package.

tenancy_ocid
string
home_region
string
user_name
string
user_email
string
group_name
string
policy_name
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenancy_ocid": "string",
  • "home_region": "string",
  • "user_name": "string",
  • "user_email": "string",
  • "group_name": "string",
  • "policy_name": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService_UpdateAccount

Request Body schema: application/json
required
tenancy_ocid
string
home_region
string
user_name
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenancy_ocid": "string",
  • "home_region": "string",
  • "user_name": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudOciRegistrationService_DownloadScript

Request Body schema: application/json
required

CloudOciDownloadScriptRequest is the JSON body for DownloadScript. Azure already owns DownloadScriptRequest in this package.

tenancy_ocid
string
deployment_method
string
is_download
boolean
parameters
string

Responses

Request samples

Content type
application/json
{
  • "tenancy_ocid": "string",
  • "deployment_method": "string",
  • "is_download": true,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService

CloudPoliciesService_GetRuleInputSchema

query Parameters
domain
string
subdomain
string
cloud_provider
string
resource_type
string
enriched
boolean
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_CloneComplianceFramework

Request Body schema: application/json
required
ids
Array of strings
parameters
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_GetComplianceControls

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_DeleteComplianceControl

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_CreateComplianceControl

Request Body schema: application/json
required
name
string
description
string
section_name
string
framework_id
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "section_name": "string",
  • "framework_id": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_GetComplianceFrameworks

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_DeleteComplianceFramework

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_CreateComplianceFramework

Request Body schema: application/json
required
name
string
description
string
active
boolean
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_GetEnrichedAsset

query Parameters
ids
Array of strings
domain
string
subdomain
string
resource_type
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_GetEvaluationResult

Request Body schema: application/json
required
logic
string
domain
string
subdomain
string
input
string
ids
Array of strings
cloud_provider
string
resource_type
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "logic": "string",
  • "domain": "string",
  • "subdomain": "string",
  • "input": "string",
  • "ids": [
    ],
  • "cloud_provider": "string",
  • "resource_type": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_DeleteRuleOverride

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_CreateRuleOverride

Request Body schema: application/json
required
rule_id
string
reason
string
comment
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "rule_id": "string",
  • "reason": "string",
  • "comment": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_GetRule

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_DeleteRuleMixin0

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_CreateRuleMixin0

Request Body schema: application/json
required
name
string
description
string
logic
string
severity
integer <int32>
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "logic": "string",
  • "severity": 0,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_DeleteSuppressionRules

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudPoliciesService_CreateSuppressionRule

Request Body schema: application/json
required
name
string
description
string
suppression_reason
string
suppression_comment
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "suppression_reason": "string",
  • "suppression_comment": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSecurityService

CloudSecurityService_ListCloudGroups

query Parameters
filter
string
sort
string
offset
integer <int32>
limit
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSecurityService_DeleteCloudGroups

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSecurityService_CreateCloudGroup

Request Body schema: application/json
required
name
string
description
string
business_impact
string
business_unit
string
environment
string
owners
Array of strings
selectors
any
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "business_impact": "string",
  • "business_unit": "string",
  • "environment": "string",
  • "owners": [
    ],
  • "selectors": null,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSecurityAssetsService

CloudSecurityAssetsService_GetAssets

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSecurityAssetsService_QueryAssets

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
after
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSecurityDetectionsService

CloudSecurityDetectionsService_GetCombinedIOMByRule

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "detections": [
    ]
}

CloudSnapshotsService

CloudSnapshotsService_ReadDeploymentsCombined

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CloudSnapshotsService_CreateDeploymentEntity

Request Body schema: application/json
required
Array of objects (v1CloudSnapshotJobCreate)
Array
account_id
string
asset_identifier
string
cloud_provider
string
region
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerAlertsService

ContainerAlertsService_SearchAndReadContainerAlerts

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerDetectionsService

ContainerDetectionsService_ReadCombinedDetections

query Parameters
filter
string
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerDetectionsService_ReadDetections

query Parameters
id
string
filter
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService

ContainerImagesService_ReadClustersByDateRangeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadClustersByKubernetesVersionCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadClustersByStatusCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadClusterCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainersByDateRangeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerCountByRegistry

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
under_assessment
boolean

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_FindContainersCountAffectedByZeroDayVulnerabilities

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerableContainerImageCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_FindContainersByContainerRunTimeVersion

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_GroupContainersByManaged

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerImageDetectionsCountByDate

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerImagesByState

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainersSensorCoverage

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerVulnerabilitiesBySeverityCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadDeploymentsByDateRangeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadDeploymentCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadClusterEnrichment

query Parameters
cluster_id
Array of strings
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerEnrichment

query Parameters
container_id
Array of strings
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadDeploymentEnrichment

query Parameters
deployment_id
Array of strings
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNodeEnrichment

query Parameters
node_name
Array of strings
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadPodEnrichment

query Parameters
pod_id
Array of strings
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_AggregateImageAssessmentHistory

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadDistinctContainerImageCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_AggregateImageCountByBaseOS

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_AggregateImageCountByState

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_AggregateImageCount

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerImagesByMostUsed

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadKubernetesIomByDateRange

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadKubernetesIomCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNamespacesByDateRangeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNamespaceCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNodesByCloudCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNodesByContainerEngineVersionCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNodesByDateRangeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNodeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadPodsByDateRangeCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadPodCount

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_PostAggregatesPods

Request Body schema: application/json
required
type
string
field
string
filter
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "field": "string",
  • "filter": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilityCountByActivelyExploited

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilityCountByCPSRating

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilityCountByCVSSScore

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilityCountBySeverity

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilityCount

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CombinedBaseImages

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadClusterCombined

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadClusterCombinedV2

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
include_counts
boolean

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadRunningContainerImages

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadContainerCombined

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadDeploymentCombined

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_GetCombinedImages

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CombinedImageByVulnerabilityCount

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CombinedImageDetail

query Parameters
filter
string
with_config
boolean
sort
string
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadCombinedImagesExport

query Parameters
filter
string
expand_vulnerabilities
boolean
expand_detections
boolean
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CombinedImageIssuesSummary

query Parameters
cid
string
registry
string
repository
string
tag
string
image_digest
string
include_base_image_vuln
boolean
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CombinedImageVulnerabilitySummary

query Parameters
cid
string
registry
string
repository
string
tag
string
image_digest
string
include_base_image_vuln
boolean
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_PostSearchKubernetesIOMEntities

Request Body schema: application/json
required
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "filter": "string",
  • "sort": "string",
  • "limit": 0,
  • "offset": 0
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_SearchAndReadKubernetesIomEntities

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadNodeCombined

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadPodCombined

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilitiesByImageCount

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadVulnerabilitiesPublicationDate

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadCombinedVulnerabilitiesDetails

query Parameters
id
string
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadCombinedVulnerabilitiesInfo

query Parameters
cve_id
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadCombinedVulnerabilities

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadImageVulnerabilities

Request Body schema: application/json
required
osversion
string
Array of objects (v1ImageVulnerabilityPackage)

Responses

Request samples

Content type
application/json
{
  • "osversion": "string",
  • "packages": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_DeleteBaseImages

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CreateBaseImagesEntities

Request Body schema: application/json
required
image_id
string
registry
string
repository
string
tag
string
image_digest
string
parameters
string
base_images
string

Responses

Request samples

Content type
application/json
{
  • "image_id": "string",
  • "registry": "string",
  • "repository": "string",
  • "tag": "string",
  • "image_digest": "string",
  • "parameters": "string",
  • "base_images": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_DownloadExportFile

query Parameters
id
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadExportJobs

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_LaunchExportJob

Request Body schema: application/json
required
expand_vulnerabilities
boolean
format
string
fql
string
resource
string
sort
string

Responses

Request samples

Content type
application/json
{
  • "expand_vulnerabilities": true,
  • "format": "string",
  • "fql": "string",
  • "resource": "string",
  • "sort": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_PostImageScanInventory

Request Body schema: application/json
required
host_name
string
agent_uuid
string
cluster_id
string

Responses

Request samples

Content type
application/json
{
  • "host_name": "string",
  • "agent_uuid": "string",
  • "cluster_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_HeadImageScanInventory

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_GetCredentials

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_DeleteImageDetails

query Parameters
image_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadKubernetesIomEntities

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ImageMatchesPolicy

query Parameters
repository
string
tag
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_PolicyChecks

query Parameters
registry
string
repository
string
tag
string
architecture
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadRegistryEntitiesByUUID

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_DeleteRegistryEntities

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_CreateRegistryEntities

Request Body schema: application/json
required
type
string
url
string
user_defined_alias
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "url": "string",
  • "user_defined_alias": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_UpdateRegistryEntities

query Parameters
id
string
Request Body schema: application/json
required
user_defined_alias
string

Responses

Request samples

Content type
application/json
{
  • "user_defined_alias": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_GetImageAssessmentReport

query Parameters
image_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_GetReportByReference

query Parameters
image_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_GetReportByScanId

path Parameters
uuid
required
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_QueryExportJobs

query Parameters
filter
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_SearchKubernetesIoms

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerImagesService_ReadRegistryEntities

query Parameters
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ContainerPackagesService

ContainerPackagesService_ReadPackagesCombined

query Parameters
filter
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ConversionService

Add a priced bundle SKU to the anonymous cart.

Request Body schema: application/json
required
sku
string
billing
string

Responses

Request samples

Content type
application/json
{
  • "sku": "string",
  • "billing": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Anonymous cart for the cs_cart cookie.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Persist a contact-us lead locally (not Marketo).

Request Body schema: application/json
required
first_name
string
last_name
string
email
string
country
string
message
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "country": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Persist a Falcon free-trial lead locally (not Marketo).

Request Body schema: application/json
required
first_name
string
last_name
string
company
string
country
string
email
string
phone
string
accepted_terms
boolean

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "company": "string",
  • "country": "string",
  • "email": "string",
  • "phone": "string",
  • "accepted_terms": true
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService

CspmRegistrationService_GetAwsAccount

query Parameters
ids
Array of strings
status
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_DeleteAwsAccount

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_CreateAwsAccount

Request Body schema: application/json
required
account_id
string
cloudtrail_region
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "cloudtrail_region": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_PatchAwsAccount

Request Body schema: application/json
required
account_id
string
cloudtrail_region
string

Responses

Request samples

Content type
application/json
{
  • "account_id": "string",
  • "cloudtrail_region": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetAwsConsoleSetupURLs

query Parameters
ids
Array of strings
use_existing_cloudtrail
string
region
string
tags
string
template
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetAwsAccountScriptsAttachment

query Parameters
ids
Array of strings
template
string
account_type
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetAzureAccount

query Parameters
ids
Array of strings
status
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_DeleteAzureAccount

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_CreateAzureAccount

Request Body schema: application/json
required
subscription_id
string
tenant_id
string

Responses

Request samples

Content type
application/json
{
  • "subscription_id": "string",
  • "tenant_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateAzureAccount

Request Body schema: application/json
required
subscription_id
string
tenant_id
string

Responses

Request samples

Content type
application/json
{
  • "subscription_id": "string",
  • "tenant_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateAzureAccountClientID

query Parameters
id
string
tenant_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateAzureTenantDefaultSubscriptionID

query Parameters
subscription_id
string
tenant_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_AzureDownloadCertificate

query Parameters
tenant_id
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetAzureManagementGroup

query Parameters
tenant_ids
Array of strings
limit
integer <int32>
offset
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_DeleteAzureManagementGroup

query Parameters
tenant_ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_CreateAzureManagementGroup

Request Body schema: application/json
required
tenant_id
string
default_subscription_id
string

Responses

Request samples

Content type
application/json
{
  • "tenant_id": "string",
  • "default_subscription_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_AzureRefreshCertificate

query Parameters
tenant_id
string
years_valid
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetAzureUserScriptsAttachment

query Parameters
tenant_id
string
subscription_ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetGcpAccount

query Parameters
ids
Array of strings
status
Array of strings
parent_type
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_DeleteGcpAccount

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_CreateGcpAccount

Request Body schema: application/json
required
parent_id
string
parent_type
string

Responses

Request samples

Content type
application/json
{
  • "parent_id": "string",
  • "parent_type": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateGcpAccount

Request Body schema: application/json
required
parent_id
string
parent_type
string

Responses

Request samples

Content type
application/json
{
  • "parent_id": "string",
  • "parent_type": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_ConnectGcpAccount

Request Body schema: application/json
required
parent_id
string
parent_type
string

Responses

Request samples

Content type
application/json
{
  • "parent_id": "string",
  • "parent_type": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetGcpValidateAccountsExt

Request Body schema: application/json
required
resources
Array of strings

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetGcpServiceAccountsExt

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateGcpServiceAccountsExt

Request Body schema: application/json
required
service_account_id
string <int64>
client_email
string

Responses

Request samples

Content type
application/json
{
  • "service_account_id": "string",
  • "client_email": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_ValidateGcpServiceAccountsExt

Request Body schema: application/json
required
service_account_id
string <int64>

Responses

Request samples

Content type
application/json
{
  • "service_account_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetGcpUserScriptsAttachment

query Parameters
parent_type
string
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetBehaviorDetections

query Parameters
cloud_provider
string
state
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetConfigurationDetections

query Parameters
cloud_provider
string
account_id
string
azure_subscription_id
string
azure_tenant_id
string
status
string
region
string
severity
string
service
string
next_token
string
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetConfigurationDetectionEntities

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetCloudEventIDs

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetConfigurationDetectionIDsV2

query Parameters
filter
string
sort
string
limit
integer <int32>
offset
integer <int32>
next_token
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetIoaEvents

query Parameters
cloud_provider
string
state
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetIoaUsers

query Parameters
cloud_provider
string
state
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetCspmPolicy

query Parameters
ids
Array of strings <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetCspmPoliciesDetails

query Parameters
ids
Array of strings <int64> [ items <int64 > ]

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetCspmPolicySettings

query Parameters
policy_id
string <int64>
cloud_platform
string
service
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateCspmPolicySettings

Request Body schema: application/json
required
policy_id
string <int64>
severity
string

Responses

Request samples

Content type
application/json
{
  • "policy_id": "string",
  • "severity": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_GetCspmScanSchedule

query Parameters
cloud_platform
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CspmRegistrationService_UpdateCspmScanSchedule

Request Body schema: application/json
required
cloud_platform
string
scan_schedule
string

Responses

Request samples

Content type
application/json
{
  • "cloud_platform": "string",
  • "scan_schedule": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

D4CRegistrationService

D4CRegistrationService_GetD4CAwsAccount

query Parameters
ids
Array of strings
organization_ids
Array of strings
status
string
limit
integer <int32>
offset
integer <int32>
migrated
string
scan_type
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

D4CRegistrationService_CreateD4CAwsAccount

Request Body schema: application/json
required
Array of objects (v1D4CAwsAccountCreate)
Array
account_id
string
account_type
string
cloudtrail_region
string
iam_role_arn
string
is_master
boolean
organization_id
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DataProtectionService

create_classification

Request Body schema: application/json
required
name
string
classification_properties
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "classification_properties": null
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_classifications

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DriftIndicatorsService

search_and_read_drift_indicators

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

EventStreamsService

EventStreamsService_RefreshActiveStreamSession

path Parameters
partition
required
integer <int32>
query Parameters
action_name
string
app_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

EventStreamsService_ListAvailableStreams

query Parameters
app_id
string
format
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

FdrService

query_event_entities

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

FileVantageService

create_policy

Request Body schema: application/json
required

CreateFileVantagePoliciesRequest is the create body. Named distinctly from ImageAssessmentPoliciesService CreatePoliciesRequest in the same package.

name
string
description
string
platform
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_policies

query Parameters
type
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

FirewallPoliciesService

get_firewall_policies

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

create_firewall_policies

Request Body schema: application/json
required
name
string
description
string
platform_name
string
resources
string
clone_id
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform_name": "string",
  • "resources": "string",
  • "clone_id": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_firewall_policies

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostsService

HostsService_GetDevices

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostsService_QueryDevices

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

AlertsService

AlertsService_GetAlerts

Request Body schema: application/json
required
composite_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "composite_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

AlertsService_UpdateAlerts

Request Body schema: application/json
required
composite_ids
Array of strings
update_status
string

Responses

Request samples

Content type
application/json
{
  • "composite_ids": [
    ],
  • "update_status": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

AlertsService_QueryAlerts

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService

HostGroupsService_PerformHostGroupAction

query Parameters
action_name
string
Request Body schema: application/json
required
ids
Array of strings
host_ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "host_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService_GetHostGroups

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService_DeleteHostGroups

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService_CreateHostGroups

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService_UpdateHostGroups

Request Body schema: application/json
required
id
string
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService_QueryHostGroupMembers

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

HostGroupsService_QueryHostGroups

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService

IdentityService_GetAccessibleScopes

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_ResetAPIClientSecret

query Parameters
ids
Array of strings
action_name
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_GetAPIClients

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_DeleteAPIClients

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_CreateAPIClient

Request Body schema: application/json
required
name
string
scopes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_UpdateAPIClient

Request Body schema: application/json
required
client_id
string
name
string
scopes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "name": "string",
  • "scopes": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_QueryAPIClients

query Parameters
filter
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Current console user (cs_console cookie) or bearer with user-management:read.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Log out; clears cs_console. Succeeds even when no cookie is present.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Create a console session. Empty email/password → 400; bad credentials → 401. Success is HTTP 201 with Set-Cookie cs_console (HttpOnly, Path=/, SameSite=Lax).

Request Body schema: application/json
required
email
string
password
string
cloud
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "cloud": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_UserRoleAction

Request Body schema: application/json
required
action
string
user_uuid
string
role_id
string

Responses

Request samples

Content type
application/json
{
  • "action": "string",
  • "user_uuid": "string",
  • "role_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_RetrieveUsers

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_DeleteUser

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_CreateUser

Request Body schema: application/json
required
email
string
first_name
string
last_name
string
password
string
role_id
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "role_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_UpdateUser

Request Body schema: application/json
required
uuid
string
first_name
string
last_name
string
role_id
string

Responses

Request samples

Content type
application/json
{
  • "uuid": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "role_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_QueryRoles

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityService_QueryUsers

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IdentityProtectionService

get_policy_rules

query Parameters
ids
Array of strings
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_policy_rules

query Parameters
name
string
enabled
string
simulation_mode
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ImageAssessmentPoliciesService

read_policies

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

create_policies

Request Body schema: application/json
required
name
string
description
string
policy_data
any
is_enabled
boolean
precedence
integer <int32>
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "policy_data": null,
  • "is_enabled": true,
  • "precedence": 0,
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ImageComplianceService

ImageComplianceService_ExtAggregateImageAssessments

query Parameters
filter
string
after
string
limit
integer <int32>
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IntelService

IntelService_GetActors

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IntelService_GetIntelIndicators

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IntelService_QueryActors

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IntelService_QueryIndicators

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService

CustomIoaService_GetRuleGroups

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_DeleteRuleGroups

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_CreateRuleGroups

Request Body schema: application/json
required
name
string
description
string
platform
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_UpdateRuleGroups

Request Body schema: application/json
required
id
string
name
string
description
string
enabled
boolean

HasEnabled distinguishes omit vs false so PATCH can disable a group.

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_GetRules

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_DeleteRules

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_CreateRules

Request Body schema: application/json
required
name
string
description
string
rulegroup_id
string
pattern_severity
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "rulegroup_id": "string",
  • "pattern_severity": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_UpdateRules

Request Body schema: application/json
required
id
string
name
string
description
string
pattern_severity
string
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "pattern_severity": "string",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_QueryRuleGroups

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

CustomIoaService_QueryRules

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IOAExclusionsService

create_ioa_exclusions_v1

Request Body schema: application/json
required
name
string
description
string
comment
string
groups
string
cl_regex
string
ifn_regex
string
detection_json
string
pattern_id
string
pattern_name
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "comment": "string",
  • "groups": "string",
  • "cl_regex": "string",
  • "ifn_regex": "string",
  • "detection_json": "string",
  • "pattern_id": "string",
  • "pattern_name": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_ioa_exclusions_v1

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
ifn_regex
string
cl_regex
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IocService

IocService_GetIndicators

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IocService_DeleteIndicators

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IocService_CreateIndicators

Request Body schema: application/json
required
type
string
value
string
action
string
severity
string
description
string
platforms
Array of strings
applied_globally
boolean

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "value": "string",
  • "action": "string",
  • "severity": "string",
  • "description": "string",
  • "platforms": [
    ],
  • "applied_globally": true
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IocService_UpdateIndicators

Request Body schema: application/json
required
id
string
action
string
severity
string
description
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "action": "string",
  • "severity": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

IocService_QueryIndicators

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ITAutomationService

create_task

Request Body schema: application/json
required
name
string
description
string
access_type
string
os_query
string
composite_query
string
assignment
string
parser
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "access_type": "string",
  • "os_query": "string",
  • "composite_query": "string",
  • "assignment": "string",
  • "parser": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

search_tasks

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService

KubernetesProtectionService_GetAwsAccounts

query Parameters
ids
Array of strings
is_horizon_acct
string
status
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_DeleteAWSAccounts

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_CreateAWSAccount

Request Body schema: application/json
required
Array of objects (v1KubernetesAwsAccountCreate)
Array
account_id
string
region
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_UpdateAWSAccount

query Parameters
ids
Array of strings
region
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_ListAzureAccounts

query Parameters
ids
Array of strings
subscription_id
Array of strings
is_horizon_acct
string
status
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_DeleteAzureSubscription

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_CreateAzureSubscription

Request Body schema: application/json
required
Array of objects (v1KubernetesAzureSubscriptionCreate)
Array
subscription_id
string
tenant_id
string

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetLocations

query Parameters
clouds
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetCombinedCloudClusters

query Parameters
locations
Array of strings
ids
Array of strings
cluster_service
Array of strings
cluster_status
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetAzureTenantConfig

query Parameters
ids
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetStaticScripts

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetHelmValuesYaml

query Parameters
cluster_name
string
is_self_managed_cluster
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetIntegrationAPIKey

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_RegenerateAPIKey

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetClusters

query Parameters
cluster_names
Array of strings
status
Array of strings
account_ids
Array of strings
locations
Array of strings
cluster_service
Array of strings
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetScan

query Parameters
scan_type
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_TriggerScan

query Parameters
scan_type
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_PatchAzureServicePrincipal

query Parameters
id
string
client_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetAzureTenantIDs

query Parameters
ids
Array of strings
status
string
limit
integer <int32>
offset
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KubernetesProtectionService_GetAzureInstallScript

query Parameters
id
string
subscription_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

K8sContainerComplianceService

image_findings

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

KnowledgeBaseService

entities_knowledge_bases_create_v1

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

queries_knowledge_bases_v1

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
include_deleted
boolean

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

MsspService

create_cid_groups

Request Body schema: application/json
required
name
string
description
string
cid
string
cid_group_id
string
resources
string
parameters
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "cid": "string",
  • "cid_group_id": "string",
  • "resources": "string",
  • "parameters": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_cid_groups

query Parameters
name
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

NetworkScanService

create_scans

Request Body schema: application/json
required
name
string
description
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

query_scans

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

NgsiemService

start_search

path Parameters
repository
required
string
Request Body schema: application/json
required
query_string
string

Responses

Request samples

Content type
application/json
{
  • "query_string": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

list_saved_queries

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
search_domain
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService

PreventionPoliciesService_PerformPreventionPoliciesAction

query Parameters
action_name
string
Request Body schema: application/json
required
ids
Array of strings
group_id
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "group_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_SetPreventionPoliciesPrecedence

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_GetPreventionPolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_DeletePreventionPolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_CreatePreventionPolicies

Request Body schema: application/json
required
name
string
description
string
platform_name
string
Array of objects (v1PreventionSetting)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform_name": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_UpdatePreventionPolicies

Request Body schema: application/json
required
id
string
name
string
description
string
Array of objects (v1PreventionSetting)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_QueryPreventionPolicyMembers

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

PreventionPoliciesService_QueryPreventionPolicies

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService

ResponsePoliciesService_PerformResponsePoliciesAction

query Parameters
action_name
string
Request Body schema: application/json
required
ids
Array of strings
group_id
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "group_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_SetResponsePoliciesPrecedence

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_GetResponsePolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_DeleteResponsePolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_CreateResponsePolicies

Request Body schema: application/json
required
name
string
description
string
platform_name
string
Array of objects (v1ResponseSetting)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform_name": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_UpdateResponsePolicies

Request Body schema: application/json
required
id
string
name
string
description
string
Array of objects (v1ResponseSetting)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_QueryResponsePolicyMembers

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResponsePoliciesService_QueryResponsePolicies

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService

SensorUpdatePoliciesService_PerformSensorUpdatePoliciesAction

query Parameters
action_name
string
Request Body schema: application/json
required
ids
Array of strings
group_id
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "group_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_SetSensorUpdatePoliciesPrecedence

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_GetSensorUpdatePolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_DeleteSensorUpdatePolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_CreateSensorUpdatePolicies

Request Body schema: application/json
required
name
string
description
string
platform_name
string
Array of objects (v1SensorUpdateSetting)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform_name": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_UpdateSensorUpdatePolicies

Request Body schema: application/json
required
id
string
name
string
description
string
Array of objects (v1SensorUpdateSetting)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_QuerySensorUpdatePolicyMembers

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorUpdatePoliciesService_QuerySensorUpdatePolicies

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService

DeviceControlPoliciesService_PerformDeviceControlPoliciesAction

query Parameters
action_name
string
Request Body schema: application/json
required
ids
Array of strings
group_id
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "group_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_SetDeviceControlPoliciesPrecedence

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_DeleteDeviceControlPolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_GetDeviceControlPolicies

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_CreateDeviceControlPolicies

Request Body schema: application/json
required
name
string
description
string
platform_name
string
Array of objects (v1DeviceControlSetting)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "platform_name": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_UpdateDeviceControlPolicies

Request Body schema: application/json
required
id
string
name
string
description
string
Array of objects (v1DeviceControlSetting)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "settings": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_QueryDeviceControlPolicyMembers

query Parameters
id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

DeviceControlPoliciesService_QueryDeviceControlPolicies

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

QuarantineService

QuarantineService_GetQuarantineFiles

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

QuarantineService_UpdateQuarantineFiles

Request Body schema: application/json
required
ids
Array of strings
action
string

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "action": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

QuarantineService_QueryQuarantineFiles

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResourceService

ResourceService_GetResourceFacets

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResourceService_GetResources

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ResourceService_QueryResources

query Parameters
cs_search
string
category
Array of strings
type
Array of strings
industry
Array of strings
cspage
integer <int32>
lang
string
featured
boolean
limit
integer <int32>
filter
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

RealTimeResponseService

RealTimeResponseService_CheckRtrCommandStatus

query Parameters
cloud_request_id
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

RealTimeResponseService_ExecuteRtrCommand

Request Body schema: application/json
required
session_id
string
base_command
string
command_string
string

Responses

Request samples

Content type
application/json
{
  • "session_id": "string",
  • "base_command": "string",
  • "command_string": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

RealTimeResponseService_GetRtrSessions

Request Body schema: application/json
required
ids
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

RealTimeResponseService_InitRtrSession

Request Body schema: application/json
required
device_id
string

Responses

Request samples

Content type
application/json
{
  • "device_id": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

RealTimeResponseService_QueryRtrSessions

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SaaSSecurityService

get_alerts

query Parameters
id
string
limit
integer <int32>
offset
integer <int32>
last_id
string
type
string
integration_id
string
from_date
string
to_date
string
ascending
boolean
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorDownloadService

SensorDownloadService_GetInstallers

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorDownloadService_GetCCID

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SensorDownloadService_QueryInstallers

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

InstallationTokensService

InstallationTokensService_GetTokens

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

InstallationTokensService_DeleteTokens

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

InstallationTokensService_CreateToken

Request Body schema: application/json
required
label
string
expires_timestamp
string

Responses

Request samples

Content type
application/json
{
  • "label": "string",
  • "expires_timestamp": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

InstallationTokensService_UpdateToken

Request Body schema: application/json
required
id
string
label
string
expires_timestamp
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "expires_timestamp": "string"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

InstallationTokensService_QueryTokens

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SiteService

Combined public chrome (promo, nav, footer).

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Homepage, login hub, or thin marketing page by id.

query Parameters
ids
Array of strings
locale
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

Search public pages for header search.

query Parameters
q
string
filter
string
limit
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SpotlightService

SpotlightService_GetVulnerabilities

query Parameters
ids
Array of strings

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

SpotlightService_QueryVulnerabilities

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

UnidentifiedContainersService

search_and_read

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

WorkflowsService

search_definitions

query Parameters
filter
string
limit
integer <int32>
offset
integer <int32>
sort
string
parameters
string

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

execute

query Parameters
definition_id
string
name
string
key
string
execution_cid
string
depth
integer <int32>
source_event_url
string
parameters
string
Request Body schema: application/json
required
object (v1WorkflowExecuteBody)

WorkflowExecuteBody is the JSON body for WorkflowExecute (ignored). Named so definition_id and other query fields stay google.api.http query parameters (body: "*" would swallow them).

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "errors": [
    ],
  • "resources": [
    ]
}

ops

Hand-written HTTP routes (not proto RPCs).

Health check

Hand-written ops route. Empty 200 when the process is up.

Responses

OpenAPI v2 spec

This document (proto RPCs plus hand-written ops routes).

Responses

Response samples

Content type
application/json
{ }

Codegen artifact manifest

Lists the Go/TS/Python SDKs, CLI, and MCP server.

Responses

Response samples

Content type
application/json
{ }

Issue a 30-minute bearer token

Hand-written form POST (not a proto RPC). application/x-www-form-urlencoded client_id and client_secret. member_cid is accepted and ignored.

Request Body schema: application/x-www-form-urlencoded
required
client_id
required
string
client_secret
required
string
member_cid
string

Accepted and ignored (MSSP later).

Responses

Revoke an OAuth2 access token

Hand-written form POST (not a proto RPC). Form token plus HTTP Basic client_id:client_secret. Unknown token still 200.

Request Body schema: application/x-www-form-urlencoded
required
token
required
string

Responses