Skip to content
Start here

Jobs

List remediation jobs
GET/accounts/{account_id}/data-security/posture/remediations/jobs
Creates remediation jobs
POST/accounts/{account_id}/data-security/posture/remediations/jobs
Create a remediation jobs export
POST/accounts/{account_id}/data-security/posture/remediations/jobs/export
ModelsExpand Collapse
JobListResponse object { id, asset, created_at, 11 more }

Information about a remediation job.

id: string

Unique identifier for the remediation job.

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

Asset information for a remediation job.

id: string

Unique identifier for the asset.

formatuuid
category: object { service, type, vendor }

Category information for a remediation job asset.

service: string

Specific service within the vendor.

type: string

Asset type.

vendor: "AWS" or "Anthropic" or "Bitbucket" or 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 of object { name, value, link }

Additional fields associated with the asset.

name: string

Field name.

value: string or number or 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" or "processing" or "completed" or 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: optional "user" or "account_token"

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: optional string

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

JobCreateResponse object { created, failed }
created: array of object { id, asset, created_at, 11 more }

Successfully created remediation jobs.

id: string

Unique identifier for the remediation job.

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

Asset information for a remediation job.

id: string

Unique identifier for the asset.

formatuuid
category: object { service, type, vendor }

Category information for a remediation job asset.

service: string

Specific service within the vendor.

type: string

Asset type.

vendor: "AWS" or "Anthropic" or "Bitbucket" or 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 of object { name, value, link }

Additional fields associated with the asset.

name: string

Field name.

value: string or number or 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" or "processing" or "completed" or 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: optional "user" or "account_token"

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: optional string

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

failed: array of object { error, finding_instance_id }

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 object { id, status, type, 5 more }

Information about an export job.

id: string

Unique identifier for the export job.

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

Status of an export job.

One of the following:
"Pending"
"Success"
"Failure"
"Rescheduled"
"In-Progress"
type: "finding" or "findingInstance" or "content" or "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: optional string

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

formaturi
maxLength1024
errors: optional string

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

file_name: optional string

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

maxLength256
file_path: optional string

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

maxLength512