Cloud Google Cloud Registration

Operations for the Cloud Google Cloud Registration service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust
Ruby	v1.4.0

---

---

Table of Contents

Operation	Description
cloud-registration-gcp-create-registration create_registration	Create 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.
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-get-registration get_registration	Retrieve a Google Cloud Registration.
cloud-registration-gcp-post-terraform-script cloud_registration_gcp_post_terraform_script	Generate Google Cloud Terraform deployment scripts (zip files)
cloud-registration-gcp-put-registration update_registration	Creates/Updates a Google Cloud Registration.
cloud-registration-gcp-trigger-health-check trigger_health_check	Trigger health check scan for GCP registrations
cloud-registration-gcp-update-registration cloud_registration_gcp_update_registration	Update a Google Cloud Registration.

---

cloud-registration-gcp-create-registration

Create a Google Cloud Registration.

Method POST

Route /cloud-security-registration-google-cloud/entities/registrations/v1

Scope Cloud Security Google Cloud Registration: WRITE

PEP 8 create_registration

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

resources body · array

deployment_method body · string

The method of deployment.

entity_id body · string or list of strings

The ID of the entity.

excluded_project_patterns body · string or list of strings

Project patterns that should be excluded.

falcon_client_key_id body · string

API client key ID.

falcon_client_key_type body · string

API client key type.

infra_project_id body · string

Infrastructure project ID.

labels body · dictionary

Prop labels.

products body · list of dictionaries

Products.

registration_name body · string

Registration name.

registration_scope body · string

Registration scope.

resource_name_prefix body · string

Resource name prefix.

Code Examples

Python

PEP 8

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']

labels = {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}

products = [
    {
        "features": [
            "string"
        ],
        "product": "string"
    }
]

response = falcon.create_registration(deployment_method="string",
                                      entity_id=id_list,
                                      excluded_project_patterns=id_list,
                                      falcon_client_key_id="string",
                                      falcon_client_key_type="string",
                                      infra_project_id="string",
                                      labels=labels,
                                      products=products,
                                      registration_name="string",
                                      registration_scope="string",
                                      resource_name_prefix="string")
print(response)

Operation ID

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']

labels = {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}

products = [
    {
        "features": [
            "string"
        ],
        "product": "string"
    }
]

response = falcon.cloud_registration_gcp_create_registration(deployment_method="string",
                                                             entity_id=id_list,
                                                             excluded_project_patterns=id_list,
                                                             falcon_client_key_id="string",
                                                             falcon_client_key_type="string",
                                                             infra_project_id="string",
                                                             labels=labels,
                                                             products=products,
                                                             registration_name="string",
                                                             registration_scope="string",
                                                             resource_name_prefix="string")
print(response)

Uber

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']

body_payload = {
    "resources": [
        {
            "additional_properties": {},
            "deployment_method": "string",
            "dspm_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "entity_id": ["string"],
            "excluded_project_patterns": ["string"],
            "falcon_client_key_id": "string",
            "falcon_client_key_type": "string",
            "infra_manager_region": "string",
            "infra_project_id": "string",
            "labels": {},
            "products": [
                {
                    "features": ["string"],
                    "product": "string"
                }
            ],
            "registration_description": "string",
            "registration_name": "string",
            "registration_scope": "string",
            "resource_name_prefix": "string",
            "resource_name_suffix": "string",
            "tags": {},
            "vulnerability_scanning_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "wif_project_id": "string",
            "wif_project_number": "string"
        }
    ]
}

