Types

check

The configuration of a gRPC health check. A Check is defined by the endpoint being checked, the period at which it the endpoint is checked and the source locations from where it is checked.

JSON

{
  "enabled": boolean
  "endpoint": string
  "location_ids": [
    string
  ]
  "period": int
  "services": [
    string
  ]
}

Fields

Field
enabled 
boolean
Whether this resource is enabled for use.
endpoint 
string
The socket (host:port) of the gRPC service to be monitored.
location_ids[] 
string
A comma-separated list of Location IDs that define from where the gRPC health checks will be run.
period 
int
The period of a gRPC health check. The value corresponds to a Golang Duration string e.g. 120s, 1h, 1h30m i.e. 2 minutes, 60 minutes, 90 minutes respectively. ackalctl list checks lists Checks with the period normalized to seconds.
services[] 
string
A comma-separated list of gRPC services to be health checked. Empty string ("") used to check overall service health.

customer

A Customer represents at least one User and at least one Domain. A User is associated with at least one Customer. The Customer identifier (customer_id) is used to interact with ackalctl commands.

JSON

{
  "billing": boolean
  "domain_name": string
  "enabled": boolean
  "name": string
}

Fields

Field
billing 
boolean
Whether the customer has a billing subscription
domain_name 
string
The domain name.
enabled 
boolean
Whether this resource is enabled for use.
name 
string
The customer name

domain

A Domain is a reference to a DNS domain name.

JSON

{
  "enabled": boolean
  "name": string
  "verification": string
  "verified": boolean
}

Fields

Field
enabled 
boolean
Whether this resource is enabled for use.
name 
string
The name of the domain.
verification 
string
An Ackal-generated verification string that must be present in the domain's records.
verified 
boolean
Whether the domain ownership has been verified.

location

A Location is a source location where a gRPC health check can be deployed.

JSON

{
  "name": string
}

Fields

Field
name 
string
The name of the location e.g. London

user

An individual user. The user authenticates to Ackal using a 3rd-party OAuth system (e.g. Google) and has a Stripe subscription for Ackal. There are no ackalctl commands for users.

JSON

NOTE user has no fields.

Fields

NOTE user has no fields.