Skip to main content

List instances

GET 

/subscription/v1/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.

Request

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 returns instances for just the TSG identified in the access token used to authorize this request

Responses

Successful response - returns an array of instance entities.

Schema
  • Array [
  • app_id string
    associations object[]
  • Array [
  • app_id string
    region string
    serial_number string
    tenant_id string
  • ]
  • auth_code string
    created_by string
    description string
    developer_defined_fields object
    name1 string
    name2 string
    extra object
    any_extra_field string
    app_display_name string
    channel_platform string
    data_size int32
    entitlement_group_id string
    is_trial boolean
    license_status string
    purchased_size int32
    sales_account_id string
    sales_account_name string
    use_pubsub boolean
    wildfire_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
  • ]
Loading...