Notploy

Registries

Container registries used to pull private images. Generated from the `notploy` command surface.

Container registries used to pull private images.

notploy registry exposes 17 commands. They map one-to-one onto the registry.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy registry --help to list these commands in your terminal, or notploy registry <command> --help for a single command.

Commands

notploy registry all

Calls GET /api/trpc/registry.all.

notploy registry all [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy registry capabilities

Calls GET /api/trpc/registry.capabilities.

notploy registry capabilities --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--profile <name>stringNo—

notploy registry create

Calls POST /api/trpc/registry.create.

notploy registry create --registryName <value> --registryUrl <value> [options]
OptionTypeRequiredAllowed values
--registryName <value>stringYes—
--providerType <value>stringNodocker-hub, ghcr, gitlab, ecr, gar, acr, quay, artifactory, harbor, zot, distribution, nexus, generic-oci
--username <value>stringNo—
--password <value>stringNo—
--registryUrl <value>stringYes—
--namespace <value>stringNo—
--imagePrefix <value>stringNo—
--authMethod <value>stringNonone, basic, token
--credentialSource <value>stringNosecret, inline
--vaultSecretId <value>stringNo—
--allowAnonymous [boolean]booleanNo—
--no-allowAnonymousbooleanNo—
--registryType <value>stringNocloud, selfHosted
--serverId <value>stringNo—
--profile <name>stringNo—

notploy registry delete-image

Calls POST /api/trpc/registry.deleteImage.

notploy registry delete-image --registryId <value> --repository <value> --digest <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--repository <value>stringYes—
--digest <value>stringYes—
--profile <name>stringNo—

notploy registry descriptors

Calls GET /api/trpc/registry.descriptors.

notploy registry descriptors [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy registry get-digest

Calls GET /api/trpc/registry.getDigest.

notploy registry get-digest --registryId <value> --repository <value> --reference <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--repository <value>stringYes—
--reference <value>stringYes—
--profile <name>stringNo—

notploy registry get-manifest

Calls GET /api/trpc/registry.getManifest.

notploy registry get-manifest --registryId <value> --repository <value> --reference <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--repository <value>stringYes—
--reference <value>stringYes—
--profile <name>stringNo—

notploy registry health

Calls GET /api/trpc/registry.health.

notploy registry health --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--profile <name>stringNo—

notploy registry list-repositories

Calls GET /api/trpc/registry.listRepositories.

notploy registry list-repositories --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--profile <name>stringNo—

notploy registry list-tags

Calls GET /api/trpc/registry.listTags.

notploy registry list-tags --registryId <value> --repository <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--repository <value>stringYes—
--profile <name>stringNo—

notploy registry one

Calls GET /api/trpc/registry.one.

notploy registry one --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--profile <name>stringNo—

notploy registry remove

Calls POST /api/trpc/registry.remove.

notploy registry remove --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--profile <name>stringNo—

notploy registry secret-options

Calls GET /api/trpc/registry.secretOptions.

notploy registry secret-options [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy registry test-connection

Calls POST /api/trpc/registry.testConnection.

notploy registry test-connection [options]
OptionTypeRequiredAllowed values
--registryId <value>stringNo—
--providerType <value>stringNodocker-hub, ghcr, gitlab, ecr, gar, acr, quay, artifactory, harbor, zot, distribution, nexus, generic-oci
--registryUrl <value>stringNo—
--namespace <value>stringNo—
--authMethod <value>stringNonone, basic, token
--credentialSource <value>stringNosecret, inline
--vaultSecretId <value>stringNo—
--username <value>stringNo—
--password <value>stringNo—
--allowAnonymous [boolean]booleanNo—
--no-allowAnonymousbooleanNo—
--profile <name>stringNo—

notploy registry test-registry

Calls POST /api/trpc/registry.testRegistry.

notploy registry test-registry [options]
OptionTypeRequiredAllowed values
--registryId <value>stringNo—
--providerType <value>stringNodocker-hub, ghcr, gitlab, ecr, gar, acr, quay, artifactory, harbor, zot, distribution, nexus, generic-oci
--registryUrl <value>stringNo—
--namespace <value>stringNo—
--authMethod <value>stringNonone, basic, token
--credentialSource <value>stringNosecret, inline
--vaultSecretId <value>stringNo—
--username <value>stringNo—
--password <value>stringNo—
--allowAnonymous [boolean]booleanNo—
--no-allowAnonymousbooleanNo—
--profile <name>stringNo—

notploy registry test-registry-by-id

Calls POST /api/trpc/registry.testRegistryById.

notploy registry test-registry-by-id --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--profile <name>stringNo—

notploy registry update

Calls POST /api/trpc/registry.update.

notploy registry update --registryId <value> [options]
OptionTypeRequiredAllowed values
--registryId <value>stringYes—
--registryName <value>stringNo—
--providerType <value>stringNodocker-hub, ghcr, gitlab, ecr, gar, acr, quay, artifactory, harbor, zot, distribution, nexus, generic-oci
--registryUrl <value>stringNo—
--namespace <value>stringNo—
--imagePrefix <value>stringNo—
--authMethod <value>stringNonone, basic, token
--credentialSource <value>stringNosecret, inline
--vaultSecretId <value>stringNo—
--username <value>stringNo—
--password <value>stringNo—
--allowAnonymous [boolean]booleanNo—
--no-allowAnonymousbooleanNo—
--createdAt <value>stringNo—
--registryType <value>stringNocloud, selfHosted
--organizationId <value>stringNo—
--serverId <value>stringNo—
--profile <name>stringNo—

Network providers

External network providers (overlay networks and peers) plus their health checks. Generated from the `notploy` command surface.

Servers

Add remote servers over SSH, validate them and read their metrics and services. Generated from the `notploy` command surface.

On this page

Commandsnotploy registry allnotploy registry capabilitiesnotploy registry createnotploy registry delete-imagenotploy registry descriptorsnotploy registry get-digestnotploy registry get-manifestnotploy registry healthnotploy registry list-repositoriesnotploy registry list-tagsnotploy registry onenotploy registry removenotploy registry secret-optionsnotploy registry test-connectionnotploy registry test-registrynotploy registry test-registry-by-idnotploy registry update