Skip to main content

Manage Tags

Tags are labels used to categorize and filter APIs, API Products, and other resources.

List tags​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/tags?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Create a tag​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/tags" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "production"
  }'

Get a tag​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/tags/<tag-id>" \
  -H "Authorization: Bearer <your-token>"

Update a tag​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/tags/<tag-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "prod"
  }'

Delete a tag​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/tags/<tag-id>" \
  -H "Authorization: Bearer <your-token>"

Using tags​

Tags are specified as string arrays on resources. When creating or updating an API or API Product, include tags in the request body:

{
  "name": "my-api",
  "displayName": "My API",
  "status": "ACTIVE",
  "tags": ["production", "v2", "public"]
}

Filter resources by tags using query parameters:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/apis?tags=production&tags=v2" \
  -H "Authorization: Bearer <your-token>"