Obtaining the Application List

Function

This API is used to obtain the application list.

URI

GET /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. To obtain a token, see Obtaining a User Token Through Password Authentication. After a response is returned, the value of X-Subject-Token in the response header is the token value. 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. To obtain an environment ID, see Obtaining the Environment List in CAE API Reference. In the response, id under items indicates the environment ID.

Response Parameters

Status code: 200

**Table 3** 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
items	Array of ApplicationItem objects	Application list.

**Table 4** ApplicationItem
Parameter	Type	Description
id	String	Application ID.
name	String	Application name.
created_at	String	Creation time.
updated_at	String	Update time.

Example Request

Obtain the application list.

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

Example Response

Status code: 200

The request is successful.

{
  "api_version" : "v1",
  "kind" : "Application",
  "items" : [ {
    "id" : "88275aa8-38ae-4428-a269-6c5f41d91491",
    "name" : "test",
    "created_at" : "2022-05-30T15:09:25.642149Z",
    "updated_at" : "2022-05-30T15:09:25.642149Z"
  } ]
}