cloudflare/resources/origin-tls-client-auth/hostnames/hostnames.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as HostnamesAPI from 'cloudflare/resources/origin-tls-client-auth/hostnames/hostnames';
import * as CertificatesAPI from 'cloudflare/resources/origin-tls-client-auth/hostnames/certificates';
import { SinglePage } from 'cloudflare/pagination';
export declare class Hostnames extends APIResource {
    certificates: CertificatesAPI.Certificates;
    /**
     * Associate a hostname to a certificate and enable, disable or invalidate the
     * association. If disabled, client certificate will not be sent to the hostname
     * even if activated at the zone level. 100 maximum associations on a single
     * certificate are allowed. Note: Use a null value for parameter _enabled_ to
     * invalidate the association.
     */
    update(params: HostnameUpdateParams, options?: Core.RequestOptions): Core.APIPromise<HostnameUpdateResponse | null>;
    /**
     * Get the Hostname Status for Client Authentication
     */
    get(hostname: string, params: HostnameGetParams, options?: Core.RequestOptions): Core.APIPromise<OriginTLSClientCertificateID>;
}
export declare class OriginTLSClientCertificateIDsSinglePage extends SinglePage<OriginTLSClientCertificateID> {
}
export interface OriginTLSClientCertificateAuthenticatedOriginPull {
    /**
     * Identifier
     */
    id?: string;
    /**
     * Identifier
     */
    cert_id?: string;
    /**
     * The hostname certificate.
     */
    certificate?: string;
    /**
     * Indicates whether hostname-level authenticated origin pulls is enabled. A null
     * value voids the association.
     */
    enabled?: boolean | null;
    /**
     * The hostname on the origin for which the client certificate uploaded will be
     * used.
     */
    hostname?: string;
    /**
     * The hostname certificate's private key.
     */
    private_key?: string;
}
export interface OriginTLSClientCertificateID {
    /**
     * Identifier
     */
    cert_id?: string;
    /**
     * Status of the certificate or the association.
     */
    cert_status?: 'initializing' | 'pending_deployment' | 'pending_deletion' | 'active' | 'deleted' | 'deployment_timed_out' | 'deletion_timed_out';
    /**
     * The time when the certificate was updated.
     */
    cert_updated_at?: string;
    /**
     * The time when the certificate was uploaded.
     */
    cert_uploaded_on?: string;
    /**
     * The hostname certificate.
     */
    certificate?: string;
    /**
     * The time when the certificate was created.
     */
    created_at?: string;
    /**
     * Indicates whether hostname-level authenticated origin pulls is enabled. A null
     * value voids the association.
     */
    enabled?: boolean | null;
    /**
     * The date when the certificate expires.
     */
    expires_on?: string;
    /**
     * The hostname on the origin for which the client certificate uploaded will be
     * used.
     */
    hostname?: string;
    /**
     * The certificate authority that issued the certificate.
     */
    issuer?: string;
    /**
     * The serial number on the uploaded certificate.
     */
    serial_number?: string;
    /**
     * The type of hash used for the certificate.
     */
    signature?: string;
    /**
     * Status of the certificate or the association.
     */
    status?: 'initializing' | 'pending_deployment' | 'pending_deletion' | 'active' | 'deleted' | 'deployment_timed_out' | 'deletion_timed_out';
    /**
     * The time when the certificate was updated.
     */
    updated_at?: string;
}
export type HostnameUpdateResponse = Array<OriginTLSClientCertificateID>;
export interface HostnameUpdateParams {
    /**
     * Path param: Identifier
     */
    zone_id: string;
    /**
     * Body param:
     */
    config: Array<HostnameUpdateParams.Config>;
}
export declare namespace HostnameUpdateParams {
    interface Config {
        /**
         * Certificate identifier tag.
         */
        cert_id?: string;
        /**
         * Indicates whether hostname-level authenticated origin pulls is enabled. A null
         * value voids the association.
         */
        enabled?: boolean | null;
        /**
         * The hostname on the origin for which the client certificate uploaded will be
         * used.
         */
        hostname?: string;
    }
}
export interface HostnameGetParams {
    /**
     * Identifier
     */
    zone_id: string;
}
export declare namespace Hostnames {
    export import OriginTLSClientCertificateAuthenticatedOriginPull = HostnamesAPI.OriginTLSClientCertificateAuthenticatedOriginPull;
    export import OriginTLSClientCertificateID = HostnamesAPI.OriginTLSClientCertificateID;
    export import HostnameUpdateResponse = HostnamesAPI.HostnameUpdateResponse;
    export import HostnameUpdateParams = HostnamesAPI.HostnameUpdateParams;
    export import HostnameGetParams = HostnamesAPI.HostnameGetParams;
    export import Certificates = CertificatesAPI.Certificates;
    export import OriginTLSClientCertificate = CertificatesAPI.OriginTLSClientCertificate;
    export import CertificateCreateParams = CertificatesAPI.CertificateCreateParams;
    export import CertificateListParams = CertificatesAPI.CertificateListParams;
    export import CertificateDeleteParams = CertificatesAPI.CertificateDeleteParams;
    export import CertificateGetParams = CertificatesAPI.CertificateGetParams;
}
//# sourceMappingURL=hostnames.d.ts.map