Deployments - CrowdStrike/falconpy GitHub Wiki

CrowdStrike Falcon CrowdStrike Subreddit

Using the Deployments service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation ID Description
CombinedReleaseNotesV1
PEP 8 query_release_notes
Queries for releases resources and returns details.
CombinedReleasesV1Mixin0
PEP 8 query_releases
Queries for releases resources and returns details.
GetDeploymentsExternalV1
PEP 8 get_deployments
Get deployment resources by IDs.
GetEntityIDsByQueryPOST
PEP 8 get_release_notes_v1
Returns the release notes for the IDs in the request.
GetEntityIDsByQueryPOSTV2
PEP 8 get_release_notes
Get entity IDs by query (v2).
QueryReleaseNotesV1
PEP 8 query_release_note_ids
Queries for release-notes resources and returns IDs.

Passing credentials

WARNING

client_id and client_secret are 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.

CombinedReleaseNotesV1

Queries for release-notes resources and returns details.

PEP8 method name

query_release_notes

Endpoint

Method Route
GET /deployment-coordinator/combined/release-notes/v1

Required Scope

deployment-coordinator:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
✅ Authorization header string authorization header
filter Service Class Support Uber Class Support query string FQL query specifying filter parameters.
limit Service Class Support Uber Class Support query integer Maximum number of records to return.
offset Service Class Support Uber Class Support query string Starting pagination offset of records to return.
parameters Service Class Support Uber Class Support query dictionary Full query parameters payload as a dictionary, not required when using other keywords.
sort Service Class Support Uber Class Support query string Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Usage

Service class example (PEP8 syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.query_release_notes(filter="string",
                                      limit=integer,
                                      offset="string",
                                      sort="string"
                                      )
print(response)
Service class example (Operation ID syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.CombinedReleaseNotesV1(filter="string",
                                         limit=integer,
                                         offset="string",
                                         sort="string"
                                         )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("CombinedReleaseNotesV1", 
                          filter="string",
                          limit=integer,
                          offset="string",
                          sort="string"
                          )
print(response)

Back to Table of Contents

CombinedReleasesV1Mixin0

Queries for releases resources and returns details.

PEP8 method name

query_releases

Endpoint

Method Route
GET /deployment-coordinator/combined/releases/v1

Required Scope

deployment-coordinator:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
✅ Authorization header string authorization header
filter Service Class Support Uber Class Support query string FQL query specifying filter parameters.
limit Service Class Support Uber Class Support query integer Maximum number of records to return.
offset Service Class Support Uber Class Support query string Starting pagination offset of records to return.
parameters Service Class Support Uber Class Support query dictionary Full query parameters payload as a dictionary, not required when using other keywords.
sort Service Class Support Uber Class Support query string Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Usage

Service class example (PEP8 syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.query_releases(filter="string",
                                 limit=integer,
                                 offset="string",
                                 sort="string"
                                 )
print(response)
Service class example (Operation ID syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.CombinedReleasesV1Mixin0(filter="string",
                                           limit=integer,
                                           offset="string",
                                           sort="string"
                                           )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("CombinedReleasesV1Mixin0",
                          filter="string",
                          limit=integer,
                          offset="string",
                          sort="string"
                          )
print(response)

Back to Table of Contents

GetDeploymentsExternalV1

Get deployment resources by IDs.

PEP8 method name

get_deployments

Endpoint

Method Route
GET /deployment-coordinator/entities/deployments/external/v1

Required Scope

deployment-coordinator:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
ids Service Class Support Uber Class Support query array (string) release version ids to retrieve deployment details
parameters Service Class Support Uber Class Support query dictionary Full query parameters payload as a dictionary, not required when using other keywords.

Usage

Service class example (PEP8 syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(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_deployments(ids=id_list)

print(response)
Service class example (Operation ID syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

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

response = falcon.GetDeploymentsExternalV1(ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
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("GetDeploymentsExternalV1", ids=id_list)

print(response)

Back to Table of Contents

GetEntityIDsByQueryPOST

Returns the release notes for the IDs in the request.

PEP8 method name

get_release_notes_v1

Endpoint

Method Route
POST /deployment-coordinator/entities/release-notes/GET/v1

Required Scope

deployment-coordinator:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body Service Class Support Uber Class Support body dictionary Full body payload provided as a dictionary.
ids Service Class Support Uber Class Support body string or list of strings Full body payload provided as a dictionary.

Usage

Service class example (PEP8 syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(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_release_notes(ids=id_list)

print(response)
Service class example (Operation ID syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

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

response = falcon.GetEntityIDsByQueryPOST(ids=id_list)

print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
  "IDs": [
    "string"
  ]
}

response = falcon.command("GetEntityIDsByQueryPOST", body=body_payload)

print(response)

Back to Table of Contents

GetEntityIDsByQueryPOSTV2

Return the release notes for the IDs in the request.

PEP8 method name

get_release_notes

Endpoint

Method Route
POST /fdr/entities/release-notes/GET/v2

Required Scope

deployments:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
body Service Class Support Uber Class Support body dictionary Full body payload in JSON format
ids Service Class Support No Uber Class Support body string or list of strings Release note IDs to be retrieved

Usage

Service class example (PEP8 syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.get_release_notes(ids="string")
print(response)

# Or with multiple IDs
response = falcon.get_release_notes(ids=["id1", "id2", "id3"])
print(response)
Service class example (Operation ID syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.GetEntityIDsByQueryPOSTV2(ids="string")
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "IDs": [
        "string"
    ]
}

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

Back to Table of Contents

QueryReleaseNotesV1

Queries for release-notes resources and returns IDs

PEP8 method name

query_release_note_ids

Endpoint

Method Route
GET /deployment-coordinator/queries/release-notes/v1

Required Scope

deployment-coordinator:read

Content-Type

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

Keyword Arguments

Name Service Uber Type Data type Description
✅ Authorization header string authorization header
filter Service Class Support Uber Class Support query string FQL query specifying filter parameters.
limit Service Class Support Uber Class Support query integer Maximum number of records to return.
offset Service Class Support Uber Class Support query string Starting pagination offset of records to return.
parameters Service Class Support Uber Class Support query dictionary Full query parameters payload as a dictionary, not required when using other keywords.
sort Service Class Support Uber Class Support query string Sort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.

Usage

Service class example (PEP8 syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.query_release_note_ids(filter="string",
                                         limit=integer,
                                         offset="string",
                                         sort="string"
                                         )
print(response)
Service class example (Operation ID syntax)
from falconpy import Deployments

# Do not hardcode API credentials!
falcon = Deployments(client_id=CLIENT_ID,
                     client_secret=CLIENT_SECRET
                     )

response = falcon.QueryReleaseNotesV1(filter="string",
                                      limit=integer,
                                      offset="string",
                                      sort="string"
                                      )
print(response)
Uber class example
from falconpy import APIHarnessV2

# Do not hardcode API credentials!
falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueryReleaseNotesV1",
                          filter="string",
                          limit=integer,
                          offset="string",
                          sort="string"
                          )
print(response)

Back to Table of Contents

⚠️ **GitHub.com Fallback** ⚠️