Skip to content
Start here

Casb

CasbApplications

List applications
client.zeroTrust.casb.applications.list(ApplicationListParams { account_id, environment } params, RequestOptionsoptions?): ApplicationListResponse { id, auth_methods, category, 7 more }
GET/accounts/{account_id}/one/applications
Get application details
client.zeroTrust.casb.applications.get("BITBUCKET" | "BOX" | "CONFLUENCE" | 7 moreapplicationID, ApplicationGetParams { account_id } params, RequestOptionsoptions?): ApplicationGetResponse { id, auth_methods, category, 6 more }
GET/accounts/{account_id}/one/applications/{application_id}
ModelsExpand Collapse
ApplicationListResponse = Array<ApplicationListResponseItem>
id: "BITBUCKET" | "BOX" | "CONFLUENCE" | 7 more

Vendor identifier (e.g. microsoft_internal, google_workspace).

  • BITBUCKET - BITBUCKET
  • BOX - BOX
  • CONFLUENCE - CONFLUENCE
  • DROPBOX - DROPBOX
  • GITHUB - GITHUB
  • GOOGLE_WORKSPACE - GOOGLE_WORKSPACE
  • JIRA - JIRA
  • MICROSOFT_INTERNAL - MICROSOFT_INTERNAL
  • SALESFORCE - SALESFORCE
  • SLACK - SLACK
One of the following:
"BITBUCKET"
"BOX"
"CONFLUENCE"
"DROPBOX"
"GITHUB"
"GOOGLE_WORKSPACE"
"JIRA"
"MICROSOFT_INTERNAL"
"SALESFORCE"
"SLACK"
auth_methods: Array<AuthMethod>

Available auth methods.

id: string

Auth method identifier.

display_name: string

Human-readable auth method name.

category: string

Vendor category (e.g. Productivity, AI).

description: string

Brief description of the integration.

display_name: string

Human-readable vendor name.

dlp_enabled: boolean

Whether DLP scanning is supported.

permissions: Array<Permission>

All permissions with severity.

display_name: string

Human-readable permission name.

scope: string

Vendor-native scope identifier.

severity: "low" | "medium" | "high" | "critical"

Permission sensitivity level.

  • low - low
  • medium - medium
  • high - high
  • critical - critical
One of the following:
"low"
"medium"
"high"
"critical"
supported_environments: Array<string>

Environments this vendor supports (standard, fedramp).

use_cases: Array<UseCase>

Supported use cases.

id: string

Use case identifier (e.g. casb, ces).

display_name: string

Human-readable use case name.

ApplicationGetResponse { id, auth_methods, category, 6 more }

Full application detail for onboarding UI.

id: "BITBUCKET" | "BOX" | "CONFLUENCE" | 7 more

Vendor identifier.

  • BITBUCKET - BITBUCKET
  • BOX - BOX
  • CONFLUENCE - CONFLUENCE
  • DROPBOX - DROPBOX
  • GITHUB - GITHUB
  • GOOGLE_WORKSPACE - GOOGLE_WORKSPACE
  • JIRA - JIRA
  • MICROSOFT_INTERNAL - MICROSOFT_INTERNAL
  • SALESFORCE - SALESFORCE
  • SLACK - SLACK
One of the following:
"BITBUCKET"
"BOX"
"CONFLUENCE"
"DROPBOX"
"GITHUB"
"GOOGLE_WORKSPACE"
"JIRA"
"MICROSOFT_INTERNAL"
"SALESFORCE"
"SLACK"
auth_methods: Array<AuthMethod>

Available authentication methods.

id: string

Auth method identifier.

display_name: string

Human-readable auth method name.

is_default: boolean

Whether this is the default auth method.

supported_environments: Array<string>

Environments this auth method supports.

category: string

Vendor category.

description: string

Brief description.

display_name: string

Human-readable vendor name.

dlp_enabled: boolean

Whether DLP scanning is supported.

instructions: string | null

Setup instructions for the user.

use_cases: Array<UseCase>

Use cases with full scope details.

id: string

Use case identifier.

base_scopes: Array<BaseScope>

Scopes always required for this use case.

display_name: string

Human-readable permission name.

scope: string

Vendor-native scope identifier.

severity: "low" | "medium" | "high" | "critical"

Permission sensitivity level.

  • low - low
  • medium - medium
  • high - high
  • critical - critical
One of the following:
"low"
"medium"
"high"
"critical"
description: string

Use case description.

display_name: string

Human-readable use case name.

features: Array<Feature>

Optional features with extra scopes.

id: string

Feature identifier.

description: string

Feature description.

display_name: string

Human-readable feature name.

scopes: Array<Scope>

Additional scopes when feature is enabled.

display_name: string

Human-readable permission name.

scope: string

Vendor-native scope identifier.

severity: "low" | "medium" | "high" | "critical"

Permission sensitivity level.

  • low - low
  • medium - medium
  • high - high
  • critical - critical
One of the following:
"low"
"medium"
"high"
"critical"

CasbApplicationsAuth Methods

Get auth methods
client.zeroTrust.casb.applications.authMethods.list("BITBUCKET" | "BOX" | "CONFLUENCE" | 7 moreapplicationID, AuthMethodListParams { account_id } params, RequestOptionsoptions?): AuthMethodListResponse { id, display_name, human_interaction_required, 4 more }
GET/accounts/{account_id}/one/applications/{application_id}/auth-methods
ModelsExpand Collapse
AuthMethodListResponse = Array<AuthMethodListResponseItem>
id: string

Auth method identifier.

display_name: string

Human-readable auth method name.

human_interaction_required: boolean

Whether setup requires human interaction or integration can be created purely using API (e.g., For OAuth can not be created without user interaction).

instructions: Instructions { markdown }

Step-by-step instructions for obtaining credentials.

markdown: string

Detailed instructions in markdown format.

payload_example: Record<string, unknown> | null

Example credentials payload with placeholder values.

payload_schema: Record<string, unknown> | null

JSON Schema for the credentials object in POST /v2/integrations request.

redirect_url: string | null

OAuth redirect URL for vendors requiring human interaction.

CasbIntegrations

List integrations
client.zeroTrust.casb.integrations.list(IntegrationListParams { account_id, application, direction, 7 more } params, RequestOptionsoptions?): IntegrationListResponse
GET/accounts/{account_id}/one/integrations
Get integration details
client.zeroTrust.casb.integrations.get(stringid, IntegrationGetParams { account_id } params, RequestOptionsoptions?): IntegrationGetResponse { id, application, auth_method, 12 more }
GET/accounts/{account_id}/one/integrations/{id}
Create integration
client.zeroTrust.casb.integrations.create(IntegrationCreateParams { account_id, application, credentials, 5 more } params, RequestOptionsoptions?): IntegrationCreateResponse { id, application, auth_method, 12 more }
POST/accounts/{account_id}/one/integrations
Update integration
client.zeroTrust.casb.integrations.update(stringid, IntegrationUpdateParams { account_id, credentials, dlp_profiles, 3 more } params, RequestOptionsoptions?): IntegrationUpdateResponse { id, application, auth_method, 12 more }
PATCH/accounts/{account_id}/one/integrations/{id}
Delete integration
client.zeroTrust.casb.integrations.delete(stringid, IntegrationDeleteParams { account_id } params, RequestOptionsoptions?): void
DELETE/accounts/{account_id}/one/integrations/{id}
Pause integration
client.zeroTrust.casb.integrations.pause(stringid, IntegrationPauseParams { account_id } params, RequestOptionsoptions?): IntegrationPauseResponse { id, application, auth_method, 12 more }
POST/accounts/{account_id}/one/integrations/{id}/pause
Resume integration
client.zeroTrust.casb.integrations.resume(stringid, IntegrationResumeParams { account_id } params, RequestOptionsoptions?): IntegrationResumeResponse { id, application, auth_method, 12 more }
POST/accounts/{account_id}/one/integrations/{id}/resume
ModelsExpand Collapse
IntegrationListResponse = unknown
IntegrationGetResponse { id, application, auth_method, 12 more }

