SignalFx Developers Guide

Developer Home

Product Docs

SignalFx

Teams API

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

Retrieve Teams Using Query

Retrieves teams based on search criteria

get /team

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team

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 .. 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
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Responses

200

Successful retrieval of one or more team objects.
NOTE: The API returns 200 even if the query doesn't match any objects. In this case, the response object is empty.

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
results
Array of object (TeamModel)

Array 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

application/json
Copy
Expand all Collapse all
{
  • "count": 0,
  • "results":
    [
    ]
}

Create Single Team

Creates a team

post /team

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team

Creates the team specified by the properties in the request body.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Request Body schema: application/json
id
string (TeamId)

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

name
string (TeamName)

A name or label that you specify for the team

description
string (TeamDescription)

Text supplied by you that provides extended information about the team

members
Array of string (TeamMembersArray)

Array of organization member IDs that belong to this team

notificationLists
object (TeamNotificationListsObject)

Specifies the notification targets to which SignalFx sends alerts when you specify the team as an alert recipient in a detector

Responses

200

Successful creation of a team

Response Schema: application/json
id
string (TeamId)

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

name
string (TeamName)

A name or label that you specify for the team

description
string (TeamDescription)

Text supplied by you that provides extended information about the team

members
Array of string (TeamMembersArray)

Array of organization member IDs that belong to this team

notificationLists
object (TeamNotificationListsObject)

Specifies the notification targets to which SignalFx sends alerts when you specify the team as an alert recipient in a detector

Request samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "members":
    [
    ],
  • "notificationLists":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "members":
    [
    ],
  • "notificationLists":
    {
    }
}

Retrieve Team Using ID

Retrieves the team specified in the {id} path parameter

get /team/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team/{id}

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
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Responses

200

Successful retrieval of team information for the specified team. The response object contains the team name and an array of IDs for the team members.

Response Schema: application/json
name
string

Team name you specified when you created the team

members
Array of string

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

404

Request failed because SignalFx couldn't find the specified team ID. The response object contains the string “Unable to find the given team.”

Response samples

application/json
Copy
Expand all Collapse all
{
  • "name": "string",
  • "members":
    [
    ]
}

Update Single Team

Updates the team specified in the {id} path parameter

put /team/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team/{id}

Updates the team object specified by the {id} path parameter.

path Parameters
id
required
string

ID of an existing team.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Request Body schema: application/json
id
string (TeamId)

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

name
string (TeamName)

A name or label that you specify for the team

description
string (TeamDescription)

Text supplied by you that provides extended information about the team

members
Array of string (TeamMembersArray)

Array of organization member IDs that belong to this team

notificationLists
object (TeamNotificationListsObject)

Specifies the notification targets to which SignalFx sends alerts when you specify the team as an alert recipient in a detector

Responses

200

Successful team object update

Response Schema: application/json
id
string (TeamId)

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

name
string (TeamName)

A name or label that you specify for the team

description
string (TeamDescription)

Text supplied by you that provides extended information about the team

members
Array of string (TeamMembersArray)

Array of organization member IDs that belong to this team

notificationLists
object (TeamNotificationListsObject)

Specifies the notification targets to which SignalFx sends alerts when you specify the team as an alert recipient in a detector

Request samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "members":
    [
    ],
  • "notificationLists":
    {
    }
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "members":
    [
    ],
  • "notificationLists":
    {
    }
}

Delete Single Team

Deletes the team specified in the {id} path parameter

delete /team/{id}

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team/{id}

Deletes the team object specified by the {id} path parameter.

path Parameters
id
required
string

ID of an existing team.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Responses

200

Successful deletion of the specified team object. The API doesn't return a response object.

Update Team Members

Updates the list of members for the team specified in the {id} path parameter

put /team/{id}/members

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team/{id}/members

Updates the list of members for the team object specified by the {id} path parameter

path Parameters
id
required
string

ID of an existing team.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Request Body schema: application/json
Array
string

SignalFx-assigned user ID that you want to add to the team

Responses

200

Successful update of the team object

Response Schema: application/json
id
string (TeamId)

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

name
string (TeamName)

A name or label that you specify for the team

description
string (TeamDescription)

Text supplied by you that provides extended information about the team

members
Array of string (TeamMembersArray)

Array of organization member IDs that belong to this team

notificationLists
object (TeamNotificationListsObject)

Specifies the notification targets to which SignalFx sends alerts when you specify the team as an alert recipient in a detector

Request samples

application/json
Copy
Expand all Collapse all
[
  • "string"
]

Response samples

application/json
Copy
Expand all Collapse all
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "members":
    [
    ],
  • "notificationLists":
    {
    }
}

Delete Team Members

Deletes team members from the team specified in the {id} path parameter

delete /team/{id}/members

SignalFx API endpoint.
Replace {REALM} with the name of your realm. For example, if your realm is eu0, use https://api.eu0.signalfx.com/v2.
To find your realm, go to your profile page in the SignalFx web UI.
If you don't include a realm and use https:/api.signalfx.com/v2, SignalFx interprets the endpoint as pointing to the us0 realm.

https://api.{REALM}.signalfx.com/v2/team/{id}/members

Deletes team members from the team specified by the {id} path parameter. Specify the team members in the request body for this operation. The body is a JSON object that uses this syntax:
{ "members": [<member>,<member>,...] }

path Parameters
id
required
string

ID of an existing team.

header Parameters
Content-Type
required
string

Format of the request payload. The only allowed value is application/json.

X-SF-Token
required
string

A valid organization access token

Responses

200

Succesful deletion of team members from the team

© Copyright 2019 SignalFx.

Third-party license information