Using the Delivery Settings service collection
Table of Contents
| Operation ID | Description | ||||
|---|---|---|---|---|---|
| Get Delivery Settings. | ||||
| Create Delivery Settings. | ||||
Passing credentials
WARNING
client_idandclient_secretare keyword arguments that contain your CrowdStrike API credentials. Please note that all examples below do not hard code these values. (These values are ingested as strings.)CrowdStrike does not recommend hard coding API credentials or customer identifiers within source code.
GetDeliverySettings
Get Delivery Settings
PEP8 method name
get_delivery_settings
Endpoint
| Method | Route |
|---|---|
/delivery-settings/entities/delivery-settings/v1 |
Required Scope
Content-Type
- Produces: application/json
Keyword Arguments
No keywords or arguments accepted.
Usage
Service class example (PEP8 syntax)
from falconpy import DeliverySettings
falcon = DeliverySettings(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_delivery_settings()
print(response)
Service class example (Operation ID syntax)
from falconpy import DeliverySettings
falcon = DeliverySettings(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.GetDeliverySettings()
print(response)
Uber class example
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.command("GetDeliverySettings")
print(response)
PostDeliverySettings
Create Delivery Settings
PEP8 method name
create_delivery_settings
Endpoint
| Method | Route |
|---|---|
/delivery-settings/entities/delivery-settings/v1 |
Required Scope
Content-Type
- Produces: application/json
Keyword Arguments
| Name | Service | Uber | Type | Data type | Description |
|---|---|---|---|---|---|
| body | body | dictionary | Full body payload in JSON format. | ||
| delivery_cadence | body | string | Delivery schedule. | ||
| delivery_type | body | string | Delivery type. |
Usage
Service class example (PEP8 syntax)
from falconpy import DeliverySettings
falcon = DeliverySettings(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.create_delivery_settings(delivery_cadence="string", delivery_type="string")
print(response)
Service class example (Operation ID syntax)
from falconpy import DeliverySettings
falcon = DeliverySettings(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.PostDeliverySettings(delivery_cadence="string", delivery_type="string")
print(response)
Uber class example
from falconpy import APIHarnessV2
falcon = APIHarnessV2(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
body_payload = {
"delivery_settings": [
{
"delivery_cadence": "string",
"delivery_type": "string"
}
]
}
response = falcon.command("PostDeliverySettings", body=body_payload)
print(response)