Get API Application Detail

Retrieves detailed information of a specific API Application by ID.

Request

Request-Line

GET /waap/v1.0/apiProtection/apiApps/{appId} HTTP/1.1

Request Parameters

Path Parameters

Parameter	Type	Required	Description
appId	Integer	Mandatory	Unique identifier assigned to the API Application.

Response

Response Body

Parameter	Type	Required	Description
appId	Integer	Mandatory	Unique identifier for the API application.
name	String	Mandatory	Name of the API application. The name must have 1-26 characters. Valid characters: 0-9, A-Z, a-z, space, . (dot), _ (underline), - (hyphen), () (parentheses), * (asterisk) and + (plus sign).
websites	Integer[]	Mandatory	List of associated website IDs.
domain	String	Mandatory	Associated domains of the application, separated by commas.
pathPrefix	String	Mandatory	URL path prefix for the application (e.g., /test, /cm)
serviceIds	Integer[]	Mandatory	List of CDN service IDs related to the application protection.

Status Codes, Error Codes and Error Messages

Status Code	Error Code	Error Message
400	AppId.Invalid	AppId is empty or invalid.
404	Application.NotFound	Application is not found.

Examples

Get API Application Detail

Request

GET /waap/v1.0/apiProtection/apiApps/56 HTTP/1.1

Successful Response Body

{
    "appId": 56,
    "name": "test1",
    "websites": [
        371,
        392
    ],
    "domain": "test1.com,test2.com",
    "pathPrefix": "/test",
    "serviceIds": [
        227481,
        227979
    ]
}