Create a tag group

Creates a group your organization names. Group names are unique within the organization, and "Application" and "Status" are reserved for the system groups.

Authorization

Authorization<token>

User API key (Bearer scp_u_...). Create in Platform > API Keys.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A named set of tags of which an entity holds at most one, in an order the organization sets, optionally limited to some entity types.

description*|

What the group is for.

entity_types*array<>|

The entity types this group's tags can be applied to. null allows every taggable type the group type admits: Status leaves out types that carry a status of their own. Fixed for Visibility, which applies to hosts.

group_type*TagGroupType

Whether this is a system group or one the organization named. Set by the server: groups created through the API are always Custom.

name*string

The group's name. A system group's name is fixed.

ordered*boolean

Whether the group's tags have an order the organization sets. An unordered group lists its tags by name. Fixed for system groups: statuses are ordered, applications are not.

organization_id*string

The organization that owns this record.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/tag-groups" \  -H "Content-Type: application/json" \  -d '{    "created_at": "2026-01-15T10:30:00Z",    "description": "Which stage of delivery an asset serves.",    "entity_types": null,    "group_type": "Custom",    "id": "550e8400-e29b-41d4-a716-446655440010",    "name": "Environment",    "ordered": true,    "organization_id": "550e8400-e29b-41d4-a716-446655440001",    "scope_computed": false,    "updated_at": "2026-01-15T10:30:00Z"  }'

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.22"
  },
  "success": true,
  "data": {
    "created_at": "2026-01-15T10:30:00Z",
    "description": "Which stage of delivery an asset serves.",
    "entity_types": null,
    "group_type": "Custom",
    "id": "550e8400-e29b-41d4-a716-446655440010",
    "name": "Environment",
    "ordered": true,
    "organization_id": "550e8400-e29b-41d4-a716-446655440001",
    "scope_computed": false,
    "updated_at": "2026-01-15T10:30:00Z"
  },
  "error": "string"
}

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.22"
  },
  "success": true,
  "code": "string",
  "error": "string",
  "params": {
    "property1": null,
    "property2": null
  }
}

Authorization

Request Body

Response Body

200application/json

400application/json

`application/json`

`application/json`