SignalFx Developers Guide

Administration

The Administration API manages organizations, teams, and access tokens:

  • Organizations represent a customer "account" in the system. Account users are members of the organization.

  • You can link organization members to dashboards and detectors using teams. In addition, teams can be notification targets for detectors.

The topic Organizations and Teams provides a detailed description of the APIs for organizations and teams.

  • Access tokens authenticate API access. You have to provide an access token for each API request you make.

  • If SignalFx turns on permissions for your organization, access tokens also control API authorization. If you provide a user access token, the user associated with that token must have permission to call the API.

To learn more about the access token APIs, read the topic Authentication Tokens.

Organizations

All users belong to an organization, and may also belong to one or more teams. The users that belong to an organization are its members; in most cases, users are members of a single organization that they think of as their "SignalFx account".

Evey SignalFx user has a user ID that’s unique across all organizations. Members of an organization also have a member ID that’s specific to that organization.

The organizations API has the following operations:

  • Organization and member retrieval

    • Retrieve information about the organization associated with the authentication token in the request, using the operation GET https://api.{REALM}.signalfx.com/v2/organization.

    • Retrieve one or more member objects for the organization, based on search criteria. These objects describe the persons themselves as well as tracking information such as object creation date. Use the operation GET https://api.{REALM}.signalfx.com/v2/organization/member.

    • Retrieve the member object for a member with a specific ID, using the operation GET https://api.{REALM}.signalfx.com/v2/organization/member/{ID}.

  • Member invitation

    • Invite a user to the organization, using the operation POST https://api.{REALM}.signalfx.com/v2/organization/member.

    • Invite a group of users to the organization, using the operation POST https://api.{REALM}.signalfx.com/v2/organization/members.

  • Manager member access

    • Update the administrative access flag for a specific member who has the member identifier ID, using the operation PUT https://api.{REALM}.signalfx.com/v2/organization/member/{ID}.

  • Custom categories

    • Retrieve custom categories for the organization, using the operation GET https://api.{REALM}.signalfx.com/v2/organization/custom-categories.

    • Create, update, and delete custom categories for the organization, using the operation PATCH https://api.{REALM}.signalfx.com/v2/organization/custom-categories.

Teams

Teams link organization members to dashboards and detectors. In addition, teams can be notification targets for detectors, so that some or all team members see alerts and other notification destinations of interest to them.

The teams API has the following endpoints:

  • Creation

    • Create a team object, using the operation POST https://api.{REALM}.signalfx.com/v2/team. The object contains information about the entire team as well as IDs for the organization members who belong to the team.

  • Retrieval

    • Retrieve information for one or more teams based on search criteria, using the operation GET https://api.{REALM}.signalfx.com/v2/team.

    • Retrieve information for a team based on its team identifier TEAM_ID, using the operation GET https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID}.

  • Update

    • Update team information for team that has the team identifier TEAM_ID, using the operation PUT https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID}. Use this endpoint to update the information in the team object itself. Use the operation PUT https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID}/members endpoint to update the members of the team.

    • Update the members of a team that has the team identifier TEAM_ID, using the operation PUT https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID}/members. Use this endpoint to add members to an existing team. Use the operation PUT https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID} update the team object for the team.

  • Delete

    • Delete a team specified by its team identifier TEAM_ID, using the operation DELETE https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID}.

    • Delete members from a team specified by its team identifier TEAM_ID, using the operation
      DELETE https://api.{REALM}.signalfx.com/v2/team/{TEAM_ID}/members.

Authentication tokens

All SignalFx API requests require an authentication token, which you specify in the X-SF-Token header of your request.

SignalFx recognizes two types of tokens:

org tokens

Long-lived organization-level tokens. You create these in the web UI, but you can update them using the API. By default, these tokens persist for 5 years, so you can use them in long-running scripts that call the SignalFx API. These are referred to as access tokens in the web UI. The following APIs require org tokens:

  • Data ingest API using the endpoint /https://ingest.{REALM}.signalfx.com/v2/datapoint

  • Data backfill API using the endpoint /https://backfill.{REALM}.signalfx.com/v1/backfill

  • Custom event ingest using the endpoint /https://ingest.{REALM}.signalfx.com/v2/event

access tokens

Short-lived user-specific tokens created in the user’s profile page. These expire automatically after 30 days. You can use these for all API requests except those described in the previous point, for which an access token is required.

© Copyright 2019 SignalFx.

Third-party license information