Squadcast is now SolarWinds Incident Response
For the complete documentation index, see llms.txt. This page is also available as Markdown.

README

Incident Response SDK for Go

Developer-friendly & type-safe Go SDK specifically catered to leverage Incident Response API.

Built by Speakeasy License: MIT

Summary

Squadcast: ## Overview The Squadcast API provides developers the capability to extend and utilize Squadcast in conjunction with other services. Our API has resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Note: Customers using the V2 version of the Squadcast API would need to migrate to Squadcast API V3, as the former would be deprecated shortly.

Service Regions

Squadcast allows customers to choose the geographic region of the Squadcast data centers that host their account. When signing up, you can choose the service region. Currently, the available options are the United States (US) and Europe (EU).

Service Region
API Endpoints

US

Authentication: https://auth.squadcast.com · Other APIs: https://api.squadcast.com

EU

Authentication: https://auth.eu.squadcast.com · Other APIs: https://api.eu.squadcast.com

Authentication

In order to access the API programmatically, HTTP bearer authentication needs to be used. HTTP bearer authentication must be constructed using an access_token, passed as the Authorization header for each request, for example Authorization: Bearer eyJleHAiOjE2MzU1OTE1OTIsImp0aSI6Im.

Steps to procure the access_token:

  1. Generate a refresh_token (API Token) from the Squadcast web app. More details on how to get the refresh_token can be found in the Squadcast support documentation.

  2. Call the authentication API with the refresh_token to obtain an access_token.

  3. Use the access_token as a Bearer token in the Authorization header for all subsequent API requests.

Example — Generating an Access Token

The API response will look similar to:

Access Control

There are three different types of user roles in Squadcast: account_owner, stakeholder, and user. Refresh tokens upon creation are mapped with one of the mentioned user roles, and access to different resources is dependent on the permissions granted to these roles. For more information, please refer to the Squadcast support documentation.

Authorization

The access token authorizes users the ability to access different APIs, based on the user roles described above. Pass the access token as a Bearer token in the Authorization header of every request.

Table of Contents

SDK Installation

To add the SDK as a dependency to your project:

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name
Type
Scheme
Environment Variable

RefreshTokenAuth

http

Custom HTTP

SQUADCASTSDK_REFRESH_TOKEN_AUTH

You can configure it using the WithSecurity option when initializing the SDK client instance. For example:

Available Resources and Operations

Available methods

Analytics

ApiTokens

  • List - Get All Tokens

AuditLogs

  • List - List all Audit Logs

  • Export - Initiate an asynchronous export of audit logs based on the provided filters. The export file will be generated and available for download. Use 'Get details of Audit Logs export history by ID' API to retrieve the download URL.

  • ListExportHistory - List all Audit Logs export history

  • GetExportHistoryByID - Get details of Audit Logs export history by ID

  • GetByID - Get audit log by ID

CommunicationCards

EscalationPolicies

  • GetByTeam - Get Escalation Policy By team

  • Create - Create Escalation Policies

  • Remove - Remove Escalation Policy

  • GetByID - Get Escalation Policy By ID

  • Update - Update Escalation Policy

Exports

Extensions.Msteams

  • UpsertConfig - Create Or Update MSTeams Configuration

Extensions.Webhooks

  • Delete - Delete Webhook

  • GetByID - Get Webhook By ID

GlobalEventRules

  • List - List Global Event Rules

  • Create - Create Global Event Rule

  • DeleteRule - Delete Global Event Rule by ID

  • GetByID - Get Global Event Rule by ID

  • UpdateByID - Update Global Event Rule by ID

  • GetRuleset - Get Ruleset

  • UpdateRuleset - Update Ruleset

  • UpdateRule - Update Rule by ID

GlobalEventRules.Rules

GlobalEventRules.Rulesets

  • Create - Create Rule

  • GetByID - Get Rule by ID

GlobalEventRulesRulesets

  • Delete - Delete GER Ruleset

GlobalEventRulesRulesetsRules

GlobalOncallReminderRules

  • Delete - Delete Global Oncall Reminder Rules

  • List - Get Global Oncall Reminder Rules

  • Create - Create Global Oncall Reminder Rules

  • Update - Update Global Oncall Reminder Rules

IncidentActions.Circleci

  • Rebuild - Rebuild a Project In CircleCI

Incidents

Incidents.Actions

Incidents.Actions.Webhook

Incidents.AdditionalResponders

  • Get - Get Additional Responders

  • Add - Add Additional Responders

  • Delete - Remove Additional Responders

Incidents.AutoPauseTransientAlerts

Incidents.CommunicationCard

  • Update - Update Communication Card

Incidents.CommunicationCards

  • GetAll - Get All Communication Card

  • Create - Create Communication Card

  • Delete - Delete Communication Card

Incidents.Events

  • List - Get Incident Events

Incidents.Notes

  • Create - Create Notes

  • Delete - Delete Note

  • Update - Update Note

Incidents.Postmortems

Incidents.Runbooks

  • Attach - Attach Runbooks

Incidents.SnoozeNotifications

  • Snooze - Snooze Incident Notifications

Incidents.Tags

  • Update - Update Tag

  • Append - Append Tag

Msteams

  • GetConfig - Get MSTeams Config

Notes

  • List - Get All Notes

Overlays

Overrides

  • GetByID - Get Override by ID

  • Update - Update Schedule Override

