Skip to main content

Get Site Profiles (v2.0)



Query and list all the created site profiles.


Path Parameters

    tenant_id stringrequired

    The tenant ID.


Details of the Site Profile to be created

    aggregate Aggregate

    The aggregate number of site profiles that match the query parameters.

    data AggregateData[]

    The details of the aggregate data.

  • Array [
  • value number

    Value of the aggregate data.

    view object

    View the aggregate date.

  • ]
  • field string


    name string

    The name of the query response.

    operator string

    Possible values: [max, count, min, avg, sum]


    statistic string

    QoS application aggregate statistics.

    unit string

    The unit.

    dest_page int32

    The destination page.

    getDeleted boolean

    The number site profiles; deleted for a time frame.

    group_by string[]

    Group the site profiles for the query.

    id string

    List the site profiles by ID.

    last_query_ts int64

    Return the ID of a specified query in the current session.

    limit int32

    The query limit.

    next_query object

    The limit.

    query_params object
    retrieved_fields string[]

    Retrieve information from a field.

    retrieved_fields_mask boolean

    List the fields to query.

    sort_params object
    total_count int64

    The total number of query parameters.


Successful Operation

    count int32

    The actual count.

    deleted_count int64

    The deleted number.

    deleted_ids string[]

    The deleted IDs.


    Description of the query. Max size = 256.

    id string

    The ID.

    next_query object

    Details of the next query.

    tenant_id string

    The tenant ID.

    total_count int64

    Total number.

    items BulkConfigCreateQueryFilter[]
  • Array [
  • data string

    Data required to deploy new sites at scale using the site template.

    deployment_count int32

    The number of deployments.

    id string

    The ID.

    site_id string

    The site ID.

    site_type string

    The site type. Branch or DC.

    status string

    The site deployment status.

    status_description string

    The description of the site deployment status.

    template_description string

    The site template description. Max length = 256.

    template_id string

    The template ID.

    template_name string

    The site template name. Max length = 128.

    tenant_id string

    The tenant ID.

    variable_map object

    Data required to deploy new sites at scale using this template.

  • ]