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

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

Responses

200

Successful Operation

application/json

Schema

Schema

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[]
Array [
deployment_id string
The site deployment ID.
id string
The ID.
template_id string
The template ID.
variable_map object
Data required to deploy new sites at scale using this template.
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "deployment_id": "string",
      "id": "string",
      "template_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"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "TEMPLATE_NOT_AVAILABLE"
      },
      {
        "code": "INVALID_VARIABLE_MAP_DATA_TYPE"
      }
    ]
  }
}

Loading...