SCscanopy
Tag Groups

Create tag group

Changed on

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

post/api/v1/tag-groups

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/tag-groups
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

descriptionstring nullable required

What the group is for.

entity_typesEntityDiscriminants[] nullable required

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'Application' | 'Status' | 'Visibility' | 'Custom' required

What kind of tag group this is.

Application, Status and Visibility are system groups: every organization has exactly one of each, and they can't be renamed, deleted or recreated. Application tags drive the application view. Status tags track where an asset is on its way from planned to decommissioned, on entities that have no status of their own. A host holding a Visibility tag is left out of topology. Custom groups are named by the organization.

namestring required

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

orderedboolean required

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_idstring uuid required

The organization that owns this record.

scope_computedboolean required

Whether entity_types is computed from entity metadata (Status, Visibility) rather than set by the organization. A computed scope is read-only and never stored.

created_atstring date-time required

When this record was first created.

idstring uuid required

Server-assigned unique identifier.

updated_atstring date-time required

When this record was last modified.

Example request

{
  "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"
}

Response

Tag group created

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "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"
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

  • 9dda1a8b8ed1Revision changes
    • info

      the request required property //// became read-only

    • info

      the response required property ///// became read-only for the status

  • e5d9c243ed3cRevision changes
    • breaking

      added the new required request property ////

    • warning

      added the new Visibility enum value to the ///// response property for the response status

    • info

      added the new Visibility enum value to the request property ////

    • info

      added the required property ///// to the response with the status

    • info

      added the required property ///// to the response with the status