Skip to main content

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

ParameterTypeRequiredDescription
idintegerMandatoryUnique identifier assigned to the API Application.

Response

Response Body

ParameterTypeRequiredDescription
idintegerMandatoryUnique identifier for the API application.
namestringMandatoryName 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).
websitesinteger[]MandatoryList of associated website IDs.
domainstringMandatoryAssociated domains of the application, separated by commas.
path_prefixstringMandatoryURL path prefix for the application (e.g., /test, /cm)
service_idsinteger[]MandatoryList of CDN service IDs related to the application protection.

Status Codes, Error Codes and Error Messages

Status CodeError CodeError Message
400Id.InvalidId is empty or invalid.
404Application.NotFoundApplication 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
]
}