delete

Use greymatter delete to delete a specific object and its configurations from the Grey Matter mesh. Objects can be zones, proxies, domains, routes, shared_rules and clusters.

Usage

greymatter [GLOBAL OPTIONS] delete [OPTIONS] <object type> <object key>

Sample Usage

$ greymatter delete domain domain-catalog
[info] 2019/07/10 03:47:57 Preferring --api.key for authentication
{
  "domain_key": "domain-catalog",
  "zone_key": "zone-default-zone",
  "name": "catalog",
  "port": 8080,
  "redirects": null,
  "gzip_enabled": false,
  "cors_config": null,
  "aliases": null,
  "force_https": false,
  "checksum": "82581e0c56c2ad385e84234fe118ccf8cf8deb1852a5aa318eab887e9a2717d2"
}

Help

To list available commands run with the global help flag, greymatter delete --help:

$ greymatter delete --help
NAME
    delete - delete an object from the Grey Matter API

USAGE
    greymatter [GLOBAL OPTIONS] delete [OPTIONS] <object type> <object key>

VERSION
    v1.2.1

DESCRIPTION
    object type is one of: zone, proxy, listener, domain, route, shared_rules, cluster

GLOBAL OPTIONS
    --api.header=header
            Specifies a custom header to send with every API request. Headers are given as
            name:value pairs. Leading and trailing whitespace will be stripped from the
            name and value. For multiple headers, this flag may be repeated or multiple
            headers can be delimited with commas.

    --api.host=host:port
            (default: localhost:80)
            The address (host:port) for API requests. If no port is given, it defaults to
            port 443 if --api.ssl is true and port 80 otherwise.

    --api.insecure
            (default: false)
            If true, don't validate server cert when using SSL for API requests

    --api.key=string
            (default: "none")
            [SENSITIVE] The auth key for API requests

    --api.prefix=value
            The url prefix for API requests. Forms the path part of <host>:<port><path>

    --api.ssl
            (default: true)
            If true, use SSL for API requests

    --api.sslCert=value
            Specifies the SSL cert to use for every API request.

    --api.sslKey=value
            Specifies the SSL key to use for every API request.

    --console.level=level
            (default: "info")
            (valid values: "debug", "info", "error", or "none")
            Selects the log level for console logs messages.

    --format=string
            (default: "json")
            The I/O format (json or yaml)

    --help  (default: false)
            Show a list of commands or help for one command

    --version
            (default: false)
            Print the version and exit

    Global options can also be configured via upper-case, underscore-delimited environment
    variables prefixed with "GREYMATTER_". For example, "--some-flag" becomes
    "GREYMATTER_SOME_FLAG". Command-line flags take precedence over environment variables.

OPTIONS
    --deep  (default: false)
            if true, delete the entire object graph below the specified object

    --help  (default: false)
            Show a list of commands or help for one command

    --key=string
            [deprecated] key of the object to delete

    --version
            (default: false)
            Print the version and exit

    Options can also be configured via upper-case, underscore-delimited environment
    variables prefixed with "GREYMATTER_DELETE_". For example, "--some-flag" becomes
    "GREYMATTER_DELETE_SOME_FLAG". Command-line flags take precedence over environment
    variables.

Questions?

Need help with the CLI?

Create an account at Grey Matter Support to reach our team.