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

Squads

Get All Squads

get
/v4/squads

This endpoint is used to get all the squads details of your organization. Requires access_token as a Bearer {{token}} in the Authorization header with squad-read scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
owner_idstringRequired
Responses
200

The request has succeeded.

application/json
get/v4/squads
GET /v4/squads?owner_id=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "text",
      "org_id": "text",
      "team_id": "text",
      "name": "text",
      "members": [
        {
          "user_id": "text",
          "role": "text"
        }
      ],
      "createdAt": "text",
      "createdBy": "text",
      "updatedAt": "text",
      "updatedBy": "text"
    }
  ],
  "pageInfo": {
    "pageSize": 1,
    "hasNext": true,
    "hasPrev": true,
    "nextCursor": "text",
    "prevCursor": "text"
  }
}

Create Squad

post
/v4/squads

This endpoint is used to create a new squad. The role will be considered only if your organization is on the OBAC permission model; otherwise, the role field will be ignored, and only the member will be added to the squad.

Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
owner_idstringRequired
namestringRequired
Responses
201

The request has succeeded and a new resource has been created as a result.

application/json
post/v4/squads
POST /v4/squads HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "owner_id": "text",
  "name": "text",
  "members": [
    {
      "user_id": "text",
      "role": "text"
    }
  ]
}
{
  "data": {
    "organization_id": "text",
    "owner_id": "text",
    "id": "text",
    "name": "text",
    "slug": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text"
      }
    ],
    "created_at": "text",
    "created_by": "text"
  }
}

Get Squad By ID

get
/v4/squads/{squadID}

This endpoint is used to get the squads details by id. Requires access_token as a Bearer {{token}} in the Authorization header with squad-read scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
squadIDstringRequired
Responses
200

The request has succeeded.

application/json
get/v4/squads/{squadID}
GET /v4/squads/{squadID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": "text",
    "org_id": "text",
    "team_id": "text",
    "name": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text"
      }
    ],
    "createdAt": "text",
    "createdBy": "text",
    "updatedAt": "text",
    "updatedBy": "text"
  }
}

Update Squad

put
/v4/squads/{squadID}

This endpoint is used to update squad.

The role will be considered only if your organization is on the OBAC permission model; otherwise, the role field will be ignored, and only the member will be added to the squad. Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
squadIDstringRequired
Body
namestringOptional
Responses
200

The request has succeeded.

application/json
put/v4/squads/{squadID}
PUT /v4/squads/{squadID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "name": "text",
  "members": [
    {
      "user_id": "text",
      "role": "text"
    }
  ]
}
{
  "data": {
    "id": "text",
    "org_id": "text",
    "team_id": "text",
    "name": "text",
    "members": [
      {
        "user_id": "text",
        "role": "text"
      }
    ],
    "createdAt": "text",
    "createdBy": "text",
    "updatedAt": "text",
    "updatedBy": "text"
  }
}

Delete Squad

delete
/v4/squads/{squadID}

This endpoint is used to delete the squad. Squad should not be assigned to any incident or part of any escalation policy. Requires access_token as a Bearer {{token}} in the Authorization header with squad-update scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
squadIDstringRequired
Responses
204

There is no content to send for this request, but the headers may be useful.

*/*
objectOptional
delete/v4/squads/{squadID}
DELETE /v4/squads/{squadID} HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Update Squad Member

put
/v4/squads/{squadID}/members/{memberID}

This endpoint is used to update a squad member's role and is only accessible if your organization is using the OBAC permission model.

If you're attempting to update a member's role from 'owner' to 'member', and that 'owner' is the last squad owner, then the 'replaceWith' query parameter is required. Setting 'replaceWith' to 'member' will promote the member to the role of owner.

Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
squadIDstringRequired
memberIDstringRequired
Query parameters
replaceWithstringRequired
Body
rolestringRequired
Responses
201

The request has succeeded and a new resource has been created as a result.

application/json
idstringRequired
put/v4/squads/{squadID}/members/{memberID}
PUT /v4/squads/{squadID}/members/{memberID}?replaceWith=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "role": "text"
}
{
  "id": "text",
  "members": [
    {
      "user_id": "text",
      "role": "text"
    }
  ]
}

Remove Squad Member

delete
/v4/squads/{squadID}/members/{memberID}

This endpoint is used to update squad member's role.

If you're attempting to remove a member whose role is 'owner', and that 'owner' is the last squad owner, then the 'replaceWith' query parameter is required. Setting 'replaceWith' to 'member' will promote another member as the owner, and the specified member will be removed.

Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
squadIDstringRequired
memberIDstringRequired
Query parameters
replaceWithstringRequired
Responses
200

The request has succeeded.

application/json
idstringRequired
delete/v4/squads/{squadID}/members/{memberID}
DELETE /v4/squads/{squadID}/members/{memberID}?replaceWith=text HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "members": [
    {
      "user_id": "text",
      "role": "text"
    }
  ]
}

Update Squad Name

put
/v4/squads/{squadID}/name

This endpoint is used to update squad's name. Requires access_token as a Bearer {{token}} in the Authorization header with squad-create scope.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
squadIDstringRequired
Body
namestringRequired
Responses
200

The request has succeeded.

application/json
put/v4/squads/{squadID}/name
PUT /v4/squads/{squadID}/name HTTP/1.1
Host: api.squadcast.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "data": {
    "id": "text",
    "name": "text"
  }
}
PreviousOverrides
NextStatus Pages/Subscribers

Last updated