This page documents commands, their options, and examples.
Run sloctl [command] --help to list commands and options.
Omit [command] to show global help.
Commands that access Nobl9 use the active configuration context. Use --context to select another context for one command, or --no-config-file to authenticate with environment variables only.
Global options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Apply Nobl9 resource definitions from one or more YAML or JSON sources.
With --replay, Replay runs only for applied SLOs. Replay is skipped during --dry-run, and applied changes are not rolled back if Replay fails.
Use --file for each input source.
A source can be a local file, directory, URL, standard input (-), or glob pattern.
Directories are read one level deep; use ** in a glob to match recursively.
Globs follow Go's filepath.Match syntax with added ** support.
Directory and glob sources include only .yaml, .yml and .json files with a Nobl9 apiVersion; unrelated files are skipped.
Before processing file contents, sloctl checks for a Nobl9 API version with the regular expression "?apiVersion"?\s*:\s*"?n9.
An explicit file without a Nobl9 apiVersion is rejected.
Quote glob patterns so the shell does not expand them before sloctl receives them.
When both flags are set,
sloctl validates the resources without starting Replay.
sloctlapply [flags]
Examples
# Apply the configuration from slo.yaml.sloctlapply-f./slo.yaml# Preview an apply without persisting changes.sloctlapply-f./slo.yaml--dry-run# Apply resources from multiple different sources at once.sloctlapply-f./slo.yaml-ftest/config.yaml-fhttps://nobl9.com/slo.yaml# Apply the YAML or JSON passed directly into stdin.sloctlapply-f- <slo.yaml# Apply the configuration from slo.yaml and set project if it is not defined in file.sloctlapply-f./slo.yaml-pslo# Apply the configurations from all the files located at cwd recursively.sloctlapply-f'**'# Apply the configurations from files with 'annotations' name within the whole directory tree.sloctlapply-f'**/annotations*'# Apply the SLO(s) from slo.yaml and import its/their data from 2023-03-02T15:00:00Z until now.sloctlapply-f./slo.yaml--replay--from=2023-03-02T15:00:00Z
Options
--dry-run
Send the request without persisting changes.
-f, --file stringArray
Path, directory, URL, glob pattern, or - for YAML or JSON from standard input. Repeat this flag to use multiple sources.
--from time
Start Replay at this RFC3339 timestamp. Must be used with --replay.
-p, --project string
Use this project for project-scoped definitions that omit metadata.project; definitions specifying another project are rejected.
--replay
Run Replay for each applied SLO. Applied changes are not rolled back if Replay fails.
-y, --yes
Skip the file-count confirmation prompt. By default, the prompt appears when a directory or glob resolves to more than 23 files. Configure filesPromptEnabled and filesPromptThreshold in the [sloctl] section of config.toml, or set SLOCTL_FILES_PROMPT_ENABLED and SLOCTL_FILES_PROMPT_THRESHOLD.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get the AWS identifiers used to configure IAM roles for Direct data sources and data exports.
Options
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Return the AWS external ID and Nobl9 AWS account ID for the named
Direct data source in the active Project.
Use these values to configure a cross-account IAM role.
The response contains the externalID and accountID fields.
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete past events for one budget adjustment. Only events that ended within the last 30 days can be deleted. Deletions recalculate affected SLO error budgets and can alter reliability reports.
Provide YAML input from a local file or standard input. Separate multiple YAML documents with ---.
Path to a YAML event definition file, or - to read from standard input.
-h, --help
Help for events.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get past and ongoing events for one budget adjustment in a required RFC3339 time range. Results are ordered by event start time and limited to 250 events.
Use --slo-name together with --slo-project to filter by one SLO. Each matching
event includes its associated SLOs.
sloctlbudgetadjustmentseventsget [flags]
Examples
# Get Adjustment Events for 'sample-adjustment-name' from 2024-09-23T00:45:00 UTC to 2024-09-23T20:46:00 UTC.sloctlbudgetadjustmentseventsget--adjustment-name=sample-adjustment-name--from=2024-09-23T00:45:00Z--to=2024-09-23T20:46:00Z# Get Adjustment Events for 'sample-adjustment-name' from 2024-09-23T00:45:00 UTC to 2024-09-23T20:46:00 UTC# only for one slo with sloName and project filters.sloctlbudgetadjustmentseventsget \--adjustment-name=sample-adjustment-name \--from=2024-09-23T00:45:00Z \--to=2024-09-23T20:46:00Z \--slo-project=sample-project-name \--slo-name=sample-slo-name
Options
--adjustment-name string
Name of the budget adjustment.
--from time
Start of the query range in RFC3339 format.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
--slo-name string
SLO name to filter by. Must be used with --slo-project.
--slo-project string
Project of the SLO to filter by. Must be used with --slo-name.
--to time
End of the query range in RFC3339 format.
-h, --help
Help for events.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Update past events for one budget adjustment. Only events that ended within the last 30 days can be updated. Updates recalculate affected SLO error budgets and can alter reliability reports.
Provide YAML input from a local file or standard input. Identify each event by its existing timestamps and SLOs, and provide the replacement timestamps under update. Separate multiple YAML documents with ---.
Path to a YAML event definition file, or - to read from standard input.
-h, --help
Help for events.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Generate a completion script for Bash, fish, PowerShell, or Zsh. Choose a shell subcommand for loading and installation instructions.
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
To persist completions, add that command to your PowerShell profile.
sloctlcompletionpowershell [flags]
Options
--no-descriptions
disable completion descriptions
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Manage authentication contexts stored in the sloctl configuration file.
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Add a context through an interactive form.
The form collects credentials, the Nobl9 instance, and a default Project.
If the configuration contains no contexts, the new context becomes the default.
Otherwise, choose whether to make it the default.
sloctlconfigadd-context [flags]
Examples
# Add a context interactively.sloctlconfigadd-context
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Print the default context name.
With --verbose, print its configuration.
By default, the client secret is masked and the access token is omitted.
--show-secret prints configured credentials without masking.
--output and --jq apply only to verbose output.
sloctlconfigcurrent-context [flags]
Examples
# Print the default context name.sloctlconfigcurrent-context# Print its masked configuration as JSON.sloctlconfigcurrent-context--verbose--outputjson# Print unmasked credentials. Treat the output as sensitive.sloctlconfigcurrent-context--verbose--show-secret
Options
-q, --jq string
Filter or transform command output using a jq expression.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Print the user ID associated with the active credentials.
With --verbose, print the complete user record.
--output and --jq apply only to verbose output.
sloctlconfigcurrent-user [flags]
Examples
# Print the current user ID.sloctlconfigcurrent-user# Print the complete user record as JSON.sloctlconfigcurrent-user--verbose--outputjson
Options
-q, --jq string
Filter or transform command output using a jq expression.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more contexts by name,
or omit the names to use an interactive multi-select.
The default context cannot be deleted; select another default context first.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
List every context name, or only the names supplied as arguments.
With --verbose, print the selected context configurations.
Client secrets are masked and access tokens are omitted.
sloctlconfigget-contexts[context-name...] [flags]
Examples
# List all context names.sloctlconfigget-contexts# Print selected contexts as TOML.sloctlconfigget-contextsdevelopmentproduction--verbose--outputtoml
Options
-q, --jq string
Filter or transform command output using a jq expression.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Rename one context by providing its existing and new names,
or omit both names to use an interactive form.
If the renamed context is the default, the new name remains the default.
# Rename a context directly.sloctlconfigrename-contextold-contextnew-context# Rename a context interactively.sloctlconfigrename-context
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Set the default context by name, or omit the name to select a context interactively.
sloctlconfiguse-context[context-name] [flags]
Examples
# Select a context interactively.sloctlconfiguse-context# Set a context directly.sloctlconfiguse-contextmy-context
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Convert supported external resource definitions with a format-specific subcommand.
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Convert OpenSLO YAML or JSON from files, directories, URLs,
glob patterns, or standard input.
Repeat --file to combine sources. Quote glob patterns to prevent shell expansion.
Converted Nobl9 resources are written to standard output and can be piped to sloctl apply.
See nobl9-openslo for conversion rules and supported resources.
sloctlconvertopenslo [flags]
Examples
# Convert the OpenSLO definitions from service.yaml.cat <<'EOF' > ./service.yamlapiVersion: openslo/v1kind: Servicemetadata: annotations: nobl9.com/metadata.project: my-project name: example-servicespec: description: Example service descriptionEOFsloctlconvertopenslo-f./service.yaml# Convert definitions from multiple different sources at once.sloctlconvertopenslo-f./service.yaml-ftest/config.yaml# Convert the YAML or JSON passed directly into stdin.sloctlconvertopenslo-f- <service.yaml# Convert definitions from all the files located at cwd recursively.sloctlconvertopenslo-f'**'# Convert definitions from files with 'data-sources' name within the whole directory tree.sloctlconvertopenslo-f'**/data-sources*'# Apply converted definitions in one step.sloctlconvertopenslo-f./service.yaml |sloctlapply-f-
Options
-f, --file stringArray
OpenSLO YAML or JSON source: file, directory, URL, glob pattern, or - for standard input. Repeat this flag to use multiple sources.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete resources described by one or more YAML or JSON sources. To delete resources by name, use a resource subcommand such as sloctl delete slos <name>.
Use --file for each input source.
A source can be a local file, directory, URL, standard input (-), or glob pattern.
Directories are read one level deep; use ** in a glob to match recursively.
Globs follow Go's filepath.Match syntax with added ** support.
Directory and glob sources include only .yaml, .yml and .json files with a Nobl9 apiVersion; unrelated files are skipped.
Before processing file contents, sloctl checks for a Nobl9 API version with the regular expression "?apiVersion"?\s*:\s*"?n9.
An explicit file without a Nobl9 apiVersion is rejected.
Quote glob patterns so the shell does not expand them before sloctl receives them.
sloctldelete [flags]
Examples
# Delete the configuration from slo.yaml.sloctldelete-f./slo.yaml# Preview deletion without persisting changes.sloctldelete-f./slo.yaml--dry-run# Delete resources from multiple different sources at once.sloctldelete-f./slo.yaml-ftest/config.yaml-fhttps://nobl9.com/slo.yaml# Delete the YAML or JSON passed directly into stdin.sloctldelete-f- <slo.yaml# Delete by passing in one or more resource names.sloctldeleteslomy-slo-nameanother-slo-name# Delete the configuration from slo.yaml and set project context if it is not defined in file.sloctldelete-f./slo.yaml-pslo# Delete the configurations from all the files located at cwd recursively.sloctldelete-f'**'# Delete the configurations from files with 'annotations' name within the whole directory tree.sloctldelete-f'**/annotations*'
Options
--dry-run
Send the request without persisting changes.
-f, --file stringArray
Path, directory, URL, glob pattern, or - for YAML or JSON from standard input. Repeat this flag to use multiple sources.
-p, --project string
Use this project for project-scoped definitions that omit metadata.project; definitions specifying another project are rejected.
-y, --yes
Skip the file-count confirmation prompt. By default, the prompt appears when a directory or glob resolves to more than 23 files. Configure filesPromptEnabled and filesPromptThreshold in the [sloctl] section of config.toml, or set SLOCTL_FILES_PROMPT_ENABLED and SLOCTL_FILES_PROMPT_THRESHOLD.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more agents by name. At least one name is required. Use --project to override the configured default project.
sloctldeleteagents<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more alert methods by name. At least one name is required. Use --project to override the configured default project.
sloctldeletealertmethods<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more alert policies by name. At least one name is required. Use --project to override the configured default project.
sloctldeletealertpolicies<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more alert silences by name. At least one name is required. Use --project to override the configured default project.
sloctldeletealertsilences<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more annotations by name. At least one name is required. Use --project to override the configured default project.
sloctldeleteannotations<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more data exports by name. At least one name is required. Use --project to override the configured default project.
sloctldeletedataexports<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more direct data sources by name. At least one name is required. Use --project to override the configured default project.
sloctldeletedirects<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more projects by name. At least one name is required.
sloctldeleteprojects<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more reports by name. At least one name is required.
sloctldeletereports<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more role bindings by name. At least one name is required. Use --project to override the configured default project.
sloctldeleterolebindings<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more services by name. At least one name is required. Use --project to override the configured default project.
sloctldeleteservices<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Delete one or more SLOs by name. At least one name is required. Use --project to override the configured default project.
sloctldeleteslos<name>[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
-p, --project string
Delete resources from this project instead of the configured default project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
The edit command allows you to directly edit Nobl9 resources like SLOs or Alert Policies.
Selected resources are written to a temporary YAML file before the editor opens.
It will open the editor defined by your SLOCTL_EDITOR or EDITOR environment variables.
SLOCTL_EDITOR takes precedence over EDITOR.
If neither is defined, it falls back to:
notepad for Windows
The first available editor from vim, vi, nano for Unix systems, including macOS
When opening the editor, sloctl first uses the shell defined in the SHELL environment variable.
If this is not defined, the default shell is /bin/bash for Unix systems or cmd for Windows.
Saving an empty or unchanged file cancels the operation.
Removing a resource from the file does not delete it.
You cannot change its kind, name, or project.
Invalid YAML or server errors reopen the editor with error details.
If the editor fails, sloctl preserves the temporary file and prints its path.
It also preserves the file and prints its path if you abandon invalid changes without fixing or reverting them.
Examples
# Edit one SLO from your default Project.sloctleditslomy-slo# Use an alternative editor.SLOCTL_EDITOR="nano"sloctleditprojectdefault# Edit one Service from a specific Project.sloctleditservicemy-service-pmy-project# Edit multiple Alert Policies in one session.sloctleditalertpolicypolicy-apolicy-b# Preview edited changes without persisting them.sloctleditservicemy-service-pmy-project--dry-run
Options
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select one agent by name and open it for editing. If the selection resolves to more than one agent, the command fails. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditagents[name] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select alert methods by name or available filters and open them for editing. Without names, all matching alert methods are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditalertmethods[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select alert policies by name or available filters and open them for editing. Without names, all matching alert policies are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditalertpolicies[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select alert silences by name or available filters and open them for editing. Without names, all matching alert silences are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditalertsilences[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select annotations by name or available filters and open them for editing. Without names, all matching annotations are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
Filter annotations whose spec.startTime is at or after this RFC3339 timestamp.
-p, --project string
Select resources from this project instead of the configured default project.
--slo string
Filter annotations by SLO name.
--system
Include annotations in system categories.
--to time
Filter annotations whose spec.endTime is at or before this RFC3339 timestamp.
--user
Include annotations in user categories.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select budget adjustments by name or available filters and open them for editing. Without names, all matching budget adjustments are opened. --project and --slo must be supplied together when filtering by SLO. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditbudgetadjustments[name...] [flags]
Options
-p, --project string
Filter budget adjustments by SLO project. Must be used with --slo.
--slo string
Filter budget adjustments by SLO name. Must be used with --project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select data exports by name or available filters and open them for editing. Without names, all matching data exports are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditdataexports[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select direct data sources by name or available filters and open them for editing. Without names, all matching direct data sources are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditdirects[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select projects by name or available filters and open them for editing. Without names, all matching projects are opened. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditprojects[name...] [flags]
Options
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select reports by name or available filters and open them for editing. Without names, all matching reports are opened. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditreports[name...] [flags]
Options
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select role bindings by name or available filters and open them for editing. Without names, all matching role bindings are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditrolebindings[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select services by name or available filters and open them for editing. Without names, all matching services are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditservices[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
-p, --project string
Select resources from this project instead of the configured default project.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Select SLOs by name or available filters and open them for editing. Without names, all matching SLOs are opened. Use --project to select a project or --all-projects to select across projects. Run sloctl edit --help for editor selection and failure safeguards.
sloctleditslos[name...] [flags]
Options
-A, --all-projects
Select resources to edit across all projects.
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
-p, --project string
Select resources from this project instead of the configured default project.
-s, --service stringArray
Filter SLOs by service name. Repeat to select multiple services.
--dry-run
Send the request without persisting changes.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get resources by name or filter and print them as YAML, JSON, or CSV. YAML is the default.
Resource names can be supplied as arguments or read from standard input. Without names, each resource command returns all resources matching its filters. Use --jq to filter or transform the results.
Examples
# Get every SLO in the configured default project.sloctlgetslos# Get selected SLOs as JSON.sloctlgetslosavailabilitylatency--projectmy-project--outputjson# Read resource names from standard input.printf '%s\n' availability latency |sloctlgetslos--projectmy-project
Options
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get agents by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching agents are returned. Use --project to select a project or --all-projects to search all projects.
--with-keys includes client_id and client_secret in the output and performs one additional credential request for every returned agent.
sloctlgetagents[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
-k, --with-keys
Include agent client_id and client_secret values. This performs one additional credential request per returned agent.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get alert methods by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching alert methods are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetalertmethods[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get alert policies by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching alert policies are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetalertpolicies[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get alerts by ID or filter. Alert IDs can also be read from standard input. Repeat the same filter to match any supplied value; different filters are combined.
Active and resolved alerts are both included by default. Set --resolved=false or --triggered=false to select only one status.
A filter can return no alerts when a referenced Alert Policy, SLO, Service, or Objective was deleted. Recreating a resource with the same name does not restore its old alerts. Unlinking an Alert Policy from an SLO can also hide related alerts.
Alert output includes these timing and resolution fields:
spec.conditions[].status.firstMetMetricTime: when the condition first became true.
spec.conditions[].status.lastsForMetMetricTime: when the required lastsFor duration was met.
spec.conditions[].status.lastMetMetricTime: the last time the condition remained true.
spec.coolDownStartedAtMetricTime: when the cooldown started for a resolved alert.
spec.resolutionReason: why the alert was resolved or canceled.
Results may be truncated by the API. If sloctl reports truncation, use narrower filters.
For alert lifecycle concepts and the web interface,
see Alert details.
The command response includes condition timing,
cooldown timing,
and the reason an alert was resolved or canceled.
sloctlgetalerts[id...] [flags]
Examples
# Get active and resolved alerts from all projects.sloctlgetalert-A# Get only active (not resolved yet) alerts.sloctlgetalert--triggered--resolved=false-A# Get only resolved alerts.sloctlgetalert--resolved--triggered=false-A# Get a specific alert by the alert ID.sloctlgetalertce1a2a10-d74d-477f-b574-b278ee54e02b-A# Get alerts related to the reportsapi service or usersapi service in project prod.sloctlgetalert--servicereportsapi--serviceusersapi-pprod# Get only resolved alerts for the specific alert policy and SLO in the specified project.sloctlgetalert--resolved--triggered=false--alert-policyslow-burn--slousersapi-latency-pprod# Get alerts triggered for the slo usersapi-availability AND objective objective-1 in project prod.sloctlgetalert--slousersapi-availability--objectiveobjective-1-pprod# Get alerts for slo usersapi-latency AND either objective-1 OR objective-2 in project prod.sloctlgetalert--slousersapi-latency--objectiveobjective-1--objectiveobjective-2-pprod# Get alerts by a time range.# We're assuming the current date is 2023-03-23T12:00:00Z:# - Alerts that were active yesterday:sloctlgetalert--from2023-03-22T00:00:00Z--to2023-03-22T23:59:59Z-A# - Alerts that have been active since yesterday:sloctlgetalert--from2023-03-22T00:00:00Z-A# - Alerts that have been active until today:sloctlgetalert--to2023-03-23T00:00:00Z-A
Options
--alert-policy stringArray
Filter by alert policy name. Repeat to match any of several policies.
--slo stringArray
Filter by SLO name. Repeat to match any of several SLOs.
--objective stringArray
Filter by objective name. Repeat to match any of several objectives.
--service stringArray
Filter by service name. Repeat to match any of several services.
--resolved
Include resolved alerts. Set --resolved=false to exclude them. (default true)
--triggered
Include active alerts. Set --triggered=false to exclude them. (default true)
--from time
Set the start of the alert metric-time range in RFC3339 format.
--to time
Set the end of the alert metric-time range in RFC3339 format.
-p, --project string
Select resources from this project instead of the configured default project.
-A, --all-projects
Select resources across all projects.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get alert silences by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching alert silences are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetalertsilences[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get annotations by name or filter. Pass names as arguments or through standard input. Without a category selector, this command returns only user categories (Comment, ReviewNote). Use --system, --user, or repeated --category flags to select other categories.
Annotation category origins:
Comment: added manually to an SLO.
ReviewNote: created when an SLO review status changes.
# Get all user annotations from all projects.sloctlgetannotations-A# Get a specific annotation by the annotation name in 'non-default' project.sloctlgetannotationce1a2a10-d74d-477f-b574-b278ee54e02b-pnon-default# Get all user annotations for 'my-slo' SLO in 'custom' project.sloctlgetannotation-pcustom--slo=my-slo# Get annotations from your default project which mark SLO edits and reviews.sloctlgetannotations--category=SloEdit--category=ReviewNote# Get all system annotations from all projects.sloctlgetannotations-A--system# Get all annotations (both system and user) from all projects.sloctlgetannotations-A--system--user# Filter user annotations by their start and end times.# `--from` requires `spec.startTime` at or after the specified timestamp.# `--to` requires `spec.endTime` at or before the specified timestamp.## We're assuming the current date is 2023-03-23T12:00:00Z.# - Annotations that apply only to yesterday:sloctlgetannotation--from2023-03-22T00:00:00Z--to2023-03-22T23:59:59Z-A# - Annotations that start at or after yesterday (no upper bound):sloctlgetannotation--from2023-03-22T00:00:00Z-A# - Annotations that end at or before today (no lower bound):sloctlgetannotation--to2023-03-23T00:00:00Z-A
Filter annotations whose spec.startTime is at or after this RFC3339 timestamp.
-p, --project string
Select resources from this project instead of the configured default project.
--slo string
Filter annotations by SLO name.
--system
Include annotations in system categories.
--to time
Filter annotations whose spec.endTime is at or before this RFC3339 timestamp.
--user
Include annotations in user categories.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get budget adjustments by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching budget adjustments are returned. --project and --slo must be supplied together when filtering by SLO.
Filter budget adjustments by SLO project. Must be used with --slo.
--slo string
Filter budget adjustments by SLO name. Must be used with --project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get data exports by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching data exports are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetdataexports[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get direct data sources by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching direct data sources are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetdirects[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get projects by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching projects are returned.
sloctlgetprojects[name...] [flags]
Options
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get reports by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching reports are returned.
sloctlgetreports[name...] [flags]
Options
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get role bindings by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching role bindings are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetrolebindings[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get services by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching services are returned. Use --project to select a project or --all-projects to search all projects.
sloctlgetservices[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
-p, --project string
Select resources from this project instead of the configured default project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get SLOs by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching SLOs are returned. Use --project to select a project or --all-projects to search all projects.
By default, all matching SLOs are returned. Use --limit and --offset to request a page.
sloctlgetslos[name...] [flags]
Options
-A, --all-projects
Select resources across all projects.
-l, --label stringArray
Filter by label. Repeat the flag or separate labels with commas, for example: team=platform,env=prod.
--limit int
Maximum number of SLOs to return (1-1000).
--offset int
Number of SLOs to skip (requires --limit).
-p, --project string
Select resources from this project instead of the configured default project.
-s, --service stringArray
Filter SLOs by service name. Repeat to select multiple services.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get users by ID. IDs can be supplied as arguments or read from standard input. Without IDs, up to --limit users are returned; the default limit is 100.
sloctlgetuser[id...] [flags]
Options
--limit uint
Maximum number of users to return. The default limit applies when no IDs are provided. (default 100)
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Get user groups by name or available filters. Names can be supplied as arguments or read from standard input. Without names, all matching user groups are returned.
sloctlgetusergroups[name...] [flags]
Options
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Start a Model Context Protocol (MCP) proxy over standard input and output. The proxy uses the active sloctl context to authenticate and forwards requests to Nobl9.
Use this proxy instead of a direct HTTP connection when the MCP client communicates over stdio, requires dynamic client registration, or should reuse credentials from the active sloctl context. See Nobl9 MCP server.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Move SLOs to another Project or assign them to another Service within the same Project.
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Move the named SLOs from the Project selected by --project or the active configuration.
If no SLO names are provided, every SLO in the source Project is moved.
Use --to-project for a cross-Project move.
Use --to-service without --to-project to reassign SLOs within the source Project.
Missing target Projects and Services are created.
For a cross-Project move without --to-service, each SLO retains its source Service name.
Cross-Project moves:
Change SLO links, so previous links no longer work.
Remove SLOs from reports filtered by their previous paths.
Fail when SLOs have attached Alert Policies unless you detach the policies
manually or with --detach-alert-policies.
Can make moved SLOs inaccessible to users without access to the target Project.
Nobl9 updates references to moved SLOs.
Update local SLO-as-code definitions that reference moved SLOs in composite SLOs
or Budget Adjustment filters.
sloctlmoveslo[slo-name...] [flags]
Examples
# Move 'slo-1' and 'slo-2' from your default Project to 'new-project'.sloctlmovesloslo-1slo-2--to-project=new-project# Move 'slo-1' and 'slo-2' from 'old-project' to 'new-project'.sloctlmovesloslo-1slo-2-pold-project--to-project=new-project# Move all SLOs from 'old-project' to 'new-project'.sloctlmoveslo-pold-project--to-project=new-project# Move 'slo-1' and 'slo-2' from 'old-project' to 'new-project' and# assign 'my-service' in 'new-project' Project for the moved SLOs.sloctlmovesloslo-1slo-2-pold-project--to-service=my-service--to-project=new-project# Move 'slo-1' and 'slo-2' from 'old-project' to 'new-project' and# detach Alert Policies from both SLOs.sloctlmovesloslo-1slo-2-pold-project--detach-alert-policies--to-project=new-project# Move 'slo-1' and 'slo-2' to 'new-service' within your default Project.sloctlmovesloslo-1slo-2--to-service=new-service# Move 'slo-1' to 'my-service', both the SLO and Service are in 'my-project'.sloctlmovesloslo-1-pmy-project--to-service=my-service# Move all SLOs in 'my-project' to 'new-service' within the same Project.sloctlmoveslo-pmy-project--to-service=new-service
Options
--detach-alert-policies
Detach all Alert Policies from moved SLOs during a cross-Project move.
-p, --project string
Source Project. Defaults to the Project in the active configuration.
--to-project string
Target Project for a cross-Project move. Omit when moving within the source Project.
--to-service string
Target Service. Required for same-Project moves; for cross-Project moves, the source Service name is used when omitted.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Create Replay jobs to recalculate SLO error budgets from a specified start
time until now. Replay is permanent and cannot be rolled back. A job can take
several minutes to an hour.
To replay one SLO, pass its name and --from. The Project defaults to the
active context's Project. To replay multiple SLOs, pass one or more local YAML
or JSON configuration files with --file. Values in a file take precedence over
--project and --from.
sloctl validates every requested SLO before starting any Replay. After
preflight succeeds, a failure for one entry does not stop the remaining
entries. Organizations with Replay queues enqueue the jobs; otherwise sloctl
waits for each Replay to finish before starting the next. Modifying an SLO
after its Replay starts does not change the running Replay.
See the Replay guide
for data-source support, restrictions, and effects on connected resources.
Composite Replay and sloctl
Running Replay for composite SLOs requires sloctlv0.27.0 or later.
sloctl replay list includes ongoing and queued Replays of composite SLOs.
The isComposite field identifies composite SLOs (true) and standard SLOs (false).
This field requires access to the SLO's project.
Active composite Replays cannot be canceled. You can remove a composite Replay while it is queued.
sloctlreplay[slo-name] [flags]
Examples
# Replay SLO 'my-slo' in Project 'my-project' data from 2023-03-02 15:00:00 UTC until now.sloctlreplay-pmy-project--from=2023-03-02T15:00:00Zmy-slo# Replay SLOs using file configuration from replay.yamlsloctlreplay-f./replay.yaml# If the project is not set, it is inferred from Nobl9 config.toml for the current context.# If 'from' is not provided in the config file, you must specify it with '--from' flag.# Setting 'project' or 'from' via flags does not take precedence over the values set in config.cat <<'EOF' > ./replay.yaml- slo: prometheus-latency from: 2023-03-02T16:00:00Z- slo: datadog-latency project: default- slo: dynatrace-latency project: default from: 2023-03-02T16:00:00ZEOFsloctlreplay-f./replay.yaml--from=2023-03-02T15:00:00Z# Minimal config with project and from set via flags.cat <<'EOF' > ./replay.yaml- slo: prometheus-latency- slo: datadog-latencyEOFsloctlreplay-f./replay.yaml-pmy-project--from2023-03-02T15:00:00Z# Replay SLOs using SLI data from other SLOs.cat <<'EOF' > ./replay.yaml- slo: prometheus-latency project: default from: 2023-03-02T16:00:00Z sourceSLO: slo: my-service-latency project: my-service-test-project objectivesMap: - source: acceptable target: objective-1 - source: alarming target: objective-2- slo: datadog-latency project: default from: 2023-03-02T16:00:00Z sourceSLO: slo: my-service-latency project: my-service-test-project objectivesMap: - source: alarming target: objective-1 - source: alarming target: objective-2EOFsloctlreplay-f./replay.yaml
Options
-f, --file stringArray
Path to a local YAML or JSON Replay configuration file. Repeat this flag to use multiple files.
--from time
Replay start time in RFC3339 format. Required for a single SLO and used for file entries that omit it.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
-p, --project string
Project for a single SLO, or fallback Project for file entries that omit it. Defaults to the active context's Project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Request cancellation of the data-import phase of the Replay for one SLO.
The Project defaults to the active context's Project. This command does not
remove a Replay that is still queued.
sloctlreplaycancel<slo-name> [flags]
Examples
sloctlreplaycancelmy-slo--projectmy-project
Options
-p, --project string
Project containing the SLO. Defaults to the active context's Project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Remove one queued Replay, or remove every queued Replay across all Projects
with --all. When an SLO name is provided, the Project defaults to the
active context's Project. This command does not cancel a Replay that is already
importing data.
Project containing the SLO. Defaults to the active context's Project.
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
List Replay queue entries and their current status across Projects. Use
--output or --jq to format or filter the result.
sloctlreplaylist [flags]
Examples
sloctlreplaylistsloctlreplaylist--outputjson
Options
-q, --jq string
Filter or transform command output using a jq expression.
-o, --output format
Output format: yaml, json, csv. (default yaml)
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Change the review status of one SLO by selecting a status subcommand.
The Project defaults to the active context's Project. The reviewed and skipped
statuses accept an optional --note.
# Set "prometheus-latency" SLO (non-default Project) review status as "reviewed" and provide a review note.sloctlreviewset-statusreviewedprometheus-latency-pnon-default-n"Targetmet,20%errorbudgetremaining"# Set "prometheus-latency" SLO (default Project) review status as "skipped" and provide a note explaining the reason for skipping.sloctlreviewset-statusskippedprometheus-latency--note"Insufficientdataforthisperiod"
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Set one SLO's review status to notStarted.
The Project defaults to the active context's Project.
Available only when the SLO's Service has no review schedule.
Project containing the SLO. Defaults to the active context's Project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Set one SLO's review status to overdue.
The Project defaults to the active context's Project.
Available only when the SLO's Service has a review schedule.
This feature requires Nobl9 Enterprise Edition.
sloctlreviewset-statusoverdue<slo-name> [flags]
Options
-p, --project string
Project containing the SLO. Defaults to the active context's Project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Set one SLO's review status to reviewed.
The Project defaults to the active context's Project.
Available whether or not the SLO's Service has a review schedule.
Use --note to attach context to the decision.
This feature requires Nobl9 Enterprise Edition.
sloctlreviewset-statusreviewed<slo-name> [flags]
Options
-n, --note string
Note to attach to the review decision.
-p, --project string
Project containing the SLO. Defaults to the active context's Project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Set one SLO's review status to skipped.
The Project defaults to the active context's Project.
Available only when the SLO's Service has a review schedule.
Use --note to attach context to the decision.
This feature requires Nobl9 Enterprise Edition.
sloctlreviewset-statusskipped<slo-name> [flags]
Options
-n, --note string
Note to attach to the review decision.
-p, --project string
Project containing the SLO. Defaults to the active context's Project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Set one SLO's review status to toReview.
The Project defaults to the active context's Project.
Available only when the SLO's Service has a review schedule.
This feature requires Nobl9 Enterprise Edition.
sloctlreviewset-statusto-review<slo-name> [flags]
Options
-p, --project string
Project containing the SLO. Defaults to the active context's Project.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Validate the SLI queries defined by existing SLOs or local SLO manifests.
sloctlvalidate [flags]
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Query the data source configured by an SLO and return the values produced by each SLI query.
Provide either an existing SLO name or one or more SLO manifests with --file. For file input, use --slo and --objective to limit validation.
The default time range is the last 15 minutes, and a range cannot exceed one hour. At most 50 SLI queries can be validated at once. Query failures are reported and cause a non-zero exit status.
sloctlvalidatesli[slo-name] [flags]
Examples
# Validate all SLI queries for an existing SLO in the default Project.sloctlvalidateslicheckout# Validate one objective from a manifest over the last 30 minutes.sloctlvalidatesli--file./slo.yaml--slocheckout--objectiveavailability--last30m# Validate an explicit time range and return JSON.sloctlvalidateslicheckout--from2026-07-02T10:00:00Z--to2026-07-02T10:30:00Z--outputjson
Options
-f, --file stringArray
Path, directory, URL, glob pattern, or - for YAML or JSON from standard input. Repeat this flag to use multiple sources.
--from time
Start of the validation time range.
-q, --jq string
Filter or transform command output using a jq expression.
--last duration
Validation time range ending now. Maximum value is 1h. (default 15m0s)
--objective string
Validate only the named objective.
-o, --output format
Output format: yaml, json, csv. (default yaml)
-p, --project string
Project of an SLO selected by name, or the default Project for file definitions that omit one. Project names specified in file definitions must match this value.
--slo string
Select one SLO by name from file input.
--to time
End of the validation time range.
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.
Print the sloctl version, Git branch and revision, operating system, architecture, and Go runtime version.
sloctlversion [flags]
Examples
sloctlversion
Options
Inherited options
--config string
Path to config.toml. If unset, use SLOCTL_CONFIG_FILE_PATH or the platform default.
-c, --context string
Use this context instead of the configured default for the selected command.
-h, --help
Help for sloctl.
--no-config-file
For API authentication, use SLOCTL_CLIENT_ID and SLOCTL_CLIENT_SECRET without reading or creating config.toml. Configuration commands still access the file.