Skip to main content

Documentation Index

Fetch the complete documentation index at: https://kosli-reference-docs-v2-17-6.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Synopsis

kosli get environment ENVIRONMENT-NAME [flags]
Get an environment’s metadata.

Flags

FlagDescription
-h, —helphelp for environment
-o, —output string[defaulted] The format of the output. Valid formats are: [table, json]. (default “table”)

Flags inherited from parent commands

FlagDescription
-a, —api-token stringThe Kosli API token.
-c, —config-file string[optional] The Kosli config file path. (default “kosli”)
—debug[optional] Print debug logs to stdout. A boolean flag docs (default false)
-H, —host string[defaulted] The Kosli endpoint. (default “https://app.kosli.com”)
—http-proxy http://proxy-server-ip:proxy-port[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 stringThe Kosli organization.

Live Example

To view a live example of ‘kosli get environment’ 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 get environment aws-prod --output=json
{
  "org": "cyber-dojo",
  "name": "aws-prod",
  "type": "ECS",
  "description": "The ECS cluster for production cyber-dojo",
  "last_modified_at": 1778149978.6593614,
  "last_reported_at": 1778149978.6593614,
  "state": true,
  "include_scaling": false,
  "tags": {
    "url": "https://cyber-dojo.org/"
  },
  "policies": [
    "build-process",
    "snyk-scan-aws-prod"
  ],
  "included_environments": null
}
Last modified on May 7, 2026