API definitions in the NetScaler App Delivery and Security service
An API definition allows you to describe API resources and the operations allowed on these API resources. After the API definition is created, you can use it while configuring a new application and also in application settings such as, content routes for an end point, content policy, and security protection. The API resource paths are available as a filter condition. For more information, see Add endpoints. Select the API definitions while creating a modern application. For more information, see Deliver a modern application.
Create an API definition
- Navigate to API Definitions > Add API.
- Type a name for the API definition. Specify the following parameters:
- Title - Title for the API definition.
- Version - API version.
- Base Path - The base path for the API definition. The base path is appended as a prefix to the API resource.
- Host - The FQDN or IP address where the API service is located.
- API Resources – Specify the methods and paths to the API resources.
-
Click Create.
Manage an API definition
The API Definitions page lists the uploaded definition. The following fields are displayed.
- Name
- Title
- Version
- Actions
In the Actions column, click the pencil icon to edit the API definition. Click the trash can icon to delete the API definition.