Serializer for v2 integration detail response with use cases.

id: string

Integration ID.

formatuuid
application: Record<string, string | null>
auth_method: Record<string, string> | null

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: Array<string>

DLP Profiles enabled for the integration.

health_details: Array<Record<string, unknown>>

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: Array<Record<string, unknown>>

Use cases enabled for the integration.

IntegrationCreateResponse { id, application, auth_method, 12 more }

Serializer for v2 integration detail response with use cases.

id: string

Integration ID.

formatuuid
application: Record<string, string | null>
auth_method: Record<string, string> | null

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: Array<string>

DLP Profiles enabled for the integration.

health_details: Array<Record<string, unknown>>

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: Array<Record<string, unknown>>

Use cases enabled for the integration.

IntegrationUpdateResponse { id, application, auth_method, 12 more }

Serializer for v2 integration detail response with use cases.

id: string

Integration ID.

formatuuid
application: Record<string, string | null>
auth_method: Record<string, string> | null

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: Array<string>

DLP Profiles enabled for the integration.

health_details: Array<Record<string, unknown>>

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: Array<Record<string, unknown>>

Use cases enabled for the integration.

IntegrationPauseResponse { id, application, auth_method, 12 more }

Serializer for v2 integration detail response with use cases.

id: string

Integration ID.

formatuuid
application: Record<string, string | null>
auth_method: Record<string, string> | null

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: Array<string>

DLP Profiles enabled for the integration.

health_details: Array<Record<string, unknown>>

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: Array<Record<string, unknown>>

Use cases enabled for the integration.

IntegrationResumeResponse { id, application, auth_method, 12 more }

Serializer for v2 integration detail response with use cases.

id: string

Integration ID.

formatuuid
application: Record<string, string | null>
auth_method: Record<string, string> | null

The integration’s authentication method.

created: string

When the integration was created.

formatdate-time
credentials_expiry: string

Credentials expiry time.

formatdate-time
dlp_profiles: Array<string>

DLP Profiles enabled for the integration.

health_details: Array<Record<string, unknown>>

Health details with remediation hints.

is_paused: boolean

Whether the user paused the integration.

last_hydrated: string

Last time the integration was hydrated.

formatdate-time
name: string

Name of the integration.

organization_id: number

Organization ID.

status: string

Integration status.

updated: string

When the integration was last updated.

formatdate-time
use_cases: Array<Record<string, unknown>>

Use cases enabled for the integration.

CasbPosture

CasbPostureFindings

List posture findings
client.zeroTrust.casb.posture.findings.list(FindingListParams { account_id, cursor, direction, 14 more } params, RequestOptionsoptions?): V4PagePaginationArray<FindingListResponse { id, active_count, archived_count, 6 more } >
GET/accounts/{account_id}/data-security/posture/findings
Get a finding type
client.zeroTrust.casb.posture.findings.get(stringfindingID, FindingGetParams { account_id } params, RequestOptionsoptions?): FindingGetResponse { id, active_count, archived_count, 6 more }
GET/accounts/{account_id}/data-security/posture/findings/{finding_id}
Create new findings export request
client.zeroTrust.casb.posture.findings.export(FindingExportParams { account_id, ignored, integration_id, 7 more } params, RequestOptionsoptions?): FindingExportResponse { id, status, type, 5 more }
POST/accounts/{account_id}/data-security/posture/findings/export
Mark a finding as ignored
client.zeroTrust.casb.posture.findings.ignore(FindingIgnoreParams { account_id, checks } params, RequestOptionsoptions?): FindingIgnoreResponse { id, active_count, archived_count, 6 more }
POST/accounts/{account_id}/data-security/posture/findings/ignore
Remove ignore marker from a finding
client.zeroTrust.casb.posture.findings.unignore(FindingUnignoreParams { account_id, checks } params, RequestOptionsoptions?): FindingUnignoreResponse { id, active_count, archived_count, 6 more }
POST/accounts/{account_id}/data-security/posture/findings/unignore
Update the severity for a finding
client.zeroTrust.casb.posture.findings.tuneSeverity(stringfindingID, FindingTuneSeverityParams { account_id, new_severity } params, RequestOptionsoptions?): FindingTuneSeverityResponse { id, active_count, archived_count, 6 more }
POST/accounts/{account_id}/data-security/posture/findings/{finding_id}/tune_finding_severity
Reset severity for a finding back to the default
client.zeroTrust.casb.posture.findings.resetSeverity(stringfindingID, FindingResetSeverityParams { account_id } params, RequestOptionsoptions?): FindingResetSeverityResponse { id, active_count, archived_count, 6 more }
POST/accounts/{account_id}/data-security/posture/findings/{finding_id}/reset_finding_severity
ModelsExpand Collapse
FindingListResponse { id, active_count, archived_count, 6 more }

Aggregated finding information with counts and metadata. This is optimized for list API queries and represents a finding along with its instance statistics.

id: string

Base64 encoded identifier of the security finding.

formatbyte
active_count: number

Number of active problematic instances identified in the security finding.

archived_count: number

Number of archived instances identified in the security finding.

