CrowdStrike Falcon CrowdStrike Subreddit

Using the Custom Storage service collection

Uber class support Service class support Documentation Version Page Updated

Table of Contents

Operation IDDescription
ListCollections
PEP 8list_collections
List available collection names in alphabetical order.
DescribeCollections
PEP 8describe_collections
Fetch metadata about one or more existing collections.
DescribeCollection
PEP 8describe_collection
Fetch metadata about an existing collection.
ListObjects
PEP 8list
List the object keys in the specified collection in alphabetical order.
SearchObjects
PEP 8search
Search for objects that match the specified filter criteria (returns metadata, not actual objects).
GetObject
PEP 8get
Get the bytes for the specified object.
PutObject
PEP 8upload
Put the specified new object at the given key or overwrite an existing object at the given key.
DeleteObject
PEP 8delete
Delete the specified object.
GetObjectMetadata
PEP 8metadata
Get the metadata for the specified object.
ListSchemas
PEP 8list_schemas
Get the list of schemas for the requested collection in reverse version order (latest first).
GetSchema
PEP 8get_schema
Get the bytes of the specified schema of the requested collection.
GetSchemaMetadata
PEP 8schema_metadata
Get the metadata for the specified schema of the requested collection.
ListObjectsByVersion
PEP 8list_by_version
List the object keys in the specified collection in alphabetical order.
SearchObjectsByVersion
PEP 8search_by_version
Search for objects that match the specified filter criteria (returns metadata, not actual objects).
GetVersionedObject
PEP 8get_version
Get the bytes for the specified object.
PutObjectByVersion
PEP 8upload_version
Put the specified new object at the given key or overwrite an existing object at the given key.
DeleteVersionedObject
PEP 8delete_version
Delete the specified versioned object.
GetVersionedObjectMetadata
PEP 8version_metadata
Get the metadata for the specified object.

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.

ListCollections

List available collection names in alphabetical order.

PEP8 method name

list_collections

Endpoint

MethodRoute
GET/customobjects/v1/collections

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
endService Class SupportUber Class SupportquerystringThe end key to end listing to.
limitService Class SupportUber Class SupportqueryintegerThe limit of results to return.
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
startService Class SupportUber Class SupportquerystringThe start key to start listing from.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.list_collections(end="string",
                                   limit=integer,
                                   start="string"
                                   )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.ListCollections(end="string",
                                  limit=integer,
                                  start="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("ListCollections",
                          end="string",
                          limit=integer,
                          start="string"
                          )
print(response)

Back to Table of Contents

DescribeCollections

Fetch metadata about one or more existing collections.

PEP8 method name

describe_collections

Endpoint

MethodRoute
PUT/customobjects/v1/collections

Required Scope

custom-storage:read

Content-Type

  • Consumes: application/octet-stream
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
namesService Class SupportUber Class Supportqueryarray (string)A set of collection names.
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

# Do not hardcode API credentials!
falcon = CustomStorage(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )
name_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.describe_collections(names=name_list)

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

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

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

response = falcon.DescribeCollections(names=name_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
                      )

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

response = falcon.command("DescribeCollections", names=name_list)

print(response)

Back to Table of Contents

DescribeCollection

Fetch metadata about an existing collection.

PEP8 method name

describe_collection

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.describe_collection(collection_name="string")

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

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

