CoreService

<back to all web services

GenerateDeploymentName

Deployment - CRUD

Generate deployment name with the user defined part

Requires Authentication
Required role:TenantReader
The following routes are available for this service:
PATCH/api/deployments/generation/nameGenerate deployment name with the user defined part
PATCH/deployments/generation/nameGenerate deployment name with the user defined part
GenerateDeploymentName Parameters:
NameParameterData TypeRequiredDescription
TenantNameheaderstringYes
UserDefinedPartbodystringYesUser defined/custom part of the name
EnvironmentbodyEnvironmentsYesWhat kind of environment is this deployment

Allowable Values

  • Lab
  • Poc
  • Dev
  • Test
  • Int
  • Uat
  • Prod
Environments Enum:
Lab
Poc
Dev
Test
Int
Uat
Prod

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PATCH /api/deployments/generation/name HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"tenantName":"String","userDefinedPart":"String","environment":"Lab","txId":"00000000-0000-0000-0000-000000000000"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

(string)