kosli list environments

Synopsis

kosli list environments [flags]

List environments for an org. By default, all environments are returned in one response. When —page or —page-limit is set, the results are paginated and the response includes pagination metadata. The list can be filtered by name, type, space and tags, and sorted with —sort and —sort-direction.

Flags

Flag	Description
`-h`, `--help`	help for environments
`--name` string	[optional] Only list environments whose name contains this substring (case-insensitive).
`-o`, `--output` string	[defaulted] The format of the output. Valid formats are: [table, json]. (default “table”)
`--page` int	[defaulted] The page number of a response. (default 1)
`-n`, `--page-limit` int	[defaulted] The number of elements per page. (default 15)
`--sort` string	[optional] The field to sort environments by. Valid values are: [name, last_modified_at, last_changed_at]. (defaults to name)
`--sort-direction` string	[optional] The direction to sort environments in. Valid values are: [asc, desc]. (defaults to asc)
`--space-id` strings	[optional] Only list environments in the space with this ID. Can be repeated to match more than one space.
`--tag` stringArray	[optional] Only list environments that have this tag, given as ‘key’ or ‘key:value’. Can be repeated to match more than one tag.
`--type` strings	[optional] Only list environments of this type. Valid types are: [K8S, ECS, S3, lambda, server, docker, azure-apps, cloud-run, logical]. Can be repeated to match more than one type.

Flags inherited from parent commands

Flag	Description
`-a`, `--api-token` string	The Kosli API token.
`-c`, `--config-file` string	[optional] The Kosli config file path. (default “kosli”)
`--debug`	[optional] Print debug logs to stdout.
`-H`, `--host` string	[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
`--http-proxy` string	[optional] The HTTP proxy URL including protocol and port number. e.g. `http://proxy-server-ip:proxy-port`
`-r`, `--max-api-retries` int	[defaulted] How many times should API calls be retried when the API host is not reachable. (default 3)
`--org` string	The Kosli organization.
`-q`, `--quiet`	[optional] Suppress non-critical warning messages. Errors and normal output are not affected. If both `--quiet` and `--debug` are set, `--debug` wins.

Live Example

To view a live example of ‘kosli list environments’ you can run the command below (for the cyber-dojo demo organization).

export KOSLI_ORG=cyber-dojo
# The API token below is read-only
export KOSLI_API_TOKEN=Pj_XT2deaVA6V1qrTlthuaWsmjVt4eaHQwqnwqjRO3A
kosli list environments --output=json

View example output

[
  {
    "org": "cyber-dojo",
    "name": "aws-beta",
    "type": "ECS",
    "description": "The ECS cluster for staging cyber-dojo",
    "last_modified_at": 1785257304.0827382,
    "last_reported_at": 1785257304.0827382,
    "last_changed_at": 1785243263.9648561,
    "state": true,
    "include_scaling": false,
    "tags": {
      "url": "https://beta.cyber-dojo.org/"
    },
    "policies": [
      "provenance",
      "pull-request",
      "snyk-scan-aws-beta",
      "trail-compliance-aws-beta"
    ],
    "included_environments": null
  },
  {
    "org": "cyber-dojo",
    "name": "aws-beta-terraform-drift-detection",
    "type": "server",
    "description": "Detection of drift of the Infrastructure-as-code components of aws-beta",
    "last_modified_at": 1785257109.0435762,
    "last_reported_at": 1785257109.0435762,
    "last_changed_at": 1785243308.9429753,
    "state": true,
    "include_scaling": false,
    "tags": {},
    "policies": [
      "provenance"
    ],
    "included_environments": null
  },
  {
    "org": "cyber-dojo",
    "name": "aws-prod",
    "type": "ECS",
    "description": "The ECS cluster for production cyber-dojo",
    "last_modified_at": 1785257278.4557931,
    "last_reported_at": 1785257278.4557931,
    "last_changed_at": 1785243478.598589,
    "state": true,
    "include_scaling": false,
    "tags": {
      "url": "https://cyber-dojo.org/"
    },
    "policies": [
      "production-promotion",
      "provenance",
      "pull-request",
      "snyk-scan-aws-prod",
      "trail-compliance-aws-prod"
    ],
    "included_environments": null
  },
  {
    "org": "cyber-dojo",
    "name": "aws-prod-terraform-drift-detection",
    "type": "server",
    "description": "Detection of drift of the Infrastructure-as-code components of aws-prod",
    "last_modified_at": 1785257011.940645,
    "last_reported_at": 1785257011.940645,
    "last_changed_at": 1785243812.1531923,
    "state": true,
    "include_scaling": false,
    "tags": {},
    "policies": [
      "provenance"
    ],
    "included_environments": null
  },
  {
    "org": "cyber-dojo",
    "name": "production",
    "type": "logical",
    "description": "Production environments for cyber-dojo",
    "last_modified_at": 1785243812.1531923,
    "last_reported_at": null,
    "last_changed_at": 1785243812.1531923,
    "state": true,
    "include_scaling": false,
    "tags": {},
    "policies": null,
    "included_environments": [
      "aws-prod",
      "aws-prod-terraform-drift-detection"
    ]
  },
  {
    "org": "cyber-dojo",
    "name": "staging",
    "type": "logical",
    "description": "Staging environments for cyber-dojo",
    "last_modified_at": 1785243308.9429753,
    "last_reported_at": null,
    "last_changed_at": 1785243308.9429753,
    "state": true,
    "include_scaling": false,
    "tags": {},
    "policies": [],
    "included_environments": [
      "aws-beta",
      "aws-beta-terraform-drift-detection"
    ]
  }
]

Examples Use Cases

These examples all assume that the flags --api-token, --org, --host, (and --flow, --trail when required), are set/provided.

list all environments for an org

kosli list environments

show the second page of environments, 25 per page

kosli list environments 
	--page 2 
	--page-limit 25 

list environments whose name contains a substring (in JSON)

kosli list environments 
	--name prod 
	--output json 

list K8S and ECS environments tagged with team=platform

kosli list environments 
	--type K8S 
	--type ECS 
	--tag team:platform 

list environments sorted by when they last changed, newest first

kosli list environments 
	--sort last_changed_at 
	--sort-direction desc 

General

Top-level commands

kosli allow

kosli archive

kosli assert

kosli attest

kosli begin

kosli create

kosli delete

kosli diff

kosli disable / enable

kosli evaluate

kosli get

kosli join

kosli list

kosli log

kosli rename

kosli report

kosli rotate

kosli snapshot

kosli unarchive

kosli update

Synopsis

Flags

Flags inherited from parent commands

Live Example

Examples Use Cases

​Synopsis

​Flags

​Flags inherited from parent commands

​Live Example

​Examples Use Cases

Synopsis

Flags

Flags inherited from parent commands

Live Example

Examples Use Cases