Rotations

  • Create - Create Rotation

  • GetByID - Get Schedule Rotation by ID

  • Update - Update Rotation

  • GetParticipants - Get Rotation Participants

  • UpdateParticipants - Update Rotation Participants

Runbooks

  • ListByTeam - Get All Runbooks By Team

  • Create - Create Runbook

  • Remove - Remove Runbook

  • GetByID - Get Runbook By ID

  • Update - Update Runbook

Schedules

Schedules.Export

Schedules.Overrides

  • List - List Overrides

  • Delete - Delete Schedule Override

Schedules.Rotations

  • List - List Schedule Rotations

Services

Services.DeduplicationRules

  • Get - Get Deduplication Rules

  • CreateOrUpdate - Create or Update Deduplication Rules

Services.Extensions

Services.MaintenanceMode

  • Get - Get Maintenance Mode

  • CreateOrUpdate - Create or Update Maintenance Mode

Services.Overlay

Services.Overlays

  • Render - Render Custom Content Overlay

  • Render - Render Dedup Key template

  • Delete - Delete Dedup Key Overlay

Services.RoutingRules

Services.SuppressionRules

  • Get - Get Suppression Rules

Services.TaggingRules

  • Get - Get Tagging Rules

Slos

Squads

Squads.V4

  • Create - Create Squad

  • GetByID - Get Squad By ID

StatusPages

  • List - List Component Groups

  • Create - Create Component Group

  • DeleteByID - Delete Component Group By ID

  • GetByID - Get Component Group By ID

StatusPages.Components

  • List - List Components

  • Create - Create Component

  • DeleteByID - Delete Component By ID

  • GetByID - Get Component By ID

  • UpdateByID - Update Component By ID

StatusPages.Issues

  • List - List Issues

  • Delete - Delete Issue By ID

  • GetByID - Get Issue By ID

  • ListStates - List Status Page Issue States

StatusPages.Maintenances

  • Create - Create Maintenance

  • DeleteByID - Delete Maintenance By ID

  • UpdateByID - Update Maintenance By ID

StatusPages.Subscribers

  • List - List Subscribers

  • DeleteByID - Delete Subscriber By ID

Teams

Teams.Members

  • GetAll - Get All Team Members

Tokens

Users

Users.ApiToken

  • Remove - Remove Token

V4.Squads

  • Update - Update Squad

Webforms

  • GetAll - Get All Webforms

  • Create - Create Webform

  • Update - Update Webform

  • Remove - Remove Webform

  • Get - Get Webform By ID

Webhooks

  • GetAll - Get All Webhooks

  • Create - Create Webhook

  • Update - Update Webhook

Workflows

  • List - List Workflows

  • Create - Create Workflow

  • BulkEnableDisable - Bulk Enable/Disable Workflows

  • Delete - Delete Workflow

  • GetByID - Get Workflow By ID

  • Update - Update Workflow

  • UpdateActionsOrder - Update Actions Order

  • DeleteAction - Delete Workflow Action

  • GetAction - Get Workflow Action By ID

  • UpdateAction - Update Workflow Action

  • ToggleEnable - Enable/Disable Workflow

  • GetLogs - Get Workflow Logs

Workflows.Actions

  • Create - Create Action

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will have a Next method that can be called to pull down the next group of results. If the return value of Next is nil, then there are no more pages to be fetched.

Here's an example of one such pagination call:

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retry.Config object to the call by using the WithRetries option:

If you'd like to override the default retry strategy for all operations that support retries, you can use the WithRetryConfig option at SDK initialization:

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or an error, they will never return both.

By Default, an API error will return apierrors.APIError. When custom error responses are specified for an operation, the SDK may also return their associated error. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation.

For example, the GetOrganization function may return the following errors:

Error Type
Status Code
Content Type

apierrors.BadRequestError

400

application/json

apierrors.UnauthorizedError

401

application/json

apierrors.PaymentRequiredError

402

application/json

apierrors.ForbiddenError

403

application/json

apierrors.NotFoundError

404

application/json

apierrors.ConflictError

409

application/json

apierrors.UnprocessableEntityError

422

application/json

apierrors.InternalServerError

500

application/json

apierrors.BadGatewayError

502

application/json

apierrors.ServiceUnavailableError

503

application/json

apierrors.GatewayTimeoutError

504

application/json

apierrors.APIError

4XX, 5XX

*/*

Example

Server Selection

Select Server by Index

You can override the default server globally using the WithServerIndex(serverIndex int) option when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#
Server
Description

0

https://api.squadcast.com

production US env

1

https://api.eu.squadcast.com

production EU env

Example

Override Server URL Per-Client

The default server can also be overridden globally using the WithServerURL(serverURL string) option when initializing the SDK client instance. For example:

Custom HTTP Client

The Go SDK makes API calls that wrap an internal HTTP client. The requirements for the HTTP client are very simple. It must match this interface:

The built-in net/http client satisfies this interface and a default client based on the built-in is provided by default. To replace this default with a client of your own, you can implement this interface yourself or provide your own client configured as desired. Here's a simple example, which adds a client with a 30 second timeout.

This can be a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration.

Special Types

This SDK defines the following custom types to assist with marshalling and unmarshalling data.

Date

types.Date is a wrapper around time.Time that allows for JSON marshaling a date string formatted as "2006-01-02".

Usage

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy

Last updated