Skip to content

Cloud GCP Registration

The Cloud GCP Registration service collection provides operations for managing Google Cloud Platform registrations. Retrieve GCP entities and registrations, trigger health checks, create, update, and delete Google Cloud registrations.

LanguageLast Update
Pythonv1.5.5
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
cloud_registration_gcp_get_entities
get_entities
Retrieve all GCP entities (organizations, folders, projects) grouped by type with support for FQL filtering, sorting, and pagination.
cloud_registration_gcp_trigger_health_check
trigger_health_check
Trigger health check scan for GCP registrations
cloud_registration_gcp_get_registration
get_registration
Retrieve a Google Cloud Registration.
cloud_registration_gcp_put_registration
update_registration
Creates/Updates a Google Cloud Registration.
cloud_registration_gcp_create_registration
create_registration
Create a Google Cloud Registration.
cloud_registration_gcp_update_registration
cloud_registration_gcp_update_registration
Update a Google Cloud Registration.
cloud_registration_gcp_delete_registration
delete_registration
Deletes a Google Cloud Registration and returns the deleted registration in the response body.

Retrieve all GCP entities (organizations, folders, projects) grouped by type with support for FQL filtering, sorting, and pagination.

GET /cloud-security-registration-google-cloud/entities/accounts/v1
Scope Cloud Google Cloud Registration: READ Consumes · Produces application/json
PEP 8 get_entities
NameTypeData typeDescription
idsqueryarray (string)Google Cloud Registration IDs to filter by.
filterquerystringFQL (Falcon Query Language) string for filtering results. Allowed filters: entity_type, entity_id, entity_name, registration_id, registration_name, registration_scope, parent_id, ioa_status, iom_status, created, updated
sortquerystringField and direction for sorting results (e.g., created|desc). Sorting applies across all entity types before grouping.
limitqueryintegerMaximum number of records to return. Default: 100, Max: 500.
offsetqueryintegerStarting index of result.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_entities(ids=id_list,
filter="string",
sort="string",
limit=integer,
offset=integer)
print(response)

cloud_registration_gcp_trigger_health_check

Section titled “cloud_registration_gcp_trigger_health_check”

Trigger health check scan for GCP registrations

POST /cloud-security-registration-google-cloud/entities/registration-scans/v1
Scope Cloud Google Cloud Registration: WRITE Consumes · Produces application/json
PEP 8 trigger_health_check
NameTypeData typeDescription
idsqueryarray (string)GCP Registration IDs
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.trigger_health_check(ids=id_list)
print(response)

Retrieve a Google Cloud Registration.

GET /cloud-security-registration-google-cloud/entities/registrations/v1
Scope Cloud Google Cloud Registration: READ Consumes · Produces application/json
PEP 8 get_registration
NameTypeData typeDescription
idsquerystringGoogle Cloud Registration ID
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.get_registration(ids=id_list)
print(response)

Creates/Updates a Google Cloud Registration.

PUT /cloud-security-registration-google-cloud/entities/registrations/v1
Scope Cloud Google Cloud Registration: WRITE Consumes · Produces application/json
PEP 8 update_registration
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format. Not required if using other keywords.
deployment_methodbodystringThe method of deployment.
entity_idbodyarray (string)The ID of the entity.
excluded_project_patternsbodyarray (string)Project patterns that should be excluded.
falcon_client_key_idbodystringAPI client key ID.
falcon_client_key_typebodystringAPI client key type.
infra_manager_regionbodystringInfrastructure manager region.
infra_project_idbodystringInfrastructure project ID.
labelsbodydictionaryProp labels.
productsbodyarray (dictionary)Products.
registration_namebodystringRegistration name.
registration_scopebodystringRegistration scope.
resource_name_prefixbodystringResource name prefix.
resource_name_suffixbodystringResource name suffix.
tagsbodydictionaryTags.
wif_project_idbodystringWIF project ID.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.update_registration(deployment_method="string",
entity_id="string",
excluded_project_patterns=["string"],
falcon_client_key_id="string",
falcon_client_key_type="string",
infra_project_id="string",
labels={},
products=[{"key": "value"}],
registration_name="string",
registration_scope="string",
resource_name_prefix="string")
print(response)

