VirtualHost

/v1/vhosts

POST http://<OME_HOST>:<API_PORT>/v1/vhosts

Creates VirtualHosts Request Example: POST http://1.2.3.4:8081/v1/vhosts

[ { "name": "default" } ]

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

Request Body

Name	Type	Description
(json body)*	array	A list of VirtualHost

200: OK Returns the specified virtual host information

Return type: Response<VirtualHost>

[
	{
		"message": "OK",
		"response": {
			"name": "defaults"
		},
		"statusCode": 200
	}
]

404: Not Found The specified VirtualHost was not found.

{
	"statusCode": 404,
	"message": "Could not find the virtual host: [non-exists] (404)"
}

409: Conflict The virtual host already exists.

[
	{
		"message": "The virtual host already exists: [default]",
		"statusCode": 409
	}
]

/v1/vhosts

GET http://<OME_HOST>:<API_PORT>/v1/vhosts

Lists all virtual host names Request Example: GET http://1.2.3.4:8081/v1/vhosts

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

200: OK Returns a list of virtual host names

Return type: Response<List>

{
	"statusCode": 200,
	"message": "OK",
	"response": [
		"default"
	]
}

/v1/vhosts/{vhost_name}

GET http://<OME_HOST>:<API_PORT>/v1/vhosts/{vhost_name}

Gets the configuration of the VirtualHost Request Example: GET http://1.2.3.4:8081/v1/vhosts/default

Path Parameters

Name	Type	Description
vhost_name	string	A name of VirtualHost

Headers

Name	Type	Description
authorization	string	A string for authentication in Basic Base64(AccessToken) format. For example, Basic b21lLWFjY2Vzcy10b2tlbg== if access token is ome-access-token.

200 - Return type: Response<VirtualHost> - Description Returns the specified virtual host information

{
	"statusCode": 200,
	"message": "OK",
	"response": {
		"name": "default",
		"host": {
			"names": [
				"*"
			],
			"tls": {
				"certPath": "airensoft_com.crt",
				"chainCertPath": "airensoft_com_chain.crt",
				"keyPath": "airensoft_com.key"
			}
		}
	}
}

404 - Return type: Response<> - Description The specified VirtualHost was not found.

{
	"statusCode": 404,
	"message": "Could not find the virtual host: [non-exists] (404)"
}