Check whether the app exists.
Function
Check whether the app exists.
URI
GET /v1/{project_id}/app-auth/apps/{app_name}/exists
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        app_name  | 
      
        Yes  | 
      
        String  | 
      
        App name.  | 
     
| 
        project_id  | 
      
        Yes  | 
      
        String  | 
      
        Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A  | 
     
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        workspace_id  | 
      
        No  | 
      
        String  | 
      
        Definition: Workspace ID Constraints: If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. Range: N/A Default Value: N/A  | 
     
Request Parameters
| 
        Parameter  | 
      
        Mandatory  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|---|
| 
        X-Auth-Token  | 
      
        Yes  | 
      
        String  | 
      
        User token, which can be obtained by calling the IAM API that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.  | 
     
Response Parameters
Status code: 200
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        exists  | 
      
        Boolean  | 
      
        Indicates whether an app exists.  | 
     
Status code: 401
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
       
 Range: N/A  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Definition: Error message. Range: N/A  | 
     
Status code: 403
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
       
 Range: N/A  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Definition: Error message. Range: N/A  | 
     
Status code: 404
| 
        Parameter  | 
      
        Type  | 
      
        Description  | 
     
|---|---|---|
| 
        error_code  | 
      
        String  | 
      
       
 Range: N/A  | 
     
| 
        error_msg  | 
      
        String  | 
      
        Definition: Error message. Range: N/A  | 
     
Example Requests
GET https://{endpoint}/v1/{project_id}/app-auth/apps/{app_name}/exists&workspace_id=0
 Example Responses
Status code: 200
OK
{
  "exists" : true
}
 Status Codes
| 
        Status Code  | 
      
        Description  | 
     
|---|---|
| 
        200  | 
      
        OK  | 
     
| 
        401  | 
      
        Unauthorized  | 
     
| 
        403  | 
      
        Forbidden  | 
     
| 
        404  | 
      
        Not Found  | 
     
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.