Create a new TLS ingest profile

post

https://{hostname}/api/content-delivery/v1/content-providers/{contentProviderId}/tls-ingest-profiles

This operation creates a TLS ingest profile. To configure the ingest of content from an origin over HTTPS, a content provider must first create a TLS ingest profile and bind the profile to the origin. The HyperCache uses the TLS parameters specified in the TLS ingest profile to ingest content from the origin. A TLS ingest profile can be bound to one or more origins, and can only be deleted if it is not bound to an origin.

Path Params

contentProviderId

integer

required

Unique identifier for each Content Provider.

Body Params

TLS ingest profile create

contentProviderId

integer

required

≥ 1

Identifies content provider which owns the TLS ingest profile.

name

string

required

length between 1 and 128

The name of the TLS ingest profile.

description

string

length ≤ 256

A description of the TLS ingest profile.

caCertificate

string

length ≤ 10000

An OpenSSL PEM-formatted certificate associated with the trusted CA that signed the origin's certificate.

enableClientAuth

boolean

Defaults to false

Allows you to enable or disable client authorization. Enabling this feature causes HyperCache to authenticate client certificates using the CA certificate for each TLS connection.

crl

string

length ≤ 10000

Certificate Revocation List. An OpenSSL PEM-formatted list of revoked client certificates.

clientTlsCertificate

string

length ≤ 10000

An OpenSSL PEM-formatted certificate associated with the trusted CA that signed the origin's certificate.

clientTlsCertificateKey

string

length ≤ 10000

An OpenSSL PEM-formatted certificate associated with the trusted CA that signed the origin's certificate.

ciphers

string

length ≤ 65535

An OpenSSL style ciphers string.

tlsProtocols

string

enum

TLS protocols supported, either TLSV1, TLSV1_1 or TLSV1_2. Defaults to TLSV1, TLSV1_1, TLSV1_2. The use of SSLV2 or SSLV3 are discouraged for security reasons.

Allowed:

Responses

201An HTTP 201 will be returned if the request is successfully processed, and a new tls-ingest-profile object is created. The location of the new object will be specified in the location header.

400An HTTP 400 will be returned if the request is badly formed or has constraint violations

403An HTTP 403 will be returned if the principal is not authorized to access the instance of blocklist that the request was made against.

409An HTTP 409 will be returned if the blocklist offered for create/update would lead to a conflicting state.