Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ Environment/ Updating an Environment Based on the Environment ID
Updated on 2025-11-28 GMT+08:00

Updating an Environment Based on the Environment ID

Function

This API is used to deliver an environment update job.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:environment:refresh

    write

    environment

    -

    -

URI

POST /v3/{project_id}/cas/environments/{environment_id}/refresh

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

environment_id

Yes

String

Environment ID. See Obtaining All Environments.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Response

Table 3 Response parameters

Parameter

Type

Description

job_id

String

Update job ID.

environment_id

String

Environment ID.

Example Request

None

Example Response

{
    "job_id": "JOB8c8573a0-012f-4d65-9d5b-1e244f375a7b",
    "environment_id": "bd30574b-2ed1-44d1-82c8-24a0e528ec37"
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.