Creating a label

POST https://{{base_url}}/v6/groups/tests/new.json

Creating a label

Creates a new label (formerly called group) in ThousandEyes, based on properties provided in the POST data. In order to create a new label, the user attempting the creation must have sufficient privileges to create labels.

Regular users are blocked from using any of the POST-based methods.

Note: When creating or updating a label and assigning agents or tests, the user needs permission to modify the objects being added.

Optional (Querystring) Parameters

  • format=json|xml optional, specifies the format of output requested. See Output Formats for more information
  • aid={aid} optional and requires the user to be assigned to the target account group, specifies the account group context of the request, obtained from the /account-groups endpoint. Specifying this parameter without the user being assigned to the target account will result in an error response. See Account group context for more information

Request

  • {type} corresponds to the following options:
    • agents
    • tests
    • endpoint-agents
  • POST body includes the following:
    • name the name of the new label - this must be unique.
    • tests an array of testId objects, if the type specified is tests
    • agents an array of agentId objects, if the type specified is agents
    • endpointAgents an array of agentId objects, if the type specified is endpoint-agents

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring