Splunk Observability Cloud API endpoint overview
Was this page helpful?
Was this page helpful?
The following table includes a complete list of the Splunk Observability Cloud API endpoints.
To create an organization access token (org token) with specific permissions, use the Splunk Observability Cloud user interface.
API | Description | Method | Endpoint |
---|---|---|---|
Send Metrics and Events API | Sends metrics to Splunk Observability Cloud | POST | https://ingest.<REALM>.signalfx.com/v2/datapoint |
Send Metrics and Events API | Sends custom events to Splunk Observability Cloud | POST | https://ingest.<REALM>.signalfx.com/v2/event |
Backfill API | Sends historical MTS to Splunk Observability Cloud | POST | https://backfill.<REALM>.signalfx.com/v1/backfill |
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 time series (MTS) metadata based on a query | GET | https://api.<REALM>.signalfx.com/v2/metrictimeseries |
Metrics Metadata API | Retrieves the MTS metadata for a metric time series | 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 | DELETE | 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 Trace Download API | Gets trace segments for a specific trace ID | GET | https://api.<REALM>.signalfx.com/v2/apm/trace/{traceId}/segments |
APM Trace Download API | Gets trace content for a specific trace segment | GET | https://api.<REALM>.signalfx.com/v2/apm/trace/{traceId}/{segmentTimestamp} |
APM Trace Download API | Gets the most recent trace segment | GET | https://api.<REALM>.signalfx.com/v2/apm/trace/{traceId}/latest |
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 | POST | https://api.<REALM>.signalfx.com/v2/chart |
Charts API | Deletes an existing chart | DELETE | 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 | POST | https://api.<REALM>.signalfx.com/v2/dashboard |
Dashboards API | Creates a new dashboard containing new charts | POST | https://api.<REALM>.signalfx.com/v2/dashboard/simple |
Dashboards API | Deletes the dashboard specified in the <id> path parameter | DELETE | 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 | POST | https://api.<REALM>.signalfx.com/v2/dashboardgroup |
Dashboard Groups API | Deletes a dashboard group | DELETE | 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 | POST | 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 | POST | https://api.<REALM>.signalfx.com/v2/detector |
Detectors API | Validates a v2 detector | POST | https://api.<REALM>.signalfx.com/v2/detector/validate |
Detectors API | Deletes a single detector | DELETE | 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 | POST | https://api.<REALM>.signalfx.com/v2/crosslink |
Data Links API | Deletes the single data link specified by an ID | DELETE | 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 | POST | https://api.<REALM>.signalfx.com/v2/alertmuting |
Incidents and Alerts API | Deletes a muting rule specified in the <id> path parameter | DELETE | 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://ingest.<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 | POST | 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 | DELETE | 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 | DELETE | https://api.<REALM>.signalfx.com/v2/session |
Session Tokens API | Creates a session token | POST | 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 | POST | https://api.<REALM>.signalfx.com/v2/token |
Org Tokens API | Deletes the org token specified in the <name> path parameter | DELETE | 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 | POST | 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 | PATCH | 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 | POST | https://api.<REALM>.signalfx.com/v2/organization/member |
Organizations API | Deletes the member specified in the <id> path parameter | DELETE | 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 | POST | 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 | POST | https://api.<REALM>.signalfx.com/v2/team |
Teams API | Deletes the team specified in the <id> path parameter | DELETE | 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 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 |
SignalFlow API | Creates a WebSocket connection to SignalFlow | GET | https://stream.<REALM>.signalfx.com/v2/signalflow/connect |
SignalFlow API | Starts a SignalFlow computation | POST | https://stream.<REALM>.signalfx.com/v2/signalflow/execute |
SignalFlow API | Preview count of detector alerts | POST | 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 | POST | 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 |