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 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

• 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

See the example below for POST body syntax

Response

If successful, sends back an HTTP/201 CREATED response code, and the new object metadata (just as if you’d called /groups/{id} with the new label ID). Metadata per the following table:

Example

$curl https://api.thousandeyes.com/v5/groups/tests/new \ -d '{ "name": "Dave's new group", "tests": [{"testId": 5048},{"testId": 6600}]}' \ -H "Content-Type: application/json" \ -u {email}:{authToken}

Header

HTTP/1.1 201 CREATED Server: nginx Date: Tue, 15 Mar 2016 00:20:26 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Strict-Transport-Security: max-age=31536000 X-Server-Name: 1-5

Body

{ "groups": [ { "name": "Dave's new group", "groupId": 1374, "type": "tests", "builtin": 0, "tests": [ { "createdDate": "2014-06-13 04:01:07", "modifiedDate": "2015-01-06 19:27:03", "createdBy": "Dave Fraleigh (dave@thousandeyes.com)", "modifiedBy": "Dave Fraleigh (dave@thousandeyes.com)", "enabled": 1, "savedEvent": 0, "testId": 6600, "testName": "Bozo BGP test 1", "type": "bgp", "prefix": "38.122.0.0/16", "alertsEnabled": 0, "liveShare": 0, "includeCoveredPrefixes": 0, "apiLinks": [...] }, { "createdDate": "2014-03-18 20:05:03", "modifiedDate": "2015-07-31 17:20:54", "createdBy": "Dave Fraleigh (dave@thousandeyes.com)", "modifiedBy": "Dave Fraleigh (dave@thousandeyes.com)", "enabled": 0, "savedEvent": 0, "testId": 5048, "testName": "www.yahoo.com A", "type": "dns-server", "interval": 300, "domain": "www.yahoo.com A", "networkMeasurements": 1, "mtuMeasurements": 1, "bandwidthMeasurements": 0, "bgpMeasurements": 1, "alertsEnabled": 0, "liveShare": 0, "recursiveQueries": 1, "dnsServers": [...], "apiLinks": [...] } ] } ] }

For error responses, see the response status codes documentation.

Updates a label (formerly called group) in ThousandEyes, based on properties provided in the POST data. In order to edit a label, the user must have access to the target label, and have access to modify the objects that the label contains. For example, to update an agent label, the user needs the Edit Agents permission assigned to their role.

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

Optional 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

• groupId the label that you wish to update, found in either the /groups or the /groups/{type} endpoint.

Response

Returns the label details, following update. Metadata of the response is returned according to the following table:

Example

$curl https://api.thousandeyes.com/v5/groups/1356/update \ -d '{ "name": "Dave's new group", "tests": [{"testId": 5048 },{"testId": 6600 }]}' \ -H "Content-Type: application/json" \ -u {email}:{authToken}

Header

HTTP/1.1 200 OK Server: nginx Date: Tue, 23 Mar 2016 00:20:26 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Strict-Transport-Security: max-age=31536000 X-Server-Name: 1-5

Body

{ "groups": [ { "name": "Dave's new group", "groupId": 1356, "type": "tests", "builtin": 0, "tests": [ { "createdDate": "2014-06-13 04:01:07", "modifiedDate": "2015-01-06 19:27:03", "createdBy": "Dave Fraleigh (dave@thousandeyes.com)", "modifiedBy": "Dave Fraleigh (dave@thousandeyes.com)", "enabled": 1, "savedEvent": 0, "testId": 6600, "testName": "Bozo BGP test 1", "type": "bgp", "prefix": "38.122.0.0/16", "alertsEnabled": 0, "liveShare": 0, "includeCoveredPrefixes": 0, "apiLinks": [...] }, { "createdDate": "2014-03-18 20:05:03", "modifiedDate": "2015-07-31 17:20:54", "createdBy": "Dave Fraleigh (dave@thousandeyes.com)", "modifiedBy": "Dave Fraleigh (dave@thousandeyes.com)", "enabled": 0, "savedEvent": 0, "testId": 5048, "testName": "www.yahoo.com A", "type": "dns-server", "interval": 300, "domain": "www.yahoo.com A", "networkMeasurements": 1, "mtuMeasurements": 1, "bandwidthMeasurements": 0, "bgpMeasurements": 1, "alertsEnabled": 0, "liveShare": 0, "recursiveQueries": 1, "dnsServers": [...], "apiLinks": [...] } ] } ] }

For error responses, see the response status codes documentation.

Deletes a label (formerly called group) currently configured in ThousandEyes. Note that built-in labels (with negative groupId numbers) are not eligible for deletion.

Optional 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

• groupId the label that you wish to delete, found in either the /groups or the /groups/{type} endpoint.
• No request body

Response

Returns an HTTP/204 NO CONTENT response.

Example

$curl https://api.thousandeyes.com/v5/groups/1356/delete \ -d '' \ -H "Content-Type: application/json" \ -u {email}:{authToken}

Header

HTTP/1.1 204 NO CONTENT Server: nginx Date: Tue, 22 Mar 2016 20:02:42 GMT Content-Type: application/json;charset=UTF-8 Transfer-Encoding: chunked Connection: keep-alive Strict-Transport-Security: max-age=31536000 X-Server-Name: 1-5

Body

• The body of a delete request will be empty.

For error responses, see the response status codes documentation.