API documentation

Resource group

A group that holds protection resources.

Fields

_idstring
Record id (24 hex characters).
firmstring
Id of the firm the record belongs to — always your API key’s firm.
namestring
Group name.
descriptionstring
Description.
isActiveboolean
Whether the group is active.
createdAtstring
Creation time (ISO 8601).
updatedAtstring
Last update time (ISO 8601).

JSON schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://darkradar.com/docs/schemas/resource-group.schema.json",
  "title": "Resource group",
  "description": "A group that holds protection resources.",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Record id (24 hex characters)."
    },
    "firm": {
      "type": "string",
      "description": "Id of the firm the record belongs to — always your API key’s firm."
    },
    "name": {
      "type": "string",
      "description": "Group name."
    },
    "description": {
      "type": "string",
      "description": "Description."
    },
    "isActive": {
      "type": "boolean",
      "description": "Whether the group is active."
    },
    "createdAt": {
      "type": "string",
      "description": "Creation time (ISO 8601)."
    },
    "updatedAt": {
      "type": "string",
      "description": "Last update time (ISO 8601)."
    }
  }
}

Was this page helpful?