Skip to content

Commit 2c4507a

Browse files
authored
update docs (#472)
1 parent 2526406 commit 2c4507a

File tree

2 files changed

+58
-58
lines changed

2 files changed

+58
-58
lines changed

docs/stackit_config_set.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -29,33 +29,33 @@ stackit config set [flags]
2929
### Options
3030

3131
```
32-
--allowed-url-domain string Domain name, used for the verification of the URLs that are given in the custom identity provider endpoint and "STACKIT curl" command
33-
--authorization-custom-endpoint string Authorization API base URL, used in calls to this API
34-
--dns-custom-endpoint string DNS API base URL, used in calls to this API
35-
-h, --help Help for "stackit config set"
36-
--iaas-custom-endpoint string IaaS API base URL, used in calls to this API
37-
--identity-provider-custom-client-id string Identity Provider client ID, used for user authentication
38-
--identity-provider-custom-endpoint string Identity Provider base URL, used for user authentication
39-
--load-balancer-custom-endpoint string Load Balancer API base URL, used in calls to this API
40-
--logme-custom-endpoint string LogMe API base URL, used in calls to this API
41-
--mariadb-custom-endpoint string MariaDB API base URL, used in calls to this API
42-
--mongodbflex-custom-endpoint string MongoDB Flex API base URL, used in calls to this API
43-
--object-storage-custom-endpoint string Object Storage API base URL, used in calls to this API
44-
--observability-custom-endpoint string Observability API base URL, used in calls to this API
45-
--opensearch-custom-endpoint string OpenSearch API base URL, used in calls to this API
46-
--postgresflex-custom-endpoint string PostgreSQL Flex API base URL, used in calls to this API
47-
--rabbitmq-custom-endpoint string RabbitMQ API base URL, used in calls to this API
48-
--redis-custom-endpoint string Redis API base URL, used in calls to this API
49-
--resource-manager-custom-endpoint string Resource Manager API base URL, used in calls to this API
50-
--runcommand-custom-endpoint string Run Command API base URL, used in calls to this API
51-
--secrets-manager-custom-endpoint string Secrets Manager API base URL, used in calls to this API
52-
--serverbackup-custom-endpoint string Server Backup API base URL, used in calls to this API
53-
--service-account-custom-endpoint string Service Account API base URL, used in calls to this API
54-
--service-enablement-custom-endpoint string Service Enablement API base URL, used in calls to this API
55-
--session-time-limit string Maximum time before authentication is required again. After this time, you will be prompted to login again to execute commands that require authentication. Can't be larger than 24h. Requires authentication after being set to take effect. Examples: 3h, 5h30m40s (BETA: currently values greater than 2h have no effect)
56-
--ske-custom-endpoint string SKE API base URL, used in calls to this API
57-
--sqlserverflex-custom-endpoint string SQLServer Flex API base URL, used in calls to this API
58-
--token-custom-endpoint string Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
32+
--allowed-url-domain string Domain name, used for the verification of the URLs that are given in the custom identity provider endpoint and "STACKIT curl" command
33+
--authorization-custom-endpoint string Authorization API base URL, used in calls to this API
34+
--dns-custom-endpoint string DNS API base URL, used in calls to this API
35+
-h, --help Help for "stackit config set"
36+
--iaas-custom-endpoint string IaaS API base URL, used in calls to this API
37+
--identity-provider-custom-client-id string Identity Provider client ID, used for user authentication
38+
--identity-provider-custom-well-known-configuration string Identity Provider well-known OpenID configuration URL, used for user authentication
39+
--load-balancer-custom-endpoint string Load Balancer API base URL, used in calls to this API
40+
--logme-custom-endpoint string LogMe API base URL, used in calls to this API
41+
--mariadb-custom-endpoint string MariaDB API base URL, used in calls to this API
42+
--mongodbflex-custom-endpoint string MongoDB Flex API base URL, used in calls to this API
43+
--object-storage-custom-endpoint string Object Storage API base URL, used in calls to this API
44+
--observability-custom-endpoint string Observability API base URL, used in calls to this API
45+
--opensearch-custom-endpoint string OpenSearch API base URL, used in calls to this API
46+
--postgresflex-custom-endpoint string PostgreSQL Flex API base URL, used in calls to this API
47+
--rabbitmq-custom-endpoint string RabbitMQ API base URL, used in calls to this API
48+
--redis-custom-endpoint string Redis API base URL, used in calls to this API
49+
--resource-manager-custom-endpoint string Resource Manager API base URL, used in calls to this API
50+
--runcommand-custom-endpoint string Run Command API base URL, used in calls to this API
51+
--secrets-manager-custom-endpoint string Secrets Manager API base URL, used in calls to this API
52+
--serverbackup-custom-endpoint string Server Backup API base URL, used in calls to this API
53+
--service-account-custom-endpoint string Service Account API base URL, used in calls to this API
54+
--service-enablement-custom-endpoint string Service Enablement API base URL, used in calls to this API
55+
--session-time-limit string Maximum time before authentication is required again. After this time, you will be prompted to login again to execute commands that require authentication. Can't be larger than 24h. Requires authentication after being set to take effect. Examples: 3h, 5h30m40s (BETA: currently values greater than 2h have no effect)
56+
--ske-custom-endpoint string SKE API base URL, used in calls to this API
57+
--sqlserverflex-custom-endpoint string SQLServer Flex API base URL, used in calls to this API
58+
--token-custom-endpoint string Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
5959
```
6060

6161
### Options inherited from parent commands

docs/stackit_config_unset.md

+31-31
Original file line numberDiff line numberDiff line change
@@ -26,37 +26,37 @@ stackit config unset [flags]
2626
### Options
2727

2828
```
29-
--allowed-url-domain Domain name, used for the verification of the URLs that are given in the IDP endpoint and curl commands. If unset, defaults to stackit.cloud
30-
--async Configuration option to run commands asynchronously
31-
--authorization-custom-endpoint Authorization API base URL. If unset, uses the default base URL
32-
--dns-custom-endpoint DNS API base URL. If unset, uses the default base URL
33-
-h, --help Help for "stackit config unset"
34-
--iaas-custom-endpoint IaaS API base URL. If unset, uses the default base URL
35-
--identity-provider-custom-client-id Identity Provider client ID, used for user authentication
36-
--identity-provider-custom-endpoint Identity Provider base URL. If unset, uses the default base URL
37-
--load-balancer-custom-endpoint Load Balancer API base URL. If unset, uses the default base URL
38-
--logme-custom-endpoint LogMe API base URL. If unset, uses the default base URL
39-
--mariadb-custom-endpoint MariaDB API base URL. If unset, uses the default base URL
40-
--mongodbflex-custom-endpoint MongoDB Flex API base URL. If unset, uses the default base URL
41-
--object-storage-custom-endpoint Object Storage API base URL. If unset, uses the default base URL
42-
--observability-custom-endpoint Observability API base URL. If unset, uses the default base URL
43-
--opensearch-custom-endpoint OpenSearch API base URL. If unset, uses the default base URL
44-
--output-format Output format
45-
--postgresflex-custom-endpoint PostgreSQL Flex API base URL. If unset, uses the default base URL
46-
--project-id Project ID
47-
--rabbitmq-custom-endpoint RabbitMQ API base URL. If unset, uses the default base URL
48-
--redis-custom-endpoint Redis API base URL. If unset, uses the default base URL
49-
--resource-manager-custom-endpoint Resource Manager API base URL. If unset, uses the default base URL
50-
--runcommand-custom-endpoint Server Command base URL. If unset, uses the default base URL
51-
--secrets-manager-custom-endpoint Secrets Manager API base URL. If unset, uses the default base URL
52-
--serverbackup-custom-endpoint Server Backup base URL. If unset, uses the default base URL
53-
--service-account-custom-endpoint Service Account API base URL. If unset, uses the default base URL
54-
--service-enablement-custom-endpoint Service Enablement API base URL. If unset, uses the default base URL
55-
--session-time-limit Maximum time before authentication is required again. If unset, defaults to 2h
56-
--ske-custom-endpoint SKE API base URL. If unset, uses the default base URL
57-
--sqlserverflex-custom-endpoint SQLServer Flex API base URL. If unset, uses the default base URL
58-
--token-custom-endpoint Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
59-
--verbosity Verbosity of the CLI
29+
--allowed-url-domain Domain name, used for the verification of the URLs that are given in the IDP endpoint and curl commands. If unset, defaults to stackit.cloud
30+
--async Configuration option to run commands asynchronously
31+
--authorization-custom-endpoint Authorization API base URL. If unset, uses the default base URL
32+
--dns-custom-endpoint DNS API base URL. If unset, uses the default base URL
33+
-h, --help Help for "stackit config unset"
34+
--iaas-custom-endpoint IaaS API base URL. If unset, uses the default base URL
35+
--identity-provider-custom-client-id Identity Provider client ID, used for user authentication
36+
--identity-provider-custom-well-known-configuration Identity Provider well-known OpenID configuration URL. If unset, uses the default identity provider
37+
--load-balancer-custom-endpoint Load Balancer API base URL. If unset, uses the default base URL
38+
--logme-custom-endpoint LogMe API base URL. If unset, uses the default base URL
39+
--mariadb-custom-endpoint MariaDB API base URL. If unset, uses the default base URL
40+
--mongodbflex-custom-endpoint MongoDB Flex API base URL. If unset, uses the default base URL
41+
--object-storage-custom-endpoint Object Storage API base URL. If unset, uses the default base URL
42+
--observability-custom-endpoint Observability API base URL. If unset, uses the default base URL
43+
--opensearch-custom-endpoint OpenSearch API base URL. If unset, uses the default base URL
44+
--output-format Output format
45+
--postgresflex-custom-endpoint PostgreSQL Flex API base URL. If unset, uses the default base URL
46+
--project-id Project ID
47+
--rabbitmq-custom-endpoint RabbitMQ API base URL. If unset, uses the default base URL
48+
--redis-custom-endpoint Redis API base URL. If unset, uses the default base URL
49+
--resource-manager-custom-endpoint Resource Manager API base URL. If unset, uses the default base URL
50+
--runcommand-custom-endpoint Server Command base URL. If unset, uses the default base URL
51+
--secrets-manager-custom-endpoint Secrets Manager API base URL. If unset, uses the default base URL
52+
--serverbackup-custom-endpoint Server Backup base URL. If unset, uses the default base URL
53+
--service-account-custom-endpoint Service Account API base URL. If unset, uses the default base URL
54+
--service-enablement-custom-endpoint Service Enablement API base URL. If unset, uses the default base URL
55+
--session-time-limit Maximum time before authentication is required again. If unset, defaults to 2h
56+
--ske-custom-endpoint SKE API base URL. If unset, uses the default base URL
57+
--sqlserverflex-custom-endpoint SQLServer Flex API base URL. If unset, uses the default base URL
58+
--token-custom-endpoint Custom endpoint for the token API, which is used to request access tokens when the service-account authentication is activated
59+
--verbosity Verbosity of the CLI
6060
```
6161

6262
### Options inherited from parent commands

0 commit comments

Comments
 (0)