| Required role: | TenantReader |
| POST | /api/deployments/ | Creates a new deployment | |
|---|---|---|---|
| POST | /deployments/ | Creates a new deployment |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TenantName | header | string | Yes | |
| Name | body | string | Yes | The name of the deployment |
| DisplayName | body | string | No | The deployments display name |
| Description | body | string | No | A more detailed description for the deployment |
| ParentId | body | string | Yes | The id of the collection, this deployment belongs to |
| TemplateId | body | string | No | The id of the template, this deployment is based on |
| DefaultResourceProviderId | body | string | Yes | The default resource provider for this deployment |
| Environment | body | Environments | Yes | What kind of environment is this deploymentAllowable Values
|
| Parameters | body | array | Yes | |
| Variables | body | array | No | |
| Tags | body | array | No | |
| ValidUntil | body | string | No | The expiry date of the environment |
| IsNeverExpiring | body | bool | No | Set if the environment should never expire |
| OwnerUserIds | body | array | Yes |
| Lab | |
| Poc | |
| Dev | |
| Test | |
| Int | |
| Uat | |
| Prod |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Description | form | string | No | |
| Value | form | string | No | Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false). Note: string values need extra quotes |
| Default | form | string | No | Optional default value for the frontend. Needs to be in the same format as the value |
| Optional | form | bool | No | Optional parameters do not need to have a value. Default -> Optional=false |
| Type | form | ParameterValueType | No | The data type of the value and default property |
| Validation | form | string | No |
| String | |
| Number | |
| Boolean | |
| SecureString |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | Yes | Value in form of a json string (e.g. Number = 1234, String = "foo", Boolean = false, List = [1,2,3,4]). Note: string values need extra quotes |
| Type | form | ValueDataType | No | The data type of the value property |
| Description | form | string | No | |
| IsInherited | form | bool | No | |
| Environment | form | Environments? | No |
| String | |
| Number | |
| Boolean | |
| List |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | Yes | |
| Value | form | string | No | |
| IsProtected | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OperationalState | form | OperationalStates | No | The operational state of the deployment (Running, Stopped, None, Unknown) |
| ResourcesRunning | form | int | No | How many start/stop-capable resources are currently running |
| ResourcesTotal | form | int | No | Total number of start/stop-capable resources in this deployment |
| ShortId | form | string | Yes | Shorter id than the guid which can be used for automation (tenant wide unique) prefixed with a 'd'. E.g. dr36x3 |
| NameUserDefinedPart | form | string | Yes | The user defined part of the name property {userDefined}_{environment} |
| TenantId | form | Guid | No | The id of the tenant |
| State | form | LifecycleStates | No | The state of the deployment |
| Environment | form | Environments | No | The environment the deployment is deployed in |
| TemplateId | form | Guid? | No | The id of the template which was used to create the deployment |
| IsTemplateBased | form | bool | No | Shows if a deployment was rolled out through a dune template or not |
| Parameters | form | IList<ParameterDto> | Yes | The parameters which were used to create this deployment |
| Variables | form | IList<VariableDto> | Yes | A deployment scoped list of variables used for deployment of resources |
| VariablesSnapshot | form | IList<VariableDto> | Yes | A snapshot of the varialbs used to create the deployment |
| ParentId | form | Guid | No | The id of the parent (collection) of the deployment |
| Parent | form | ConfigItemDto | No | The parent (collection) of the deployment |
| ValidFrom | form | DateTime | No | The Date when the resources got deployed |
| ValidUntil | form | DateTime? | No | The Date when the deployment expires and has to be reevaluated |
| IsNeverExpiring | form | bool | No | The deployment will never expire |
| NextPatchDate | form | DateTime? | No | The date, when the deployments resources will receive updates |
| DefaultResourceProviderId | form | Guid | No | The default resource provider where the resources are deployed |
| NeedsAttention | form | bool | No | Deployments which have issues in Jobs are marked with NeedsAttention |
| Composition | form | ResourceCompositions | No | Composition show if all resources in the deployment are dune native, dune foreign or a mix of both |
| MonthlyBudget | form | decimal? | No | The monthly cost budget for the whole collection |
| SendBudgetNotificationMails | form | bool? | No | Whether to send budget information mails to the collection owners |
| BudgetWarningThresholdPercent | form | int? | No | A threshold, when to send the first budget warning mail |
| Links | form | IList<LinkDto> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| DisplayName | form | string | Yes | |
| Description | form | string | No | |
| ObjectType | form | ObjectTypes | No | |
| SelfLink | form | string | Yes | |
| Tags | form | IList<TagDto> | Yes | |
| Path | form | IList<PathItemDto> | Yes | |
| Created | form | DateTime | No | |
| CreateUser | form | string | Yes | |
| CreateUserId | form | string | Yes | |
| Modified | form | DateTime | No | |
| ModifyUser | form | string | Yes | |
| ModifyUserId | form | string | Yes | |
| IsDeleted | form | bool | No | |
| Deleted | form | DateTime? | No | |
| DeleteUser | form | string | No | |
| DeleteUserId | form | string | No | |
| Links | form | IList<LinkDto> | Yes |
| None | |
| ConfigItem | |
| Tenant | |
| Collection | |
| Resource | |
| ComputeNode | |
| VirtualMachine | |
| PhysicalMachine | |
| Disk | |
| Subnet | |
| IPAddress | |
| Job | |
| JobEvent | |
| FreezePeriod | |
| ResourceGroup | |
| Deployment | |
| ResourceGroupTemplate | |
| DeploymentTemplate | |
| ResourceProvider | |
| GenericResource | |
| Role | |
| Permission | |
| User | |
| PatchingWindow | |
| Update | |
| ReportDefinition | |
| TimeSeries | |
| DataPoint | |
| Action | |
| ActionAssignment | |
| UserNote |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Label | form | string | Yes | |
| Link | form | string | Yes | |
| ObjectType | form | ObjectTypes | No | |
| ObjectId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Caption | form | string | Yes | |
| Rel | form | string | Yes | |
| HRef | form | string | Yes | |
| Method | form | string | Yes |
| None | |
| Starting | |
| Running | |
| Stopping | |
| Stopped | |
| Restarting | |
| Deleting | |
| Unknown |
| New | |
| Deploying | |
| Deployed | |
| Removing | |
| Removed | |
| Failure | |
| Imported |
| Native | |
| Foreign | |
| Mixed |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/deployments/ HTTP/1.1
Host: core.starburst.svc
Accept: application/json
Content-Type: application/json
Content-Length: length
{"tenantName":"String","name":"String","displayName":"String","description":"String","parentId":"00000000-0000-0000-0000-000000000000","templateId":"00000000-0000-0000-0000-000000000000","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","environment":"Lab","parameters":null,"variables":null,"tags":null,"validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"ownerUserIds":null,"txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"operationalState":"None","resourcesRunning":0,"resourcesTotal":0,"shortId":"String","nameUserDefinedPart":"String","tenantId":"00000000-0000-0000-0000-000000000000","state":"New","environment":"Lab","templateId":"00000000-0000-0000-0000-000000000000","isTemplateBased":true,"parameters":null,"variables":null,"variablesSnapshot":null,"parentId":"00000000-0000-0000-0000-000000000000","parent":{"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String","links":null},"validFrom":"0001-01-01T00:00:00.0000000Z","validUntil":"0001-01-01T00:00:00.0000000Z","isNeverExpiring":false,"nextPatchDate":"0001-01-01T00:00:00.0000000Z","defaultResourceProviderId":"00000000-0000-0000-0000-000000000000","needsAttention":false,"composition":"Native","monthlyBudget":0,"sendBudgetNotificationMails":false,"budgetWarningThresholdPercent":0,"links":[{"caption":"Index","rel":"index","hRef":"/deployments/","method":"GET"},{"caption":"Collection","rel":"up","hRef":"/collections/00000000-0000-0000-0000-000000000000","method":"GET"},{"caption":"Resourcegroups","rel":"down","hRef":"/resourcegroups?parentId=00000000-0000-0000-0000-000000000000","method":"GET"}],"id":"00000000-0000-0000-0000-000000000000","name":"String","displayName":"String","description":"String","objectType":"None","selfLink":"String","tags":null,"path":null,"created":"0001-01-01T00:00:00.0000000Z","createUser":"String","createUserId":"String","modified":"0001-01-01T00:00:00.0000000Z","modifyUser":"String","modifyUserId":"String","isDeleted":false,"deleted":"0001-01-01T00:00:00.0000000Z","deleteUser":"String","deleteUserId":"String"}