---
title: "Return available AutoSSL providers"
method: GET
path: "/get_autossl_providers"
tags: ["SSL", "Auto-Generated Certificates"]
---

# Return available AutoSSL providers

`GET /get_autossl_providers`

This function lists available AutoSSL providers on the server.

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `payload` object[] — This array of objects contains information about available AutoSSL providers.
      - `display_name` string — The AutoSSL provider module's display name.
      - `enabled` 0 | 1 — Whether the AutoSSL provider is enabled. * `1` - The provider is enabled. * `0` - The provider is disabled.
      - `module_name` string — The AutoSSL provider module's name.
      - `specs` object — The provider's specifications.
        - `AVERAGE_DELIVERY_TIME` integer — The amount of time in seconds that the provider requires to issue a certificate.
        - `DCV_METHODS` string[] — The methods that the provider uses to validate the domain. * `dns` - DNS Validation Method. * `http` - HTTP Validation Method.
        - `DELIVERY_METHOD` 'queue' | 'api' — The method that the provider uses to issue the certificate. * `queue` - The provider delivers certificates through a download queue. * `api` - The provider delivers certificates through API calls.
        - `HTTP_DCV_MAX_REDIRECTS` integer — The maximum number of redirections a domain can use and still pass an HTTP-based DCV.
        - `MAX_DOMAINS_PER_CERTIFICATE` integer — The number of unique domains each certificate can contain.
        - `RATE_LIMIT_CERTIFICATES_PER_REGISTERED_DOMAIN_PER_WEEK` integer — The maximum number of certificates that the provider will allow per domain in a week.
        - `SUPPORTS_ANCESTOR_DCV` 0 | 1 — Whether the successful Domain Control Validation (DCV) of a parent domain implies the success of a subdomain. * `1` - The provider supports DCV. * `0` - The provider does **not** support DCV."
        - `SUPPORTS_WILDCARD` 0 | 1 — Whether the provider supports wildcard domains on an SSL certificate. * `1` - The provider supports wildcard domains. * `0` - The provider does **not** support wildcard domains.
        - `VALIDITY_PERIOD` integer — The amount of time before the certificate expired, in seconds. **Note:** A valid integer.
      - `x_account_id` string — The user's account profile URL at the provider.
      - `x_terms_of_service` string, url — The URL of the provider's current terms of service. **Note:** If the terms of service available at the `x_terms_of_service` location is newer than the `x_terms_of_service_accepted` location, the system administrator will need to accept the new terms of service.
      - `x_terms_of_service_accepted` 0 | 1 — Whether the AutoSSL provider is Enabled. * `1` - The AutoSSL provider is enabled. * `0` - The AutoSSL provider is **not** enabled.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the API function failed when the `metadata.result` field is 0. This field may display a success message when a function succeeds.
    - `result` 0 | 1 — * `1` - Success. * `0` - Failed. Check the reason field for more details.
    - `version` integer — The version of the API function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)
