Create a deployment

post/deployments

Creates a deployment of type edge or cluster, to manage ESP servers and projects.

Request Samples

1

Response Samples

1{
2  "createdBy": "user1",
3  "createdOn": 1675175923129,
4  "deleted": false,
5  "description": "Created by user1",
6  "label": "clusterDeployment",
7  "modifiedBy": "user1",
8  "modifiedOn": 1675175923129,
9  "production": false,
10  "projectStatuses": {},
11  "serverCount": 0,
12  "serverStatuses": {},
13  "servers": [],
14  "tags": [],
15  "type": "cluster",
16  "uuid": "6fdd9044-f8e7-47b9-9837-cc457d8e2bee"
17}

Request Body

A representation for creating a deployment with the following details: a name, a description, information about whether the deployment is a production deployment, tags, and the deployment's type.

NameTypeRequiredDescription
description
string
false
<= 255 characters
name
string
true
>= 1 characters
production
boolean
false
tags
array [string]
false
type
string
true
Match pattern:
^cluster|edge$

Responses

StatusMeaningDescription
201Created

The request succeeded.

HeadersSchema
400Bad Request

The request was invalid. Additional information is available in the application logs if the environment variable LOGGING_LEVEL_ORG_SPRINGFRAMEWORK is set to DEBUG.

Schema