Falcon Container
The Falcon Container service collection provides operations for managing container security. Download and manage export jobs, check prevention policies, retrieve image assessment reports, manage registry credentials, and handle container image scan inventories.
| Language | Last Update |
|---|---|
| Python | v1.6.5 |
| PowerShell | v2.2.9 |
| Go | v0.22.0 |
| TypeScript | v0.6.0 |
| Rust | v0.7.1 |
| Ruby | v1.4.0 |
Table of Contents
Section titled “Table of Contents”| Operation | Description |
|---|---|
CreateRegistryEntitiescreate_registry_entities | Create a registry entity using the provided details |
DeleteImageDetailsdelete_image_details | Delete Images by ids. |
DeleteRegistryEntitiesdelete_registry_entities | Delete the registry entity identified by the entity UUID |
DownloadExportFiledownload_export_file | Download an export file |
GetCredentialsget_credentials | Gets the registry credentials |
GetImageAssessmentReportget_assessment | Retrieves the Assessment report for the Image ID provided. |
GetReportByReferenceget_report_by_reference | Get image assessment scan report by image reference (v2) |
GetReportByScanIDget_report_by_id | Get image assessment scan report by scan UUID (v2) |
HeadImageScanInventoryget_scan_headers | Get headers for POST request for image scan inventory |
ImageMatchesPolicyimage_matches_policy | After an image scan, use this operation to see if any images match a policy. |
LaunchExportJoblaunch_export_job | Launch an export job of a Container Security resource. |
PolicyCheckscheck_prevention_policies | Check image prevention policies |
PostImageScanInventoryscan_inventory | Post image scan inventory |
QueryExportJobsquery_export_jobs | Query export jobs entities |
ReadExportJobsread_export_jobs | Read export jobs entities |
ReadImageVulnerabilitiesread_image_vulnerabilities | Retrieve known vulnerabilities for the provided image |
ReadRegistryEntitiesread_registry_entities | Retrieves a list of registry entities identified by the customer id. |
ReadRegistryEntitiesByUUIDread_registry_entities_by_uuid | Retrieves a list of registry entities by the provided UUIDs. |
UpdateRegistryEntitiesupdate_registry_entities | Update the registry entity, as identified by the entity UUID, using the provided details |
CreateRegistryEntities
Section titled “CreateRegistryEntities”Create a registry entity using the provided details
Method POST
Route /container-security/entities/registries/v1
Scope Falcon Container Image: WRITE
PEP 8
create_registry_entitiesParameters
Section titled “Parameters”body body · dictionary
Full body payload as JSON formatted dictionary.
credential body · object
type body · string
url body · string
url_uniqueness_key body · string
user_defined_alias body · string
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
credential = { "details": {}}
response = falcon.create_registry_entities(credential=credential, type="string", url="string", url_uniqueness_key="string", user_defined_alias="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
credential = { "details": {}}
response = falcon.CreateRegistryEntities(credential=credential, type="string", url="string", url_uniqueness_key="string", user_defined_alias="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "credential": { "details": {} }, "type": "string", "url": "string", "url_uniqueness_key": "string", "user_defined_alias": "string"}
response = falcon.command("CreateRegistryEntities", body=body_payload)print(response)New-FalconContainerRegistry -Name "string" ` -Type "string" ` -Url "string" ` -Credential @{}package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
typeVar := "string" url := "string" url_uniqueness_key := "string" user_defined_alias := "string"
response, err := client.FalconContainerImage.CreateRegistryEntities( &falcon_container_image.CreateRegistryEntitiesParams{ Body: &models.RegistryassessmentExternalRegistryPayload{ Credential: &struct{}{}, Type: &typeVar, URL: &url, UrlUniquenessKey: &url_uniqueness_key, UserDefinedAlias: &user_defined_alias, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.createRegistryEntities( { credential: { details: {} }, type: "string", url: "string", urlUniquenessKey: "string", userDefinedAlias: "string"} // body);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::create_registry_entities;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::RegistryassessmentExternalRegistryPayload;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = RegistryassessmentExternalRegistryPayload { credential: Default::default(), type: Some("string".to_string()), url: Some("string".to_string()), ..Default::default() };
let response = create_registry_entities( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
body = Falcon::RegistryassessmentExternalRegistryPayload.new( credential: { details: {} }, type: 'string', url: 'string', url_uniqueness_key: 'string', user_defined_alias: 'string')
response = api.create_registry_entities(body)
puts responseResponses
{ "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string"}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": { "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": { "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": { "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }}DeleteImageDetails
Section titled “DeleteImageDetails”Delete Images by ids.
Method DELETE
Route /images/{}
PEP 8
delete_image_detailsParameters
Section titled “Parameters”image_id path · string
The ID of the image to be deleted.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.delete_image_details(image_id="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.DeleteImageDetails(image_id="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("DeleteImageDetails", image_id="string")print(response)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
DeleteRegistryEntities
Section titled “DeleteRegistryEntities”Delete the registry entity identified by the entity UUID
Method DELETE
Route /container-security/entities/registries/v1
Scope Falcon Container Image: WRITE
PEP 8
delete_registry_entitiesParameters
Section titled “Parameters”ids query · string
Registry entity UUID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.delete_registry_entities(ids=id_list)print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.DeleteRegistryEntities(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("DeleteRegistryEntities", ids="string")print(response)Remove-FalconContainerRegistry -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.FalconContainerImage.DeleteRegistryEntities( &falcon_container_image.DeleteRegistryEntitiesParams{ Ids: "string", Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.deleteRegistryEntities("string"); // ids
console.log(response);use rusty_falcon::apis::falcon_container_image_api::delete_registry_entities;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = delete_registry_entities( &falcon.cfg, // configuration "string", // ids ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.delete_registry_entities('string')
puts responseResponses
[ { "created_at": "string", "credential": {}, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}DownloadExportFile
Section titled “DownloadExportFile”Download an export file
Method GET
Route /container-security/entities/exports/files/v1
Scope Falcon Container Image: READ
PEP 8
download_export_fileParameters
Section titled “Parameters”id query · string
Export job ID.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
with open("output_file", "wb") as save_file: response = falcon.download_export_file(id="string", stream=boolean) save_file.write(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
with open("output_file", "wb") as save_file: response = falcon.DownloadExportFile(id="string", stream=boolean) save_file.write(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
with open("output_file", "wb") as save_file: response = falcon.command("DownloadExportFile", id="string") save_file.write(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.FalconContainerImage.DownloadExportFile( &falcon_container_image.DownloadExportFileParams{ ID: "string", Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.downloadExportFile("string"); // id
console.log(response);use rusty_falcon::apis::falcon_container_image_api::download_export_file;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = download_export_file( &falcon.cfg, // configuration "string", // id ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.download_export_file('string')
puts responseResponses
{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}GetCredentials
Section titled “GetCredentials”Gets the registry credentials
Method GET
Route /container-security/entities/image-registry-credentials/v1
Scope Falcon Container CLI: READ
PEP 8
get_credentialsCode Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.get_credentials()print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.GetCredentials()print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("GetCredentials")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.FalconContainer.GetCredentials( &falcon_container.GetCredentialsParams{ Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainer.getCredentials();
console.log(response);use rusty_falcon::apis::falcon_container_api::get_credentials;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_credentials(&falcon.cfg).await.expect("API call failed"); // configuration
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainer.new
response = api.get_credentials
puts responseResponses
[ { "token": "string" }]{ "code": 0, "id": "string", "message": "string"}{ "code": 0, "id": "string", "message": "string"}{ "code": 0, "id": "string", "message": "string"}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ { "token": "string" } ]}GetImageAssessmentReport
Section titled “GetImageAssessmentReport”Retrieves the Assessment report for the Image ID provided.
Method GET
Route /reports
PEP 8
get_assessmentParameters
Section titled “Parameters”digest query · string
The hash digest for the image.
image_id query · string
The image ID.
repository query · string
The repository the image resides within.
tag query · string
The image tag.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.get_assessment(digest="string", image_id="string", repository="string", tag="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.GetImageAssessmentReport(digest="string", image_id="string", repository="string", tag="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("GetImageAssessmentReport", digest="string", image_id="string", repository="string", tag="string")print(response)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
GetReportByReference
Section titled “GetReportByReference”Get image assessment scan report by image reference (v2)
Method GET
Route /image-assessment/entities/reports/v2
Scope Falcon Container Image: READ
PEP 8
get_report_by_referenceParameters
Section titled “Parameters”registry query · string
Registry
repository query · string
Repository
tag query · string
Tag
image_id query · string
Image ID
digest query · string
Digest
architecture query · string
Platform architecture to filter multi-arch images (e.g. amd64, arm64)
report_format query · string
Specify image-assessment scan report format. Supported formats:
Available values (3)
cyclonedx-json | json | sarif |
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.get_report_by_reference(registry="string", repository="string", tag="string", image_id="string", digest="string", report_format="string", architecture="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.GetReportByReference(registry="string", repository="string", tag="string", image_id="string", digest="string", report_format="string", architecture="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("GetReportByReference", registry="string", repository="string", tag="string", image_id="string", digest="string", architecture="string", report_format="string")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
registry := "string" repository := "string" tag := "string" imageID := "string" digest := "string" architecture := "string" reportFormat := "string"
response, err := client.FalconContainerImage.GetReportByReference( &falcon_container_image.GetReportByReferenceParams{ Registry: ®istry, Repository: &repository, Tag: &tag, ImageID: &imageID, Digest: &digest, Architecture: &architecture, ReportFormat: &reportFormat, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.getReportByReference( "string", // registry "string", // repository "string", // tag "string", // imageId "string", // digest "string", // architecture "string" // reportFormat);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::get_report_by_reference;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_report_by_reference( &falcon.cfg, // configuration Some("string"), // registry Some("string"), // repository Some("string"), // tag Some("string"), // image_id Some("string"), // digest Some("string"), // report_format ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.get_report_by_reference(registry: 'string', repository: 'string', tag: 'string', image_id: 'string', digest: 'string', architecture: 'string', report_format: 'string')
puts responseResponses
{}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}GetReportByScanID
Section titled “GetReportByScanID”Get image assessment scan report by scan UUID (v2)
Method GET
Route /image-assessment/entities/reports/v2/{uuid}
Scope Falcon Container Image: READ
PEP 8
get_report_by_idParameters
Section titled “Parameters”uuid path · string
Scan UUID
report_format query · string
Specify image-assessment scan report format. Supported formats:
Available values (3)
cyclonedx-json | json | sarif |
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.get_report_by_id(uuid="string", report_format="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.GetReportByScanID(uuid="string", report_format="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("GetReportByScanID", uuid="string", report_format="string")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
reportFormat := "string"
response, err := client.FalconContainerImage.GetReportByScanID( &falcon_container_image.GetReportByScanIDParams{ UUID: "string", ReportFormat: &reportFormat, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.getReportByScanID( "string", // uuid "string" // reportFormat);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::get_report_by_scan_id;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = get_report_by_scan_id( &falcon.cfg, // configuration "string", // uuid Some("string"), // report_format ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.get_report_by_scan_id('string')
puts responseResponses
{}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}HeadImageScanInventory
Section titled “HeadImageScanInventory”Get headers for POST request for image scan inventory
Method HEAD
Route /image-assessment/entities/image-inventory/v1
Scope Falcon Container CLI: READ
PEP 8
get_scan_headersCode Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.get_scan_headers()print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.HeadImageScanInventory()print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("HeadImageScanInventory")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.FalconContainerImage.HeadImageScanInventory( &falcon_container_image.HeadImageScanInventoryParams{ Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.headImageScanInventory();
console.log(response);use rusty_falcon::apis::falcon_container_image_api::head_image_scan_inventory;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = head_image_scan_inventory(&falcon.cfg).await.expect("API call failed"); // configuration
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.head_image_scan_inventory
puts responseResponses
{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}ImageMatchesPolicy
Section titled “ImageMatchesPolicy”After an image scan, use this operation to see if any images match a policy.
Method GET
Route /policy-checks
PEP 8
image_matches_policyParameters
Section titled “Parameters”repository query · string
The repository the image resides within.
tag query · string
The image tag.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.image_matches_policy(repository="string", tag="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.ImageMatchesPolicy(repository="string", tag="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("ImageMatchesPolicy", repository="string", tag="string")print(response)Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
Examples coming soon.
LaunchExportJob
Section titled “LaunchExportJob”Launch an export job of a Container Security resource.
Method POST
Route /container-security/entities/exports/v1
Scope Falcon Container Image: READ
PEP 8
launch_export_jobParameters
Section titled “Parameters”body body · dictionary
Full body payload as JSON formatted dictionary.
expand_vulnerabilities body · boolean
When set to true for function vulnerabilities export, includes detailed vulnerability information. Currently returns same data as without expansion - full expansion to be implemented in next step
format body · string
Format of the export file. One of:
Available values (2)
csv | json |
fql body · string
Falcon Query Language string to filter documents
resource body · string
Resource to export. Refer to API docs for the possible values
sort body · string
Sort value to apply to documents. Note: not all resources support sorting
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.launch_export_job(format="string", fql="string", resource="string", sort="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.LaunchExportJob(format="string", fql="string", resource="string", sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "expand_vulnerabilities": boolean, "format": "string", "fql": "string", "resource": "string", "sort": "string"}
response = falcon.command("LaunchExportJob", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
expand_vulnerabilities := boolean format := "string" fql := "string" resource := "string" sort := "string"
response, err := client.FalconContainerImage.LaunchExportJob( &falcon_container_image.LaunchExportJobParams{ Body: &models.ExportsLaunchExportRequest{ ExpandVulnerabilities: &expand_vulnerabilities, Format: &format, Fql: &fql, Resource: &resource, Sort: &sort, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.launchExportJob( { expandVulnerabilities: boolean, format: "string", fql: "string", resource: "string", sort: "string"} // body);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::launch_export_job;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::ExportsLaunchExportRequest;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = ExportsLaunchExportRequest { format: Some("string".to_string()), resource: Some("string".to_string()), sort: Some("string".to_string()), ..Default::default() };
let response = launch_export_job( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}Examples coming soon.
Responses
[ "string"]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}PolicyChecks
Section titled “PolicyChecks”Check image prevention policies
Method GET
Route /image-assessment/entities/policy-checks/v2
Scope Falcon Container Image: READ
PEP 8
check_prevention_policiesParameters
Section titled “Parameters”registry query · string
Registry
repository query · string
Repository
tag query · string
Tag
architecture query · string
Architecture e.g. ‘amd64’, ‘arm64’…
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.check_prevention_policies(registry="string", repository="string", tag="string", architecture="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.PolicyChecks(registry="string", repository="string", tag="string", architecture="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("PolicyChecks", registry="string", repository="string", tag="string", architecture="string")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
registry := "string" architecture := "string"
response, err := client.FalconContainerImage.PolicyChecks( &falcon_container_image.PolicyChecksParams{ Registry: ®istry, Repository: "string", Tag: "string", Architecture: &architecture, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.policyChecks( "string", // repository "string", // tag "string", // registry "string" // architecture);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::policy_checks;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = policy_checks( &falcon.cfg, // configuration "string", // repository "string", // tag Some("string"), // registry ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.policy_checks('string', 'string')
puts responseResponses
[ { "action": "string", "conditions": [], "deny": false, "evaluated_at": "string", "evaluation_details": {}, "image": {}, "policy": {}, "policy_group": {}, "policy_type": {} }]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ { "action": "string", "conditions": [], "deny": false, "evaluated_at": "string", "evaluation_details": {}, "image": {}, "policy": {}, "policy_group": {}, "policy_type": {} } ]}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ { "action": "string", "conditions": [], "deny": false, "evaluated_at": "string", "evaluation_details": {}, "image": {}, "policy": {}, "policy_group": {}, "policy_type": {} } ]}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ { "action": "string", "conditions": [], "deny": false, "evaluated_at": "string", "evaluation_details": {}, "image": {}, "policy": {}, "policy_group": {}, "policy_type": {} } ]}PostImageScanInventory
Section titled “PostImageScanInventory”Post image scan inventory
Method POST
Route /image-assessment/entities/image-inventory/v1
Scope Falcon Container CLI: WRITE
PEP 8
scan_inventoryParameters
Section titled “Parameters”body body · dictionary
Full body payload as JSON formatted dictionary.
agent_uuid body · string
Agent UUID
agent_version body · string
Agent version
agent_version_hash body · string
Agent version hash
cluster_id body · string
Cluster ID
cluster_name body · string
Cluster Name
container_id body · string
Container ID
ephemeral_scan body · boolean
Flag indicating if this is an ephemeral scan.
helm_version body · string
Helm version used
high_entropy_strings body · array
List of high entropy string dictionaries
host_ip body · string
Host IP address
host_name body · string
Host name
inventory body · object
Complete inventory detail as a dictionary
original_image_name body · string
Name of the original image
pod_id body · string
Pod ID
pod_name body · string
Pod name
pod_namespace body · string
Pod namespace
runmode body · string
Run mode
runtime_type body · string
Type of runtime used
scan_request body · object
Requested scan in dictionary format
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.scan_inventory(agent_uuid="string", agent_version="string", agent_version_hash="string", cluster_id="string", cluster_name="string", container_id="string", ephemeral_scan=boolean, helm_version="string", high_entropy_strings=[{"key": "value"}], host_ip="string", host_name="string", inventory={}, original_image_name="string", pod_id="string", pod_name="string", pod_namespace="string", runmode="string", runtime_type="string", scan_request={})print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.PostImageScanInventory(agent_uuid="string", agent_version="string", agent_version_hash="string", cluster_id="string", cluster_name="string", container_id="string", ephemeral_scan=boolean, helm_version="string", high_entropy_strings=[{"key": "value"}], host_ip="string", host_name="string", inventory={}, original_image_name="string", pod_id="string", pod_name="string", pod_namespace="string", runmode="string", runtime_type="string", scan_request={})print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "agent_uuid": "string", "agent_version": "string", "agent_version_hash": "string", "cluster_id": "string", "cluster_name": "string", "container_id": "string", "ephemeral_scan": boolean, "helm_version": "string", "high_entropy_strings": [ { "layer_hash": "string", "layer_index": integer, "path": "string", "strings": [ { "hash": "string", "line": integer, "name": "string", "regex_name": "string", "string": "string" } ] } ], "host_ip": "string", "host_name": "string", "inventory": { "application_packages": [ { "libraries": ["string"], "type": integer } ], "config": { "architecture": "string", "author": "string", "config": {}, "created": "string", "history": ["string"], "os": "string", "os.features": ["string"], "os.version": "string", "rootfs": {}, "variant": "string" }, "config_info": { "cmd": ["string"], "entrypoint": ["string"], "env": ["string"], "exposed_ports": {}, "labels": {}, "stop_signal": "string", "user": "string", "volumes": {}, "working_dir": "string" }, "elfbinaries": [ { "details": {}, "hash": "string", "layer_hash": "string", "layer_index": integer, "malicious": boolean, "path": "string", "permissions": "string", "size": integer } ], "hashed_files": [ { "hash": "string", "layer_hash": "string", "layer_index": integer, "path": "string", "permissions": "string", "size": integer } ], "image_info": { "architecture": "string", "created_at": "string", "digest": "string", "id": "string", "index_digest": "string", "registry": "string", "repository": "string", "size": integer, "tag": "string", "config_s3_key": "string", "manifest_s3_key": "string", "scan_request_s3_key": "string", "source": "string" }, "inventory_engine_info": { "cwppscanner_version": "string", "collected_at": "string", "engine_version": "string", "malware_metadata": {} }, "layers": [ { "created_at": "string", "created_by": "string", "digest": "string", "size": integer, "layer_inventory_s3_key": "string", "layer_reference_key": "string", "layer_reference_type": integer, "type": integer } ], "mlmodels": [ { "details": {}, "detection_name": "string", "hash": "string", "layer_hash": "string", "layer_index": integer, "malicious": boolean, "path": "string", "size": integer } ], "manifest": { "annotations": {}, "artifact_type": "string", "config": {}, "layers": ["string"], "media_type": "string", "schema_version": integer, "subject": {} }, "osinfo": { "display_version": "string", "edition_id": "string", "install_type": "string", "layer_hash": "string", "layer_index": integer, "name": "string", "version": "string" }, "packages": [ { "install_date": "string", "layer_hash": "string", "layer_index": integer, "major_version": "string", "package_hash": "string", "package_provider": "string", "package_source": "string", "product": "string", "software_architecture": "string", "status": "string", "vendor": "string" } ], "ai_related": boolean, "high_entropy_s3_file_exists": boolean, "interesting_strings": [ { "layer_hash": "string", "layer_index": integer, "path": "string", "strings": ["string"] } ], "whiteout_files": ["string"] }, "original_image_name": "string", "pod_id": "string", "pod_name": "string", "pod_namespace": "string", "runmode": "string", "runtime_type": "string", "scan_request": { "config": { "architecture": "string", "author": "string", "config": {}, "created": "string", "history": ["string"], "os": "string", "os.features": ["string"], "os.version": "string", "rootfs": {}, "variant": "string" }, "config_info": { "cmd": ["string"], "entrypoint": ["string"], "env": ["string"], "exposed_ports": {}, "labels": {}, "stop_signal": "string", "user": "string", "volumes": {}, "working_dir": "string" }, "image_info": { "architecture": "string", "created_at": "string", "digest": "string", "id": "string", "index_digest": "string", "registry": "string", "repository": "string", "size": integer, "tag": "string", "config_s3_key": "string", "manifest_s3_key": "string", "scan_request_s3_key": "string", "source": "string" }, "image_metadata": { "image_metadata_config_s3_key": "string", "image_metadata_high_entropy_strings_s3_key": "string", "image_metadata_image_inventory_s3_key": "string", "image_metadata_image_inventory_s3_path": "string", "image_metadata_manifest_s3_key": "string", "image_metadata_scan_report_s3_key": "string" }, "layers": [ { "created_at": "string", "created_by": "string", "digest": "string", "size": integer, "layer_inventory_s3_key": "string", "layer_reference_key": "string", "layer_reference_type": integer, "type": integer } ], "manifest": { "annotations": {}, "artifact_type": "string", "config": {}, "layers": ["string"], "media_type": "string", "schema_version": integer, "subject": {} }, "scan_info": { "correlation_uuid": "string", "requested_at": "string", "scan_uuid": "string", "user_uuid": "string", "username": "string", "cid": "string" }, "high_entropy_strings_s3_key": "string", "image_inventory_s3_key": "string", "layer_inventory_s3_key": "string", "scan_report_s3_key": "string", "scan_request_s3_key": "string" }}
response = falcon.command("PostImageScanInventory", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
agent_uuid := "string" agent_version := "string" agent_version_hash := "string" cluster_id := "string" cluster_name := "string" container_id := "string" ephemeral_scan := boolean helm_version := "string" LayerHash := "string" LayerIndex := integer Path := "string" Hash := "string" Line := integer Name := "string" RegexName := "string" String := "string" host_ip := "string" host_name := "string" original_image_name := "string" pod_id := "string" pod_name := "string" pod_namespace := "string" runmode := "string" runtime_type := "string"
response, err := client.FalconContainerImage.PostImageScanInventory( &falcon_container_image.PostImageScanInventoryParams{ Body: &models.ModelsInventoryScanRequestType{ AgentUuid: &agent_uuid, AgentVersion: &agent_version, AgentVersionHash: &agent_version_hash, ClusterID: &cluster_id, ClusterName: &cluster_name, ContainerID: &container_id, EphemeralScan: &ephemeral_scan, HelmVersion: &helm_version, HighEntropyStrings: []interface{}{ { Layerhash: &LayerHash, Layerindex: &LayerIndex, Path: &Path, Strings: []interface{}{ { Hash: &Hash, Line: &Line, Name: &Name, Regexname: &RegexName, String: &String, }, }, }, }, HostIp: &host_ip, HostName: &host_name, Inventory: &struct{}{}, OriginalImageName: &original_image_name, PodID: &pod_id, PodName: &pod_name, PodNamespace: &pod_namespace, Runmode: &runmode, RuntimeType: &runtime_type, ScanRequest: &struct{}{}, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.postImageScanInventory( { agentUuid: "string", agentVersion: "string", agentVersionHash: "string", clusterId: "string", clusterName: "string", containerId: "string", ephemeralScan: boolean, helmVersion: "string", highEntropyStrings: [{ LayerHash: "string", LayerIndex: integer, Path: "string", Strings: [{ Hash: "string", Line: integer, Name: "string", RegexName: "string", String: "string" }] }], hostIp: "string", hostName: "string", inventory: { ApplicationPackages: [{ libraries: [], type: integer }], Config: { architecture: "string", author: "string", config: {}, created: "string", history: [], os: "string", os.features: [], os.version: "string", rootfs: {}, variant: "string" }, ConfigInfo: { Cmd: [], Entrypoint: [], Env: [], ExposedPorts: {}, Labels: {}, StopSignal: "string", User: "string", Volumes: {}, WorkingDir: "string" }, ELFBinaries: [{ Details: {}, Hash: "string", LayerHash: "string", LayerIndex: integer, Malicious: boolean, Path: "string", Permissions: "string", Size: integer }], HashedFiles: [{ Hash: "string", LayerHash: "string", LayerIndex: integer, Path: "string", Permissions: "string", Size: integer }], ImageInfo: { Architecture: "string", CreatedAt: "string", Digest: "string", ID: "string", IndexDigest: "string", Registry: "string", Repository: "string", Size: integer, Tag: "string", configS3Key: "string", manifestS3Key: "string", scanRequestS3Key: "string", source: "string" }, InventoryEngineInfo: { CWPPScannerVersion: "string", CollectedAt: "string", EngineVersion: "string", MalwareMetadata: {} }, Layers: [{ CreatedAt: "string", CreatedBy: "string", Digest: "string", Size: integer, layerInventoryS3Key: "string", layerReferenceKey: "string", layerReferenceType: integer, type: integer }], MLModels: [{ Details: {}, DetectionName: "string", Hash: "string", LayerHash: "string", LayerIndex: integer, Malicious: boolean, Path: "string", Size: integer }], Manifest: { annotations: {}, artifactType: "string", config: {}, layers: [], mediaType: "string", schemaVersion: integer, subject: {} }, OSInfo: { DisplayVersion: "string", EditionID: "string", InstallType: "string", LayerHash: "string", LayerIndex: integer, Name: "string", Version: "string" }, Packages: [{ InstallDate: "string", LayerHash: "string", LayerIndex: integer, MajorVersion: "string", PackageHash: "string", PackageProvider: "string", PackageSource: "string", Product: "string", SoftwareArchitecture: "string", Status: "string", Vendor: "string" }], aiRelated: boolean, highEntropyS3FileExists: boolean, interestingStrings: [{ LayerHash: "string", LayerIndex: integer, Path: "string", Strings: [] }], whiteoutFiles: [] }, originalImageName: "string", podId: "string", podName: "string", podNamespace: "string", runmode: "string", runtimeType: "string", scanRequest: { Config: { architecture: "string", author: "string", config: {}, created: "string", history: [], os: "string", os.features: [], os.version: "string", rootfs: {}, variant: "string" }, ConfigInfo: { Cmd: [], Entrypoint: [], Env: [], ExposedPorts: {}, Labels: {}, StopSignal: "string", User: "string", Volumes: {}, WorkingDir: "string" }, ImageInfo: { Architecture: "string", CreatedAt: "string", Digest: "string", ID: "string", IndexDigest: "string", Registry: "string", Repository: "string", Size: integer, Tag: "string", configS3Key: "string", manifestS3Key: "string", scanRequestS3Key: "string", source: "string" }, ImageMetadata: { imageMetadataConfigS3Key: "string", imageMetadataHighEntropyStringsS3Key: "string", imageMetadataImageInventoryS3Key: "string", imageMetadataImageInventoryS3Path: "string", imageMetadataManifestS3Key: "string", imageMetadataScanReportS3Key: "string" }, Layers: [{ CreatedAt: "string", CreatedBy: "string", Digest: "string", Size: integer, layerInventoryS3Key: "string", layerReferenceKey: "string", layerReferenceType: integer, type: integer }], Manifest: { annotations: {}, artifactType: "string", config: {}, layers: [], mediaType: "string", schemaVersion: integer, subject: {} }, ScanInfo: { CorrelationUUID: "string", RequestedAt: "string", ScanUUID: "string", UserUUID: "string", Username: "string", cid: "string" }, highEntropyStringsS3Key: "string", imageInventoryS3Key: "string", layerInventoryS3Key: "string", scanReportS3Key: "string", scanRequestS3Key: "string" }} // body);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::post_image_scan_inventory;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::ModelsInventoryScanRequestType;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = ModelsInventoryScanRequestType { agent_uuid: Some("string".to_string()), agent_version: Some("string".to_string()), agent_version_hash: Some("string".to_string()), cluster_id: Some("string".to_string()), cluster_name: Some("string".to_string()), helm_version: Some("string".to_string()), host_ip: Some("string".to_string()), host_name: Some("string".to_string()), inventory: Default::default(), original_image_name: Some("string".to_string()), runmode: Some("string".to_string()), scan_request: Default::default(), ..Default::default() };
let response = post_image_scan_inventory( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
body = Falcon::ModelsInventoryScanRequestType.new( agent_uuid: 'string', agent_version: 'string', agent_version_hash: 'string', cluster_id: 'string', cluster_name: 'string', container_id: 'string', ephemeral_scan: boolean, helm_version: 'string', high_entropy_strings: [{ LayerHash: 'string', LayerIndex: integer, Path: 'string', Strings: [{ Hash: 'string', Line: integer, Name: 'string', RegexName: 'string', String: 'string' }] }], host_ip: 'string', host_name: 'string', inventory: { ApplicationPackages: [{ libraries: [], type: integer }], Config: { architecture: 'string', author: 'string', config: {}, created: 'string', history: [], os: 'string', os.features: [], os.version: 'string', rootfs: {}, variant: 'string' }, ConfigInfo: { Cmd: [], Entrypoint: [], Env: [], ExposedPorts: {}, Labels: {}, StopSignal: 'string', User: 'string', Volumes: {}, WorkingDir: 'string' }, ELFBinaries: [{ Details: {}, Hash: 'string', LayerHash: 'string', LayerIndex: integer, Malicious: boolean, Path: 'string', Permissions: 'string', Size: integer }], HashedFiles: [{ Hash: 'string', LayerHash: 'string', LayerIndex: integer, Path: 'string', Permissions: 'string', Size: integer }], ImageInfo: { Architecture: 'string', CreatedAt: 'string', Digest: 'string', ID: 'string', IndexDigest: 'string', Registry: 'string', Repository: 'string', Size: integer, Tag: 'string', config_s3_key: 'string', manifest_s3_key: 'string', scan_request_s3_key: 'string', source: 'string' }, InventoryEngineInfo: { CWPPScannerVersion: 'string', CollectedAt: 'string', EngineVersion: 'string', MalwareMetadata: {} }, Layers: [{ CreatedAt: 'string', CreatedBy: 'string', Digest: 'string', Size: integer, layer_inventory_s3_key: 'string', layer_reference_key: 'string', layer_reference_type: integer, type: integer }], MLModels: [{ Details: {}, DetectionName: 'string', Hash: 'string', LayerHash: 'string', LayerIndex: integer, Malicious: boolean, Path: 'string', Size: integer }], Manifest: { annotations: {}, artifactType: 'string', config: {}, layers: [], mediaType: 'string', schemaVersion: integer, subject: {} }, OSInfo: { DisplayVersion: 'string', EditionID: 'string', InstallType: 'string', LayerHash: 'string', LayerIndex: integer, Name: 'string', Version: 'string' }, Packages: [{ InstallDate: 'string', LayerHash: 'string', LayerIndex: integer, MajorVersion: 'string', PackageHash: 'string', PackageProvider: 'string', PackageSource: 'string', Product: 'string', SoftwareArchitecture: 'string', Status: 'string', Vendor: 'string' }], ai_related: boolean, high_entropy_s3_file_exists: boolean, interesting_strings: [{ LayerHash: 'string', LayerIndex: integer, Path: 'string', Strings: [] }], whiteout_files: [] }, original_image_name: 'string', pod_id: 'string', pod_name: 'string', pod_namespace: 'string', runmode: 'string', runtime_type: 'string', scan_request: { Config: { architecture: 'string', author: 'string', config: {}, created: 'string', history: [], os: 'string', os.features: [], os.version: 'string', rootfs: {}, variant: 'string' }, ConfigInfo: { Cmd: [], Entrypoint: [], Env: [], ExposedPorts: {}, Labels: {}, StopSignal: 'string', User: 'string', Volumes: {}, WorkingDir: 'string' }, ImageInfo: { Architecture: 'string', CreatedAt: 'string', Digest: 'string', ID: 'string', IndexDigest: 'string', Registry: 'string', Repository: 'string', Size: integer, Tag: 'string', config_s3_key: 'string', manifest_s3_key: 'string', scan_request_s3_key: 'string', source: 'string' }, ImageMetadata: { image_metadata_config_s3_key: 'string', image_metadata_high_entropy_strings_s3_key: 'string', image_metadata_image_inventory_s3_key: 'string', image_metadata_image_inventory_s3_path: 'string', image_metadata_manifest_s3_key: 'string', image_metadata_scan_report_s3_key: 'string' }, Layers: [{ CreatedAt: 'string', CreatedBy: 'string', Digest: 'string', Size: integer, layer_inventory_s3_key: 'string', layer_reference_key: 'string', layer_reference_type: integer, type: integer }], Manifest: { annotations: {}, artifactType: 'string', config: {}, layers: [], mediaType: 'string', schemaVersion: integer, subject: {} }, ScanInfo: { CorrelationUUID: 'string', RequestedAt: 'string', ScanUUID: 'string', UserUUID: 'string', Username: 'string', cid: 'string' }, high_entropy_strings_s3_key: 'string', image_inventory_s3_key: 'string', layer_inventory_s3_key: 'string', scan_report_s3_key: 'string', scan_request_s3_key: 'string' })
response = api.post_image_scan_inventory(body)
puts responseResponses
{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}QueryExportJobs
Section titled “QueryExportJobs”Query export jobs entities
Method GET
Route /container-security/queries/exports/v1
Scope Falcon Container Image: READ
PEP 8
query_export_jobsParameters
Section titled “Parameters”filter query · string
Filter exports using a query in Falcon Query Language (FQL). Only the last 100 jobs are returned. Supported filter fields:
Available values (2)
resource | status |
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.query_export_jobs(filter="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.QueryExportJobs(filter="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("QueryExportJobs", filter="string")print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
filter := "string"
response, err := client.FalconContainerImage.QueryExportJobs( &falcon_container_image.QueryExportJobsParams{ Filter: &filter, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.queryExportJobs("string"); // filter
console.log(response);use rusty_falcon::apis::falcon_container_image_api::query_export_jobs;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = query_export_jobs( &falcon.cfg, // configuration Some("string"), // filter ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.query_export_jobs(filter: 'string')
puts responseResponses
[ "string"]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}ReadExportJobs
Section titled “ReadExportJobs”Read export jobs entities
Method GET
Route /container-security/entities/exports/v1
Scope Falcon Container Image: READ
PEP 8
read_export_jobsParameters
Section titled “Parameters”ids query · string or list of strings
Export Job IDs to read. Allowed up to 100 IDs per request.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.read_export_jobs(ids=id_list)print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.ReadExportJobs(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("ReadExportJobs", ids=id_list)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.FalconContainerImage.ReadExportJobs( &falcon_container_image.ReadExportJobsParams{ Ids: []string{"ID1", "ID2", "ID3"}, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.readExportJobs(["ID1", "ID2", "ID3"]); // ids
console.log(response);use rusty_falcon::apis::falcon_container_image_api::read_export_jobs;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = read_export_jobs( &falcon.cfg, // configuration vec!["string".to_string()], // ids ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.read_export_jobs(['ID1', 'ID2', 'ID3'])
puts responseResponses
[ { "created_at": "string", "id": "string", "resource": "string", "retries": 0, "status": "string", "updated_at": "string" }]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}ReadImageVulnerabilities
Section titled “ReadImageVulnerabilities”Retrieve known vulnerabilities for the provided image
Method POST
Route /image-assessment/combined/vulnerability-lookups/v1
Scope Falcon Container CLI: WRITE
PEP 8
read_image_vulnerabilitiesParameters
Section titled “Parameters”body body · dictionary
Full body payload as JSON formatted dictionary.
application_packages body · array
applicationPackages body · array
ApplicationPackages body · array
osversion body · string
Operating system version for the image to be checked.
packages body · array
List of images to retrieve vulnerabilities for.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
applicationPackages = [ { "libraries": [ { "Hash": "string", "LayerHash": "string", "LayerIndex": 0, "License": "string", "Name": "string", "Path": "string", "Version": "string" } ], "type": "string" }]
packages = [ { "LayerHash": "string", "LayerIndex": 0, "MajorVersion": "string", "PackageHash": "string", "PackageProvider": "string", "PackageSource": "string", "Product": "string", "SoftwareArchitecture": "string", "Status": "string", "Vendor": "string" }]
response = falcon.read_image_vulnerabilities(applicationPackages=applicationPackages, packages=packages, osversion="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
applicationPackages = [ { "libraries": [ { "Hash": "string", "LayerHash": "string", "LayerIndex": 0, "License": "string", "Name": "string", "Path": "string", "Version": "string" } ], "type": "string" }]
packages = [ { "LayerHash": "string", "LayerIndex": 0, "MajorVersion": "string", "PackageHash": "string", "PackageProvider": "string", "PackageSource": "string", "Product": "string", "SoftwareArchitecture": "string", "Status": "string", "Vendor": "string" }]
response = falcon.ReadImageVulnerabilities(applicationPackages=applicationPackages, packages=packages, osversion="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "application_packages": [ { "libraries": [ { "hash": "string", "layer_hash": "string", "layer_index": integer, "license": "string", "name": "string", "path": "string", "version": "string", "ai_related": boolean } ], "type": integer } ], "osversion": "string", "packages": [ { "install_date": "string", "layer_hash": "string", "layer_index": integer, "major_version": "string", "package_hash": "string", "package_provider": "string", "package_source": "string", "product": "string", "software_architecture": "string", "status": "string", "vendor": "string" } ]}
response = falcon.command("ReadImageVulnerabilities", body=body_payload)print(response)Examples coming soon.
package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_cli" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
Hash := "string" LayerHash := "string" LayerIndex := integer License := "string" Name := "string" Path := "string" Version := "string" ai_related := boolean typeVar := integer osversion := "string" InstallDate := "string" MajorVersion := "string" PackageHash := "string" PackageProvider := "string" PackageSource := "string" Product := "string" SoftwareArchitecture := "string" Status := "string" Vendor := "string"
response, err := client.FalconContainerCli.ReadImageVulnerabilities( &falcon_container_cli.ReadImageVulnerabilitiesParams{ Body: &models.APIImageLookupRequest{ Applicationpackages: []interface{}{ { Libraries: []interface{}{ { Hash: &Hash, Layerhash: &LayerHash, Layerindex: &LayerIndex, License: &License, Name: &Name, Path: &Path, Version: &Version, AiRelated: &ai_related, }, }, Type: &typeVar, }, }, Osversion: &osversion, Packages: []interface{}{ { Installdate: &InstallDate, Layerhash: &LayerHash, Layerindex: &LayerIndex, Majorversion: &MajorVersion, Packagehash: &PackageHash, Packageprovider: &PackageProvider, Packagesource: &PackageSource, Product: &Product, Softwarearchitecture: &SoftwareArchitecture, Status: &Status, Vendor: &Vendor, }, }, }, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerCli.readImageVulnerabilities( { applicationPackages: [{ libraries: [{ Hash: "string", LayerHash: "string", LayerIndex: integer, License: "string", Name: "string", Path: "string", Version: "string", aiRelated: boolean }], type: integer }], osversion: "string", packages: [{ InstallDate: "string", LayerHash: "string", LayerIndex: integer, MajorVersion: "string", PackageHash: "string", PackageProvider: "string", PackageSource: "string", Product: "string", SoftwareArchitecture: "string", Status: "string", Vendor: "string" }]} // body);
console.log(response);use rusty_falcon::apis::falcon_container_cli_api::read_image_vulnerabilities;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::ApiImageLookupRequest;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = ApiImageLookupRequest { osversion: Some("string".to_string()), packages: vec![PackageInfoType { layer_index: Some(integer), ..Default::default() }], ..Default::default() };
let response = read_image_vulnerabilities( &falcon.cfg, // configuration body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerCli.new
body = Falcon::ApiImageLookupRequest.new( applicationPackages: [{ libraries: [{ Hash: 'string', LayerHash: 'string', LayerIndex: integer, License: 'string', Name: 'string', Path: 'string', Version: 'string', ai_related: boolean }], type: integer }], osversion: 'string', packages: [{ InstallDate: 'string', LayerHash: 'string', LayerIndex: integer, MajorVersion: 'string', PackageHash: 'string', PackageProvider: 'string', PackageSource: 'string', Product: 'string', SoftwareArchitecture: 'string', Status: 'string', Vendor: 'string' }])
response = api.read_image_vulnerabilities(body)
puts responseResponses
{}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": {}}ReadRegistryEntities
Section titled “ReadRegistryEntities”Retrieves a list of registry entities identified by the customer id.
Method GET
Route /container-security/queries/registries/v1
Scope Falcon Container Image: READ
PEP 8
read_registry_entitiesParameters
Section titled “Parameters”limit query · integer
The upper-bound on the number of records to retrieve.
offset query · integer
The offset from where to begin.
sort query · string
FQL formatted string to use to sort returned results.
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.read_registry_entities(limit=integer, offset=integer, sort="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.ReadRegistryEntities(limit=integer, offset=integer, sort="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
response = falcon.command("ReadRegistryEntities", limit=integer, offset=integer, sort="string")print(response)Get-FalconContainerRegistry -Sort "string" ` -Limit integer ` -Offset integerpackage main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
limit := int64(0) offset := int64(0) sort := "string"
response, err := client.FalconContainerImage.ReadRegistryEntities( &falcon_container_image.ReadRegistryEntitiesParams{ Limit: &limit, Offset: &offset, Sort: &sort, Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.readRegistryEntities( integer, // limit integer, // offset "string" // sort);
console.log(response);use rusty_falcon::apis::falcon_container_image_api::read_registry_entities;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = read_registry_entities( &falcon.cfg, // configuration Some(integer), // limit Some(integer), // offset Some("string"), // sort ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.read_registry_entities(limit: integer, offset: integer, sort: 'string')
puts responseResponses
[ "string"]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ "string" ]}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ "string" ]}ReadRegistryEntitiesByUUID
Section titled “ReadRegistryEntitiesByUUID”Retrieves a list of registry entities by the provided UUIDs.
Method GET
Route /container-security/entities/registries/v1
Scope Falcon Container Image: READ
PEP 8
read_registry_entities_by_uuidParameters
Section titled “Parameters”ids query · string
Registry entity UUID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.read_registry_entities_by_uuid(ids=id_list)print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.ReadRegistryEntitiesByUUID(ids=id_list)print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.command("ReadRegistryEntitiesByUUID", ids="string")print(response)Get-FalconContainerRegistry -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
response, err := client.FalconContainerImage.ReadRegistryEntitiesByUUID( &falcon_container_image.ReadRegistryEntitiesByUUIDParams{ Ids: "string", Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.readRegistryEntitiesByUUID("string"); // ids
console.log(response);use rusty_falcon::apis::falcon_container_image_api::read_registry_entities_by_uuid;use rusty_falcon::easy::client::FalconHandle;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let response = read_registry_entities_by_uuid( &falcon.cfg, // configuration "string", // ids ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
response = api.read_registry_entities_by_uuid('string')
puts responseResponses
[ { "created_at": "string", "credential": {}, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }]{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ { "created_at": "string", "credential": {}, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" } ]}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": [ { "created_at": "string", "credential": {}, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" } ]}UpdateRegistryEntities
Section titled “UpdateRegistryEntities”Update the registry entity, as identified by the entity UUID, using the provided details
Method PATCH
Route /container-security/entities/registries/v1
Scope Falcon Container Image: WRITE
PEP 8
update_registry_entitiesParameters
Section titled “Parameters”body body · dictionary
Full body payload as JSON formatted dictionary.
credential body · object
state body · string
Available values (2)
pause | resume |
user_defined_alias body · string
id query · string
Registry entity UUID
parameters query · dictionary
Full query string parameters payload in JSON format. Not required when using other keywords.
Code Examples
from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
credential = { "details": {}, "type": "string"}
response = falcon.update_registry_entities(credential=credential, state="string", user_defined_alias="string", id="string")print(response)from falconpy import FalconContainer
falcon = FalconContainer(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
credential = { "details": {}, "type": "string"}
response = falcon.UpdateRegistryEntities(credential=credential, state="string", user_defined_alias="string", id="string")print(response)from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID, client_secret=CLIENT_SECRET )
body_payload = { "credential": { "details": {}, "type": "string" }, "state": "string", "user_defined_alias": "string"}
response = falcon.command("UpdateRegistryEntities", id="string", body=body_payload)print(response)Edit-FalconContainerRegistry -Id "string"package main
import ( "context" "fmt" "os"
"github.com/crowdstrike/gofalcon/falcon" "github.com/crowdstrike/gofalcon/falcon/client/falcon_container_image" "github.com/crowdstrike/gofalcon/falcon/models")
func main() { client, err := falcon.NewClient(&falcon.ApiConfig{ ClientId: os.Getenv("FALCON_CLIENT_ID"), ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"), Context: context.Background(), }) if err != nil { panic(err) }
state := "string" user_defined_alias := "string"
response, err := client.FalconContainerImage.UpdateRegistryEntities( &falcon_container_image.UpdateRegistryEntitiesParams{ Body: &models.RegistryassessmentExternalRegistryPatchPayload{ Credential: &struct{}{}, State: &state, UserDefinedAlias: &user_defined_alias, }, ID: "string", Context: context.Background(), }, ) if err != nil { panic(falcon.ErrorExplain(err)) }
fmt.Printf("%+v\n", response.Payload)}import { FalconClient } from "crowdstrike-falcon";
const client = new FalconClient({ cloud: process.env.FALCON_CLOUD!, clientId: process.env.FALCON_CLIENT_ID!, clientSecret: process.env.FALCON_CLIENT_SECRET!,});
const response = await client.falconContainerImage.updateRegistryEntities( "string", // id { // body credential: { details: {}, type: "string" }, state: "string", userDefinedAlias: "string" });
console.log(response);use rusty_falcon::apis::falcon_container_image_api::update_registry_entities;use rusty_falcon::easy::client::FalconHandle;use rusty_falcon::models::RegistryassessmentExternalRegistryPatchPayload;
#[tokio::main]async fn main() { let falcon = FalconHandle::from_env().await.expect("Could not authenticate");
let body = RegistryassessmentExternalRegistryPatchPayload { credential: Default::default(), ..Default::default() };
let response = update_registry_entities( &falcon.cfg, // configuration "string", // id body, // body ).await.expect("API call failed");
println!("{:?}", response);}require "crimson-falcon"
Falcon.configure do |config| config.client_id = ENV["FALCON_CLIENT_ID"] config.client_secret = ENV["FALCON_CLIENT_SECRET"] config.cloud = ENV["FALCON_CLOUD"]end
api = Falcon::FalconContainerImage.new
body = Falcon::RegistryassessmentExternalRegistryPatchPayload.new( credential: { details: {}, type: 'string' }, state: 'string', user_defined_alias: 'string')
response = api.update_registry_entities(body, 'string')
puts responseResponses
{ "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string"}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": { "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": { "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }}{ "errors": [ { "code": 0, "id": "string", "message": "string" } ], "meta": { "pagination": { "limit": 0, "offset": 0, "total": 0 }, "powered_by": "string", "query_time": 0.0, "trace_id": "string", "writes": { "resources_affected": 0 } }, "resources": { "created_at": "string", "credential": { "created_at": "string", "details": {}, "expired": false, "expired_at": "string", "id": "string", "updated_at": "string" }, "id": "string", "last_refreshed_at": "string", "next_refresh_at": "string", "refresh_interval": 0, "state": "string", "state_changed_at": "string", "type": "string", "updated_at": "string", "url": "string", "url_uniqueness_alias": "string", "user_defined_alias": "string" }}