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)
namespace CoreService.ServiceModel.Dtos.Base.Responses

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    ///<summary>
    ///Returns a list of hostnames
    ///</summary>
    [<Api(Description="Returns a list of hostnames")>]
    [<ApiResponse(Description="Success", IsDefaultResponse=true, ResponseType=typeof<0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]>, StatusCode=200)>]
    [<AllowNullLiteral>]
    type GetHostNames() = 
        interface IGet
        [<ApiMember(DataType="string", IsRequired=true, ParameterType="header")>]
        [<Validate(Validator="NotEmpty")>]
        member val TenantName:String = null with get,set

        ///<summary>
        ///If set, hostnames will be created using it
        ///</summary>
        [<ApiMember(DataType="string", Description="If set, hostnames will be created using it", ParameterType="query")>]
        [<Validate(Validator="MaximumLength(2)")>]
        member val Prefix:String = null with get,set

        ///<summary>
        ///Defines how long the hostname will be including the prefix
        ///</summary>
        [<ApiMember(DataType="int", Description="Defines how long the hostname will be including the prefix", ParameterType="query")>]
        [<Validate(Validator="ExclusiveBetween(7,17)")>]
        member val Length:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///The number of hostnames to be returned
        ///</summary>
        [<ApiMember(DataType="int", Description="The number of hostnames to be returned", IsRequired=true)>]
        [<Validate(Validator="GreaterThanOrEqual(1)")>]
        member val Count:Int32 = new Int32() with get,set

    type ValueDataType =
        | String = 0
        | Number = 1
        | Boolean = 2
        | List = 3

    type Environments =
        | Lab = 0
        | Poc = 1
        | Dev = 2
        | Test = 3
        | Int = 4
        | Uat = 5
        | Prod = 6

    [<AllowNullLiteral>]
    type VariableDto() = 
        member val Name:String = null with get,set
        ///<summary>
        ///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
        ///</summary>
        member val Value:String = null with get,set

        ///<summary>
        ///The data type of the value property
        ///</summary>
        member val Type:ValueDataType = new ValueDataType() with get,set

        member val Description:String = null with get,set
        member val IsInherited:Boolean = new Boolean() with get,set
        member val Environment:Nullable<Environments> = new Nullable<Environments>() with get,set

    [<AllowNullLiteral>]
    type ItemsResponse<T>() = 
        member val Items:IList<VariableDto> = null with get,set
        member val Offset:Int32 = new Int32() with get,set
        member val Total:Int32 = new Int32() with get,set
        member val IsGrouped:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Meta:Dictionary<String, String> = null with get,set

F# GetHostNames DTOs

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"}}