CoreService

<back to all web services

GetHostNames

HostName - CRUD

Returns a list of hostnames

Requires Authentication
Required role:TenantReaderRequires the role:Workflow
The following routes are available for this service:
GET/api/resourceaddons/hostnamesReturns a list of hostnames for one time use (the pool will never return already obtained hostnames)
GET/resourceaddons/hostnamesReturns a list of hostnames for one time use (the pool will never return already obtained hostnames)
GetHostNames Parameters:
NameParameterData TypeRequiredDescription
TenantNameheaderstringYes
PrefixquerystringNoIf set, hostnames will be created using it
LengthqueryintNoDefines how long the hostname will be including the prefix
CountqueryintYesThe number of hostnames to be returned
ItemsResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ItemsformIList<VariableDto>Yes
OffsetformintNo
TotalformintNo
IsGroupedformboolNo
ResponseStatusformResponseStatusNo
MetaformDictionary<string, string>No
VariableDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringYes
ValueformstringYesValue 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
TypeformValueDataTypeNoThe data type of the value property
DescriptionformstringNo
IsInheritedformboolNo
EnvironmentformEnvironments?No
ValueDataType Enum:
String
Number
Boolean
List
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.

GET /api/resourceaddons/hostnames HTTP/1.1 
Host: core.starburst.svc 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"items":null,"offset":0,"total":0,"isGrouped":false,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"meta":{"String":"String"}}