Network Containment

Operations for the Network Containment service collection.

Language	Last Update
Python	v1.6.6
PowerShell
Go
TypeScript
Rust
Ruby

---

Table of Contents

Operation	Description
CreateContainmentAllowlistRules create_allowlist_rules	Add new network containment allowlist rules
DeleteContainmentAllowlistRules delete_allowlist_rules	Delete network containment allowlist rules by ID
GetContainmentAllowlistRules get_allowlist_rules	Get network containment allowlist rules for the specified IDs
QueryContainmentAllowlistRules query_allowlist_rules	Search for network containment allowlist rules by context
UpdateContainmentAllowlistRules update_allowlist_rules	Update network containment allowlist rules

---

CreateContainmentAllowlistRules

Add new network containment allowlist rules

Method POST

Route /customers/entities/containment-allowlist-rules/v1

Scope Network Containment Allowlist: WRITE

PEP 8 create_allowlist_rules

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

rules body · array

The rules value.

Code Examples

Python

PEP 8

from falconpy import NetworkContainment

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

rules = [
    {
        "cid": "string",
        "context": "string",
        "created_by": "string",
        "created_on": "string",
        "id": "string",
        "label": "string",
        "options": {
            "allow_subdomain": True
        },
        "rule": "string",
        "type": "string"
    }
]

response = falcon.create_allowlist_rules(rules=rules)
print(response)

Operation ID

from falconpy import NetworkContainment

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

rules = [
    {
        "cid": "string",
        "context": "string",
        "created_by": "string",
        "created_on": "string",
        "id": "string",
        "label": "string",
        "options": {
            "allow_subdomain": True
        },
        "rule": "string",
        "type": "string"
    }
]

response = falcon.CreateContainmentAllowlistRules(rules=rules)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "rules": [
        {
            "cid": "string",
            "context": "string",
            "created_by": "string",
            "created_on": "string",
            "id": "string",
            "label": "string",
            "options": {
                "allow_subdomain": boolean
            },
            "rule": "string",
            "type": "string"
        }
    ]
}

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

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 OK

[
  {
    "cid": "string",
    "context": "string",
    "created_by": "string",
    "created_on": "string",
    "id": "string",
    "label": "string",
    "options": {},
    "rule": "string",
    "type": "string"
  }
]

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 Unexpected 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
    }
  }
}

---

---

DeleteContainmentAllowlistRules

Delete network containment allowlist rules by ID

Method DELETE

Route /customers/entities/containment-allowlist-rules/v1

Scope Network Containment Allowlist: WRITE

PEP 8 delete_allowlist_rules

Parameters

ids query · string

Containment allowlist rule 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 NetworkContainment

falcon = NetworkContainment(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_allowlist_rules(ids=id_list)
print(response)

Operation ID

from falconpy import NetworkContainment

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

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

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

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("DeleteContainmentAllowlistRules",
                          ids="string")
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 OK

[
  {
    "cid": "string",
    "context": "string",
    "created_by": "string",
    "created_on": "string",
    "id": "string",
    "label": "string",
    "options": {},
    "rule": "string",
    "type": "string"
  }
]

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 Unexpected 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
    }
  }
}

---

---

GetContainmentAllowlistRules

Get network containment allowlist rules for the specified IDs

Method GET

Route /customers/entities/containment-allowlist-rules/v1

Scope Network Containment Allowlist: READ

PEP 8 get_allowlist_rules

Parameters

ids query · string or list of strings

Containment allowlist rule 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 NetworkContainment

falcon = NetworkContainment(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_allowlist_rules(ids=id_list)
print(response)

Operation ID

from falconpy import NetworkContainment

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

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

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

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 OK

[
  {
    "cid": "string",
    "context": "string",
    "created_by": "string",
    "created_on": "string",
    "id": "string",
    "label": "string",
    "options": {},
    "rule": "string",
    "type": "string"
  }
]

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 Unexpected 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
    }
  }
}

---

---

QueryContainmentAllowlistRules

Search for network containment allowlist rules by context

Method GET

Route /customers/queries/containment-allowlist-rules/v1

Scope Network Containment Allowlist: READ

PEP 8 query_allowlist_rules

Parameters

filter query · string

Allowlist FQL filter. Can only filter based on the context parameter

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 NetworkContainment

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

response = falcon.query_allowlist_rules(filter="string")
print(response)

Operation ID

from falconpy import NetworkContainment

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

response = falcon.QueryContainmentAllowlistRules(filter="string")
print(response)

Uber

from falconpy import APIHarnessV2

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

response = falcon.command("QueryContainmentAllowlistRules",
                          filter="string")
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 OK

[
  "string"
]

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 Unexpected 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
    }
  }
}

---

---

UpdateContainmentAllowlistRules

Update network containment allowlist rules

Method PATCH

Route /customers/entities/containment-allowlist-rules/v1

Scope Network Containment Allowlist: WRITE

PEP 8 update_allowlist_rules

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

rules body · array

The rules value.

Code Examples

Python

PEP 8

from falconpy import NetworkContainment

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

rules = [
    {
        "cid": "string",
        "context": "string",
        "created_by": "string",
        "created_on": "string",
        "id": "string",
        "label": "string",
        "options": {
            "allow_subdomain": True
        },
        "rule": "string",
        "type": "string"
    }
]

response = falcon.update_allowlist_rules(rules=rules)
print(response)

Operation ID

from falconpy import NetworkContainment

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

rules = [
    {
        "cid": "string",
        "context": "string",
        "created_by": "string",
        "created_on": "string",
        "id": "string",
        "label": "string",
        "options": {
            "allow_subdomain": True
        },
        "rule": "string",
        "type": "string"
    }
]

response = falcon.UpdateContainmentAllowlistRules(rules=rules)
print(response)

Uber

from falconpy import APIHarnessV2

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

body_payload = {
    "rules": [
        {
            "cid": "string",
            "context": "string",
            "created_by": "string",
            "created_on": "string",
            "id": "string",
            "label": "string",
            "options": {
                "allow_subdomain": boolean
            },
            "rule": "string",
            "type": "string"
        }
    ]
}

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

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 OK

[
  {
    "cid": "string",
    "context": "string",
    "created_by": "string",
    "created_on": "string",
    "id": "string",
    "label": "string",
    "options": {},
    "rule": "string",
    "type": "string"
  }
]

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 Unexpected 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
    }
  }
}