Splunk® SOAR (On-premises)

REST API Reference for Splunk SOAR (On-premises)

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

REST Tenant

The tenant API allows you to get information about configured tenants on your deployment. Multi-tenancy is only supported for on premises deployments of Splunk SOAR.

/rest/tenant

Get information about the tenants configured on the deployment.

For information on configuring multi-tenancy, see Configure multiple tenants on your Splunk SOAR (On-premises) instance.

Syntax

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

GET

Get a list of all configured tenants.

Example request
Get a list of tenants, using paging parameters.

curl -k -u admin:changeme https://localhost/rest/note?page_size=5&page=0 -G -X GET

Example response
A successful GET will return a 200 response, and a JSON formatted list of tenants. This example has multi-tenancy turned on, but only the default tenant is configured.

{
    "count": 1,
    "num_pages": 1,
    "data": [
        {
            "id": 0,
            "name": "Default",
            "description": "This is the default system tenant.",
            "contact": "contact name",
            "disabled": false,
            "slas": {
                "high": 60,
                "medium": 720,
                "low": 1440
            },
            "executive_approvers": null,
            "sla_expiry_warning_in_mins": null,
            "environment_variables": {}
        }
    ]
}
Last modified on 23 November, 2021
PREVIOUS
REST Workbook
 

This documentation applies to the following versions of Splunk® SOAR (On-premises): 5.0.1, 5.1.0, 5.2.1, 5.3.1, 5.3.2, 5.3.3, 5.3.4


Was this documentation topic helpful?


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