cloud_registration_gcp_create_registration

Section titled “cloud_registration_gcp_create_registration”

Create a Google Cloud Registration.

POST /cloud-security-registration-google-cloud/entities/registrations/v1
Scope Cloud Google Cloud Registration: WRITE Consumes · Produces application/json
PEP 8 create_registration
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
deployment_methodbodystringThe method of deployment.
entity_idbodyarray (string)The ID of the entity.
excluded_project_patternsbodyarray (string)Project patterns that should be excluded.
falcon_client_key_idbodystringAPI client key ID.
falcon_client_key_typebodystringAPI client key type.
infra_manager_regionbodystringInfrastructure manager region.
infra_project_idbodystringInfrastructure project ID.
labelsbodydictionaryProp labels.
productsbodyarray (dictionary)Products.
registration_namebodystringRegistration name.
registration_scopebodystringRegistration scope.
resource_name_prefixbodystringResource name prefix.
resource_name_suffixbodystringResource name suffix.
tagsbodydictionaryTags.
wif_project_idbodystringWIF project ID.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.create_registration(deployment_method="string",
entity_id="string",
excluded_project_patterns=["string"],
falcon_client_key_id="string",
falcon_client_key_type="string",
infra_project_id="string",
labels={},
products=[{"key": "value"}],
registration_name="string",
registration_scope="string",
resource_name_prefix="string")
print(response)

cloud_registration_gcp_update_registration

Section titled “cloud_registration_gcp_update_registration”

Update a Google Cloud Registration.

PATCH /cloud-security-registration-google-cloud/entities/registrations/v1
Scope Cloud Google Cloud Registration: WRITE Consumes · Produces application/json
PEP 8 cloud_registration_gcp_update_registration
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
idsquerystringGoogle Cloud Registration ID.
deployment_methodbodystringThe method of deployment.
entity_idbodyarray (string)The ID of the entity.
excluded_project_patternsbodyarray (string)Project patterns that should be excluded.
falcon_client_key_idbodystringAPI client key ID.
falcon_client_key_typebodystringAPI client key type.
infra_manager_regionbodystringInfrastructure manager region.
infra_project_idbodystringInfrastructure project ID.
labelsbodydictionaryProp labels.
productsbodyarray (dictionary)Products.
registration_namebodystringRegistration name.
registration_scopebodystringRegistration scope.
resource_name_prefixbodystringResource name prefix.
resource_name_suffixbodystringResource name suffix.
tagsbodydictionaryTags.
wif_project_idbodystringWIF project ID.
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
id_list = 'ID1,ID2,ID3' # Can also pass a list here: ['ID1', 'ID2', 'ID3']
response = falcon.cloud_registration_gcp_update_registration(ids=id_list,
deployment_method="string",
entity_id="string",
excluded_project_patterns=["string"],
falcon_client_key_id="string",
falcon_client_key_type="string",
infra_project_id="string",
labels={},
products=[{"key": "value"}],
registration_name="string",
registration_scope="string",
resource_name_prefix="string")
print(response)

cloud_registration_gcp_delete_registration

Section titled “cloud_registration_gcp_delete_registration”

Deletes a Google Cloud Registration and returns the deleted registration in the response body.

DELETE /cloud-security-registration-google-cloud/entities/registrations/v1
Scope Cloud Google Cloud Registration: WRITE Consumes · Produces application/json
PEP 8 delete_registration
NameTypeData typeDescription
idsquerystringGoogle Cloud Registration ID
parametersquerydictionaryFull query string parameters payload in JSON format. Not required when using other keywords.
from falconpy import CloudGoogleCloudRegistration
falcon = CloudGoogleCloudRegistration(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_registration(ids=id_list)
print(response)