Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

The classic playbook editor will be deprecated in early 2025. Convert your classic playbooks to modern mode.
After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:

REST Vault

/rest/vault_document

Get a list of vault documents.

Syntax

https://<username>:<password>@<host>/rest/vault_document

GET

Fetch a list of vault documents.

Example
A successful GET returns a list of vault documents.

{
    "count": 2,
    "num_pages": 1,
    "data": [
        {
            "tags": [],
            "id": 1,
            "contains": [
                "vault id"
            ],
            "first_seen_time": "2020-10-02T16:40:14.180537Z",
            "hash": "71b20ece47a85e9567225a1e25bfac827454f9ce",
            "meta": {
                "md5": "22b60c8b3bdf157772ccde6afd6d909a",
                "sha1": "71b20ece47a85e9567225a1e25bfac827454f9ce",
                "size": 42842,
                "sha256": "95c9a949ccb5e3b5337a4294df0830d5c12c7eec4995024f92153bd4e5a3c17c",
                "contains": [
                    "vault id"
                ]
            },
            "names": [
                "electric-plug.png"
            ],
            "sources": [
                {
                    "user_id": 3
                },
                {
                    "user_id": 3
                }
            ],
            "size": 42842,
            "version": 1,
            "deleted": false
        },
        {
            "tags": [],
            "id": 2,
            "contains": [
                "vault id"
            ],
            "first_seen_time": "2020-10-02T16:40:53.862877Z",
            "hash": "8526180d1f10a67de16b3f2bece163cb3c039cfd",
            "meta": {
                "md5": "82e658dff169edb23c29cdf6373d3e82",
                "sha1": "8526180d1f10a67de16b3f2bece163cb3c039cfd",
                "size": 484897,
                "sha256": "bfdc5bd10f344f4cb36c47f72a308deadbfa2ae4552f329509c0b6896a790fc8",
                "contains": [
                    "vault id"
                ]
            },
            "names": [
                "Screen Shot 2020-09-23 at 12.02.17 PM.png"
            ],
            "sources": [
                {
                    "user_id": 3
                }
            ],
            "size": 484897,
            "version": 1,
            "deleted": false
        }
    ]
}

Use the page filter to control how many documents you want to show at a time. For example, to see 10 records at a time use page_size.

Example request

/rest/vault_document?page_size=10

To choose which 10 records to display out of a list of 100, add page to the request:

Example request

/rest/vault_document?page_size=10&page=0
/rest/vault_document?page_size=10&page=1

/rest/vault_document/1

Fetch an individual vault document.

Syntax

https://<username>:<password>@<host>/rest/vault_document/1

GET

Fetch an individual vault document.

Example
A successful GET returns the individual vault document.

{
    "tags": [],
    "id": 1,
    "contains": [
        "vault id"
    ],
    "first_seen_time": "2020-10-02T16:40:14.180537Z",
    "hash": "71b20ece47a85e9567225a1e25bfac827454f9ce",
    "meta": {
        "md5": "22b60c8b3bdf157772ccde6afd6d909a",
        "sha1": "71b20ece47a85e9567225a1e25bfac827454f9ce",
        "size": 42842,
        "sha256": "95c9a949ccb5e3b5337a4294df0830d5c12c7eec4995024f92153bd4e5a3c17c",
        "contains": [
            "vault id"
        ]
    },
    "names": [
        "electric-plug.png"
    ],
    "sources": [
        {
            "user_id": 3
        },
        {
            "user_id": 3
        }
    ],
    "size": 42842,
    "version": 1,
    "deleted": false
}
Last modified on 27 February, 2024
REST Search   REST Warm standby

This documentation applies to the following versions of Splunk® SOAR (On-premises): 6.0.0, 6.0.1, 6.0.2, 6.1.0, 6.1.1, 6.2.0, 6.2.1, 6.2.2, 6.3.0


Was this topic useful?







You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters