Kubernetes Protection

Using the Kubernetes Protection service collection

Table of Contents

Operation ID	Description
GetAWSAccountsMixin0 PEP 8 get_aws_accounts	Provides a list of AWS accounts.
CreateAWSAccount PEP 8 create_aws_account	Creates a new AWS account in our system for a customer and generates the installation script
DeleteAWSAccountsMixin0 PEP 8 delete_aws_accounts	Delete AWS accounts.
UpdateAWSAccount PEP 8 update_aws_account	Updates the AWS account per the query parameters provided
GetLocations PEP 8 get_locations	Provides the cloud locations acknowledged by the Kubernetes Protection service
GetHelmValuesYaml PEP 8 get_helm_values_yaml	Provides a sample Helm values.yaml file for a customer to install alongside the agent Helm chart
RegenerateAPIKey PEP 8 regenerate	Regenerate API key for docker registry integrations
GetClusters PEP 8 get_clusters	Provides the clusters acknowledged by the Kubernetes Protection service
TriggerScan PEP 8 trigger_scan	Triggers a dry run or a full scan of a customer's kubernetes footprint

GetAWSAccountsMixin0

Provides a list of AWS accounts.

PEP8 method name

get_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ids			query	string or list of strings	AWS Account ID(s).
limit			query	integer	Maximum number of records to return.
offset			query	integer	Starting index of overall result set from which to return ids.
parameters			query	string	Full query string parameters payload in JSON format.
status			query	string	Filter by account status.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_aws_accounts(status="string",
                                   limit=integer,
                                   offset=integer,
                                   ids=id_list
                                   )
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.GetAWSAccountsMixin0(status="string",
                                       limit=integer,
                                       offset=integer,
                                       ids=id_list
                                       )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("GetAWSAccountsMixin0",
                          status="string",
                          limit=integer,
                          offset=integer,
                          ids=id_list
                          )

print(response)

CreateAWSAccount

Creates a new AWS account in our system for a customer and generates the installation script

PEP8 method name

create_aws_account

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	Full body payload in JSON format.
account_id			body	string	Account ID.
region			body	string	Cloud region.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.create_aws_account(account_id="string", region="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.CreateAWSAccount(account_id="string", region="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

BODY = {
    "resources": [
        {
            "account_id": "string",
            "region": "string"
        }
    ]
}

response = falcon.command("CreateAWSAccount", body=BODY)
print(response)

DeleteAWSAccountsMixin0

Delete AWS accounts.

PEP8 method name

delete_aws_accounts

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ids			query	string or list of strings	AWS Account ID(s) to delete.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.delete_aws_accounts(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.DeleteAWSAccountsMixin0(ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("DeleteAWSAccountsMixin0", ids=id_list)
print(response)

UpdateAWSAccount

Updates the AWS account per the query parameters provided

PEP8 method name

update_aws_account

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
ids			query	string or list of strings	AWS Account ID(s) to update.
parameters			query	string	Full query string parameters payload in JSON format.
region			query	string	Default region for account automation.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.update_aws_account(region="string", ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.UpdateAWSAccount(region="string", ids=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("UpdateAWSAccount", region="string", ids=id_list)
print(response)

GetLocations

Provides the cloud locations acknowledged by the Kubernetes Protection service

PEP8 method name

get_locations

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
clouds			query	string or list of strings	Cloud provider.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'aws,azure,gcp'  # Can also pass a list here: ['aws', 'azure', 'gcp']

response = falcon.get_locations(clouds=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

id_list = 'aws,azure,gcp'  # Can also pass a list here: ['aws', 'azure', 'gcp']

response = falcon.GetLocations(clouds=id_list)
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'aws,azure,gcp'  # Can also pass a list here: ['aws', 'azure', 'gcp']

response = falcon.command("GetLocations", clouds=id_list)
print(response)

GetHelmValuesYaml

Provides a sample Helm values.yaml file for a customer to install alongside the agent Helm chart

PEP8 method name

get_helm_values_yaml

Content-Type

• Consumes: application/json
• Produces: application/yaml

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
cluster_name			query	string or list of strings	Cluster name. For EKS this will be the cluster ARN.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.get_helm_values_yaml(cluster_name="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.GetHelmValuesYaml(cluster_name="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("GetHelmValuesYaml", cluster_name="string")
print(response)

RegenerateAPIKey

Regenerate API key for docker registry integrations.

PEP8 method name

regenerate

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

No keywords are arguments are required.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.regenerate()
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.RegenerateAPIKey()
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("RegenerateAPIKey")
print(response)

GetClusters

Provides the clusters acknowledged by the Kubernetes Protection service

PEP8 method name

get_clusters

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
cluster_name			query	string or list of strings	Cluster name. For EKS this will be the cluster ARN.
account_ids			query	string or list of strings	Cluster account ID. For EKS this will be the AWS account ID.
locations			query	string or list of strings	Cloud location.
cluster_service			query	string	Cluster service.
limit			query	integer	Maximum number of results to return.
offset			query	integer	Starting offset to begin returning results.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

clusters = 'CLID1,CLID2,CLID3'  # Can also pass a list here: ['CLID1', 'CLID2', 'CLID3']

accounts = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

locations = 'LOC1,LOC2,LOC3'  # Can also pass a list here: ['LOC1', 'LOC2', 'LOC3']

response = falcon.get_clusters(cluster_names=clusters,
                               account_ids=accounts,
                               locations=locations,
                               cluster_service="string",
                               limit=integer,
                               offset=integer
                               )
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

clusters = 'CLID1,CLID2,CLID3'  # Can also pass a list here: ['CLID1', 'CLID2', 'CLID3']

accounts = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

locations = 'LOC1,LOC2,LOC3'  # Can also pass a list here: ['LOC1', 'LOC2', 'LOC3']

response = falcon.GetClusters(cluster_names=clusters,
                              account_ids=accounts,
                              locations=locations,
                              cluster_service="string",
                              limit=integer,
                              offset=integer
                              )
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

clusters = 'CLID1,CLID2,CLID3'  # Can also pass a list here: ['CLID1', 'CLID2', 'CLID3']

accounts = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

locations = 'LOC1,LOC2,LOC3'  # Can also pass a list here: ['LOC1', 'LOC2', 'LOC3']

response = falcon.command("GetClusters",
                          cluster_names=clusters,
                          account_ids=accounts,
                          locations=locations,
                          cluster_service="string",
                          limit=integer,
                          offset=integer
                          )
print(response)

TriggerScan

Triggers a dry run or a full scan of a customer's kubernetes footprint.

PEP8 method name

trigger_scan

Content-Type

• Consumes: application/json
• Produces: application/json

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
scan_type			query	string	Type of scan to perform, cluster-refresh, dry-run or full. Defaults to dry-run.
parameters			query	string	Full query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.trigger_scan(scan_type="string")
print(response)

Service class example (Operation ID syntax)

from falconpy import KubernetesProtection

falcon = KubernetesProtection(client_id="API_CLIENT_ID_HERE",
                              client_secret="API_CLIENT_SECRET_HERE"
                              )

response = falcon.TriggerScan(scan_type="string")
print(response)

Uber class example

from falconpy import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

response = falcon.command("TriggerScan", scan_type="string")
print(response)