Updated on 2025-02-14 GMT+08:00

Creating an Application

Function

This API is used to create an application.

URI

POST /v1/{project_id}/cae/applications

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. See Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

Maximum characters: 16,384

X-Enterprise-Project-ID

No

String

Enterprise project ID.

  • When an environment is created, it will be bound with an enterprise project ID.
  • Enter 0 or up to 36 characters in UUID format with hyphens (-).
  • If this parameter is not specified or set to 0, resources in the default enterprise project are queried.
NOTE:

For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

X-Environment-ID

Yes

String

Environment ID.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

api_version

Yes

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

Yes

String

API type. Fixed value: Application.

Enumerated value:

  • Application

metadata

Yes

metadata object

Request data.

Table 4 metadata

Parameter

Mandatory

Type

Description

name

Yes

String

Application name.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

api_version

String

API version. Fixed value: v1.

Enumerated value:

  • v1

kind

String

API type. Fixed value: Application.

Enumerated value:

  • Application

metadata

metadata object

Response data.

Table 6 metadata

Parameter

Type

Description

id

String

Application ID.

name

String

Application name.

created_at

String

Creation time.

updated_at

String

Update time.

Example Request

Create application test.

POST https://{endpoint}/v1/{project_id}/cae/applications

{
  "api_version" : "v1",
  "kind" : "Application",
  "metadata" : {
    "name" : "test"
  }
}

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "Application",
  "metadata" : {
    "id" : "02022b3f-0594-496e-b34e-b41acd2bdde4",
    "name" : "test",
    "created_at" : "2022-06-10T06:49:24.836171213Z",
    "updated_at" : "2022-06-10T06:49:24.836171213Z"
  }
}

Status Code

Status Code

Description

200

The request is successful.

Error Code

For details, see Error Codes.