Domains
Attach domains to applications and Compose stacks, and generate or validate them. Generated from the `notploy` command surface.
Attach domains to applications and Compose stacks, and generate or validate them.
notploy domain exposes 11 commands. They map one-to-one onto the domain.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy domain --help to list these commands in your terminal, or
notploy domain <command> --help for a single command.
Commands
notploy domain by-application-id
Calls GET /api/trpc/domain.byApplicationId.
notploy domain by-application-id --applicationId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--applicationId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain by-compose-id
Calls GET /api/trpc/domain.byComposeId.
notploy domain by-compose-id --composeId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--composeId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain can-generate-traefik-me-domains
Calls GET /api/trpc/domain.canGenerateTraefikMeDomains.
notploy domain can-generate-traefik-me-domains --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain create
Calls POST /api/trpc/domain.create.
notploy domain create --host <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--host <value> | string | Yes | — |
--path <value> | string | No | — |
--port <value> | number | No | — |
--customEntrypoint <value> | string | No | — |
--https [boolean] | boolean | No | — |
--no-https | boolean | No | — |
--applicationId <value> | string | No | — |
--certificateType <value> | string | No | letsencrypt, none, custom |
--customCertResolver <value> | string | No | — |
--composeId <value> | string | No | — |
--serviceName <value> | string | No | — |
--domainType <value> | string | No | compose, application, preview |
--previewDeploymentId <value> | string | No | — |
--internalPath <value> | string | No | — |
--stripPath [boolean] | boolean | No | — |
--no-stripPath | boolean | No | — |
--middlewares <json> | array | No | — |
--forwardAuthEnabled [boolean] | boolean | No | — |
--no-forwardAuthEnabled | boolean | No | — |
--profile <name> | string | No | — |
notploy domain delete
Calls POST /api/trpc/domain.delete.
notploy domain delete --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain generate-domain
Calls POST /api/trpc/domain.generateDomain.
notploy domain generate-domain --appName <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--appName <value> | string | Yes | — |
--serverId <value> | string | No | — |
--profile <name> | string | No | — |
notploy domain internal-dns
Calls GET /api/trpc/domain.internalDns.
notploy domain internal-dns [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy domain one
Calls GET /api/trpc/domain.one.
notploy domain one --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain toggle-enable
Calls POST /api/trpc/domain.toggleEnable.
notploy domain toggle-enable --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain update
Calls POST /api/trpc/domain.update.
notploy domain update --host <value> --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--host <value> | string | Yes | — |
--path <value> | string | No | — |
--port <value> | number | No | — |
--customEntrypoint <value> | string | No | — |
--https [boolean] | boolean | No | — |
--no-https | boolean | No | — |
--certificateType <value> | string | No | letsencrypt, none, custom |
--customCertResolver <value> | string | No | — |
--serviceName <value> | string | No | — |
--domainType <value> | string | No | compose, application, preview |
--internalPath <value> | string | No | — |
--stripPath [boolean] | boolean | No | — |
--no-stripPath | boolean | No | — |
--middlewares <json> | array | No | — |
--forwardAuthEnabled [boolean] | boolean | No | — |
--no-forwardAuthEnabled | boolean | No | — |
--enabled [boolean] | boolean | No | — |
--no-enabled | boolean | No | — |
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy domain validate-domain
Calls POST /api/trpc/domain.validateDomain.
notploy domain validate-domain --domain <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domain <value> | string | Yes | — |
--serverId <value> | string | No | — |
--profile <name> | string | No | — |