MinIO

An Integration with MinIO Object Storage.

Database · DevSecOps

Details

IDMinIO
ProviderMinIO Inc
CategoryDatabase
From Version6.0.0
Docker Imagedemisto/py3-tools:1.0.0.114656
Supported ModulesAgentix XSIAM

README

An Integration with MinIO Object Storage
This integration was integrated and tested with RELEASE.2020-12 of MinIO.

Configure MinIO in Cortex

Parameter Description Required
server Server Name or Address (e.g. 8.8.8.8) True
port Port Number True
access_key Access Key True
access_secret Access Secret True
ssl Connect over SSL False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

minio-make-bucket

Create a new bucket.

Base Command

minio-make-bucket

Input

Argument Name Description Required
name Bucket Name. Required

Context Output

Path Type Description
MinIO.Buckets.bucket Unknown MinIO Bucket Name
MinIO.Buckets.status Unknown MinIO Bucket Status

Command Example

!minio-make-bucket name="test20"

Context Example

{
    "MinIO": {
        "Buckets": {
            "bucket": "test20",
            "status": "created"
        }
    }
}

Human Readable Output

Results

bucket status
test20 created

minio-remove-bucket

Remove an existing bucket.

Base Command

minio-remove-bucket

Input

Argument Name Description Required
name Bucket Name. Required

Context Output

Path Type Description
MinIO.Buckets.bucket Unknown MinIO Bucket Name
MinIO.Buckets.status Unknown MinIO Bucket Status

Command Example

!minio-remove-bucket name="test20"

Context Example

{
    "MinIO": {
        "Buckets": {
            "bucket": "test20",
            "status": "removed"
        }
    }
}

Human Readable Output

Results

bucket status
test20 removed

minio-list-buckets

List All MinIO Buckets

Base Command

minio-list-buckets

Input

There are no input arguments for this command.

Context Output

Path Type Description
MinIO.Buckets Unknown MinIO Buckets

Command Example


#### Context Example