response = falcon.command("cloud_registration_gcp_create_registration", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
  "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)
  }

  deployment_method := "string"
  falcon_client_key_id := "string"
  falcon_client_key_type := "string"
  infra_manager_region := "string"
  infra_project_id := "string"
  product := "string"
  registration_description := "string"
  registration_name := "string"
  registration_scope := "string"
  resource_name_prefix := "string"
  resource_name_suffix := "string"
  wif_project_id := "string"
  wif_project_number := "string"

  response, err := client.CloudGoogleCloudRegistration.CloudRegistrationGcpCreateRegistration(
    &cloud_google_cloud_registration.CloudRegistrationGcpCreateRegistrationParams{
      Body: &models.DtoGCPRegistrationCreateRequestExtV1{
        Resources: []interface{}{
          {
          AdditionalProperties: &struct{}{},
          DeploymentMethod: &deployment_method,
          DspmSettings: &struct{}{},
          EntityID: []string{"string"},
          ExcludedProjectPatterns: []string{"string"},
          FalconClientKeyID: &falcon_client_key_id,
          FalconClientKeyType: &falcon_client_key_type,
          InfraManagerRegion: &infra_manager_region,
          InfraProjectID: &infra_project_id,
          Labels: &struct{}{},
          Products: []interface{}{
            {
            Features: []string{"string"},
            Product: &product,
            },
          },
          RegistrationDescription: &registration_description,
          RegistrationName: &registration_name,
          RegistrationScope: &registration_scope,
          ResourceNamePrefix: &resource_name_prefix,
          ResourceNameSuffix: &resource_name_suffix,
          Tags: &struct{}{},
          VulnerabilityScanningSettings: &struct{}{},
          WifProjectID: &wif_project_id,
          WifProjectNumber: &wif_project_number,
          },
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpCreateRegistration(
  {
    resources: [{
        additionalProperties: {},
        deploymentMethod: "string",
        dspmSettings: {
          deploymentVersion: "string",
          infra: {},
          userInputs: {},
          wifPrincipal: "string"
        },
        entityId: [],
        excludedProjectPatterns: [],
        falconClientKeyId: "string",
        falconClientKeyType: "string",
        infraManagerRegion: "string",
        infraProjectId: "string",
        labels: {},
        products: [{
            features: [],
            product: "string"
          }],
        registrationDescription: "string",
        registrationName: "string",
        registrationScope: "string",
        resourceNamePrefix: "string",
        resourceNameSuffix: "string",
        tags: {},
        vulnerabilityScanningSettings: {
          deploymentVersion: "string",
          infra: {},
          userInputs: {},
          wifPrincipal: "string"
        },
        wifProjectId: "string",
        wifProjectNumber: "string"
      }]
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

body = Falcon::DtoGCPRegistrationCreateRequestExtV1.new(
  resources: [{
      additional_properties: {},
      deployment_method: 'string',
      dspm_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      entity_id: [],
      excluded_project_patterns: [],
      falcon_client_key_id: 'string',
      falcon_client_key_type: 'string',
      infra_manager_region: 'string',
      infra_project_id: 'string',
      labels: {},
      products: [{
          features: [],
          product: 'string'
        }],
      registration_description: 'string',
      registration_name: 'string',
      registration_scope: 'string',
      resource_name_prefix: 'string',
      resource_name_suffix: 'string',
      tags: {},
      vulnerability_scanning_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      wif_project_id: 'string',
      wif_project_number: 'string'
    }]
)

response = api.cloud_registration_gcp_create_registration(body)

puts response

Responses

201 Created

[
  {
    "additional_properties": {},
    "cloud_registration_enabled": false,
    "created": "string",
    "cspm_enabled": false,
    "deployment_method": "string",
    "dspm_settings": {},
    "excluded_project_patterns": [],
    "falcon_client_key_id": "string",
    "falcon_client_key_type": "string",
    "folders": [],
    "infra_manager_properties": {},
    "infra_project_id": "string",
    "labels": {},
    "last_healthcheck_completed_at": "string",
    "log_ingestion_properties": {},
    "organization": {},
    "products": [],
    "projects": [],
    "registration_description": "string",
    "registration_id": "string",
    "registration_name": "string",
    "registration_scope": "string",
    "resource_name_prefix": "string",
    "resource_name_suffix": "string",
    "service_account_properties": {},
    "status": "string",
    "tags": {},
    "updated": "string",
    "vulnerability_scanning_settings": {},
    "wif_properties": {}
  }
]

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

409 Conflict

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-delete-registration

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

Method DELETE

Route /cloud-security-registration-google-cloud/entities/registrations/v1

Scope Cloud Security Google Cloud Registration: WRITE

PEP 8 delete_registration

Parameters

ids query · string

Google Cloud Registration ID

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

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)

Operation ID

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_delete_registration(ids=id_list)
print(response)

Uber

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("cloud_registration_gcp_delete_registration",
                          ids="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
)

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.CloudGoogleCloudRegistration.CloudRegistrationGcpDeleteRegistration(
    &cloud_google_cloud_registration.CloudRegistrationGcpDeleteRegistrationParams{
      Ids: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpDeleteRegistration("string");  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

response = api.cloud_registration_gcp_delete_registration('string')

puts response

Responses

200 OK

[
  {
    "additional_properties": {},
    "cloud_registration_enabled": false,
    "created": "string",
    "cspm_enabled": false,
    "deployment_method": "string",
    "dspm_settings": {},
    "excluded_project_patterns": [],
    "falcon_client_key_id": "string",
    "falcon_client_key_type": "string",
    "folders": [],
    "infra_manager_properties": {},
    "infra_project_id": "string",
    "labels": {},
    "last_healthcheck_completed_at": "string",
    "log_ingestion_properties": {},
    "organization": {},
    "products": [],
    "projects": [],
    "registration_description": "string",
    "registration_id": "string",
    "registration_name": "string",
    "registration_scope": "string",
    "resource_name_prefix": "string",
    "resource_name_suffix": "string",
    "service_account_properties": {},
    "status": "string",
    "tags": {},
    "updated": "string",
    "vulnerability_scanning_settings": {},
    "wif_properties": {}
  }
]

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

404 Not Found

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-get-entities

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

Method GET

Route /cloud-security-registration-google-cloud/entities/accounts/v1

Scope Cloud Security Google Cloud Registration: READ

PEP 8 get_entities

Parameters

ids query · string or list of strings

Google Cloud Registration IDs to filter by

filter query · string

FQL (Falcon Query Language) string for filtering results. Allowed filters are:

Available values (14)

entity_type	entity_id	entity_name
registration_id	registration_name	registration_scope
parent_id	project_number	ioa_status
iom_status	dspm_status	vulnerability_scanning_status
created	updated

sort query · string

Field and direction for sorting results (e.g., created|desc). Sorting applies across all entity types before grouping.

limit query · integer

Maximum number of records to return (default: 100, max: 500). Limit applies across all entity types.

offset query · integer

Starting index of result

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

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)

Operation ID

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_get_entities(ids=id_list,
                                                      filter="string",
                                                      sort="string",
                                                      limit=integer,
                                                      offset=integer)
print(response)

Uber

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("cloud_registration_gcp_get_entities",
                          ids=id_list,
                          filter="string",
                          sort="string",
                          limit=integer,
                          offset=integer)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
)

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"
  sort := "string"
  limit := int64(0)
  offset := int64(0)

  response, err := client.CloudGoogleCloudRegistration.CloudRegistrationGcpGetEntities(
    &cloud_google_cloud_registration.CloudRegistrationGcpGetEntitiesParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Filter: &filter,
      Sort: &sort,
      Limit: &limit,
      Offset: &offset,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpGetEntities(
  ["ID1", "ID2", "ID3"],  // ids
  "string",  // filter
  "string",  // sort
  integer,  // limit
  integer  // offset
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

response = api.cloud_registration_gcp_get_entities(ids: ['ID1', 'ID2', 'ID3'],
                                                   filter: 'string',
                                                   sort: 'string',
                                                   limit: integer,
                                                   offset: integer)

puts response

Responses

200 OK

{
  "folders": [],
  "organizations": [],
  "projects": []
}

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-get-registration

Retrieve a Google Cloud Registration.

Method GET

Route /cloud-security-registration-google-cloud/entities/registrations/v1

Scope Cloud Security Google Cloud Registration: READ

PEP 8 get_registration

Parameters

ids query · string

Google Cloud Registration ID

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

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)

Operation ID

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_get_registration(ids=id_list)
print(response)

Uber

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("cloud_registration_gcp_get_registration",
                          ids="string")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
)

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.CloudGoogleCloudRegistration.CloudRegistrationGcpGetRegistration(
    &cloud_google_cloud_registration.CloudRegistrationGcpGetRegistrationParams{
      Ids: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpGetRegistration("string");  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

response = api.cloud_registration_gcp_get_registration('string')

puts response

Responses

200 OK

[
  {
    "additional_properties": {},
    "cloud_registration_enabled": false,
    "created": "string",
    "cspm_enabled": false,
    "deployment_method": "string",
    "dspm_settings": {},
    "excluded_project_patterns": [],
    "falcon_client_key_id": "string",
    "falcon_client_key_type": "string",
    "folders": [],
    "infra_manager_properties": {},
    "infra_project_id": "string",
    "labels": {},
    "last_healthcheck_completed_at": "string",
    "log_ingestion_properties": {},
    "organization": {},
    "products": [],
    "projects": [],
    "registration_description": "string",
    "registration_id": "string",
    "registration_name": "string",
    "registration_scope": "string",
    "resource_name_prefix": "string",
    "resource_name_suffix": "string",
    "service_account_properties": {},
    "status": "string",
    "tags": {},
    "updated": "string",
    "vulnerability_scanning_settings": {},
    "wif_properties": {}
  }
]

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

404 Not Found

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-post-terraform-script

Generate Google Cloud Terraform deployment scripts (zip files)

Method POST

Route /cloud-security-registration-google-cloud/entities/scripts-terraform/v1

Scope Cloud Security Google Cloud Registration: WRITE

PEP 8 cloud_registration_gcp_post_terraform_script

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

resources body · array

The resources value.

Code Examples

Python

PEP 8

from falconpy import CloudGoogleCloudRegistration

falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
                                      client_secret=CLIENT_SECRET
                                      )

response = falcon.cloud_registration_gcp_post_terraform_script(resources=["string"])
print(response)

Operation ID

from falconpy import CloudGoogleCloudRegistration

falcon = CloudGoogleCloudRegistration(client_id=CLIENT_ID,
                                      client_secret=CLIENT_SECRET
                                      )

response = falcon.cloud_registration_gcp_post_terraform_script(resources=["string"])
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "resources": [
        {
            "dspm_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "entity_id": ["string"],
            "excluded_project_patterns": ["string"],
            "falcon_client_key_id": "string",
            "falcon_client_key_type": "string",
            "infra_project_id": "string",
            "labels": "string",
            "realtime_visibility_enabled": boolean,
            "registration_id": "string",
            "registration_name": "string",
            "resource_name_prefix": "string",
            "resource_name_suffix": "string",
            "tags": "string",
            "vars_only": boolean,
            "vulnerability_scanning_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "wif_project_id": "string"
        }
    ]
}

response = falcon.command("cloud_registration_gcp_post_terraform_script", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
  "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)
  }

  falcon_client_key_id := "string"
  falcon_client_key_type := "string"
  infra_project_id := "string"
  labels := "string"
  realtime_visibility_enabled := boolean
  registration_id := "string"
  registration_name := "string"
  resource_name_prefix := "string"
  resource_name_suffix := "string"
  tags := "string"
  vars_only := boolean
  wif_project_id := "string"

  response, err := client.CloudGoogleCloudRegistration.CloudRegistrationGcpPostTerraformScript(
    &cloud_google_cloud_registration.CloudRegistrationGcpPostTerraformScriptParams{
      Body: &models.DtoGCPTerraformScriptRequestV1{
        Resources: []interface{}{
          {
          DspmSettings: &struct{}{},
          EntityID: []string{"string"},
          ExcludedProjectPatterns: []string{"string"},
          FalconClientKeyID: &falcon_client_key_id,
          FalconClientKeyType: &falcon_client_key_type,
          InfraProjectID: &infra_project_id,
          Labels: &labels,
          RealtimeVisibilityEnabled: &realtime_visibility_enabled,
          RegistrationID: &registration_id,
          RegistrationName: &registration_name,
          ResourceNamePrefix: &resource_name_prefix,
          ResourceNameSuffix: &resource_name_suffix,
          Tags: &tags,
          VarsOnly: &vars_only,
          VulnerabilityScanningSettings: &struct{}{},
          WifProjectID: &wif_project_id,
          },
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpPostTerraformScript(
  {
    resources: [{
        dspmSettings: {
          deploymentVersion: "string",
          infra: {},
          userInputs: {},
          wifPrincipal: "string"
        },
        entityId: [],
        excludedProjectPatterns: [],
        falconClientKeyId: "string",
        falconClientKeyType: "string",
        infraProjectId: "string",
        labels: "string",
        realtimeVisibilityEnabled: boolean,
        registrationId: "string",
        registrationName: "string",
        resourceNamePrefix: "string",
        resourceNameSuffix: "string",
        tags: "string",
        varsOnly: boolean,
        vulnerabilityScanningSettings: {
          deploymentVersion: "string",
          infra: {},
          userInputs: {},
          wifPrincipal: "string"
        },
        wifProjectId: "string"
      }]
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

body = Falcon::DtoGCPTerraformScriptRequestV1.new(
  resources: [{
      dspm_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      entity_id: [],
      excluded_project_patterns: [],
      falcon_client_key_id: 'string',
      falcon_client_key_type: 'string',
      infra_project_id: 'string',
      labels: 'string',
      realtime_visibility_enabled: boolean,
      registration_id: 'string',
      registration_name: 'string',
      resource_name_prefix: 'string',
      resource_name_suffix: 'string',
      tags: 'string',
      vars_only: boolean,
      vulnerability_scanning_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      wif_project_id: 'string'
    }]
)

response = api.cloud_registration_gcp_post_terraform_script(body)

puts response

Responses

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

404 Not Found

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-put-registration

Creates/Updates a Google Cloud Registration.

Method PUT

Route /cloud-security-registration-google-cloud/entities/registrations/v1

Scope Cloud Security Google Cloud Registration: WRITE

PEP 8 update_registration

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

resources body · array

deployment_method body · string

The method of deployment.

entity_id body · string or list of strings

The ID of the entity.

excluded_project_patterns body · string or list of strings

Project patterns that should be excluded.

falcon_client_key_id body · string

API client key ID.

falcon_client_key_type body · string

API client key type.

infra_project_id body · string

Infrastructure project ID.

labels body · dictionary

Prop labels.

products body · list of dictionaries

Products.

registration_name body · string

Registration name.

registration_scope body · string

Registration scope.

resource_name_prefix body · string

Resource name prefix.

Code Examples

Python

PEP 8

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']

labels = {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}

products = [
    {
        "features": [
            "string"
        ],
        "product": "string"
    }
]

response = falcon.update_registration(deployment_method="string",
                                      entity_id=id_list,
                                      excluded_project_patterns=id_list,
                                      falcon_client_key_id="string",
                                      falcon_client_key_type="string",
                                      infra_project_id="string",
                                      labels=labels,
                                      products=products,
                                      registration_name="string",
                                      registration_scope="string",
                                      resource_name_prefix="string")
print(response)

Operation ID

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']

labels = {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}

products = [
    {
        "features": [
            "string"
        ],
        "product": "string"
    }
]

response = falcon.cloud_registration_gcp_put_registration(deployment_method="string",
                                                          entity_id=id_list,
                                                          excluded_project_patterns=id_list,
                                                          falcon_client_key_id="string",
                                                          falcon_client_key_type="string",
                                                          infra_project_id="string",
                                                          labels=labels,
                                                          products=products,
                                                          registration_name="string",
                                                          registration_scope="string",
                                                          resource_name_prefix="string")
print(response)

Uber

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']

body_payload = {
    "resources": [
        {
            "additional_properties": {},
            "deployment_method": "string",
            "dspm_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "entity_id": ["string"],
            "excluded_project_patterns": ["string"],
            "falcon_client_key_id": "string",
            "falcon_client_key_type": "string",
            "infra_manager_region": "string",
            "infra_project_id": "string",
            "labels": {},
            "products": [
                {
                    "features": ["string"],
                    "product": "string"
                }
            ],
            "registration_description": "string",
            "registration_name": "string",
            "registration_scope": "string",
            "resource_name_prefix": "string",
            "resource_name_suffix": "string",
            "tags": {},
            "vulnerability_scanning_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "wif_project_id": "string",
            "wif_project_number": "string"
        }
    ]
}

response = falcon.command("cloud_registration_gcp_put_registration", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
  "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)
  }

  deployment_method := "string"
  falcon_client_key_id := "string"
  falcon_client_key_type := "string"
  infra_manager_region := "string"
  infra_project_id := "string"
  product := "string"
  registration_description := "string"
  registration_name := "string"
  registration_scope := "string"
  resource_name_prefix := "string"
  resource_name_suffix := "string"
  wif_project_id := "string"
  wif_project_number := "string"

  response, err := client.CloudGoogleCloudRegistration.CloudRegistrationGcpPutRegistration(
    &cloud_google_cloud_registration.CloudRegistrationGcpPutRegistrationParams{
      Body: &models.DtoGCPRegistrationCreateRequestExtV1{
        Resources: []interface{}{
          {
          AdditionalProperties: &struct{}{},
          DeploymentMethod: &deployment_method,
          DspmSettings: &struct{}{},
          EntityID: []string{"string"},
          ExcludedProjectPatterns: []string{"string"},
          FalconClientKeyID: &falcon_client_key_id,
          FalconClientKeyType: &falcon_client_key_type,
          InfraManagerRegion: &infra_manager_region,
          InfraProjectID: &infra_project_id,
          Labels: &struct{}{},
          Products: []interface{}{
            {
            Features: []string{"string"},
            Product: &product,
            },
          },
          RegistrationDescription: &registration_description,
          RegistrationName: &registration_name,
          RegistrationScope: &registration_scope,
          ResourceNamePrefix: &resource_name_prefix,
          ResourceNameSuffix: &resource_name_suffix,
          Tags: &struct{}{},
          VulnerabilityScanningSettings: &struct{}{},
          WifProjectID: &wif_project_id,
          WifProjectNumber: &wif_project_number,
          },
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpPutRegistration(
  {
    resources: [{
        additionalProperties: {},
        deploymentMethod: "string",
        dspmSettings: {
          deploymentVersion: "string",
          infra: {},
          userInputs: {},
          wifPrincipal: "string"
        },
        entityId: [],
        excludedProjectPatterns: [],
        falconClientKeyId: "string",
        falconClientKeyType: "string",
        infraManagerRegion: "string",
        infraProjectId: "string",
        labels: {},
        products: [{
            features: [],
            product: "string"
          }],
        registrationDescription: "string",
        registrationName: "string",
        registrationScope: "string",
        resourceNamePrefix: "string",
        resourceNameSuffix: "string",
        tags: {},
        vulnerabilityScanningSettings: {
          deploymentVersion: "string",
          infra: {},
          userInputs: {},
          wifPrincipal: "string"
        },
        wifProjectId: "string",
        wifProjectNumber: "string"
      }]
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

body = Falcon::DtoGCPRegistrationCreateRequestExtV1.new(
  resources: [{
      additional_properties: {},
      deployment_method: 'string',
      dspm_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      entity_id: [],
      excluded_project_patterns: [],
      falcon_client_key_id: 'string',
      falcon_client_key_type: 'string',
      infra_manager_region: 'string',
      infra_project_id: 'string',
      labels: {},
      products: [{
          features: [],
          product: 'string'
        }],
      registration_description: 'string',
      registration_name: 'string',
      registration_scope: 'string',
      resource_name_prefix: 'string',
      resource_name_suffix: 'string',
      tags: {},
      vulnerability_scanning_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      wif_project_id: 'string',
      wif_project_number: 'string'
    }]
)

response = api.cloud_registration_gcp_put_registration(body)

puts response

Responses

200 OK

[
  {
    "additional_properties": {},
    "cloud_registration_enabled": false,
    "created": "string",
    "cspm_enabled": false,
    "deployment_method": "string",
    "dspm_settings": {},
    "excluded_project_patterns": [],
    "falcon_client_key_id": "string",
    "falcon_client_key_type": "string",
    "folders": [],
    "infra_manager_properties": {},
    "infra_project_id": "string",
    "labels": {},
    "last_healthcheck_completed_at": "string",
    "log_ingestion_properties": {},
    "organization": {},
    "products": [],
    "projects": [],
    "registration_description": "string",
    "registration_id": "string",
    "registration_name": "string",
    "registration_scope": "string",
    "resource_name_prefix": "string",
    "resource_name_suffix": "string",
    "service_account_properties": {},
    "status": "string",
    "tags": {},
    "updated": "string",
    "vulnerability_scanning_settings": {},
    "wif_properties": {}
  }
]

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

409 Conflict

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-trigger-health-check

Trigger health check scan for GCP registrations

Method POST

Route /cloud-security-registration-google-cloud/entities/registration-scans/v1

Scope Cloud Security Google Cloud Registration: WRITE

PEP 8 trigger_health_check

Parameters

ids query · string or list of strings

GCP Registration IDs

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

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)

Operation ID

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_trigger_health_check(ids=id_list)
print(response)

Uber

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("cloud_registration_gcp_trigger_health_check",
                          ids=id_list)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
)

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.CloudGoogleCloudRegistration.CloudRegistrationGcpTriggerHealthCheck(
    &cloud_google_cloud_registration.CloudRegistrationGcpTriggerHealthCheckParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpTriggerHealthCheck(["ID1", "ID2", "ID3"]);  // ids

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

response = api.cloud_registration_gcp_trigger_health_check(ids: ['ID1', 'ID2', 'ID3'])

puts response

Responses

200 OK

[
  {
    "registration_id": "string"
  }
]

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}

---

---

cloud-registration-gcp-update-registration

Update a Google Cloud Registration.

Method PATCH

Route /cloud-security-registration-google-cloud/entities/registrations/v1

Scope Cloud Security Google Cloud Registration: WRITE

PEP 8 cloud_registration_gcp_update_registration

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

resources body · array

ids query · string

Google Cloud Registration ID

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

deployment_method body · string

The method of deployment.

entity_id body · string or list of strings

The ID of the entity.

excluded_project_patterns body · string or list of strings

Project patterns that should be excluded.

falcon_client_key_id body · string

API client key ID.

falcon_client_key_type body · string

API client key type.

infra_project_id body · string

Infrastructure project ID.

labels body · dictionary

Prop labels.

products body · list of dictionaries

Products.

registration_name body · string

Registration name.

registration_scope body · string

Registration scope.

resource_name_prefix body · string

Resource name prefix.

Code Examples

Python

PEP 8

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']

labels = {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}

products = [
    {
        "features": [
            "string"
        ],
        "product": "string"
    }
]

response = falcon.cloud_registration_gcp_update_registration(ids=id_list,
                                                             deployment_method="string",
                                                             entity_id=id_list,
                                                             excluded_project_patterns=id_list,
                                                             falcon_client_key_id="string",
                                                             falcon_client_key_type="string",
                                                             infra_project_id="string",
                                                             labels=labels,
                                                             products=products,
                                                             registration_name="string",
                                                             registration_scope="string",
                                                             resource_name_prefix="string")
print(response)

Operation ID

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']

labels = {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}

products = [
    {
        "features": [
            "string"
        ],
        "product": "string"
    }
]

response = falcon.cloud_registration_gcp_update_registration(ids=id_list,
                                                             deployment_method="string",
                                                             entity_id=id_list,
                                                             excluded_project_patterns=id_list,
                                                             falcon_client_key_id="string",
                                                             falcon_client_key_type="string",
                                                             infra_project_id="string",
                                                             labels=labels,
                                                             products=products,
                                                             registration_name="string",
                                                             registration_scope="string",
                                                             resource_name_prefix="string")
print(response)

Uber

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']

body_payload = {
    "resources": [
        {
            "additional_properties": {},
            "deployment_method": "string",
            "dspm_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "entity_id": ["string"],
            "excluded_project_patterns": ["string"],
            "falcon_client_key_id": "string",
            "falcon_client_key_type": "string",
            "infra_manager_region": "string",
            "infra_project_id": "string",
            "labels": {},
            "log_ingestion_sink_name": "string",
            "log_ingestion_subscription_name": "string",
            "log_ingestion_topic_id": "string",
            "products": [
                {
                    "features": ["string"],
                    "product": "string"
                }
            ],
            "registration_description": "string",
            "registration_name": "string",
            "registration_scope": "string",
            "resource_name_prefix": "string",
            "resource_name_suffix": "string",
            "tags": {},
            "vulnerability_scanning_settings": {
                "deployment_version": "string",
                "infra": {},
                "user_inputs": {},
                "wif_principal": "string"
            },
            "wif_pool_name": "string",
            "wif_project_id": "string",
            "wif_project_number": "string",
            "wif_provider_name": "string"
        }
    ]
}

response = falcon.command("cloud_registration_gcp_update_registration",
                          ids="string",
                          body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_google_cloud_registration"
  "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)
  }

  deployment_method := "string"
  falcon_client_key_id := "string"
  falcon_client_key_type := "string"
  infra_manager_region := "string"
  infra_project_id := "string"
  log_ingestion_sink_name := "string"
  log_ingestion_subscription_name := "string"
  log_ingestion_topic_id := "string"
  product := "string"
  registration_description := "string"
  registration_name := "string"
  registration_scope := "string"
  resource_name_prefix := "string"
  resource_name_suffix := "string"
  wif_pool_name := "string"
  wif_project_id := "string"
  wif_project_number := "string"
  wif_provider_name := "string"

  response, err := client.CloudGoogleCloudRegistration.CloudRegistrationGcpUpdateRegistration(
    &cloud_google_cloud_registration.CloudRegistrationGcpUpdateRegistrationParams{
      Body: &models.DtoGCPRegistrationUpdateRequestExtV1{
        Resources: []interface{}{
          {
          AdditionalProperties: &struct{}{},
          DeploymentMethod: &deployment_method,
          DspmSettings: &struct{}{},
          EntityID: []string{"string"},
          ExcludedProjectPatterns: []string{"string"},
          FalconClientKeyID: &falcon_client_key_id,
          FalconClientKeyType: &falcon_client_key_type,
          InfraManagerRegion: &infra_manager_region,
          InfraProjectID: &infra_project_id,
          Labels: &struct{}{},
          LogIngestionSinkName: &log_ingestion_sink_name,
          LogIngestionSubscriptionName: &log_ingestion_subscription_name,
          LogIngestionTopicID: &log_ingestion_topic_id,
          Products: []interface{}{
            {
            Features: []string{"string"},
            Product: &product,
            },
          },
          RegistrationDescription: &registration_description,
          RegistrationName: &registration_name,
          RegistrationScope: &registration_scope,
          ResourceNamePrefix: &resource_name_prefix,
          ResourceNameSuffix: &resource_name_suffix,
          Tags: &struct{}{},
          VulnerabilityScanningSettings: &struct{}{},
          WifPoolName: &wif_pool_name,
          WifProjectID: &wif_project_id,
          WifProjectNumber: &wif_project_number,
          WifProviderName: &wif_provider_name,
          },
        },
      },
      Ids: "string",
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

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.cloudGoogleCloudRegistration.cloudRegistrationGcpUpdateRegistration(
  "string",  // ids
  {  // body
      resources: [{
          additionalProperties: {},
          deploymentMethod: "string",
          dspmSettings: {
            deploymentVersion: "string",
            infra: {},
            userInputs: {},
            wifPrincipal: "string"
          },
          entityId: [],
          excludedProjectPatterns: [],
          falconClientKeyId: "string",
          falconClientKeyType: "string",
          infraManagerRegion: "string",
          infraProjectId: "string",
          labels: {},
          logIngestionSinkName: "string",
          logIngestionSubscriptionName: "string",
          logIngestionTopicId: "string",
          products: [{
              features: [],
              product: "string"
            }],
          registrationDescription: "string",
          registrationName: "string",
          registrationScope: "string",
          resourceNamePrefix: "string",
          resourceNameSuffix: "string",
          tags: {},
          vulnerabilityScanningSettings: {
            deploymentVersion: "string",
            infra: {},
            userInputs: {},
            wifPrincipal: "string"
          },
          wifPoolName: "string",
          wifProjectId: "string",
          wifProjectNumber: "string",
          wifProviderName: "string"
        }]
  }
);

console.log(response);

Rust

Examples coming soon.

Ruby

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::CloudGoogleCloudRegistration.new

body = Falcon::DtoGCPRegistrationUpdateRequestExtV1.new(
  resources: [{
      additional_properties: {},
      deployment_method: 'string',
      dspm_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      entity_id: [],
      excluded_project_patterns: [],
      falcon_client_key_id: 'string',
      falcon_client_key_type: 'string',
      infra_manager_region: 'string',
      infra_project_id: 'string',
      labels: {},
      log_ingestion_sink_name: 'string',
      log_ingestion_subscription_name: 'string',
      log_ingestion_topic_id: 'string',
      products: [{
          features: [],
          product: 'string'
        }],
      registration_description: 'string',
      registration_name: 'string',
      registration_scope: 'string',
      resource_name_prefix: 'string',
      resource_name_suffix: 'string',
      tags: {},
      vulnerability_scanning_settings: {
        deployment_version: 'string',
        infra: {},
        user_inputs: {},
        wif_principal: 'string'
      },
      wif_pool_name: 'string',
      wif_project_id: 'string',
      wif_project_number: 'string',
      wif_provider_name: 'string'
    }]
)

response = api.cloud_registration_gcp_update_registration(body, 'string')

puts response

Responses

200 OK

[
  {
    "additional_properties": {},
    "cloud_registration_enabled": false,
    "created": "string",
    "cspm_enabled": false,
    "deployment_method": "string",
    "dspm_settings": {},
    "excluded_project_patterns": [],
    "falcon_client_key_id": "string",
    "falcon_client_key_type": "string",
    "folders": [],
    "infra_manager_properties": {},
    "infra_project_id": "string",
    "labels": {},
    "last_healthcheck_completed_at": "string",
    "log_ingestion_properties": {},
    "organization": {},
    "products": [],
    "projects": [],
    "registration_description": "string",
    "registration_id": "string",
    "registration_name": "string",
    "registration_scope": "string",
    "resource_name_prefix": "string",
    "resource_name_suffix": "string",
    "service_account_properties": {},
    "status": "string",
    "tags": {},
    "updated": "string",
    "vulnerability_scanning_settings": {},
    "wif_properties": {}
  }
]

400 Bad Request

{
  "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
    }
  }
}

403 Forbidden

{
  "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
    }
  }
}

404 Not Found

{
  "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
    }
  }
}

429 Too Many Requests

{
  "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
    }
  }
}

500 Internal Server Error

{
  "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
    }
  }
}