apoxy
Apoxy helps you expose, explore, and evolve your APIs and services.
Synopsis
The Apoxy CLI is the quickest and easiest way to create and control Apoxy proxies.
Start by creating an account on https://apoxy.dev (opens in a new tab) and logging in with 'apoxy auth'.
Options
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-h, --help help for apoxy
-v, --verbose enable verbose outputSEE ALSO
- apoxy auth - Authenticate this CLI
- apoxy domain - Manage domain objects
- apoxy k8s - Commands that manage Apoxy on Kubernetes
- apoxy logs - View proxy logs
- apoxy proxy - Manage proxy objects
- apoxy version - The version of this CLI
apoxy auth
Authenticate this CLI
Synopsis
If you are not authenticated, this will open a browser window to login via the Apoxy Dashboard.
If your CLI is already authenticated this will return information about your session.
apoxy auth [flags]Options
-h, --help help for authOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy - Apoxy helps you expose, explore, and evolve your APIs and services.
apoxy domain
Manage domain objects
Synopsis
Expose proxies on your own domains or borrow one of ours to get going quickly.
apoxy domain [flags]Options
-h, --help help for domainOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy - Apoxy helps you expose, explore, and evolve your APIs and services.
- apoxy domain create - Create domain objects
- apoxy domain delete - Delete domain objects
- apoxy domain get - Get domain objects
- apoxy domain list - List domain objects
apoxy domain create
Create domain objects
Synopsis
Create domain objects by providing a configuration as a file or via stdin.
apoxy domain create [-f filename] [flags]Options
-f, --filename string The file that contains the configuration to create.
-h, --help help for create
--magic Create a new magic domain.
--name string A name for the new domain.
--random Generate a random name of the domain.Options inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy domain - Manage domain objects
apoxy domain delete
Delete domain objects
apoxy domain delete [flags]Options
-h, --help help for deleteOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy domain - Manage domain objects
apoxy domain get
Get domain objects
apoxy domain get <name> [flags]Options
-h, --help help for get
-p, --proxies List the proxies this domain points to.Options inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy domain - Manage domain objects
apoxy domain list
List domain objects
apoxy domain list [flags]Options
-h, --help help for list
--show-labels Print the domain's labels.Options inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy domain - Manage domain objects
apoxy k8s
Commands that manage Apoxy on Kubernetes
Options
-h, --help help for k8sOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy - Apoxy helps you expose, explore, and evolve your APIs and services.
- apoxy k8s install - Install Apoxy Controller in Kubernetes
apoxy k8s install
Install Apoxy Controller in Kubernetes
Synopsis
Install the Apoxy Controller into the target Kubernetes cluster.
This will create a new namespace and deploy the controller and supporting resources. The controller will automatically connect to the Apoxy API and begin managing your in-cluster Apoxy resources.
apoxy k8s install [flags]Options
--dry-run If true, only print the YAML that would be applied
--force If true, forces value overwrites (See: https://v1-28.docs.kubernetes.io/docs/reference/using-api/server-side-apply/#conflicts)
-h, --help help for install
--kubeconfig string Path to the kubeconfig file to use for Kubernetes API access
--namespace string The namespace to install the controller into (default "apoxy")Options inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy k8s - Commands that manage Apoxy on Kubernetes
apoxy logs
View proxy logs
Synopsis
View the request/process logs generated by your proxies. Logs can be filtered by proxy instance and/or date range. By default, logs are streamed in real-time.
apoxy logs [flags]Options
-f, --follow Follow logs in real-time
-h, --help help for logs
--json Output in raw JSON format
--since duration Show logs since a given duration (e.g. 5m, 1h)
--since-time string Show logs from a given date (e.g. 2019-01-01T00:00:00Z)Options inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy - Apoxy helps you expose, explore, and evolve your APIs and services.
apoxy proxy
Manage proxy objects
Synopsis
The core object in the Apoxy API.
apoxy proxy [flags]Options
-h, --help help for proxyOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy - Apoxy helps you expose, explore, and evolve your APIs and services.
- apoxy proxy create - Create proxy objects
- apoxy proxy delete - Delete proxy objects
- apoxy proxy get - Get proxy objects
- apoxy proxy list - List proxy objects
apoxy proxy create
Create proxy objects
Synopsis
Create proxy objects by providing a configuration as a file or via stdin.
apoxy proxy create [-f filename] [flags]Options
-f, --filename string The file that contains the configuration to create.
-h, --help help for createOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy proxy - Manage proxy objects
apoxy proxy delete
Delete proxy objects
apoxy proxy delete [flags]Options
-h, --help help for deleteOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy proxy - Manage proxy objects
apoxy proxy get
Get proxy objects
apoxy proxy get <name> [flags]Options
-h, --help help for getOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy proxy - Manage proxy objects
apoxy proxy list
List proxy objects
apoxy proxy list [flags]Options
-h, --help help for list
--show-labels Print the proxy's labels.Options inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy proxy - Manage proxy objects
apoxy version
The version of this CLI
apoxy version [flags]Options
-h, --help help for versionOptions inherited from parent commands
--check only check the authentication status
--config string config file (default is $HOME/.apoxy/config.yaml)
-v, --verbose enable verbose outputSEE ALSO
- apoxy - Apoxy helps you expose, explore, and evolve your APIs and services.