```json
{
    "MinIO": {
        "Buckets": [
            {
                "bucket": "opencti-bucket",
                "creation_date": "2020-12-18 17:06:04.887000+00:00"
            },
            {
                "bucket": "test1",
                "creation_date": "2020-12-29 10:54:39.996000+00:00"
            },
            {
                "bucket": "test10",
                "creation_date": "2020-12-29 10:45:46.962000+00:00"
            }
        ]
    }
}

Human Readable Output

Results

bucket creation_date
opencti-bucket 2020-12-18 17:06:04.887000+00:00
test1 2020-12-29 10:54:39.996000+00:00
test10 2020-12-29 10:45:46.962000+00:00

minio-list-objects

Lists object information of a bucket.

Base Command

minio-list-objects

Input

Argument Name Description Required
bucket_name Name of the bucket. Required
prefix Object name starts with prefix. Optional
start_after List objects after this key name. Optional
include_user_meta MinIO specific flag to control to include user metadata. Possible values are: True, False. Optional

Context Output

Path Type Description
MinIO.Objects Unknown MinIO Objects

Command Example

!minio-list-objects bucket_name="test10"

Context Example

{
    "MinIO": {
        "Objects": [
            {
                "bucket": "test10",
                "etag": "4be6f1e4bda138a555416b866a90530c",
                "is_dir": false,
                "last_modified": "2020-12-29 10:46:04.387000+00:00",
                "object": "MINIO_wordmark.png",
                "size": 11496
            },
            {
                "bucket": "test10",
                "etag": "c4e3802707693c8df821b37c91c0cfd8",
                "is_dir": false,
                "last_modified": "2020-12-30 06:10:37.886000+00:00",
                "object": "test.txt",
                "size": 9
            },
            {
                "bucket": "test10",
                "etag": "7a6add52bec4ca39eedeea16927c92e3",
                "is_dir": false,
                "last_modified": "2020-12-30 06:12:33.487000+00:00",
                "object": "test.yml",
                "size": 34960
            }
        ]
    }
}

Human Readable Output

Results

bucket etag is_dir last_modified object size
test10 4be6f1e4bda138a555416b866a90530c false 2020-12-29 10:46:04.387000+00:00 MINIO_wordmark.png 11496
test10 c4e3802707693c8df821b37c91c0cfd8 false 2020-12-30 06:10:37.886000+00:00 test.txt 9
test10 7a6add52bec4ca39eedeea16927c92e3 false 2020-12-30 06:12:33.487000+00:00 test.yml 34960

minio-get-object

Gets data from offset to length of an object.

Base Command

minio-get-object

Input

Argument Name Description Required
bucket_name Bucket Name. Required
name Object Name. Required
offset Start byte position of object data. Optional
length Number of bytes of object data from offset. Possible values are: . Optional
request_headers Any additional headers to be added with GET request. Optional
extra_query_params Extra query parameters for advanced usage. Optional

Context Output

There is no context output for this command.

Command Example

!minio-get-object bucket_name="test10" name="MINIO_wordmark.png"

Context Example

{
    "File": {
        "EntryID": "399@58b146a9-f748-4f65-8846-a1d63c7e77f4",
        "Extension": "png",
        "Info": "image/png",
        "MD5": "4be6f1e4bda138a555416b866a90530c",
        "Name": "MINIO_wordmark.png",
        "SHA1": "568f64faee0471c811e6ef5234428751236f9ad2",
        "SHA256": "d53ad84d5c44a6991b0b6109703aff663d5d016ee93762eaf46624144f1c6fc5",
        "SHA512": "8d5ba7577cd2a98c0a973997978c31700996d54dd76e332a108fdb5a4694e55c7c172c8bae1d1189810b4d766bbffa52c6f1acb599c5679666a4e8368241a710",
        "SSDeep": "192:DBfcNvyaPaOjCOSXA/DA47c6qurTlvUnHjXoRBVaYuKY7BF019UtNB2KBlloHfoe:iB1PaO7SXA/DA47LqqToD6TaYufAcJNq",
        "Size": 11496,
        "Type": "PNG image data, 2401 x 362, 8-bit colormap, non-interlaced"
    }
}

Human Readable Output

minio-stat-object

Get object information and metadata of an object.

Base Command

minio-stat-object

Input

Argument Name Description Required
bucket_name Bucket Name. Required
name Object Name. Required
extra_query_params Extra query parameters for advanced usage. Optional

Context Output

There is no context output for this command.

Command Example

!minio-stat-object bucket_name="test10" name="test.txt"

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test10",
            "content-type": "application/octet-stream",
            "etag": "\"c4e3802707693c8df821b37c91c0cfd8\"",
            "object": "test.txt",
            "size": 9
        }
    }
}

Human Readable Output

Results

bucket content-type etag object size
test10 application/octet-stream “c4e3802707693c8df821b37c91c0cfd8” test.txt 9

minio-remove-object

Remove an object.

Base Command

minio-remove-object

Input

Argument Name Description Required
bucket_name Bucket Name. Required
name Object Name. Required

Context Output

Path Type Description
MinIO.Objects.name Unknown Object Name
MinIO.Objects.status Unknown Object Status

Command Example

!minio-remove-object bucket_name="test10" name="test.txt"

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test10",
            "object": "test.txt",
            "status": "removed"
        }
    }
}

Human Readable Output

Results

bucket object status
test10 test.txt removed

minio-fput-object

Uploads data from a file to an object in a bucket.

Base Command

minio-fput-object

Input

Argument Name Description Required
bucket_name Bucket Name. Possible values are: . Required
entry_id File Entry ID. Required
content_type File Type. Optional
metadata Any additional metadata to be uploaded along with your PUT request. Optional

Context Output

There is no context output for this command.

Command Example

!minio-fput-object bucket_name="test10" entry_id="297@58b146a9-f748-4f65-8846-a1d63c7e77f4"

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test10",
            "object": "test.yml",
            "status": "uploaded"
        }
    }
}

Human Readable Output

Results

bucket object status
test10 test.yml uploaded

minio-put-object

Uploads data from a stream to an object in a bucket.

Base Command

minio-put-object

Input

Argument Name Description Required
bucket_name Bucket Name. Possible values are: . Required
data Contains object data. Required
name Object name in the bucket. Required
content_type File Type. Optional
metadata Any additional metadata to be uploaded along with your PUT request. Optional

Context Output

There is no context output for this command.

Command Example

!minio-put-object bucket_name="test10" data="'test100'" name="test.txt"

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test10",
            "object": "test.txt",
            "status": "uploaded"
        }
    }
}

Human Readable Output

Results

bucket object status
test10 test.txt uploaded

minio-get-tags

Get tags configuration of an object.

Base Command

minio-get-tags

Input

Argument Name Description Required
bucket_name Bucket Name. Required
name Object name in the bucket. Required

Context Output

Path Type Description
MinIO.Objects.bucket Unknown Bucket Name.
MinIO.Objects.object Unknown Object Name.
MinIO.Objects.tags Unknown Object Tags.

Command Example

!minio-get-tags bucket_name="test11" name="test.txt"

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test11",
            "object": "test.txt",
            "status": "completed",
            "tags": {
                "test": "test"
            }
        }
    }
}

minio-set-tag

Set tags configuration to an object.

Base Command

minio-set-tag

Input

Argument Name Description Required
bucket_name Bucket Name. Required
name Object name in the bucket. Required
tag_key Key for the tag to add on the object. Required
tag_value Value for the tag to add on the object. Required

Context Output

Path Type Description
MinIO.Objects.bucket Unknown Bucket Name.
MinIO.Objects.object Unknown Object Name.
MinIO.Objects.tags Unknown Object Tags.

Command Example

!minio-set-tag bucket_name="test11" name="test.txt" tag_key="status" tag_value="in_progress"

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test11",
            "object": "test.txt",
            "status": "completed",
            "tags": {
                "test": "test",
                "status": "in_progress"
            }
        }
    }
}

minio-copy-object

Create an object by server-side copying data from another object.

Base Command

minio-copy-object

Input

Argument Name Description Required
bucket_name_src Bucket Name to copy object from. Required
name_src Object name to copy. Required
bucket_name_dst Bucket Name to copy object to. Required
name_dst Object name copied. Required
metadata Any user-defined metadata to be copied along with destination object. Optional

Context Output

Path Type Description
MinIO.Objects.bucket Unknown Bucket Name.
MinIO.Objects.object Unknown Object Name
MinIO.Objects.status Unknown Object Status

Command Example

!minio-copy-object bucket_name_src="test12" name_src="test_source.txt" bucket_name_dst="test12" name_dst="test_destination.txt"

!minio-copy-object bucket_name_src="test12" name_src="test_source.txt" bucket_name_dst="test12" name_dst="myFolder/test_destination.txt" (It will create the folder myFolder)

Context Example

{
    "MinIO": {
        "Objects": {
            "bucket": "test12",
            "object": "test_destination.txt",
            "status": "copied"
        }
    }
}

Configuration parameters

  • server — Server Name or Address (e.g. 8.8.8.8) (required)
  • port — Port Number (required)
  • access_key — Access Key (required)
  • access_secret — Access Secret (required)
  • ssl — Connect over SSL

Commands (12)

  • minio-copy-object

    Create an object by server-side copying data from another object.

  • minio-fput-object

    Uploads data from a file to an object in a bucket.

  • minio-get-object

    Gets data from offset to length of an object.

  • minio-get-tags

    Get tags configuration of an object.

  • minio-list-buckets

    List All MinIO Buckets.

  • minio-list-objects

    Lists object information of a bucket.

  • minio-make-bucket

    Create a new bucket.

  • minio-put-object

    Uploads data from a stream to an object in a bucket.

  • minio-remove-bucket

    Remove an existing bucket.

  • minio-remove-object

    Remove an object.

  • minio-set-tag

    Set tags configuration to an object.

  • minio-stat-object

    Get object information and metadata of an object.

Source

MinIO.py MinIO.yml MinIO_description.md command_examples.txt
Download History Raw 
category: Database
provider: MinIO Inc
commonfields:
  id: MinIO
  version: -1
configuration:
- display: Server Name or Address (e.g. 8.8.8.8)
  name: server
  required: true
  type: 0
- defaultvalue: '9000'
  display: Port Number
  name: port
  required: true
  type: 0
- display: Access Key
  name: access_key
  required: true
  type: 4
- display: Access Secret
  name: access_secret
  required: true
  type: 4
- display: Connect over SSL
  name: ssl
  type: 8
  required: false
description: An Integration with MinIO Object Storage.
display: MinIO
name: MinIO
script:
  commands:
  - arguments:
    - description: Bucket Name.
      name: name
      required: true
    description: Create a new bucket.
    name: minio-make-bucket
    outputs:
    - contextPath: MinIO.Buckets.bucket
      description: MinIO Bucket Name.
      type: Unknown
    - contextPath: MinIO.Buckets.status
      description: MinIO Bucket Status.
      type: Unknown
  - arguments:
    - description: Bucket Name.
      name: name
      required: true
    description: Remove an existing bucket.
    name: minio-remove-bucket
    outputs:
    - contextPath: MinIO.Buckets.bucket
      description: MinIO Bucket Name.
      type: Unknown
    - contextPath: MinIO.Buckets.status
      description: MinIO Bucket Status.
      type: Unknown
  - description: List All MinIO Buckets.
    name: minio-list-buckets
    outputs:
    - contextPath: MinIO.Buckets
      description: MinIO Buckets.
      type: Unknown
  - arguments:
    - description: Name of the bucket.
      name: bucket_name
      required: true
    - description: Object name starts with prefix.
      name: prefix
    - description: List objects after this key name.
      name: start_after
    - auto: PREDEFINED
      description: MinIO specific flag to control to include user metadata.
      name: include_user_meta
      predefined:
      - 'True'
      - 'False'
    description: Lists object information of a bucket.
    name: minio-list-objects
    outputs:
    - contextPath: MinIO.Objects
      description: MinIO Objects.
      type: Unknown
  - arguments:
    - description: Bucket Name.
      name: bucket_name
      required: true
    - description: Object Name.
      name: name
      required: true
    - description: Start byte position of object data.
      name: offset
    - description: Number of bytes of object data from offset.
      name: length
    - description: Any additional headers to be added with GET request.
      name: request_headers
    - description: Extra query parameters for advanced usage.
      name: extra_query_params
    description: Gets data from offset to length of an object.
    name: minio-get-object
  - arguments:
    - description: Bucket Name.
      name: bucket_name
      required: true
    - description: Object Name.
      name: name
      required: true
    - description: Extra query parameters for advanced usage.
      name: extra_query_params
    description: Get object information and metadata of an object.
    name: minio-stat-object
  - arguments:
    - description: Bucket Name.
      name: bucket_name
      required: true
    - description: Object Name.
      name: name
      required: true
    description: Remove an object.
    name: minio-remove-object
    outputs:
    - contextPath: MinIO.Objects.name
      description: Object Name.
      type: Unknown
    - contextPath: MinIO.Objects.status
      description: Object Status.
      type: Unknown
  - arguments:
    - description: Bucket Name.
      name: bucket_name
      required: true
    - description: File Entry ID.
      name: entry_id
      required: true
    - description: File Type.
      name: content_type
    - description: Any additional metadata to be uploaded along with your PUT request.
      name: metadata
    description: Uploads data from a file to an object in a bucket.
    name: minio-fput-object
  - arguments:
    - description: Bucket Name.
      name: bucket_name
      required: true
    - description: Contains object data.
      name: data
      required: true
    - description: Object name in the bucket.
      name: name
      required: true
    - description: File Type.
      name: content_type
    - description: Any additional metadata to be uploaded along with your PUT request.
      name: metadata
    description: Uploads data from a stream to an object in a bucket.
    name: minio-put-object
  - name: minio-copy-object
    arguments:
    - name: bucket_name_src
      description: Bucket Name Source.
      required: true
    - name: name_src
      description: Object Name Source.
      required: true
    - name: bucket_name_dst
      description: Bucket Name Destination.
      required: true
    - name: name_dst
      description: Object Name Destination.
      required: true
    - name: metadata
      description: Any additional metadata to be copied.
    outputs:
    - contextPath: MinIO.Objects.bucket
      description: MinIO Destination Bucket Name.
    - contextPath: MinIO.Objects.object
      description: MinIO Destination Object Name.
    - contextPath: MinIO.Objects.status
      description: MinIO Object status.
    description: Create an object by server-side copying data from another object.
  - name: minio-get-tags
    arguments:
    - name: bucket_name
      description: Bucket Name.
      required: true
    - name: name
      description: Object Name.
      required: true
    outputs:
    - contextPath: MinIO.Objects.bucket
      description: MinIO Bucket Name.
    - contextPath: MinIO.Objects.object
      description: MinIO Object Name.
    - contextPath: MinIO.Objects.tags
      description: MinIO Object Tags.
    description: Get tags configuration of an object.
  - name: minio-set-tag
    arguments:
    - name: bucket_name
      description: Bucket Name.
      required: true
    - name: name
      description: Object Name.
      required: true
    - name: tag_key
      description: Key for the tag.
      required: true
    - name: tag_value
      description: Value for the tag.
      required: true
    outputs:
    - contextPath: MinIO.Objects.bucket
      description: MinIO Bucket Name.
    - contextPath: MinIO.Objects.object
      description: MinIO Object Name.
    - contextPath: MinIO.Objects.tags
      description: MinIO Object Tags.
    description: Set tags configuration to an object.
  dockerimage: demisto/py3-tools:1.0.0.114656
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- No tests (auto formatted)
fromversion: 6.0.0