Foundry API

GetHealthCheckRequest

The following routes are available for this service:
GET	/health

import java.math.*
import java.util.*
import net.servicestack.client.*


open class GetHealthCheckRequest : GetOperationUnTenanted<GetHealthCheckResponse>()
{
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class GetHealthCheckResponse
{
    var responseStatus:ResponseStatus? = null
    var name:String? = null
    var version:String? = null
    var status:String? = null
}

Kotlin GetHealthCheckRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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

GET /health HTTP/1.1 
Host: staging-api.foundrylab.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	name: String,
	version: String,
	status: String
}