Skip to content

Deployments

The Deployments service collection provides operations for querying deployment and release information. Retrieve deployment resources by ID, query release notes and releases, and search for release-note IDs using FQL filters.

LanguageLast Update
Pythonv1.5.4
PowerShellv2.2.9
Gov0.20.0
TypeScriptv0.6.0
Rustv0.7.0
Rubyv1.2.0
OperationDescription
CombinedReleaseNotesV1
query_release_notes
Queries for releases resources and returns details.
CombinedReleasesV1Mixin0
query_releases
Queries for releases resources and returns details.
GetDeploymentsExternalV1
get_deployments
Get deployment resources by IDs.
GetEntityIDsByQueryPOST
get_release_notes_v1
Returns the release notes for the IDs in the request.
GetEntityIDsByQueryPOSTV2
get_release_notes
Get entity IDs by query (v2).
QueryReleaseNotesV1
query_release_note_ids
Queries for release-notes resources and returns IDs.

Queries for release-notes resources and returns details.

GET /deployment-coordinator/combined/release-notes/v1
Scope Deployment Coordinator: READ Consumes · Produces application/json
PEP 8 query_release_notes
NameTypeData typeDescription
AuthorizationheaderstringAuthorization header.
filterquerystringFQL query specifying filter parameters.
limitqueryintegerMaximum number of records to return.
offsetquerystringStarting pagination offset of records to return.
parametersquerydictionaryFull query parameters payload as a dictionary, not required when using other keywords.
sortquerystringSort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
from falconpy import Deployments
falcon = Deployments(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_release_notes(filter="string",
limit=integer,
offset=integer,
sort=["string"])
print(response)

Queries for releases resources and returns details.

GET /deployment-coordinator/combined/releases/v1
Scope Deployment Coordinator: READ Consumes · Produces application/json
PEP 8 query_releases
NameTypeData typeDescription
AuthorizationheaderstringAuthorization header.
filterquerystringFQL query specifying filter parameters.
limitqueryintegerMaximum number of records to return.
offsetquerystringStarting pagination offset of records to return.
parametersquerydictionaryFull query parameters payload as a dictionary, not required when using other keywords.
sortquerystringSort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
from falconpy import Deployments
falcon = Deployments(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_releases(filter="string",
limit=integer,
offset=integer,
sort=["string"])
print(response)

Get deployment resources by IDs.

GET /deployment-coordinator/entities/deployments/external/v1
Scope Deployment Coordinator: READ Consumes · Produces application/json
PEP 8 get_deployments
NameTypeData typeDescription
idsqueryarray (string)Release version ids to retrieve deployment details.
parametersquerydictionaryFull query parameters payload as a dictionary, not required when using other keywords.
from falconpy import Deployments
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)

Returns the release notes for the IDs in the request.

POST /deployment-coordinator/entities/release-notes/GET/v1
Scope Deployment Coordinator: READ Consumes · Produces application/json
PEP 8 get_release_notes_v1
NameTypeData typeDescription
bodybodydictionaryFull body payload provided as a dictionary.
idsbodystring or list of stringsFull body payload provided as a dictionary.
from falconpy import Deployments
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_v1(ids=id_list)
print(response)

Return the release notes for the IDs in the request.

POST /fdr/entities/release-notes/GET/v2
Scope Deployments: READ Consumes · Produces application/json
PEP 8 get_release_notes
NameTypeData typeDescription
bodybodydictionaryFull body payload in JSON format.
idsbodystring or list of stringsRelease note IDs to be retrieved.
from falconpy import Deployments
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)

Queries for release-notes resources and returns IDs.

GET /deployment-coordinator/queries/release-notes/v1
Scope Deployment Coordinator: READ Consumes · Produces application/json
PEP 8 query_release_note_ids
NameTypeData typeDescription
AuthorizationheaderstringAuthorization header.
filterquerystringFQL query specifying filter parameters.
limitqueryintegerMaximum number of records to return.
offsetquerystringStarting pagination offset of records to return.
parametersquerydictionaryFull query parameters payload as a dictionary, not required when using other keywords.
sortquerystringSort items by providing a comma separated list of property and direction (eg name.desc,time.asc). If direction is omitted, defaults to descending.
from falconpy import Deployments
falcon = Deployments(client_id=CLIENT_ID,
client_secret=CLIENT_SECRET
)
response = falcon.query_release_note_ids(filter="string",
limit=integer,
offset=integer,
sort=["string"])
print(response)