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.

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

---

---

Table of Contents

Operation	Description
GetDeliverySettings get_delivery_settings	Get Delivery Settings
PostDeliverySettings create_delivery_settings	Create Delivery Settings

---

GetDeliverySettings

Get Delivery Settings

Method GET

Route /delivery-settings/entities/delivery-settings/v1

Scope Delivery Settings: READ

PEP 8 get_delivery_settings

Code Examples

Python

PEP 8

from falconpy import DeliverySettings

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

response = falcon.get_delivery_settings()
print(response)

Operation ID

from falconpy import DeliverySettings

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

response = falcon.GetDeliverySettings()
print(response)

Uber

from falconpy import APIHarnessV2

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

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

PowerShell

Get-FalconContentControl

Go

package main

import (
  "context"
  "fmt"
  "os"

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

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.DeliverySettings.GetDeliverySettings(
    &delivery_settings.GetDeliverySettingsParams{
      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.deliverySettings.getDeliverySettings();

console.log(response);

Rust

use rusty_falcon::apis::delivery_settings_api::get_delivery_settings;
use rusty_falcon::easy::client::FalconHandle;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let response = get_delivery_settings(&falcon.cfg).await.expect("API call failed");  // configuration

    println!("{:?}", response);
}

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

response = api.get_delivery_settings

puts response

Responses

200 OK

[
  {
    "api_created_by": "string",
    "api_updated_at": "string",
    "api_updated_by": "string",
    "cid": "string",
    "created_at": "string",
    "created_by": "string",
    "deleted_at": "string",
    "deleted_by": "string",
    "delivery_cadence": "string",
    "delivery_type": "string",
    "updated_at": "string",
    "updated_by": "string",
    "uuid": "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
    }
  }
}

---

---

PostDeliverySettings

Create Delivery Settings

Method POST

Route /delivery-settings/entities/delivery-settings/v1

Scope Delivery Settings: WRITE

PEP 8 create_delivery_settings

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

delivery_settings body · array

delivery_cadence body · string

Cadence for the delivery.

delivery_type body · string

Type of delivery.

Code Examples

Python

PEP 8

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)

Operation ID

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

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)

PowerShell

Set-FalconContentControl -Type "string" -Cadence "string"

Go

package main

import (
  "context"
  "fmt"
  "os"

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

  delivery_cadence := "string"
  delivery_type := "string"

  response, err := client.DeliverySettings.PostDeliverySettings(
    &delivery_settings.PostDeliverySettingsParams{
      Body: &models.ModelsDeliverySettingsRequest{
        DeliverySettings: []interface{}{
          {
          DeliveryCadence: &delivery_cadence,
          DeliveryType: &delivery_type,
          },
        },
      },
      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.deliverySettings.postDeliverySettings(
  {
    deliverySettings: [{
        deliveryCadence: "string",
        deliveryType: "string"
      }]
}  // body
);

console.log(response);

Rust

use rusty_falcon::apis::delivery_settings_api::post_delivery_settings;
use rusty_falcon::easy::client::FalconHandle;
use rusty_falcon::models::ModelsDeliverySettingsRequest;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let body = ModelsDeliverySettingsRequest {
        delivery_settings: vec![DeliverySettingsInput {
            delivery_cadence: Some("string".to_string()),
            delivery_type: Some("string".to_string()),
            ..Default::default()
        }],
        ..Default::default()
    };

    let response = post_delivery_settings(
        &falcon.cfg,  // configuration
        body,  // body
    ).await.expect("API call failed");

    println!("{:?}", response);
}

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

body = Falcon::ModelsDeliverySettingsRequest.new(
  delivery_settings: [{
      delivery_cadence: 'string',
      delivery_type: 'string'
    }]
)

response = api.post_delivery_settings(body)

puts response

Responses

200 OK

[
  {
    "api_created_by": "string",
    "api_updated_at": "string",
    "api_updated_by": "string",
    "cid": "string",
    "created_at": "string",
    "created_by": "string",
    "deleted_at": "string",
    "deleted_by": "string",
    "delivery_cadence": "string",
    "delivery_type": "string",
    "updated_at": "string",
    "updated_by": "string",
    "uuid": "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
    }
  }
}