Deploy a Site (v2.0)
POST/v2.0/api/tenants/:tenant_id/bulkconfigurations/sitetemplates/:site_template_id/deployments
List the details of the site profile to be deployed.
Request
Path Parameters
tenant_id stringrequired
The tenant ID.
site_template_id stringrequired
The site template ID.
- application/json
Body
Details of the Site Profile to be deployed
id string
The ID.
variable_map object[]
Data required to deploy new sites at scale using this template.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
count int32
The actual count.
deleted_count int64
The deleted number.
deleted_ids string[]
The deleted IDs.
description
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 BulkConfigPush[]
deployment_id string
The site deployment ID.
id string
The ID.
site_id string
Site Id
template_id string
The template ID.
variable_map object
Data required to deploy new sites at scale using this template.
{
"count": 0,
"deleted_count": 0,
"deleted_ids": [
"string"
],
"id": "string",
"next_query": {},
"tenant_id": "string",
"total_count": 0,
"items": [
{
"deployment_id": "string",
"id": "string",
"site_id": "string",
"template_id": "string",
"variable_map": {}
}
]
}
Bad Request
- application/json
- Schema
- Example (from schema)
- Example
Schema
- Array [
- ]
_error ErrorResponse[]
code string
The error code.
message string
The error message.
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_INPUT_PARAM"
},
{
"code": "INVALID_JSON_EXTRA_ATTRIBUTE"
},
{
"code": "TEMPLATE_NOT_AVAILABLE"
},
{
"code": "INVALID_VARIABLE_MAP_DATA_TYPE"
},
{
"code": "INVALID_VARIABLE_CHARACTER"
}
]
}
}
Loading...