SignalFx Developers Guide

API Endpoint Overview

List of API endpoints

Table 1. SignalFx APIs
API Description Request method Endpoint

Send Metrics and Events API

Sends metrics to SignalFx

https://ingest.{REALM}.signalfx.com/v2/datapoint

Send Metrics and Events API

Sends custom events to SignalFx

https://ingest.{REALM}.signalfx.com/v2/event

Backfill API

Sends historical MTS to SignalFx

https://backfill.{REALM}.signalfx.com/v1/backfill

Send µAPM PG Tracing Data API

Sends tracing data to SignalFx

https://ingest.{REALM}.signalfx.com/v1/trace

Metrics Metadata API

Retrieves dimensions based on a query

GET

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

Metrics Metadata API

Retrieves metadata for a dimension and value

GET

https://api.{REALM}.signalfx.com/v2/dimension/{key}/{value}

Metrics Metadata API

Overwrites metadata for the specified dimension

PUT

https://api.{REALM}.signalfx.com/v2/dimension/{key}/{value}

Metrics Metadata API

Retrieve metadata for metrics

GET

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

Metrics Metadata API

Retrieves the metadata for a metric name

GET

https://api.{REALM}.signalfx.com/v2/metric/{name}

Metrics Metadata API

Retrieves metric timeseries (MTS) metadata based on a query

GET

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

Metrics Metadata API

Retrieves the MTS metadata for a metric timeseries

GET

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

Metrics Metadata API

Retrieves metadata for tags

GET

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

Metrics Metadata API

Deletes a tag

https://api.{REALM}.signalfx.com/v2/tag/{name}

Metrics Metadata API

Retrieves metadata for a tag

GET

https://api.{REALM}.signalfx.com/v2/tag/{name}

Metrics Metadata API

Creates or updates a tag

PUT

https://api.{REALM}.signalfx.com/v2/tag/{name}

µAPM PG Service Map Retrieval API

Retrieves a service map

GET

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

µAPM PG Service Map Retrieval API

Retrieves service maps based on search criteria

https://api.{REALM}.signalfx.com/v2/servicemap/traces

µAPM PG Trace Retrieval API

Retrieves traces specified by search criteria

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

µAPM PG Trace Retrieval API

Retrieves operation names and endpoints

GET

https://api.{REALM}.signalfx.com/v2/trace/operations

µAPM PG Trace Retrieval API

Retrieves trace outlier analysis specified by search criteria

https://api.{REALM}.signalfx.com/v2/trace/outliers

µAPM PG Trace Retrieval API

Retrieves trace data specified by service names

GET

https://api.{REALM}.signalfx.com/v2/trace/services

µAPM PG Trace Retrieval API

Retrieves span names for spans received in the last 48 hours

GET

https://api.{REALM}.signalfx.com/v2/trace/spannamesbyservice

µAPM PG Trace Retrieval API

Retrieves span tags specified by search criteria

https://api.{REALM}.signalfx.com/v2/trace/spantags

µAPM PG Trace Retrieval API

Retrieves all the spans for a trace

GET

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

µAPM PG Trace Retrieval API

Retrieves all the anomaly data for the trace specified in the {id} path parameter

GET

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

Charts API

Gets one or more charts based on selection criteria

GET

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

Charts API

Creates a new chart

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

Charts API

Deletes an existing chart

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

Charts API

Retrieves a single chart

GET

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

Charts API

Updates an existing chart

PUT

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

Dashboards API

Retrieves dashboards based on search criteria

GET

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

Dashboards API

Creates a single dashboard

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

Dashboards API

Creates a new dashboard containing new charts

https://api.{REALM}.signalfx.com/v2/dashboard/simple

Dashboards API

Deletes the dashboard specified in the {id} path parameter

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

Dashboards API

Retrieves a dashboard specified in the {id} path parameter

GET

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

Dashboards API

Updates a dashboard specified in the {id} path parameter

PUT

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

Dashboard Groups API

Retrieves dashboard groups based on search criteria

GET

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

Dashboard Groups API

Creates a dashboard group

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

Dashboard Groups API

Deletes a dashboard group

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

Dashboard Groups API

Retrieves a single dashboard group

GET

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

Dashboard Groups API

Updates a dashboard group

PUT

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

Dashboard Groups API

Make a clone of an existing dashboard

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

Detectors API

Retrieves detectors based on search criteria

GET

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

Detectors API

Creates a detector

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

Detectors API

Validates a v2 detector

https://api.{REALM}.signalfx.com/v2/detector/validate

Detectors API

Deletes a single detector

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

Detectors API

Retrieves a specified detector

GET

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

Detectors API

Updates properties for a v2 detector

PUT

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

Detectors API

Disables detect blocks for a v2 detector

PUT

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

Detectors API

Enables detect blocks for a v2 detector

PUT

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

Detectors API

Retrieves events generated by a v2 detector

GET

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

Detectors API

Gets active incidents for a v2 detector

