tags

Embed

<a href="https://hermeticor.com/docs/ref-tags"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/6667a052-4f76-479f-902d-a676511e6007/social-card.svg?v=3e7ae33eec8b" alt="tags" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/tags

Tag directory: every tag with per-resource-type counts and its group

Parameters

resourceTypestringquery

qstringquery

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "tag": "string",
      "group": "string",
      "color": "string",
      "description": "string",
      "counts": {}
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

tagstringrequired

groupstringrequired

colorstringrequired

descriptionstringrequired

countsobjectrequired

nextCursorstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/tags

POSThttps://hermeticor.com/v1/tags

Create a tag before anything carries it

Request body

application/json

namestringrequired

colorstring

descriptionstring

{
  "name": "string",
  "color": "string",
  "description": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/tags" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","description":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "name": "string",
  "created": true,
  "color": "string",
  "description": "string"
}

Schema

namestringrequired

createdbooleanrequired

colorstringrequired

descriptionstringrequired

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

GEThttps://hermeticor.com/v1/tags/{name}

One tag with its colour and description

Parameters

namestringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/tags/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "name": "string",
  "color": "string",
  "description": "string"
}

Schema

namestringrequired

colorstringrequired

descriptionstringrequired

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

DELETEhttps://hermeticor.com/v1/tags/{name}

Delete a tag from every profile and resource

Parameters

namestringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/tags/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

PATCHhttps://hermeticor.com/v1/tags/{name}

Rename a tag everywhere (merges into an existing tag of that name) and/or set its colour and description

Parameters

namestringpathrequired

Request body

application/json

namestring

colorstring

descriptionstring

{
  "name": "string",
  "color": "string",
  "description": "string"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/tags/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","color":"string","description":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/tags/{name}

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

GEThttps://hermeticor.com/v1/tag-groups

Parameters

limitintegerquery

Page size; omitted returns the whole list

cursorstringquery

Opaque: the nextCursor of the previous page

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/tag-groups" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "exclusive": false,
      "isDefault": false,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem8[]required

Show child parameters

idstringrequired

namestringrequired

tagsstring[]required

exclusivebooleanrequired

= false

isDefaultbooleanrequired

= false

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

POSThttps://hermeticor.com/v1/tag-groups

Request body

application/json

namestringrequired

tagsstring[]

exclusiveboolean

isDefaultboolean

{
  "name": "string",
  "tags": [
    "string"
  ],
  "exclusive": true,
  "isDefault": true
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/tag-groups" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","tags":["string"],"exclusive":true,"isDefault":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "tags": [
    "string"
  ],
  "exclusive": false,
  "isDefault": false,
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

tagsstring[]required

exclusivebooleanrequired

= false

isDefaultbooleanrequired

= false

createdAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

GEThttps://hermeticor.com/v1/tag-groups/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/tag-groups/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/tag-groups

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

DELETEhttps://hermeticor.com/v1/tag-groups/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/tag-groups/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · DELETE /v1/tags/{name}

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

PATCHhttps://hermeticor.com/v1/tag-groups/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

tagsstring[]

exclusiveboolean

isDefaultboolean

{
  "name": "string",
  "tags": [
    "string"
  ],
  "exclusive": true,
  "isDefault": true
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/tag-groups/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","tags":["string"],"exclusive":true,"isDefault":true}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/tag-groups

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

GEThttps://hermeticor.com/v1/tags/resources/{resourceType}/{resourceId}

Parameters

resourceTypestringpathrequired

resourceIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/tags/resources/{resourceType}/{resourceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "tags": [
    "string"
  ]
}

Schema

tagsstring[]required

4XX Default Response

Same as 4XX · GET /v1/tags

5XX Default Response

Same as 4XX · GET /v1/tags

Next part

Updated Nov 8, 2026

Was this page helpful?