Adding Tags to an API
Pre-requisites:
You must have the Manage APIs functional privilege assigned to perform this task.
Tags are not automatically assigned to APIs, resources, methods, or operations. You can add one or more tags, and you can remove tags from an API, resource, method, or operation at any time.
You can define a set of consistent tags that meets your needs for each API, resource, method, or operation. Using a consistent set of tags makes it easier to manage the APIs, resources, methods, or operations. You can search the APIs, resources, methods, or operations based on the tags you add.
When tagging an API, keep the following points in mind:
![*](chapterTOC_bullet.png)
You cannot tag an API if it is in active state. You have to deactivate the API before tagging it.
![*](chapterTOC_bullet.png)
You can assign tags to the following APIs and its components:
SOAP API. You can assign tags to the SOAP API itself and to its operations.
REST API. You can assign tags to the REST API itself and to its resources, and methods.
REST-enabled SOAP API. You can assign tags to the REST-enabled SOAP API. Also, you can assign tags to the REST resources and methods which correspond to the transformed SOAP operations.
OData API. You can assign tags to the OData API only.
WebSocket API. You can assign tags to the WebSocket API only.
![*](chapterTOC_bullet.png)
You can assign tags to an API, resource, method, or operation only.
![*](chapterTOC_bullet.png)
When you delete an API, resource, method, or operation in
API Gateway, any tags that were assigned to that API, resource, method, or operation are not deleted.
![*](icon_task_xpe.png)
To tag an API
1. Click APIs in the title navigation bar.
A list of all registered APIs appears.
2. Select the required API.
The API details page appears.
3. Click Edit.
4. Click Tags.
5. To add tags to the API, resource, method, or operation, do the following:
Tagging an API. In the Basic information section, select an existing tag or type the new tag in the
Search and add tags drop-down list, and then click
![](../yai-webhelp/images/add_list.png)
.
Tagging a Resource or Method. In the Resources and methods section, locate the required resource or method for tagging, select an existing tag or type the new tag in the
Search and add tags drop-down list, and then click
![](../yai-webhelp/images/add_list.png)
.
Tagging an Operation. In the Operations section, locate the required operation for tagging, select an existing tag or type the new tag in the
Search and add tags drop-down list, and then click
![](../yai-webhelp/images/add_list.png)
.
The tag is listed next to Added tags. To delete a tag, click the x icon.
6. Click Save.