GET

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

Data Links API

Retrieves data links based on search criteria

GET

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

Data Links API

Creates one or more data link targets

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

Data Links API

Deletes the single data link specified by an ID

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

Data Links API

Retrieves the single data link specified by an ID

GET

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

Data Links API

Updates the single data link specified by an ID

PUT

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

Incidents and Alerts API

Retrieves muting rules based on search criteria

GET

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

Incidents and Alerts API

Creates a new muting rule

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

Incidents and Alerts API

Deletes a muting rule specified in the {id} path parameter

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

Incidents and Alerts API

Retrieves the muting rule specified in the {id} path parameter

GET

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

Incidents and Alerts API

Updates a muting rule

PUT

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

Incidents and Alerts API

Ends the active muting period for a muting rule

PUT

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

Incidents and Alerts API

Retrieves information for all incidents

GET

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

Incidents and Alerts API

Clears specified incidents

PUT

https://api.{REALM}.signalfx.com/v2/incident/clear

Incidents and Alerts API

Retrieves the incident specified in the {id} path parameter

GET

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

Incidents and Alerts API

Clears an incident specified by the `{id}`path parameter

PUT

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

Retrieve Custom Events API

Retrieves custom events specified by search criteria

GET

https://api.{REALM}.signalfx.com/v1/event

Integrations API

Retrieves integrations based on search criteria

GET

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

Integrations API

Creates an integration

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

Integrations API

Validates the integration specified in the {id} path parameter

GET

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

Integrations API

Deletes an integration specified in the {id} path parameter

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

Integrations API

Retrieves an integration specified in the {id} path parameter

GET

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

Integrations API

Updates an integration specified in the {id} path parameter

PUT

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

Session Tokens API

Invalidates an existing session token

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

Session Tokens API

Creates a session token

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

Org Tokens API

Retrieve one or more org tokens specified by search criteria

GET

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

Org Tokens API

Create an org token

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

Org Tokens API

Deletes the org token specified in the {name} path parameter

https://api.{REALM}.signalfx.com/v2/token/{name}

Org Tokens API

Retrieve the org token specified in the {name} path parameter

GET

https://api.{REALM}.signalfx.com/v2/token/{name}

Org Tokens API

Updates the org token specified in the {name} path parameter

PUT

https://api.{REALM}.signalfx.com/v2/token/{name}

Org Tokens API

Rotates the secret for the org token specified in the {name} path parameter

https://api.{REALM}.signalfx.com/v2/token/{name}/rotate

Organizations API

Gets the organization object

GET

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

Organizations API

Retrieve all custom categories for the organization

GET

https://api.{REALM}.signalfx.com/v2/organization/custom-categories

Organizations API

Create, update, or delete custom categories

https://api.{REALM}.signalfx.com/v2/organization/custom-categories

Organizations API

Retrieves members of the organization

GET

https://api.{REALM}.signalfx.com/v2/organization/member

Organizations API

Invites a user to the organization

https://api.{REALM}.signalfx.com/v2/organization/member

Organizations API

Deletes the member specified in the {id} path parameter

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

Organizations API

Retrieves the information for the member specified in the {id} path parameter

GET

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

Organizations API

Updates the administrative access for the member specified in the {id} path parameter

PUT

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

Organizations API

Invites users to the organization

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

Teams API

Retrieves teams based on search criteria

GET

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

Teams API

Creates a team

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

Teams API

Deletes the team specified in the {id} path parameter

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

Teams API

Retrieves the team specified in the {id} path parameter

GET

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

Teams API

Updates the team specified in the {id} path parameter

PUT

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

Teams API

Retrieves a team member for a team

GET

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

Teams API

Updates team members

PUT

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

Teams API

Updates SignalFx user team manager flag for a single user

PUT

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

Teams API

Updates team manager flags for multiple team members

PUT

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

Teams API

Deletes link between a dashboard group and a team

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

Teams API

Links a dashboard group to a team

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

Teams API

Deletes link between a detector and a team

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

Teams API

Links a detector to a team

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

SignalFlow API

Creates a WebSocket connection to SignalFlow

GET

https://stream.{REALM}.signalfx.com/v2/signalflow/connect

SignalFlow API

Starts a SignalFlow computation

https://stream.{REALM}.signalfx.com/v2/signalflow/execute

SignalFlow API

Preview count of detector alerts

https://stream.{REALM}.signalfx.com/v2/signalflow/preflight

SignalFlow API

Retrieves status and feedback messages for a computation

GET

https://stream.{REALM}.signalfx.com/v2/signalflow/{id}/feedback

SignalFlow API

Stops a SignalFlow computation

https://stream.{REALM}.signalfx.com/v2/signalflow/{id}/stop

Retrieve MTS API

Retrieves MTS for a specified time window

GET

https://api.{REALM}.signalfx.com/v1/timeserieswindow

© Copyright 2020 Splunk, Inc.

Third-party license information