> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kosli.com/llms.txt
> Use this file to discover all available pages before exploring further.
## Submitting Feedback
If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback:
POST https://docs.kosli.com/feedback
```json
{
"path": "/client_reference/kosli_report_approval",
"feedback": "Description of the issue"
}
```
Only submit feedback when you have something specific and actionable to report.
# kosli report approval
> Report an approval of deploying an artifact to an environment to Kosli.
## Synopsis
```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
kosli report approval [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]
```
Report an approval of deploying an artifact to an environment to Kosli.
The artifact fingerprint can be provided directly with the `--fingerprint` flag, or
calculated based on `--artifact-type` flag.
Artifact type can be one of: "file" for files, "dir" for directories, "oci" for container
images in registries or "docker" for local docker images.
Note: `--artifact-type=docker` reads the image's repo digest via the local Docker daemon.
The image must have been pushed to or pulled from a registry for a repo digest to exist;
a freshly built image (just `docker build`) will not have one. If the image is already in
a registry, prefer `--artifact-type=oci`, which fetches the digest directly from the
registry without needing a local Docker daemon.
## Flags
| Flag | Description |
| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| --approver string | \[optional] The user approving an approval. |
| -t, --artifact-type string | The type of the artifact to calculate its SHA256 fingerprint. One of: \[oci, docker, file, dir]. Only required if you want Kosli to calculate the fingerprint for you (i.e. when you don't specify '--fingerprint' on commands that allow it). |
| -d, --description string | \[optional] The approval description. |
| -D, --dry-run | \[optional] Run in dry-run mode. When enabled, no data is sent to Kosli and the CLI exits with 0 exit code regardless of any errors. |
| -e, --environment string | \[defaulted] The environment the artifact is approved for. (defaults to all environments) |
| -x, --exclude strings | \[optional] The comma separated list of directories and files to exclude from fingerprinting. Can take glob patterns. Only applicable for --artifact-type dir. |
| -F, --fingerprint string | \[conditional] The SHA256 fingerprint of the artifact. Only required if you don't specify '--artifact-type'. |
| -f, --flow string | The Kosli flow name. |
| -h, --help | help for approval |
| --newest-commit string | \[defaulted] The source commit sha for the newest change in the deployment. Can be any commit-ish. (default "HEAD") |
| --oldest-commit string | \[conditional] The source commit sha for the oldest change in the deployment. Can be any commit-ish. Only required if you don't specify '--environment'. |
| --registry-password string | \[conditional] The container registry password or access token. Only required if you want to read container image SHA256 digest from a remote container registry. |
| --registry-username string | \[conditional] The container registry username. Only required if you want to read container image SHA256 digest from a remote container registry. |
| --repo-root string | \[defaulted] The directory where the source git repository is available. (default ".") |
| -u, --user-data string | \[optional] The path to a JSON file containing additional data you would like to attach to the approval. |
## 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. A boolean flag [docs](/faq/#boolean-flags) (default false) |
| -H, --host string | \[defaulted] The Kosli endpoint. (default "[https://app.kosli.com](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. |
## Live Examples in different CI systems
View an example of the `kosli report approval` command in GitHub.
In [this YAML file](https://github.com/cyber-dojo/differ/blob/30dffd09c3f896a322c65029247abcea3019c43a/.github/workflows/main.yml#L358)
View an example of the `kosli report approval` command in GitLab.
In [this YAML file](https://gitlab.com/cyber-dojo/creator/-/blob/48bdbd3b059d45489e8ae5f9f680f48bc6201ad8/.gitlab/workflows/main.yml#L200)
## Examples Use Cases
These examples all assume that the flags `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](/getting_started/install/#assigning-flags-via-environment-variables).
```shell theme={"theme":"dracula","languages":{"custom":["/languages/rego.json"]}}
# Report that an artifact with a provided fingerprint (sha256) has been approved for
# deployment to environment .
# The approval is for all git commits since the last approval to this environment.
kosli report approval \
--api-token yourAPIToken \
--description "An optional description for the approval" \
--environment yourEnvironmentName \
--approver username \
--org yourOrgName \
--flow yourFlowName \
--fingerprint yourArtifactFingerprint
# Report that a file type artifact has been approved for deployment to environment .
# The approval is for all git commits since the last approval to this environment.
kosli report approval FILE.tgz \
--api-token yourAPIToken \
--artifact-type file \
--description "An optional description for the approval" \
--environment yourEnvironmentName \
--newest-commit HEAD \
--approver username \
--org yourOrgName \
--flow yourFlowName
# Report that an artifact with a provided fingerprint (sha256) has been approved for deployment.
# The approval is for all environments.
# The approval is for all commits since the git commit of origin/production branch.
kosli report approval \
--api-token yourAPIToken \
--description "An optional description for the approval" \
--newest-commit HEAD \
--oldest-commit origin/production \
--approver username \
--org yourOrgName \
--flow yourFlowName \
--fingerprint yourArtifactFingerprint
```