response = falcon.DescribeCollection(collection_name="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("DescribeCollection", collection_name="string")

print(response)

Back to Table of Contents

ListObjects

List the object keys in the specified collection in alphabetical order

PEP8 method name

list

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/objects

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
endService Class SupportUber Class SupportquerystringThe end key to end listing to
limitService Class SupportUber Class SupportqueryintegerThe limit of results to return
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
startService Class SupportUber Class SupportquerystringThe start key to start listing from

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.list(end="string",
                       limit=integer,
                       start="string",
                       collection_name="string"
                       )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.ListObjects(end="string",
                              limit=integer,
                              start="string",
                              collection_name="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("ListObjects",
                          end="string"
                          limit=integer,
                          start="string",
                          collection_name="string"
                          )
print(response)

Back to Table of Contents

SearchObjects

Search for objects that match the specified filter criteria (returns metadata, not actual objects)

PEP8 method name

search

Endpoint

MethodRoute
POST/customobjects/v1/collections/{collection_name}/objects

Required Scope

custom-storage:read

Content-Type

  • Consumes: application/octet-stream
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
filterService Class SupportUber Class SupportquerystringThe filter to limit the returned results.
limitService Class SupportUber Class SupportqueryintegerThe limit of results to return
offsetService Class SupportUber Class SupportqueryintegerThe offset of results to return
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
sortService Class SupportUber Class SupportquerystringThe sort order for the returned results.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

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

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

response = falcon.SearchObjects(filter="string",
                                limit=integer,
                                offset=integer,
                                sort="string",
                                collection_name="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("SearchObjects",
                          filter="string",
                          limit=integer,
                          offset=integer,
                          sort="string",
                          collection_name="string"
                          )
print(response)

Back to Table of Contents

GetObject

Get the bytes for the specified object

PEP8 method name

get

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/objects/{object_key}

Required Scope

custom-storage:read

Content-Type

  • Consumes: application/json
  • Produces: application/octet-stream

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
object_keyService Class SupportUber Class SupportpathstringThe object key

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

with open("some_file.ext", "wb", encoding="utf-8") as save_file:
    save_file.write(falcon.get(collection_name="string", object_key="string"))
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

with open("some_file.ext", "wb", encoding="utf-8") as save_file:
    save_file.write(falcon.GetObject(collection_name="string", object_key="string"))
Uber class example
from falconpy import APIHarnessV2

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

with open("some_file.ext", "wb", encoding="utf-8") as save_file:
    save_file.write(falcon.command("GetObject", collection_name="string", object_key="string"))

Back to Table of Contents

PutObject

Put the specified new object at the given key or overwrite an existing object at the given key

PEP8 method name

upload

Endpoint

MethodRoute
PUT/customobjects/v1/collections/{collection_name}/objects/{object_key}

Required Scope

custom-storage:write

Content-Type

  • Consumes: application/octet-stream
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
bodyService Class SupportUber Class SupportbodystringThe object to be uploaded in binary format.
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection.
dry_runService Class SupportUber Class SupportquerybooleanIf false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_keyService Class SupportUber Class SupportpathstringThe object key.
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
schema_versionService Class SupportUber Class SupportquerystringThe version of the collection schema.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

# Do not hardcode API credentials!
falcon = CustomStorage(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )
with open("some_file.ext", "rb") as upload_file:
    response = falcon.upload(body=upload_file.read(),
                             collection_name="string",
                             dry_run=boolean,
                             object_key="string",
                             schema_version="string"
                             )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

# Do not hardcode API credentials!
falcon = CustomStorage(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )
with open("some_file.ext", "rb") as upload_file:
    response = falcon.PutObject(body=upload_file.read(),
                                collection_name="string",
                                dry_run=boolean,
                                object_key="string",
                                schema_version="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
                      )

with open("some_file.ext", "rb") as upload_file:
    response = falcon.command("PutObject",
                              body=upload_file.read(),
                              collection_name="string",
                              dry_run=boolean,
                              object_key="string",
                              schema_version="string"
                              )
print(response)

Back to Table of Contents

DeleteObject

Delete the specified object

PEP8 method name

delete

Endpoint

MethodRoute
DELETE/customobjects/v1/collections/{collection_name}/objects/{object_key}

Required Scope

custom-storage:write

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
dry_runService Class SupportUber Class SupportquerybooleanIf false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_keyService Class SupportUber Class SupportpathstringThe object key
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.delete(collection_name="string", object_key="string", dry_run=boolean)

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

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

response = falcon.DeleteObject(collection_name="string", object_key="string", dry_run=boolean)

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("DeleteObject",
                          collection_name="string",
                          object_key="string",
                          dry_run=boolean
                          )
print(response)

Back to Table of Contents

GetObjectMetadata

Get the metadata for the specified object

PEP8 method name

metadata

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/objects/{object_key}/metadata

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
object_keyService Class SupportUber Class SupportpathstringThe object key

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.metadata(collection_name="string", object_key="string")
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.GetObjectMetadata(collection_name="string", object_key="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("GetObjectMetadata", collection_name="string", object_key="string")
print(response)

Back to Table of Contents

ListSchemas

Get the list of schemas for the requested collection in reverse version order (latest first).

PEP8 method name

list_schemas

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/schemas

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection.
endService Class SupportUber Class Supportquerystring
limitService Class SupportUber Class Supportqueryinteger
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
startService Class SupportUber Class SupportquerystringThe start key to start listing from.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.list_schemas(end="string",
                               limit=integer,
                               start="string"
                               )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.ListSchemas(end="string",
                              limit=integer,
                              start="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("ListSchemas",
                          end="string",
                          limit=integer,
                          start="string"
                          )
print(response)

Back to Table of Contents

GetSchema

Get the bytes of the specified schema of the requested collection.

PEP8 method name

get_schema

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/schemas/{schema_version}

Required Scope

custom-storage:read

Content-Type

  • Consumes: application/json
  • Produces: application/octet-stream

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
schema_versionService Class SupportUber Class SupportpathstringThe version of the collection schema or 'latest' for the latest version

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

save_file = "some_file.ext"
with open(save_file, "wb") as file_output:
    file_output.write(falcon.get_schema(collection_name="string", schema_version="string"))
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

save_file = "some_file.ext"
with open(save_file, "wb") as file_output:
    file_output.write(falcon.GetSchema(collection_name="string", schema_version="string"))
Uber class example
from falconpy import APIHarnessV2

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

save_file = "some_file.ext"
with open(save_file, "wb") as file_output:
    file_output.write(falcon.command("GetSchema", collection_name="string", schema_version="string"))

Back to Table of Contents

GetSchemaMetadata

Get the metadata for the specified schema of the requested collection.

PEP8 method name

schema_metadata

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/schemas/{schema_version}/metadata

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection.
schema_versionService Class SupportUber Class SupportpathstringThe version of the collection schema or 'latest' for the latest version.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.schema_metadata(collection_name="string", schema_version="string")

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

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

response = falcon.GetSchemaMetadata(collection_name="string", schema_version="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("GetSchemaMetadata", collection_name="string", schema_version="string")

print(response)

Back to Table of Contents

ListObjectsByVersion

List the object keys in the specified collection in alphabetical order

PEP8 method name

list_by_version

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/{collection_version}/objects

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
collection_versionService Class SupportUber Class SupportpathstringThe version of the collection
endService Class SupportUber Class SupportquerystringThe end key to end listing to
limitService Class SupportUber Class SupportqueryintegerThe limit of results to return
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
startService Class SupportUber Class SupportquerystringThe start key to start listing from

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.list_by_version(end="string",
                                  limit=integer,
                                  start="string",
                                  collection_name="string",
                                  collection_version="string"
                                  )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.ListObjectsByVersion(end="string",
                                       limit=integer,
                                       start="string",
                                       collection_name="string",
                                       collection_version="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("ListObjectsByVersion",
                          end="string"
                          limit=integer,
                          start="string",
                          collection_name="string",
                          collection_version="string"
                          )
print(response)

Back to Table of Contents

SearchObjectsByVersion

Search for objects that match the specified filter criteria (returns metadata, not actual objects)

PEP8 method name

search_by_version

Endpoint

MethodRoute
POST/customobjects/v1/collections/{collection_name}/{collection_version}/objects

Required Scope

custom-storage:read

Content-Type

  • Consumes: application/octet-stream
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
collection_versionService Class SupportUber Class SupportpathstringThe version of the collection
filterService Class SupportUber Class SupportquerystringThe filter to limit the returned results.
limitService Class SupportUber Class SupportqueryintegerThe limit of results to return
offsetService Class SupportUber Class SupportqueryintegerThe offset of results to return
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
sortService Class SupportUber Class SupportquerystringThe sort order for the returned results.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

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

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

response = falcon.SearchObjectsByVersion(filter="string",
                                         limit=integer,
                                         offset=integer,
                                         sort="string",
                                         collection_name="string",
                                         collection_version="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("SearchObjectsByVersion",
                          filter="string",
                          limit=integer,
                          offset=integer,
                          sort="string",
                          collection_name="string",
                          collection_version="string"
                          )
print(response)

Back to Table of Contents

GetVersionedObject

Get the bytes for the specified object

PEP8 method name

get_version

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}

Required Scope

custom-storage:read

Content-Type

  • Consumes: application/json
  • Produces: application/octet-stream

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
collection_versionService Class SupportUber Class SupportpathstringThe version of the collection
object_keyService Class SupportUber Class SupportpathstringThe object key

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

with open("some_file.ext", "wb", encoding="utf-8") as save_file:
    save_file.write(falcon.get(collection_name="string",
                               collection_version="string",
                               object_key="string"
                               ))
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

with open("some_file.ext", "wb", encoding="utf-8") as save_file:
    save_file.write(falcon.GetObject(collection_name="string",
                                     collection_version="string",
                                     object_key="string"
                                     ))
Uber class example
from falconpy import APIHarnessV2

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

with open("some_file.ext", "wb", encoding="utf-8") as save_file:
    save_file.write(falcon.command("GetObject",
                                   collection_name="string",
                                   collection_version="string",
                                   object_key="string"
                                   ))

Back to Table of Contents

PutObjectByVersion

Put the specified new object at the given key or overwrite an existing object at the given key

PEP8 method name

upload_version

Endpoint

MethodRoute
PUT/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}

Required Scope

custom-storage:write

Content-Type

  • Consumes: application/octet-stream
  • Produces: application/json

Keyword Arguments

NameServiceUberTypeData typeDescription
bodyService Class SupportUber Class SupportbodystringThe object to be uploaded in binary format.
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection.
collection_versionService Class SupportUber Class SupportpathstringThe version of the collection.
dry_runService Class SupportUber Class SupportquerybooleanIf false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_keyService Class SupportUber Class SupportpathstringThe object key.
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.
schema_versionService Class SupportUber Class SupportquerystringThe version of the collection schema.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

# Do not hardcode API credentials!
falcon = CustomStorage(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )
with open("some_file.ext", "rb") as upload_file:
    response = falcon.upload(body=upload_file.read(),
                             collection_name="string",
                             collection_version="string",
                             dry_run=boolean,
                             object_key="string",
                             schema_version="string"
                             )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

# Do not hardcode API credentials!
falcon = CustomStorage(client_id=CLIENT_ID,
                       client_secret=CLIENT_SECRET
                       )
with open("some_file.ext", "rb") as upload_file:
    response = falcon.PutObject(body=upload_file.read(),
                                collection_name="string",
                                collection_version="string",
                                dry_run=boolean,
                                object_key="string",
                                schema_version="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
                      )

with open("some_file.ext", "rb") as upload_file:
    response = falcon.command("PutObject",
                              body=upload_file.read(),
                              collection_name="string",
                              collection_version="string",
                              dry_run=boolean,
                              object_key="string",
                              schema_version="string"
                              )
print(response)

Back to Table of Contents

DeleteVersionedObject

Delete the specified versioned object

PEP8 method name

delete_version

Endpoint

MethodRoute
DELETE/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}

