Custom Storage

Using the Custom Storage service collection

Table of Contents

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

Method	Route
	/customobjects/v1/collections

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
end			query	string	The end key to end listing to.
limit			query	integer	The limit of results to return.
parameters			query	dictionary	Full query string parameters payload in JSON format.
start			query	string	The 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

Method	Route
	/customobjects/v1/collections

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
names			query	array (string)	A set of collection names.
parameters			query	dictionary	Full 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

Method	Route
	/customobjects/v1/collections/{collection_name}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/objects

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
end			query	string	The end key to end listing to
limit			query	integer	The limit of results to return
parameters			query	dictionary	Full query string parameters payload in JSON format.
start			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/objects

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
filter			query	string	The filter to limit the returned results.
limit			query	integer	The limit of results to return
offset			query	integer	The offset of results to return
parameters			query	dictionary	Full query string parameters payload in JSON format.
sort			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/objects/{object_key}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
object_key			path	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/objects/{object_key}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	The object to be uploaded in binary format.
collection_name			path	string	The name of the collection.
dry_run			query	boolean	If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_key			path	string	The object key.
parameters			query	dictionary	Full query string parameters payload in JSON format.
schema_version			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/objects/{object_key}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
dry_run			query	boolean	If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_key			path	string	The object key
parameters			query	dictionary	Full 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

Method	Route
	/customobjects/v1/collections/{collection_name}/objects/{object_key}/metadata

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
object_key			path	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/schemas

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection.
	end			query	string
	limit			query	integer
parameters			query	dictionary	Full query string parameters payload in JSON format.
start			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/schemas/{schema_version}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
schema_version			path	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/schemas/{schema_version}/metadata

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection.
schema_version			path	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/{collection_version}/objects

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
collection_version			path	string	The version of the collection
end			query	string	The end key to end listing to
limit			query	integer	The limit of results to return
parameters			query	dictionary	Full query string parameters payload in JSON format.
start			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/{collection_version}/objects

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
collection_version			path	string	The version of the collection
filter			query	string	The filter to limit the returned results.
limit			query	integer	The limit of results to return
offset			query	integer	The offset of results to return
parameters			query	dictionary	Full query string parameters payload in JSON format.
sort			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
collection_version			path	string	The version of the collection
object_key			path	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
body			body	string	The object to be uploaded in binary format.
collection_name			path	string	The name of the collection.
collection_version			path	string	The version of the collection.
dry_run			query	boolean	If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_key			path	string	The object key.
parameters			query	dictionary	Full query string parameters payload in JSON format.
schema_version			query	string	The 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

Method	Route
	/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
collection_version			path	string	The version of the collection
dry_run			query	boolean	If false, run the operation as normal. If true, validate that the request would succeed, but don't execute it.
object_key			path	string	The object key
parameters			query	dictionary	Full 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

Method	Route
	/customobjects/v1/collections/{collection_name}/{collection_version}/objects/{object_key}/metadata

Required Scope

Content-Type

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

Keyword Arguments

Name	Service	Uber	Type	Data type	Description
collection_name			path	string	The name of the collection
collection_version			path	string	The version of the collection
object_key			path	string	The 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