tags

Embed
Preview of the card
<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>
PUThttps://hermeticor.com/v1/tags/resources/{resourceType}/{resourceId}

Replace the resource tag set

Parameters

resourceTypestringpathrequired
resourceIdstringpathrequired

Request body

application/json
tagsstring[]required
{
  "tags": [
    "string"
  ]
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/tags/resources/{resourceType}/{resourceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "tags": [
    "string"
  ]
}
Schema
tagsstring[]required
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

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

Add tags to a resource without touching its other tags

Parameters

resourceTypestringpathrequired
resourceIdstringpathrequired

Request body

application/json
tagsstring[]required
{
  "tags": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/tags/resources/{resourceType}/{resourceId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"tags":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PUT /v1/tags/resources/{resourceType}/{resourceId}

4XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

GEThttps://hermeticor.com/v1/tags/by-tag/{resourceType}/{name}

Parameters

resourceTypestringpathrequired
namestringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/tags/by-tag/{resourceType}/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ids": [
    "string"
  ]
}
Schema
idsstring[]required
4XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

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

Remove one tag from a resource

Parameters

resourceTypestringpathrequired
resourceIdstringpathrequired
namestringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/tags/resources/{resourceType}/{resourceId}/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · PUT /v1/tags/resources/{resourceType}/{resourceId}

4XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

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

Ids of the resources of one type that carry the tag

Parameters

namestringpathrequired
resourceTypestringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/tags/{name}/relationships/{resourceType}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/tags/by-tag/{resourceType}/{name}

4XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

POSThttps://hermeticor.com/v1/tags/{name}/relationships/{resourceType}

Tag many resources with this tag (profiles use their own tag store)

Parameters

namestringpathrequired
resourceTypestringpathrequired

Request body

application/json
idsstring[]required
{
  "ids": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/tags/{name}/relationships/{resourceType}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/tags/by-tag/{resourceType}/{name}

4XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

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

Remove this tag from many resources

Parameters

namestringpathrequired
resourceTypestringpathrequired

Request body

application/json
idsstring[]required
{
  "ids": [
    "string"
  ]
}

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/tags/{name}/relationships/{resourceType}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ids":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/tags/by-tag/{resourceType}/{name}

4XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

5XX Default Response

Same as 4XX · PUT /v1/tags/resources/{resourceType}/{resourceId}

Updated