API (v1alpha1.Ackal)

Create a gRPC health check for a set of services, from a set of locations, with a specific frequency against an endpoint.

NOTE The combination of an endpoint and period uniquely specifies a health check. Creating a health check will replace existing health checks with the same endpoint and period

If successful, the command returns the Check ID.

CheckCreateRequest

message CheckCreateRequest {
    Check check
    string customer_id
}
                                    

CheckCreateResponse

message CheckCreateResponse {
    string check_id
}
                                    

Delete a gRPC health check.

NOTE The combination of an endpoint and period uniquely specifics a health check. In order to delete a health check, you will need to specify both an endpoint and a period.

.

CheckDeleteRequest

message CheckDeleteRequest {
    string check_id
    string customer_id
    string domain_id
}
                                    

CheckDeleteResponse

message CheckDeleteResponse {
}
                                    

Get (details of) a gRPC health check.
If successful, returns details of the health check.

CheckGetRequest

message CheckGetRequest {
    string check_id
    string customer_id
    string domain_id
}
                                    

CheckGetResponse

message CheckGetResponse {
    Check check
}
                                    

Lists the gRPC health checks.

CheckListRequest

message CheckListRequest {
    string customer_id
}
                                    

CheckListResponse

message CheckListResponse {
    repeated Check checks
}
                                    

Update a gRPC health check.

CheckUpdateRequest

message CheckUpdateRequest {
    string check_id
    string customer_id
    string domain_id
    boolean enabled
}
                                    

CheckUpdateResponse

message CheckUpdateResponse {
}
                                    

Get (details of) a customer

CustomerGetRequest

message CustomerGetRequest {
    string customer_id
}
                                    

CustomerGetResponse

message CustomerGetResponse {
    Customer customer
}
                                    

Update a customer

CustomerUpdateRequest

message CustomerUpdateRequest {
    string customer_id
    boolean enabled
}
                                    

CustomerUpdateResponse

message CustomerUpdateResponse {
}
                                    

Create a reference to a domain name.

NOTE Once a reference to a domain is created, ownership of the domain must be verified. Use ackalctl get domain to obtain the verification code that Ackal has generated for the domain, update the domain's custom records with a TXT entry for the domain, see Verifying Domains and then ackalctl verify domain to ensure the domain verifies correctly.

DomainCreateRequest

message DomainCreateRequest {
    string customer_id
    string domain
}
                                    

DomainCreateResponse

message DomainCreateResponse {
    string domain_id
}
                                    

Delete a reference to a domain name.

DomainDeleteRequest

message DomainDeleteRequest {
    string customer_id
    string domain_id
}
                                    

DomainDeleteResponse

message DomainDeleteResponse {
}
                                    

Get (details of) a domain.

DomainGetRequest

message DomainGetRequest {
    string customer_id
    string domain_id
}
                                    

DomainGetResponse

message DomainGetResponse {
    Domain domain
}
                                    

List this customer's domain name references.

DomainListRequest

message DomainListRequest {
    string customer_id
}
                                    

DomainListResponse

message DomainListResponse {
    repeated Domain domains
}
                                    

Update a reference to a domain name.

DomainUpdateRequest

message DomainUpdateRequest {
    string customer_id
    string domain_id
    boolean enabled
}
                                    

DomainUpdateResponse

message DomainUpdateResponse {
}
                                    

Verify ownership of a domain name.

DomainVerifyRequest

message DomainVerifyRequest {
    string customer_id
    string domain_id
}
                                    

DomainVerifyResponse

message DomainVerifyResponse {
}
                                    

List the locations that can be used to create health checks.

LocationListRequest

message LocationListRequest {
    string customer_id
}
                                    

LocationListResponse

message LocationListResponse {
    repeated Location locations
}