Help Center/ ROMA Connect/ API Reference/ Public Resource APIs/ Application Management/ Verifying the Existence of an Application
Updated on 2025-07-18 GMT+08:00
View PDF

Verifying the Existence of an Application

Function

This API is used to check whether an application that meets a given condition exists.

URI

GET /v2/{project_id}/instances/{instance_id}/validate-apps

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Instance ID.

project_id

Yes

String

Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

name

No

String

Application name. Fuzzy match by application name is not supported.

id

No

String

Application ID.

key

No

String

Application key.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Application ID.

name

String

Application name.

  • Characters allowed: letters, digits, hyphens (-), underscores (_), periods (.), spaces, and parentheses.

  • Constraints: The value must be unique in an instance.

remark

String

Application description.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_details

String

Error information.

request_id

String

Request ID.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

error_details

String

Error information.

request_id

String

Request ID.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "name" : "MyApp",
  "id" : "b2e6b145-4f3f-4a80-aa45-f4b8029f95a3",
  "remark" : ""
}

Status code: 403

Forbidden

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

Status code: 404

Not Found

{
  "error_code" : "ROMA.00000101",
  "error_msg" : "error summary",
  "error_details" : "some error details here",
  "request_id" : "13760c1fe8655e61209b75665e9bef43"
}

Status Codes

Status Code

Description

200

OK

403

Forbidden

404

Not Found

Error Codes

See Error Codes.

Parent topic: Application Management