SignalFx Developers Guide

Developer Home

Product Docs

SignalFx
Documentation Powered by ReDoc

Teams API

Overview

An API for creating, retrieving, updating, and deleting teams

Authentication

The Teams API uses some specific session tokens (User API access tokens):

  • An admin session token is for a user who's an admin for the organization.
  • For Team Controls, a team member session token is for a member of the team.
  • For Team Controls, a team manager session token is for a manager of the team.

User API access token requirements:

  • Some operations always require an admin session token.
  • If you've configured Team Controls:
    • Some operations require a team member session token
    • Some operations require a team manager or admin session token
  • If you haven't configured Team Controls, some operations can use a session token for any user.

The following sections describe each requirement.

Admin session token

The following operations always require an admin session token:

  • Create a team: POST /team
  • Update a team: PUT /team/{id}
  • Delete a team: DELETE /team/{id}

Admin or team manager session token

The following operation requires an admin session token. If you've configured Team Controls, you can also use a team manager session token.

  • Update the team manager flag for a team member: PUT /v2/team/{id}/membership

Team member session token

If you've configured Team Controls, the following operations require a team member session token:

  • Retrieve a team member for a team: GET /v2/team/{id}/member/{orgUserId}
  • Link a dashboard group to a team: POST /v2/team/{teamId}/dashboardgroup/{dashboardGroupId}
  • Remove the link between a dashboard group and a team: DELETE /v2/team/{teamId}/dashboardgroup/{dashboardGroupId}
  • Link a detector to a team: POST /v2/team/{teamId}/detector/{detectorId}
  • Remove the link between a detector and a team: DELETE /v2/team/{teamId}/detector/{detectorId}

Otherwise, you can use any session token.

Retrieve Teams Using Query

Retrieves teams based on search criteria

Retrieves one or more SignalFx team objects, based on the selection criteria specified in the query parameters.

query Parameters
limit
integer >= 1
Default: 20

Maximum number of team objects to return. The default is 20, and SignalFx uses this value if you specify an invalid value.

offset
number <int32> >= 0
Default: 0

0-based index in the result set where SignalFx should start returning team objects.

name
string

A search pattern for the value of the name property of a team object. You can use any ASCII character in the string, and SignalFx matches the pattern to any part of the name property. For example, name=Sig matches the following team names:

  • SignalFx
  • `SignedMetrics
  • Insignia

The following conditions cause SignalFx to match any value of the name property:

  • String of length 0
  • Omitting the name parameter from the query
orderBy
string
Default: "lastUpdated"

Team object property that SignalFx should sort results on.

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

Response Schema: application/json
count
integer <int32>

Number of team objects that matched the provided search criteria.

NOTE: This value is a count of the total number of objects in the result set. The number of objects that the system returns is affected by the limit and offset query parameters. In summary:

  • count: Size of result set
  • number of returned objects:
    • (limit - offset) >= count: count
    • (limit - offset) < count: limit - offset
Array of objects (TeamModel)

List of team objects that the system returns as the result of the request. The number and location of the objects within the result set depend on the query parameters you specify in the request. To learn more, see the top-level description of the API and the description of the count response property

Response samples

Content type
application/json
{
  • "count": 0,
  • "results":
    [
    ]
}

Create Single Team

Creates a team

Creates the team specified by the properties in the request body

header Parameters
Content-Type
required
string

Format of the request body. Always "application/json".

X-SF-TOKEN
required
string

Authentication token. Must be a session token (User API access token) for a SignalFx user who has administrative privileges.

Request Body schema: application/json

Properties that SignalFx uses to create the team object

description
string (TeamDescription)

Text that provides extended information about the team

id
string (TeamId)

SignalFx-defined ID for the team. This property is read-only.

members
Array of strings (TeamMembersArray)

List of SignalFx user IDs that belong to this team

name
string (TeamName)

Name or label for the team

object (TeamNotificationLists)

Team notification policy, in the form of a set of notification service lists that SignalFx uses to send alert messages for an alerting rule or org token threshold. Each list has the form of a JSON array of objects.
Alerting rules specify a severity, and SignalFx uses the team notification policy for that severity when it sends a message. You can specify a list of notification services for each severity.
To send email notifications:

  • The team must already exist.
  • For one or more individual users, use "type": "Email".
  • For a single SignalFx team, use "type": "TeamEmail".
  • For multiple SignalFx teams, use multiple list objects, each with "type": "TeamEmail" and the team ID.

Responses

Response Schema: application/json
description
string (TeamDescription)

Text that provides extended information about the team

id
string (TeamId)

SignalFx-defined ID for the team. This property is read-only.

members
Array of strings (TeamMembersArray)

List of SignalFx user IDs that belong to this team

name
string (TeamName)

Name or label for the team

object (TeamNotificationLists)

Team notification policy, in the form of a set of notification service lists that SignalFx uses to send alert messages for an alerting rule or org token threshold. Each list has the form of a JSON array of objects.
Alerting rules specify a severity, and SignalFx uses the team notification policy for that severity when it sends a message. You can specify a list of notification services for each severity.
To send email notifications:

  • The team must already exist.
  • For one or more individual users, use "type": "Email".
  • For a single SignalFx team, use "type": "TeamEmail".
  • For multiple SignalFx teams, use multiple list objects, each with "type": "TeamEmail" and the team ID.

Request samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "members":
    [
    ],
  • "name": "string",
  • "notificationLists":
    {
    }
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "members":
    [
    ],
  • "name": "string",
  • "notificationLists":
    {
    }
}

Delete Team

Deletes the team specified in the {id} path parameter

Deletes a team from the organization, based on the team's ID specified by the {id} path parameter.

path Parameters
id
required
string

ID of an existing team

header Parameters
X-SF-TOKEN
required
string

Authentication token. Must be a session token (User API access token) for a SignalFx user who has administrative privileges.

Responses

Retrieve Team Using ID

Retrieves the team specified in the {id} path parameter

Retrieves the team name and team members for the team specified by the id path parameter.

path Parameters
id
required
string

ID of an existing team

header Parameters
X-SF-TOKEN
required
string

Authentication token

Responses

Response Schema: application/json
members
Array of strings

List of member IDs. Each element contains the SignalFx user ID of a user that belongs to this team.

name
string

Team name you specified when you created the team

Response samples

Content type
application/json