Get Site Profile (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/bulkconfigurations/sitetemplates/:site_template_id

List a site profile.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_template_id stringrequired

The site template ID.

Responses

200

Successful Operation

application/json

Schema

Schema

data string

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

id string

The ID.

site_id string

The site ID.

site_type stringrequired

The site type. Branch or DC.

template_description string

The site template description. Max length = 256.

template_id string

The template ID.

template_name stringrequired

The site template name. Max length = 128.

tenant_id stringrequired

The tenant ID.

variable_map object

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

Example (from schema)

{
  "data": "string",
  "id": "string",
  "site_id": "string",
  "site_type": "string",
  "template_description": "string",
  "template_id": "string",
  "template_name": "string",
  "tenant_id": "string",
  "variable_map": {}
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_INPUT_PARAM"
      }
    ]
  }
}

Loading...