List instances
Retrieves a list of all instances
that belong to the TSG identified in the access
token used to authorize this request. Optionally retrieves a list of all instances
belonging to this TSG's descendents.
An instance
is a tenant with an allocated license.
Query Parameters
- with_children string
Possible values: [
true
,false
]This parameter with any value causes this request to also return
instances
belonging to descendent TSGs. If this parameter is not used, then this API returnsinstances
for just the TSG identified in the access token used to authorize this request
Responses
- 200
Successful response - returns an array of instance
entities.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- app_id string
associations object[]
Array [app_id stringregion stringserial_number stringtenant_id string]- auth_code string
- created_by string
- description string
developer_defined_fields object
name1 stringname2 stringextra object
any_extra_field stringapp_display_name stringchannel_platform stringdata_size int32entitlement_group_id stringis_trial booleanlicense_status stringpurchased_size int32sales_account_id stringsales_account_name stringuse_pubsub booleanwildfire_api_key string- instance_id string
- license_quota_id string
- message string
- provisioning_message string
- provisioning_status string
- region string
- serial_number string
- sku string
- status string
- tenant_instance_name string
- tsg_id string
- url string
- ]
[
{
"app_id": "logging_service",
"associations": [
{
"app_id": "prisma_access",
"instance_id": "1122334455",
"region": "americas",
"serial_number": "5566778899"
}
],
"auth_code": "I886699",
"created_by": "user@company.com",
"description": "This is an instance for demo",
"developer_defined_fields": {
"name1": "value1",
"name2": "value2"
},
"extra": {
"any_extra_field": "any extra value",
"app_display_name": "Cortex Data Lake",
"channel_platform": "INTERNAL",
"data_size": 10,
"entitlement_group_id": "0472e9ce-9c19-460f-a938-45b0165410fb",
"is_trial": true,
"license_status": "ACTIVE",
"purchased_size": 1,
"sales_account_id": "0011000000oKIiiAAA",
"sales_account_name": "Palo Alto Networks",
"use_pubsub": true,
"wildfire_api_key": "fd995d5eb7c6d1ee0b97b9e0004dc5c815373312b1b579e4993d652b789776c6"
},
"instance_id": "D68FKGiM0V4NEbJbIfWHh",
"message": "Temporarily unavailable",
"provisioning_message": "Recepter provisioning faild",
"provisioning_status": "complete",
"region": "americas",
"serial_number": "55667788",
"sku": "LGS1T",
"status": "running",
"support_account_name": "Pepsi",
"tenant_instance_name": "My CDL US",
"tsg_id": "jXe6iXutrmINurbNrjVun",
"url": "https://mylgs.logging-service.paloaltonetworks.com"
}
]
Loading...