Get API Application Details
Retrieve detailed information of a specific API Application by ID.
Request
Request-Line
GET /waap/v1.0/apiProtection/apiApp/{id} HTTP/1.1
Request Parameters
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
id | integer | Mandatory | Unique identifier assigned to the API Application. |
Response
Response Body
Parameter | Type | Required | Description |
---|---|---|---|
id | 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. |
path_prefix | string | Mandatory | URL path prefix for the application (e.g., /test , /cm ) |
service_ids | 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 | Id.Invalid | Id is empty or invalid. |
404 | Application.NotFound | Application is not found. |
Examples
Get API Application Details
Request
GET /waap/v1.0/apiProtection/apiApp/56 HTTP/1.1
Successful Response Body
{
"id": 56,
"name": "test1",
"websites": [
371,
392
],
"domain": "test1.com,test2.com",
"path_prefix": "/test",
"service_ids": [
227481,
227979
]
}