finding: Finding { id, category, name, 4 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

description?: string | null

Detailed description of the finding.

remediation?: Remediation { id, frameworks, guide, 3 more }

Remediation guide information for a finding.

id: string

Remediation Id.

formatuuid
frameworks: Array<string>

Relevant Compliance Frameworks.

guide: string

Remediation guide text.

impact: string

Description of the potential impact.

locale: string

I18N Locale.

threat: string

Description of the threat.

ignored: boolean

Determines if finding is currently ignored.

instance_count: number

Number of total (Active or archived) problematic instances identified in the security finding.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Timestamp of the latest affliction date of an active finding.

formatdate-time
severity_override?: SeverityOverride { created_by, severity }

Override information for finding severity.

created_by: string

User ID who created the override.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
FindingGetResponse { id, active_count, archived_count, 6 more }

Aggregated finding information with counts and metadata. This is optimized for list API queries and represents a finding along with its instance statistics.

id: string

Base64 encoded identifier of the security finding.

formatbyte
active_count: number

Number of active problematic instances identified in the security finding.

archived_count: number

Number of archived instances identified in the security finding.

finding: Finding { id, category, name, 4 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

description?: string | null

Detailed description of the finding.

remediation?: Remediation { id, frameworks, guide, 3 more }

Remediation guide information for a finding.

id: string

Remediation Id.

formatuuid
frameworks: Array<string>

Relevant Compliance Frameworks.

guide: string

Remediation guide text.

impact: string

Description of the potential impact.

locale: string

I18N Locale.

threat: string

Description of the threat.

ignored: boolean

Determines if finding is currently ignored.

instance_count: number

Number of total (Active or archived) problematic instances identified in the security finding.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Timestamp of the latest affliction date of an active finding.

formatdate-time
severity_override?: SeverityOverride { created_by, severity }

Override information for finding severity.

created_by: string

User ID who created the override.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
FindingExportResponse { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

formatuuid
status: "Pending" | "Success" | "Failure" | 2 more

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" | "findingInstance" | "content" | "remediationJob"

Type of export job.

One of the following:
"finding"
"findingInstance"
"content"
"remediationJob"
user_id: string

ID of the export-requesting user.

maxLength128
download_url?: string | null

The URL by which the successfully created export can be downloaded by the end users.

formaturi
maxLength1024
errors?: string | null

Contains information on errors which may have occurred during export creation.

file_name?: string | null

The base name of the file that is/was generated by the export job.

maxLength256
file_path?: string | null

The full path of the file that is stored within external storage (currently R2).

maxLength512
FindingIgnoreResponse { id, active_count, archived_count, 6 more }

Aggregated finding information with counts and metadata. This is optimized for list API queries and represents a finding along with its instance statistics.

id: string

Base64 encoded identifier of the security finding.

formatbyte
active_count: number

Number of active problematic instances identified in the security finding.

archived_count: number

Number of archived instances identified in the security finding.

finding: Finding { id, category, name, 4 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

description?: string | null

Detailed description of the finding.

remediation?: Remediation { id, frameworks, guide, 3 more }

Remediation guide information for a finding.

id: string

Remediation Id.

formatuuid
frameworks: Array<string>

Relevant Compliance Frameworks.

guide: string

Remediation guide text.

impact: string

Description of the potential impact.

locale: string

I18N Locale.

threat: string

Description of the threat.

ignored: boolean

Determines if finding is currently ignored.

instance_count: number

Number of total (Active or archived) problematic instances identified in the security finding.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Timestamp of the latest affliction date of an active finding.

formatdate-time
severity_override?: SeverityOverride { created_by, severity }

Override information for finding severity.

created_by: string

User ID who created the override.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
FindingUnignoreResponse { id, active_count, archived_count, 6 more }

Aggregated finding information with counts and metadata. This is optimized for list API queries and represents a finding along with its instance statistics.

id: string

Base64 encoded identifier of the security finding.

formatbyte
active_count: number

Number of active problematic instances identified in the security finding.

archived_count: number

Number of archived instances identified in the security finding.

finding: Finding { id, category, name, 4 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

description?: string | null

Detailed description of the finding.

remediation?: Remediation { id, frameworks, guide, 3 more }

Remediation guide information for a finding.

id: string

Remediation Id.

formatuuid
frameworks: Array<string>

Relevant Compliance Frameworks.

guide: string

Remediation guide text.

impact: string

Description of the potential impact.

locale: string

I18N Locale.

threat: string

Description of the threat.

ignored: boolean

Determines if finding is currently ignored.

instance_count: number

Number of total (Active or archived) problematic instances identified in the security finding.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Timestamp of the latest affliction date of an active finding.

formatdate-time
severity_override?: SeverityOverride { created_by, severity }

Override information for finding severity.

created_by: string

User ID who created the override.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
FindingTuneSeverityResponse { id, active_count, archived_count, 6 more }

Aggregated finding information with counts and metadata. This is optimized for list API queries and represents a finding along with its instance statistics.

id: string

Base64 encoded identifier of the security finding.

formatbyte
active_count: number

Number of active problematic instances identified in the security finding.

archived_count: number

Number of archived instances identified in the security finding.

finding: Finding { id, category, name, 4 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

description?: string | null

Detailed description of the finding.

remediation?: Remediation { id, frameworks, guide, 3 more }

Remediation guide information for a finding.

id: string

Remediation Id.

formatuuid
frameworks: Array<string>

Relevant Compliance Frameworks.

guide: string

Remediation guide text.

impact: string

Description of the potential impact.

locale: string

I18N Locale.

threat: string

Description of the threat.

ignored: boolean

Determines if finding is currently ignored.

instance_count: number

Number of total (Active or archived) problematic instances identified in the security finding.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Timestamp of the latest affliction date of an active finding.

formatdate-time
severity_override?: SeverityOverride { created_by, severity }

Override information for finding severity.

created_by: string

User ID who created the override.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
FindingResetSeverityResponse { id, active_count, archived_count, 6 more }

Aggregated finding information with counts and metadata. This is optimized for list API queries and represents a finding along with its instance statistics.

id: string

Base64 encoded identifier of the security finding.

formatbyte
active_count: number

Number of active problematic instances identified in the security finding.

archived_count: number

Number of archived instances identified in the security finding.

finding: Finding { id, category, name, 4 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

description?: string | null

Detailed description of the finding.

remediation?: Remediation { id, frameworks, guide, 3 more }

Remediation guide information for a finding.

id: string

Remediation Id.

formatuuid
frameworks: Array<string>

Relevant Compliance Frameworks.

guide: string

Remediation guide text.

impact: string

Description of the potential impact.

locale: string

I18N Locale.

threat: string

Description of the threat.

ignored: boolean

Determines if finding is currently ignored.

instance_count: number

Number of total (Active or archived) problematic instances identified in the security finding.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Timestamp of the latest affliction date of an active finding.

formatdate-time
severity_override?: SeverityOverride { created_by, severity }

Override information for finding severity.

created_by: string

User ID who created the override.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"

CasbPostureFindingsInstances

List instances of a finding
client.zeroTrust.casb.posture.findings.instances.list(stringfindingID, InstanceListParams { account_id, archived, asset_ids, 10 more } params, RequestOptionsoptions?): V4PagePaginationArray<InstanceListResponse { affliction_date, asset, dlp_contexts, 4 more } >
GET/accounts/{account_id}/data-security/posture/findings/{finding_id}/instances
Get a finding instance using an instance ID
client.zeroTrust.casb.posture.findings.instances.get(stringinstanceID, InstanceGetParams { account_id, finding_id } params, RequestOptionsoptions?): InstanceGetResponse { affliction_date, asset, dlp_contexts, 4 more }
GET/accounts/{account_id}/data-security/posture/findings/{finding_id}/instances/{instance_id}
Create a finding instances export
client.zeroTrust.casb.posture.findings.instances.export(stringstorageNamespaceID, InstanceExportParams { account_id, archived, max_affliction_date, 3 more } params, RequestOptionsoptions?): InstanceExportResponse { id, status, type, 5 more }
POST/accounts/{account_id}/data-security/posture/findings/{storage_namespace_id}/instances/export
Archive a finding
client.zeroTrust.casb.posture.findings.instances.archive(stringfindingID, InstanceArchiveParams { account_id, check_instances } params, RequestOptionsoptions?): InstanceArchiveResponse { affliction_date, asset, dlp_contexts, 4 more }
POST/accounts/{account_id}/data-security/posture/findings/{finding_id}/instances/archive
Remove the archive marking from a finding instance
client.zeroTrust.casb.posture.findings.instances.unarchive(stringfindingID, InstanceUnarchiveParams { account_id, check_instances } params, RequestOptionsoptions?): InstanceUnarchiveResponse { affliction_date, asset, dlp_contexts, 4 more }
POST/accounts/{account_id}/data-security/posture/findings/{finding_id}/instances/unarchive
ModelsExpand Collapse
InstanceListResponse { affliction_date, asset, dlp_contexts, 4 more }

A specific instance of a security finding. In the API interface, we refer to the ‘finding’ table in our DB as finding instances, optimized for the p99 use case.

affliction_date: string

When this specific instance was identified.

formatdate-time
asset: Asset { category, external_id, fields, 3 more }

Asset information including metadata and categorization.

category: Category { service, type, vendor, id }

Category information for an asset.

service: string | null

The specific service within the vendor the asset is part of (often none). Example - AWS is the vendor, S3 is the service.

type: string

The type of asset.

vendor: string

The vendor the asset is part of.

id?: string

Unique identifier for the asset category.

formatuuid
external_id: string

External identifier from the source system.

maxLength512
fields: Array<Field>

The fields associated with the asset.

name: string

The name of the field.

value: string

The value of the field.

name: string

Human-readable name of the asset.

id?: string

Unique identifier for the asset.

formatuuid
dlp_contexts: Array<DLPContext>

DLP context information if this is a content finding.

created: string

When the DLP context was created.

formatdate-time
entry_ids: Array<string>

DLP Entry IDs.

profile_id: string

DLP Profile ID.

formatuuid
updated: string

When the DLP context was last updated.

formatdate-time
id?: string

Unique identifier for the DLP context.

formatuuid
deleted?: string | null

When the DLP context was deleted.

formatdate-time
match_context_max_extent?: number | null

DLP Right Boundary of match context.

maximum2147483647
minimum0
match_context_min_extent?: number | null

DLP Left Boundary of match context.

maximum2147483647
minimum0
match_context_payload?: Record<string, unknown> | null

DLP Match context payload that matched the profile in question.

remediations: Array<Remediation>

A list of the 10 most recent remediation jobs for this finding instance, ordered by creation time (most recent first). The ‘stale’ field indicates whether the remediation job was created before the finding instance’s affliction_date (true) or after it (false). If there has never been a remediation job for this finding instance, this field will be an empty array.

id: string

Unique identifier for the remediation job.

formatuuid
created_at: string

When the remediation job was created.

formatdate-time
stale: boolean

Whether this remediation job is stale (created before the finding instance’s affliction_date).

status: "pending" | "processing" | "completed" | 2 more

Status of a remediation job.

One of the following:
"pending"
"processing"
"completed"
"failed"
"validating"
webhooks: Array<Webhook>

The most recent webhook job invocation for each webhook configuration associated with this finding instance. Each entry represents the latest job (any status) per webhook config. The ‘stale’ field indicates whether the job was invoked before the finding instance’s current affliction_date. If no webhook jobs have been created, this field will be an empty array.

latest_job: LatestJob { id, created_at, stale, status }

The most recent webhook job for this webhook configuration.

id: string

Unique identifier for the webhook job.

formatuuid
created_at: string

When the webhook job was created.

formatdate-time
stale: boolean

Whether this webhook job is stale (created before the finding instance’s current affliction_date).

status: "pending" | "processing" | "completed"

Current status of the webhook job.

One of the following:
"pending"
"processing"
"completed"
webhook_id: string

Unique identifier for the webhook configuration.

formatuuid
webhook_label: string

Account-specified display label for the webhook configuration.

id?: string

Unique identifier for the finding instance.

formatuuid
is_archived?: boolean

Whether this finding instance has been archived.

InstanceGetResponse { affliction_date, asset, dlp_contexts, 4 more }

A specific instance of a security finding. In the API interface, we refer to the ‘finding’ table in our DB as finding instances, optimized for the p99 use case.

affliction_date: string

When this specific instance was identified.

formatdate-time
asset: Asset { category, external_id, fields, 3 more }

Asset information including metadata and categorization.

category: Category { service, type, vendor, id }

Category information for an asset.

service: string | null

The specific service within the vendor the asset is part of (often none). Example - AWS is the vendor, S3 is the service.

type: string

The type of asset.

vendor: string

The vendor the asset is part of.

id?: string

Unique identifier for the asset category.

formatuuid
external_id: string

External identifier from the source system.

maxLength512
fields: Array<Field>

The fields associated with the asset.

name: string

The name of the field.

value: string

The value of the field.

name: string

Human-readable name of the asset.

id?: string

Unique identifier for the asset.

formatuuid
dlp_contexts: Array<DLPContext>

DLP context information if this is a content finding.

created: string

When the DLP context was created.

formatdate-time
entry_ids: Array<string>

DLP Entry IDs.

profile_id: string

DLP Profile ID.

formatuuid
updated: string

When the DLP context was last updated.

formatdate-time
id?: string

Unique identifier for the DLP context.

formatuuid
deleted?: string | null

When the DLP context was deleted.

formatdate-time
match_context_max_extent?: number | null

DLP Right Boundary of match context.

maximum2147483647
minimum0
match_context_min_extent?: number | null

DLP Left Boundary of match context.

maximum2147483647
minimum0
match_context_payload?: Record<string, unknown> | null

DLP Match context payload that matched the profile in question.

remediations: Array<Remediation>

A list of the 10 most recent remediation jobs for this finding instance, ordered by creation time (most recent first). The ‘stale’ field indicates whether the remediation job was created before the finding instance’s affliction_date (true) or after it (false). If there has never been a remediation job for this finding instance, this field will be an empty array.

id: string

Unique identifier for the remediation job.

formatuuid
created_at: string

When the remediation job was created.

formatdate-time
stale: boolean

Whether this remediation job is stale (created before the finding instance’s affliction_date).

status: "pending" | "processing" | "completed" | 2 more

Status of a remediation job.

One of the following:
"pending"
"processing"
"completed"
"failed"
"validating"
webhooks: Array<Webhook>

The most recent webhook job invocation for each webhook configuration associated with this finding instance. Each entry represents the latest job (any status) per webhook config. The ‘stale’ field indicates whether the job was invoked before the finding instance’s current affliction_date. If no webhook jobs have been created, this field will be an empty array.

latest_job: LatestJob { id, created_at, stale, status }

The most recent webhook job for this webhook configuration.

id: string

Unique identifier for the webhook job.

formatuuid
created_at: string

When the webhook job was created.

formatdate-time
stale: boolean

Whether this webhook job is stale (created before the finding instance’s current affliction_date).

status: "pending" | "processing" | "completed"

Current status of the webhook job.

One of the following:
"pending"
"processing"
"completed"
webhook_id: string

Unique identifier for the webhook configuration.

formatuuid
webhook_label: string

Account-specified display label for the webhook configuration.

id?: string

Unique identifier for the finding instance.

formatuuid
is_archived?: boolean

Whether this finding instance has been archived.

InstanceExportResponse { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

formatuuid
status: "Pending" | "Success" | "Failure" | 2 more

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" | "findingInstance" | "content" | "remediationJob"

Type of export job.

One of the following:
"finding"
"findingInstance"
"content"
"remediationJob"
user_id: string

ID of the export-requesting user.

maxLength128
download_url?: string | null

The URL by which the successfully created export can be downloaded by the end users.

formaturi
maxLength1024
errors?: string | null

Contains information on errors which may have occurred during export creation.

file_name?: string | null

The base name of the file that is/was generated by the export job.

maxLength256
file_path?: string | null

The full path of the file that is stored within external storage (currently R2).

maxLength512
InstanceArchiveResponse { affliction_date, asset, dlp_contexts, 4 more }

A specific instance of a security finding. In the API interface, we refer to the ‘finding’ table in our DB as finding instances, optimized for the p99 use case.

affliction_date: string

When this specific instance was identified.

formatdate-time
asset: Asset { category, external_id, fields, 3 more }

Asset information including metadata and categorization.

category: Category { service, type, vendor, id }

Category information for an asset.

service: string | null

The specific service within the vendor the asset is part of (often none). Example - AWS is the vendor, S3 is the service.

type: string

The type of asset.

vendor: string

The vendor the asset is part of.

id?: string

Unique identifier for the asset category.

formatuuid
external_id: string

External identifier from the source system.

maxLength512
fields: Array<Field>

The fields associated with the asset.

name: string

The name of the field.

value: string

The value of the field.

name: string

Human-readable name of the asset.

id?: string

Unique identifier for the asset.

formatuuid
dlp_contexts: Array<DLPContext>

DLP context information if this is a content finding.

created: string

When the DLP context was created.

formatdate-time
entry_ids: Array<string>

DLP Entry IDs.

profile_id: string

DLP Profile ID.

formatuuid
updated: string

When the DLP context was last updated.

formatdate-time
id?: string

Unique identifier for the DLP context.

formatuuid
deleted?: string | null

When the DLP context was deleted.

formatdate-time
match_context_max_extent?: number | null

DLP Right Boundary of match context.

maximum2147483647
minimum0
match_context_min_extent?: number | null

DLP Left Boundary of match context.

maximum2147483647
minimum0
match_context_payload?: Record<string, unknown> | null

DLP Match context payload that matched the profile in question.

remediations: Array<Remediation>

A list of the 10 most recent remediation jobs for this finding instance, ordered by creation time (most recent first). The ‘stale’ field indicates whether the remediation job was created before the finding instance’s affliction_date (true) or after it (false). If there has never been a remediation job for this finding instance, this field will be an empty array.

id: string

Unique identifier for the remediation job.

formatuuid
created_at: string

When the remediation job was created.

formatdate-time
stale: boolean

Whether this remediation job is stale (created before the finding instance’s affliction_date).

status: "pending" | "processing" | "completed" | 2 more

Status of a remediation job.

One of the following:
"pending"
"processing"
"completed"
"failed"
"validating"
webhooks: Array<Webhook>

The most recent webhook job invocation for each webhook configuration associated with this finding instance. Each entry represents the latest job (any status) per webhook config. The ‘stale’ field indicates whether the job was invoked before the finding instance’s current affliction_date. If no webhook jobs have been created, this field will be an empty array.

latest_job: LatestJob { id, created_at, stale, status }

The most recent webhook job for this webhook configuration.

id: string

Unique identifier for the webhook job.

formatuuid
created_at: string

When the webhook job was created.

formatdate-time
stale: boolean

Whether this webhook job is stale (created before the finding instance’s current affliction_date).

status: "pending" | "processing" | "completed"

Current status of the webhook job.

One of the following:
"pending"
"processing"
"completed"
webhook_id: string

Unique identifier for the webhook configuration.

formatuuid
webhook_label: string

Account-specified display label for the webhook configuration.

id?: string

Unique identifier for the finding instance.

formatuuid
is_archived?: boolean

Whether this finding instance has been archived.

InstanceUnarchiveResponse { affliction_date, asset, dlp_contexts, 4 more }

A specific instance of a security finding. In the API interface, we refer to the ‘finding’ table in our DB as finding instances, optimized for the p99 use case.

affliction_date: string

When this specific instance was identified.

formatdate-time
asset: Asset { category, external_id, fields, 3 more }

Asset information including metadata and categorization.

category: Category { service, type, vendor, id }

Category information for an asset.

service: string | null

The specific service within the vendor the asset is part of (often none). Example - AWS is the vendor, S3 is the service.

type: string

The type of asset.

vendor: string

The vendor the asset is part of.

id?: string

Unique identifier for the asset category.

formatuuid
external_id: string

External identifier from the source system.

maxLength512
fields: Array<Field>

The fields associated with the asset.

name: string

The name of the field.

value: string

The value of the field.

name: string

Human-readable name of the asset.

id?: string

Unique identifier for the asset.

formatuuid
dlp_contexts: Array<DLPContext>

DLP context information if this is a content finding.

created: string

When the DLP context was created.

formatdate-time
entry_ids: Array<string>

DLP Entry IDs.

profile_id: string

DLP Profile ID.

formatuuid
updated: string

When the DLP context was last updated.

formatdate-time
id?: string

Unique identifier for the DLP context.

formatuuid
deleted?: string | null

When the DLP context was deleted.

formatdate-time
match_context_max_extent?: number | null

DLP Right Boundary of match context.

maximum2147483647
minimum0
match_context_min_extent?: number | null

DLP Left Boundary of match context.

maximum2147483647
minimum0
match_context_payload?: Record<string, unknown> | null

DLP Match context payload that matched the profile in question.

remediations: Array<Remediation>

A list of the 10 most recent remediation jobs for this finding instance, ordered by creation time (most recent first). The ‘stale’ field indicates whether the remediation job was created before the finding instance’s affliction_date (true) or after it (false). If there has never been a remediation job for this finding instance, this field will be an empty array.

id: string

Unique identifier for the remediation job.

formatuuid
created_at: string

When the remediation job was created.

formatdate-time
stale: boolean

Whether this remediation job is stale (created before the finding instance’s affliction_date).

status: "pending" | "processing" | "completed" | 2 more

Status of a remediation job.

One of the following:
"pending"
"processing"
"completed"
"failed"
"validating"
webhooks: Array<Webhook>

The most recent webhook job invocation for each webhook configuration associated with this finding instance. Each entry represents the latest job (any status) per webhook config. The ‘stale’ field indicates whether the job was invoked before the finding instance’s current affliction_date. If no webhook jobs have been created, this field will be an empty array.

latest_job: LatestJob { id, created_at, stale, status }

The most recent webhook job for this webhook configuration.

id: string

Unique identifier for the webhook job.

formatuuid
created_at: string

When the webhook job was created.

formatdate-time
stale: boolean

Whether this webhook job is stale (created before the finding instance’s current affliction_date).

status: "pending" | "processing" | "completed"

Current status of the webhook job.

One of the following:
"pending"
"processing"
"completed"
webhook_id: string

Unique identifier for the webhook configuration.

formatuuid
webhook_label: string

Account-specified display label for the webhook configuration.

id?: string

Unique identifier for the finding instance.

formatuuid
is_archived?: boolean

Whether this finding instance has been archived.

CasbPostureExports

List all export jobs
client.zeroTrust.casb.posture.exports.list(ExportListParams { account_id, page, per_page, status } params, RequestOptionsoptions?): V4PagePaginationArray<ExportListResponse { id, status, type, 5 more } >
GET/accounts/{account_id}/data-security/posture/exports
Get a single export job
client.zeroTrust.casb.posture.exports.get(stringid, ExportGetParams { account_id } params, RequestOptionsoptions?): ExportGetResponse { id, status, type, 5 more }
GET/accounts/{account_id}/data-security/posture/exports/{id}
ModelsExpand Collapse
ExportListResponse { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

formatuuid
status: "Pending" | "Success" | "Failure" | 2 more

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" | "findingInstance" | "content" | "remediationJob"

Type of export job.

One of the following:
"finding"
"findingInstance"
"content"
"remediationJob"
user_id: string

ID of the export-requesting user.

maxLength128
download_url?: string | null

The URL by which the successfully created export can be downloaded by the end users.

formaturi
maxLength1024
errors?: string | null

Contains information on errors which may have occurred during export creation.

file_name?: string | null

The base name of the file that is/was generated by the export job.

maxLength256
file_path?: string | null

The full path of the file that is stored within external storage (currently R2).

maxLength512
ExportGetResponse { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

formatuuid
status: "Pending" | "Success" | "Failure" | 2 more

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" | "findingInstance" | "content" | "remediationJob"

Type of export job.

One of the following:
"finding"
"findingInstance"
"content"
"remediationJob"
user_id: string

ID of the export-requesting user.

maxLength128
download_url?: string | null

The URL by which the successfully created export can be downloaded by the end users.

formaturi
maxLength1024
errors?: string | null

Contains information on errors which may have occurred during export creation.

file_name?: string | null

The base name of the file that is/was generated by the export job.

maxLength256
file_path?: string | null

The full path of the file that is stored within external storage (currently R2).

maxLength512

CasbPostureFinding Types

List all finding types
client.zeroTrust.casb.posture.findingTypes.list(FindingTypeListParams { account_id, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<FindingTypeListResponse { id, category, name, 2 more } >
GET/accounts/{account_id}/data-security/posture/finding_types
Get finding by ID
client.zeroTrust.casb.posture.findingTypes.get(stringfindingTypeID, FindingTypeGetParams { account_id } params, RequestOptionsoptions?): FindingTypeGetResponse { id, category, name, 2 more }
GET/accounts/{account_id}/data-security/posture/finding_types/{finding_type_id}
ModelsExpand Collapse
FindingTypeListResponse { id, category, name, 2 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

FindingTypeGetResponse { id, category, name, 2 more }

Basic finding type information.

id: string

The unique identifier of the finding.

formatuuid
category: Category { observation, product, type }

Category information for a finding.

observation: "Issue" | "Insight" | "Activity"

The type of the observation.

One of the following:
"Issue"
"Insight"
"Activity"
product: "SaaS" | "Cloud"

The product category.

One of the following:
"SaaS"
"Cloud"
type: "Content" | "Posture"

The type of the finding category.

One of the following:
"Content"
"Posture"
name: string

The name of the finding.

severity: "Critical" | "High" | "Medium" | "Low"

The severity level of a finding.

One of the following:
"Critical"
"High"
"Medium"
"Low"
vendor: string

The SaaS/Cloud vendor of the platform with which the finding is associated.

CasbPostureFinding TypesRemediation Types

List remediation types for a finding type
client.zeroTrust.casb.posture.findingTypes.remediationTypes.list(stringfindingTypeID, RemediationTypeListParams { account_id, cursor, integration_id, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<RemediationTypeListResponse { id, description, display_name, 2 more } >
GET/accounts/{account_id}/data-security/posture/finding_types/{finding_type_id}/remediation_types
ModelsExpand Collapse
RemediationTypeListResponse { id, description, display_name, 2 more }

Information about a remediation type.

id: string

The identifier for the remediation type.

formatuuid
description: string

A description of the action(s) taken by the remediation type.

display_name: string

The name of the remediation type as displayed in the cloudflare dashboard.

finding_type_id: string

The identifier of the finding_type which this remediation type should remediate.

formatuuid
remediation_type: string

The name of the remediation type.

CasbPostureContent

List DLP content findings
client.zeroTrust.casb.posture.content.list(ContentListParams { account_id, direction, dlp_profile_id, 8 more } params, RequestOptionsoptions?): V4PagePaginationArray<ContentListResponse { asset_id, asset_name, dlp_contexts, 4 more } >
GET/accounts/{account_id}/data-security/posture/content
Create a content export
client.zeroTrust.casb.posture.content.export(ContentExportParams { account_id, dlp_profile_information, dlp_profile_id, 6 more } params, RequestOptionsoptions?): ContentExportResponse { id, status, type, 5 more }
POST/accounts/{account_id}/data-security/posture/content/export
ModelsExpand Collapse
ContentListResponse { asset_id, asset_name, dlp_contexts, 4 more }

Content asset with DLP information.

asset_id: string

Unique identifier for the asset.

formatuuid
asset_name: string

Name of the asset.

dlp_contexts: Array<DLPContext>

DLP context information for this asset.

created: string

When the DLP context was created.

formatdate-time
entry_ids: Array<string>

DLP Entry IDs.

profile_id: string

DLP Profile ID.

formatuuid
updated: string

When the DLP context was last updated.

formatdate-time
id?: string

Unique identifier for the DLP context.

formatuuid
deleted?: string | null

When the DLP context was deleted.

formatdate-time
match_context_max_extent?: number | null

DLP Right Boundary of match context.

maximum2147483647
minimum0
match_context_min_extent?: number | null

DLP Left Boundary of match context.

maximum2147483647
minimum0
match_context_payload?: Record<string, unknown> | null

DLP Match context payload that matched the profile in question.

dlp_profile_count: number

Number of DLP profiles that flagged this asset.

dlp_profile_ids: Array<string>

IDs of DLP profiles that flagged this asset.

integration: Integration { created, last_hydrated, name, 12 more }

Summary information about an integration.

created: string

When entity was created.

formatdate-time
last_hydrated: string

When were the integration credentials last updated.

formatdate-time
name: string

Name of the integration.

maxLength256
permissions: Array<string>

The vendor-specific permissions associated with the integration.

policy: Policy { id, client_id, compliance_level, 4 more }

Policy configuration for an integration.

id?: string

Policy identifier.

formatuuid
client_id?: string | null

OAuth client ID for the policy.

compliance_level?: string

Compliance level for the policy.

dlp_enabled?: boolean

Whether DLP is enabled for this policy.

name?: string

Policy name.

permissions?: Array<string>

List of permissions included in the policy.

status: string

Current status of the integration.

updated: string

Last entity was updated.

formatdate-time
upgradable: boolean

Whether the integrations permissions can be updated.

vendor: Vendor { id, description, display_name, 5 more }

Information about a vendor/service provider.

id: string

The id of the vendor.

description: string | null

Detailed information about what kinds of issues are detected for this vendor.

display_name: string

The display name of the vendor.

name: string

The name of the vendor.

zt_enrollments: Array<string>

The vendor’s compatible Zero Trust products.

policies?: Array<Record<string, unknown>>

The policies related to the vendor.

zt_enrollments: Array<ZtEnrollment>

Zero Trust products associated with this integration.

id?: string

The internal identifier of the Zero Trust Product.

description?: string

Brief description of the Zero Trust Product.

display_name?: string

The verbose name of the Zero Trust Product.

enabled?: boolean

Flag to enable/disable access to the listed integration from the corresponding Cloudflare product.

id?: string

Integration ID.

formatuuid
credential_health_status?: "Initializing" | "Healthy" | "Unhealthy"

Health status of integration credentials.

One of the following:
"Initializing"
"Healthy"
"Unhealthy"
credentials_expiry?: string | null

The date and time when the integration credentials will expire.

formatdate-time
is_paused?: boolean

Whether the given integration is paused by the user.

upgrade_dismissed?: boolean

UI State as to whether a potential permissions upgrade has been dismissed.

latest_affliction_date: string

Most recent date this asset was flagged.

formatdate-time
ContentExportResponse { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

formatuuid
status: "Pending" | "Success" | "Failure" | 2 more

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" | "findingInstance" | "content" | "remediationJob"

Type of export job.

One of the following:
"finding"
"findingInstance"
"content"
"remediationJob"
user_id: string

ID of the export-requesting user.

maxLength128
download_url?: string | null

The URL by which the successfully created export can be downloaded by the end users.

formaturi
maxLength1024
errors?: string | null

Contains information on errors which may have occurred during export creation.

file_name?: string | null

The base name of the file that is/was generated by the export job.

maxLength256
file_path?: string | null

The full path of the file that is stored within external storage (currently R2).

maxLength512

CasbPostureRemediations

CasbPostureRemediationsJobs

List remediation jobs
client.zeroTrust.casb.posture.remediations.jobs.list(JobListParams { account_id, cursor, direction, 9 more } params, RequestOptionsoptions?): V4PagePaginationArray<JobListResponse { id, asset, created_at, 11 more } >
GET/accounts/{account_id}/data-security/posture/remediations/jobs
Creates remediation jobs
client.zeroTrust.casb.posture.remediations.jobs.create(JobCreateParams { account_id, finding_instance_ids, remediation_type_id } params, RequestOptionsoptions?): JobCreateResponse { created, failed }
POST/accounts/{account_id}/data-security/posture/remediations/jobs
Create a remediation jobs export
client.zeroTrust.casb.posture.remediations.jobs.export(JobExportParams { account_id, integration_id, max_updated_at, 4 more } params, RequestOptionsoptions?): JobExportResponse { id, status, type, 5 more }
POST/accounts/{account_id}/data-security/posture/remediations/jobs/export
ModelsExpand Collapse
JobListResponse { id, asset, created_at, 11 more }

Information about a remediation job.

id: string

Unique identifier for the remediation job.

formatuuid
asset: Asset { id, category, external_id, 3 more }

Asset information for a remediation job.

id: string

Unique identifier for the asset.

formatuuid
category: Category { service, type, vendor }

Category information for a remediation job asset.

service: string

Specific service within the vendor.

type: string

Asset type.

vendor: "AWS" | "Anthropic" | "Bitbucket" | 16 more

Display names for vendor types.

One of the following:
"AWS"
"Anthropic"
"Bitbucket"
"Box"
"Confluence"
"Dropbox"
"GitHub"
"Google Cloud Platform"
"Google Workspace"
"Jira"
"Microsoft"
"Microsoft Internal"
"Okta"
"OpenAI"
"Slack"
"Salesforce"
"ServiceNow"
"Workday"
"Zoom"
external_id: string

External identifier from the source system.

fields: Array<Field>

Additional fields associated with the asset.

name: string

Field name.

value: string | number | boolean

Field value (can be string, number, or boolean).

One of the following:
string
number
boolean
name: string

Human-readable name of the asset.

created_at: string

When the remediation job was created.

formatdate-time
finding_id: string

Encoded finding ID.

finding_instance_id: string

ID of the finding instance being remediated.

formatuuid
finding_type_id: string

ID of the finding type.

formatuuid
finding_type_name: string

Name of the finding type.

integration_name: string

Name of the integration.

last_updated: string

When the remediation job was last updated.

formatdate-time
remediation_type: string

Type of remediation being performed.

status: "pending" | "processing" | "completed" | 2 more

Status of a remediation job.

One of the following:
"pending"
"processing"
"completed"
"failed"
"validating"
triggered_by_user: string

Email of the user who triggered the remediation. For account-token actors this is the literal “Account API Token”; for policy actors this is empty.

triggered_by_actor?: "user" | "account_token" | null

Type of actor that triggered the remediation job. Null on legacy rows created before this column was populated.

One of the following:
"user"
"account_token"
triggered_by_id?: string | null

ID of the actor that triggered the job. Meaning depends on triggered_by_actor. Null on legacy rows.

JobCreateResponse { created, failed }
created: Array<Created>

Successfully created remediation jobs.

id: string

Unique identifier for the remediation job.

formatuuid
asset: Asset { id, category, external_id, 3 more }

Asset information for a remediation job.

id: string

Unique identifier for the asset.

formatuuid
category: Category { service, type, vendor }

Category information for a remediation job asset.

service: string

Specific service within the vendor.

type: string

Asset type.

vendor: "AWS" | "Anthropic" | "Bitbucket" | 16 more

Display names for vendor types.

One of the following:
"AWS"
"Anthropic"
"Bitbucket"
"Box"
"Confluence"
"Dropbox"
"GitHub"
"Google Cloud Platform"
"Google Workspace"
"Jira"
"Microsoft"
"Microsoft Internal"
"Okta"
"OpenAI"
"Slack"
"Salesforce"
"ServiceNow"
"Workday"
"Zoom"
external_id: string

External identifier from the source system.

fields: Array<Field>

Additional fields associated with the asset.

name: string

Field name.

value: string | number | boolean

Field value (can be string, number, or boolean).

One of the following:
string
number
boolean
name: string

Human-readable name of the asset.

created_at: string

When the remediation job was created.

formatdate-time
finding_id: string

Encoded finding ID.

finding_instance_id: string

ID of the finding instance being remediated.

formatuuid
finding_type_id: string

ID of the finding type.

formatuuid
finding_type_name: string

Name of the finding type.

integration_name: string

Name of the integration.

last_updated: string

When the remediation job was last updated.

formatdate-time
remediation_type: string

Type of remediation being performed.

status: "pending" | "processing" | "completed" | 2 more

Status of a remediation job.

One of the following:
"pending"
"processing"
"completed"
"failed"
"validating"
triggered_by_user: string

Email of the user who triggered the remediation. For account-token actors this is the literal “Account API Token”; for policy actors this is empty.

triggered_by_actor?: "user" | "account_token" | null

Type of actor that triggered the remediation job. Null on legacy rows created before this column was populated.

One of the following:
"user"
"account_token"
triggered_by_id?: string | null

ID of the actor that triggered the job. Meaning depends on triggered_by_actor. Null on legacy rows.

failed: Array<Failed>

Failed remediation job creation attempts.

error: string

Error message describing the failure.

finding_instance_id: string

ID of the finding instance that failed to create a remediation job.

formatuuid
JobExportResponse { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

formatuuid
status: "Pending" | "Success" | "Failure" | 2 more

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" | "findingInstance" | "content" | "remediationJob"

Type of export job.

One of the following:
"finding"
"findingInstance"
"content"
"remediationJob"
user_id: string

ID of the export-requesting user.

maxLength128
download_url?: string | null

The URL by which the successfully created export can be downloaded by the end users.

formaturi
maxLength1024
errors?: string | null

Contains information on errors which may have occurred during export creation.

file_name?: string | null

The base name of the file that is/was generated by the export job.

maxLength256
file_path?: string | null

The full path of the file that is stored within external storage (currently R2).

maxLength512

CasbPostureWebhooks

List webhook configurations
client.zeroTrust.casb.posture.webhooks.list(WebhookListParams { account_id } params, RequestOptionsoptions?): SinglePage<WebhookListResponse { id, authentication_type, created_at, 6 more } >
GET/accounts/{account_id}/data-security/posture/webhooks
Create a new webhook configuration
client.zeroTrust.casb.posture.webhooks.create(WebhookCreateParams { account_id, authentication_type, destination_url, 3 more } params, RequestOptionsoptions?): WebhookCreateResponse { id, authentication_type, created_at, 6 more }
POST/accounts/{account_id}/data-security/posture/webhooks
Get webhook configuration by ID
client.zeroTrust.casb.posture.webhooks.get(stringwebhookID, WebhookGetParams { account_id } params, RequestOptionsoptions?): WebhookGetResponse { id, authentication_type, created_at, 6 more }
GET/accounts/{account_id}/data-security/posture/webhooks/{webhook_id}
Update an existing webhook configuration
client.zeroTrust.casb.posture.webhooks.update(stringwebhookID, WebhookUpdateParams { account_id, authentication_type, destination_url, 4 more } params, RequestOptionsoptions?): WebhookUpdateResponse { id, authentication_type, created_at, 6 more }
PUT/accounts/{account_id}/data-security/posture/webhooks/{webhook_id}
Delete a webhook configuration
client.zeroTrust.casb.posture.webhooks.delete(stringwebhookID, WebhookDeleteParams { account_id } params, RequestOptionsoptions?): WebhookDeleteResponse { errors, messages, success }
DELETE/accounts/{account_id}/data-security/posture/webhooks/{webhook_id}
Test a webhook configuration before creating it
client.zeroTrust.casb.posture.webhooks.evaluate(WebhookEvaluateParams { account_id, authentication_type, destination_url, 2 more } params, RequestOptionsoptions?): WebhookEvaluateResponse { message, status_code, success }
POST/accounts/{account_id}/data-security/posture/webhooks/evaluate
Test an existing webhook configuration
client.zeroTrust.casb.posture.webhooks.evaluateExisting(stringwebhookID, WebhookEvaluateExistingParams { account_id } params, RequestOptionsoptions?): WebhookEvaluateExistingResponse { message, status_code, success }
POST/accounts/{account_id}/data-security/posture/webhooks/{webhook_id}/evaluate
ModelsExpand Collapse
WebhookListResponse { id, authentication_type, created_at, 6 more }

Webhook configuration for sending finding notifications.

id: string

Unique identifier for the specific webhook configuration.

formatuuid
authentication_type: "Basic Auth" | "None" | "Bearer Auth" | 2 more

Type of authentication used for the webhook.

One of the following:
"Basic Auth"
"None"
"Bearer Auth"
"Static Headers"
"HMAC-Signing"
created_at: string

Timestamp when the webhook configuration was created.

formatdate-time
destination_url: string

Target URL for the webhook configuration. Where resulting data will be sent.

formaturi
label: string

Account-specified display label for the webhook configuration.

status: "enabled" | "disabled"

Current status of the webhook configuration. If disabled, data cannot be sent through this configuration.

One of the following:
"enabled"
"disabled"
updated_at: string

Timestamp when the webhook configuration was last updated.

formatdate-time
version: number

Version number of the configuration.

formatuint32
headers?: Array<Header>

List of header keys configured for this webhook. Values are not included for security reasons.

key?: string

Header key name (lowercase).

value?: string

Header value. This field is never returned in API responses for security reasons.

WebhookCreateResponse { id, authentication_type, created_at, 6 more }

Webhook configuration for sending finding notifications.

id: string

Unique identifier for the specific webhook configuration.

formatuuid
authentication_type: "Basic Auth" | "None" | "Bearer Auth" | 2 more

Type of authentication used for the webhook.

One of the following:
"Basic Auth"
"None"
"Bearer Auth"
"Static Headers"
"HMAC-Signing"
created_at: string

Timestamp when the webhook configuration was created.

formatdate-time
destination_url: string

Target URL for the webhook configuration. Where resulting data will be sent.

formaturi
label: string

Account-specified display label for the webhook configuration.

status: "enabled" | "disabled"

Current status of the webhook configuration. If disabled, data cannot be sent through this configuration.

One of the following:
"enabled"
"disabled"
updated_at: string

Timestamp when the webhook configuration was last updated.

formatdate-time
version: number

Version number of the configuration.

formatuint32
headers?: Array<Header>

List of header keys configured for this webhook. Values are not included for security reasons.

key?: string

Header key name (lowercase).

value?: string

Header value. This field is never returned in API responses for security reasons.

WebhookGetResponse { id, authentication_type, created_at, 6 more }

Webhook configuration for sending finding notifications.

id: string

Unique identifier for the specific webhook configuration.

formatuuid
authentication_type: "Basic Auth" | "None" | "Bearer Auth" | 2 more

Type of authentication used for the webhook.

One of the following:
"Basic Auth"
"None"
"Bearer Auth"
"Static Headers"
"HMAC-Signing"
created_at: string

Timestamp when the webhook configuration was created.

formatdate-time
destination_url: string

Target URL for the webhook configuration. Where resulting data will be sent.

formaturi
label: string

Account-specified display label for the webhook configuration.

status: "enabled" | "disabled"

Current status of the webhook configuration. If disabled, data cannot be sent through this configuration.

One of the following:
"enabled"
"disabled"
updated_at: string

Timestamp when the webhook configuration was last updated.

formatdate-time
version: number

Version number of the configuration.

formatuint32
headers?: Array<Header>

List of header keys configured for this webhook. Values are not included for security reasons.

key?: string

Header key name (lowercase).

value?: string

Header value. This field is never returned in API responses for security reasons.

WebhookUpdateResponse { id, authentication_type, created_at, 6 more }

Webhook configuration for sending finding notifications.

id: string

Unique identifier for the specific webhook configuration.

formatuuid
authentication_type: "Basic Auth" | "None" | "Bearer Auth" | 2 more

Type of authentication used for the webhook.

One of the following:
"Basic Auth"
"None"
"Bearer Auth"
"Static Headers"
"HMAC-Signing"
created_at: string

Timestamp when the webhook configuration was created.

formatdate-time
destination_url: string

Target URL for the webhook configuration. Where resulting data will be sent.

formaturi
label: string

Account-specified display label for the webhook configuration.

status: "enabled" | "disabled"

Current status of the webhook configuration. If disabled, data cannot be sent through this configuration.

One of the following:
"enabled"
"disabled"
updated_at: string

Timestamp when the webhook configuration was last updated.

formatdate-time
version: number

Version number of the configuration.

formatuint32
headers?: Array<Header>

List of header keys configured for this webhook. Values are not included for security reasons.

key?: string

Header key name (lowercase).

value?: string

Header value. This field is never returned in API responses for security reasons.

WebhookDeleteResponse { errors, messages, success }

Common response structure for all API endpoints.

errors: Array<Error>
code: number

Error or message code.

minimum1000
message: string

Human-readable message.

documentation_url?: string

Link to relevant documentation.

formaturi
source?: Source { pointer }
pointer?: string

JSON pointer to the source of the error.

messages: Array<Message>
code: number

Error or message code.

minimum1000
message: string

Human-readable message.

documentation_url?: string

Link to relevant documentation.

formaturi
source?: Source { pointer }
pointer?: string

JSON pointer to the source of the error.

success: boolean

Whether the API call was successful.

WebhookEvaluateResponse { message, status_code, success }

Response body for webhook evaluation test results.

message: string

Human-readable message describing the test result.

status_code: number

HTTP status code returned by the webhook endpoint. 0 if connection failed.

success: boolean

Whether the webhook test was successful (received 2xx response).

WebhookEvaluateExistingResponse { message, status_code, success }

Response body for webhook evaluation test results.

message: string

Human-readable message describing the test result.

status_code: number

HTTP status code returned by the webhook endpoint. 0 if connection failed.

success: boolean

Whether the webhook test was successful (received 2xx response).

CasbPostureWebhooksJobs

Create webhook jobs
client.zeroTrust.casb.posture.webhooks.jobs.create(JobCreateParams { account_id, finding_instance_ids, webhook_ids } params, RequestOptionsoptions?): JobCreateResponse { created, failed }
POST/accounts/{account_id}/data-security/posture/webhooks/jobs
ModelsExpand Collapse
JobCreateResponse { created, failed }
created: Array<Created>

Successfully created webhook jobs.

id: string

Unique identifier for the webhook job.

formatuuid
asset_data: Record<string, unknown>

Asset data associated with this webhook job.

created_at: string

When the webhook job was created.

formatdate-time
integration_id: string

ID of the integration.

formatuuid
last_updated_at: string

When the webhook job was last updated.

formatdate-time
parameters: Parameters { finding_instance_id }

Parameters for a webhook job.

finding_instance_id: string

ID of the finding instance.

formatuuid
status: "pending" | "processing" | "completed" | "failed"

Status of a webhook job.

One of the following:
"pending"
"processing"
"completed"
"failed"
triggered_by_actor: "user" | "account_token"

Type of actor that triggered the webhook job.

One of the following:
"user"
"account_token"
triggered_by_id: string

ID of the actor that triggered the job.

webhook_id: string

ID of the webhook configuration.

formatuuid
failure_details?: Record<string, unknown>

Additional details about the failure.

failure_reason?: "Permission Denied" | "Integration Unavailable" | "Service Temporarily Unavailable" | "System Error"

Reason for webhook job failure.

One of the following:
"Permission Denied"
"Integration Unavailable"
"Service Temporarily Unavailable"
"System Error"
failed: Array<Failed>

Failed webhook job creation attempts.

error: string

Error message describing the failure.

finding_instance_id: string

ID of the finding instance that failed to create a webhook job.

formatuuid
webhook_id: string

ID of the webhook configuration.

formatuuid