Skip to content

Delivery Settings

The Delivery Settings service collection provides operations for managing delivery settings. Retrieve your current delivery configuration and create or update delivery settings including delivery cadence and delivery type.

LanguageLast Update
Pythonv1.4.6
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
GetDeliverySettings
get_delivery_settings
Get Delivery Settings.
PostDeliverySettings
create_delivery_settings
Create Delivery Settings.

Get Delivery Settings

GET /delivery-settings/entities/delivery-settings/v1
Scope Delivery Settings: READ Consumes · Produces application/json
PEP 8 get_delivery_settings

No keywords or arguments accepted.

from falconpy import DeliverySettings
falcon = DeliverySettings(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.get_delivery_settings()
print(response)

Create Delivery Settings

POST /delivery-settings/entities/delivery-settings/v1
Scope Delivery Settings: WRITE Consumes · Produces application/json
PEP 8 create_delivery_settings
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
delivery_cadencebodystringDelivery schedule.
delivery_typebodystringDelivery type.
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)