This is the multi-page printable view of this section. Click here to print.
Set Api Description
1 - 1.3
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
Set api description
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.3 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | Description | description |
2 - 1.2
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
Set api description
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.2 | 20260630 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | Description | description |
3 - 1.1
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
Set api description
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.1 | 20260430 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | Description | description |
4 - 1.0
scpcli application-apigateway api description set
--api_id <value>
[--description <value>]
Description
Set api description
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| api_id required | string | Api ID | 31e749b7b260868f441e862b |
| description optional | string | Description | description |