Required Scope

custom-storage:write

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
collection_versionService Class SupportUber Class SupportpathstringThe version of the collection
dry_runService Class SupportUber Class SupportquerybooleanIf false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_keyService Class SupportUber Class SupportpathstringThe object key
parametersService Class SupportUber Class SupportquerydictionaryFull query string parameters payload in JSON format.

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.delete_version(collection_name="string",
                                 collection_version="string",
                                 object_key="string",
                                 dry_run=boolean
                                 )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.DeleteVersionedObject(collection_name="string",
                                        collection_version="string",
                                        object_key="string",
                                        dry_run=boolean
                                        )
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("DeleteVersionedObject",
                          collection_name="string",
                          collection_version="string",
                          object_key="string",
                          dry_run=boolean
                          )
print(response)

Back to Table of Contents

GetVersionedObjectMetadata

Get the metadata for the specified object

PEP8 method name

version_metadata

Endpoint

MethodRoute
GET/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}/metadata

Required Scope

custom-storage:read

Content-Type

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

Keyword Arguments

NameServiceUberTypeData typeDescription
collection_nameService Class SupportUber Class SupportpathstringThe name of the collection
collection_versionService Class SupportUber Class SupportpathstringThe version of the collection
object_keyService Class SupportUber Class SupportpathstringThe object key

Usage

Service class example (PEP8 syntax)
from falconpy import CustomStorage

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

response = falcon.version_metadata(collection_name="string",
                                   collection_version="string",
                                   object_key="string"
                                   )
print(response)
Service class example (Operation ID syntax)
from falconpy import CustomStorage

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

response = falcon.GetVersionedObjectMetadata(collection_name="string",
                                             collection_version="string",
                                             object_key="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("GetVersionedObjectMetadata",
                          collection_name="string",
                          collection_version="string",
                          object_key="string"
                          )
print(response)

Back to Table of Contents