Skip to main content
GET
/
integration
/
{id}
Get integration by ID
curl --request GET \
  --url https://api.wirespeed.co/integration/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "platform": "aws",
  "enabled": true,
  "teamId": "<string>",
  "config": {
    "authType": "oauth2",
    "name": "<string>",
    "customFields": [
      {
        "slug": "<string>",
        "display": "<string>",
        "type": "<string>",
        "required": true,
        "description": "<string>",
        "validationPattern": "<string>",
        "validationMinLength": 123,
        "validationMaxLength": 123,
        "source": "<string>",
        "advancedOption": true
      }
    ],
    "logo": "<string>",
    "logoLight": "<string>",
    "logoDark": "<string>",
    "beta": true,
    "description": "<string>",
    "slug": "<string>",
    "internalCreds": true,
    "docsUrl": "<string>",
    "default": true,
    "rtfm": true,
    "useCases": [
      "chat_ops"
    ],
    "webhookActions": [
      {
        "slug": "<string>",
        "display": "<string>",
        "description": "<string>",
        "useCases": [
          "chat_ops"
        ]
      }
    ],
    "oauthRequiresRedirect": true,
    "requiresConfiguration": true
  },
  "permissionsUpdateAvailable": true,
  "permissionUpdateExplanation": "<string>",
  "identityFields": {},
  "teamName": "<string>",
  "requiresConfiguration": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Integration ID

Response

​
id
string
required

Unique identifier for the integration

​
platform
enum<string>
required

Integration platform type

Available options:
aws,
bitwarden,
box,
checkpoint-firewall,
checkpoint-harmony,
cisco-catalyst,
cisco-duo,
cisco-meraki,
cisco-umbrella,
connectwise-psa,
crowdstrike-falcon,
darktrace,
email,
fortianalyzer,
fortinet,
generic-json,
generic-syslog,
google-alert-center,
google-directory,
google-security-center,
have-i-been-pwned,
hyas-protect,
ipinfo,
jamf-pro,
jamf-protect,
jira-cloud,
jira-data-center,
kandji,
manage-engine-ad-audit-plus,
microsoft,
microsoft-entra,
microsoft-teams,
mimecast,
okta,
one-password,
orca-security,
reversing-labs,
safebreach,
sentinel-one,
slack,
sms,
sonic-wall,
thinkst-canary,
vectra,
windows-event-logs,
wirespeed,
wiz,
wordfence
​
enabled
boolean
required

Whether the integration is enabled

​
teamId
string
required

ID of the team that owns this integration

​
config
object
required

Integration configuration metadata

​
permissionsUpdateAvailable
boolean
required

Whether a permissions update is available for this integration

​
permissionUpdateExplanation
string
required

Explanation for why a permissions update is available

​
identityFields
object
required

Identity fields that uniquely identify this integration instance

​
teamName
string

Name of the team that owns this integration

​
requiresConfiguration
string

Whether the integration requires additional configuration