This command created a new HTTPS Endpoint.

​
Synopsis

Usage:
  aptible endpoints:https:create [--app APP] SERVICE

Options:
      [--environment=ENVIRONMENT]
      [--app=APP]
  -r, [--remote=REMOTE]
      [--default-domain], [--no-default-domain]            # Enable Default Domain on this Endpoint
      [--port=N]                                           # A port to expose on this Endpoint
      [--internal], [--no-internal]                        # Restrict this Endpoint to internal traffic
      [--ip-whitelist=one two three]                       # A list of IPv4 sources (addresses or CIDRs) to which to restrict traffic to this Endpoint
      [--certificate-file=CERTIFICATE_FILE]                # A file containing a certificate to use on this Endpoint
      [--private-key-file=PRIVATE_KEY_FILE]                # A file containing a private key to use on this Endpoint
      [--managed-tls], [--no-managed-tls]                  # Enable Managed TLS on this Endpoint
      [--managed-tls-domain=MANAGED_TLS_DOMAIN]            # A domain to use for Managed TLS
      [--certificate-fingerprint=CERTIFICATE_FINGERPRINT]  # The fingerprint of an existing Certificate to use on this Endpoint

​
Examples

In all the examples below, $SERVICE represents the name of a Service for the app you are adding an Endpoint to.

📘 If your app is using an Implicit Service, the service name is always cmd.

​
Create a new Endpoint using a new Custom Certificate

In the example below, $CERTIFICATE_FILE is the path to a file containing a PEM-formatted certificate bundle, and $PRIVATE_KEY_FILE is the path to a file containing the matching private key (see Format for more information).

aptible endpoints:https:create \
        --app "$APP_HANDLE" \
        --certificate-file "$CERTIFICATE_FILE" \
        --private-key-file "$PRIVATE_KEY_FILE" \
        "$SERVICE"

​
Create a new Endpoint using an existing Custom Certificate

In the example below, $CERTIFICATE_FINGERPRINT is the SHA-256 fingerprint of a Custom Certificate that exist in the same Environment as the App you are adding an Endpoint for.

📘 Tip: Use the Dashboard to easily locate the Certificate Fingerprint for a given Certificate.

aptible endpoints:https:create \
        --app "$APP_HANDLE" \
        --certificate-fingerprint "$CERTIFICATE_FINGERPRINT" \
        "$SERVICE"

​
Create a new Endpoint using Managed TLS

In the example below, $YOUR_DOMAIN is the domain you intend to use with your Endpoint.

After initial provisioning completes, the CLI will return the Managed HTTPS Validation Records you need to create in order to finalize the Endpoint.

Once you’ve created these records, use the aptible endpoints:renew to complete provisioning.

aptible endpoints:https:create \
        --app "$APP_HANDLE" \
        --managed-tls \
        --managed-tls-domain "$YOUR_DOMAIN"
        "$SERVICE"

​
Create a new Endpoint using a Default Domain

aptible endpoints:https:create \
        --app "$APP_HANDLE" \
        --default-domain \
        "$SERVICE"

​
Create a new Endpoint using a custom Container Port and an existing Certificate

aptible endpoints:https:create \
        --app "$APP_HANDLE" \
        --certificate-fingerprint "$CERTIFICATE_FINGERPRINT" \
        --port 80 \
        "$SERVICE"

Was this page helpful?

aptible endpoints:deprovisionaptible endpoints:https:modify