On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ CodeArts Deploy/ API Reference/ APIs/ Managing Environments/ Creating an Environment for an Application

Creating an Environment for an Application

Updated on 2025-05-27 GMT+08:00

View PDF

Function

This API is used to create an environment for an application.

Calling Method

For details, see Calling APIs.

URI

POST /v1/applications/{application_id}/environments

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
application_id	Yes	String	Application ID

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Message body type (format).
X-Auth-Token	Yes	String	User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details, see Obtaining a Project ID.
name	Yes	String	Environment name
deploy_type	Yes	Integer	Deployment type. 0: Host. 1: Kubernetes.
os	Yes	String	Operating system: Windows or Linux, which must be the same as that of the host cluster.
description	No	String	Environment description

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
status	String	Request success or failure status
id	String	Environment ID

Example Requests

https://{endpoint}/v1/applications/43943381f7764c52baae8e697720873f/environments

{
  "project_id" : "55837d272adf4eee90319800e2da6961",
  "name" : "Environment name",
  "deploy_type" : 0,
  "description" : "Environment Description",
  "os" : "linux"
}

Example Responses

Status code: 200

OK: The request is successful.

{
  "status" : "success",
  "id" : "140ca97e701d4c4c93c5932d5bdb32ec"
}

Status Codes


Status Code	Description
200	OK: The request is successful.

Error Codes

See Error Codes.

Parent topic: Managing Environments

Previous topic: Managing Environments

Next topic: Querying an Environment List of an Application

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel