Skip to main content

Resource Tags

Key/value tags attached to resources for organization, filtering, and cost allocation.

Resource base path: /restapi/resourcetags

MethodPathDescription
POST/restapi/resourcetags/createTagsCreate Tags
GET/restapi/resourcetags/resourceTagsListList Resource Tags
DELETE/restapi/resourcetags/deleteResourceTag/{uuid}Delete Resource Tag
note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.


Create Tags

Create Tags.

POST /restapi/resourcetags/createTags

Parameters

ParameterInTypeRequiredDescription
resourceTypequerystring✅ YesOne of: UserVm, Volume, Snapshot, VMSnapshot, Network, PublicIpAddress, FirewallRule, LoadBalancer, PortForwardingRule, Vpc, StaticRoute, NetworkACL, Template, ISO.
zoneUuidquerystring✅ YesUUID of the zone the resource belongs to.

Request body

FieldTypeRequiredDescription
valuestringNo
resourceUuidstringNo
keystringNo
{
"value": "string",
"resourceUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"key": "string"
}

Example request

curl -X POST \
"https://portal.your-domain.com/restapi/resourcetags/createTags?resourceType=VALUE&zoneUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
-H "apikey: YOUR_API_KEY" \
-H "secretkey: YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"value": "string",
"resourceUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"key": "string"
}'

Responses

CodeDescription
200Successful operation.
401Invalid authentication credentials.
550Permission denied.
{
"kongCreateTagsResponse": [
{
"isActive": true,
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"value": "string",
"resourceUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"key": "string",
"resourceType": "string"
}
],
"count": 1
}

List Resource Tags

List Resource Tags.

GET /restapi/resourcetags/resourceTagsList

Parameters

ParameterInTypeRequiredDescription
uuidquerystringNoUUID of the resource.
resourceUuidquerystringNo
resourceTypequerystringNoSame enum as Create Tags.

Example request

curl -X GET \
"https://portal.your-domain.com/restapi/resourcetags/resourceTagsList" \
-H "apikey: YOUR_API_KEY" \
-H "secretkey: YOUR_SECRET_KEY"

Responses

CodeDescription
200Successful operation.
401Invalid authentication credentials.
550Permission denied.
{
"kongCreateTagsResponse": [
{
"isActive": true,
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"value": "string",
"resourceUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"key": "string",
"resourceType": "string"
}
],
"count": 1
}

Delete Resource Tag

Delete Resource Tag.

DELETE /restapi/resourcetags/deleteResourceTag/{uuid}

Parameters

ParameterInTypeRequiredDescription
uuidpathstring✅ YesUUID of the resource.

Example request

curl -X DELETE \
"https://portal.your-domain.com/restapi/resourcetags/deleteResourceTag/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
-H "apikey: YOUR_API_KEY" \
-H "secretkey: YOUR_SECRET_KEY"

Responses

CodeDescription
200Successful operation.
401Invalid authentication credentials.
550Permission denied.
{
"kongCreateTagsResponse": [
{
"isActive": true,
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"value": "string",
"resourceUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"key": "string",
"resourceType": "string"
}
],
"count": 1
}