Create

POST v1/application_servers

Description

Create a new application server.

Normal Response Codes

201

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_cannot_read_object

SM_eexist

SM_enospc

SM_invalid_arg_value

SM_invalid_keyvalue

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_too_many

SM_unexpected_arg

SM_unexpected_child

SM_unexpected_query_param

SM_version_name

Request

Parameter Type JSON Type Description Default Mandatory Deprecated
name NsObjectName string Name for the application server. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.   true  
hostname NsFqdn string Application server hostname. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'.   true  
port NsPort number Application server port number. Positive integer value up to 65535 representing TCP/IP port. Example: 1234. 65536 false  
username NsDescription string Application server username. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. '' false  
description NsDescription string Text description of application server. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. '' false  
password NsFlexiblePassword string Application server password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'. '' false  
server_type NsAppServerType string enum Application server type ({invalid|vss|vmware}). Possible values: 'vss', 'vmware'. 'vmware' false  
metadata NsKeyValues Array of NsKeyValue Key-value pairs that augment an application server's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed. [] false  

JSON Request 


            
            
            {
                "data":{
                    "hostname":"hostname",
                    "port":12345,
                    "username":"username",
                    "server_type":"vmware",
                    "description":"description",
                    "password":"supersecret"
                }
            }

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for the application server. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsObjectName string Name for the application server. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
hostname NsFqdn string Application server hostname. String of alphanumeric characters, valid range is from 2 to 255; Each label must be between 1 and 63 characters long; - and . are allowed after the first and before the last character. Example: 'example-1.com'.  
port NsPort number Application server port number. Positive integer value up to 65535 representing TCP/IP port. Example: 1234.  
username NsDescription string Application server username. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
description NsDescription string Text description of application server. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
server_type NsAppServerType string enum Application server type ({invalid|vss|vmware}). Possible values: 'vss', 'vmware'.  
metadata NsKeyValues Array of NsKeyValue Key-value pairs that augment an application server's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.  
creation_time NsTime number Time when this application server was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this application server was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  

JSON Response 


            
            
            {
                "data":{
                    "description":"description",
                    "hostname":"hostname",
                    "id":"2900000000000004d3000000000000000000000001",
                    "metadata":null,
                    "port":65536,
                    "server_type":"vmware",
                    "username":"username"
                }
            }