JockDaRock / qt-test001

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

perch_api

PerchApi - JavaScript client for perch_api Interactive documentation functionality is incomplete and may not work as expected. We recommend you connect with a REST client such as Postman, Httpie, or even plan old CURL. Obtain your API username, password, and key from your <a href="https://app.perchsecurity.com/user/groups\" target="blank">group settings

Root URL

<table class="parameters table table-bordered table-striped">Base URLhttps://api.perch.rocksVersionv1

Headers

<table class="parameters table table-bordered table-striped">x-api-key(your api key from the group settings page)AuthorizationBearer (your access token returned from /auth/access_token) This SDK is automatically generated by the Swagger Codegen project:

  • API version: v1
  • Package version: v1
  • Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install perch_api --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your perch_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('perch_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PerchApi = require('perch_api');

var defaultClient = PerchApi.ApiClient.instance;

// Configure HTTP basic authorization: Basic
var Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME'
Basic.password = 'YOUR PASSWORD'

var api = new PerchApi.AddOnsApi()

var opts = { 
  'ordering': "ordering_example" // {String} Which field to use when ordering the results.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addOnsList(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://api.perchsecurity.com

Class Method HTTP request Description
PerchApi.AddOnsApi addOnsList GET /add-ons
PerchApi.AddOnsApi addOnsRead GET /add-ons/{id}
PerchApi.AlertsApi alertsCreate POST /{version}/alerts
PerchApi.AlertsApi alertsDelete DELETE /{version}/alerts/{id}
PerchApi.AlertsApi alertsList GET /{version}/alerts
PerchApi.AlertsApi alertsPartialUpdate PATCH /{version}/alerts/{id}
PerchApi.AlertsApi alertsRead GET /{version}/alerts/{id}
PerchApi.AlertsApi alertsSuppressionsBulkCidrs POST /alerts/suppressions/bulk-cidrs
PerchApi.AlertsApi alertsSuppressionsCreate POST /alerts/suppressions
PerchApi.AlertsApi alertsSuppressionsDelete DELETE /alerts/suppressions/{id}
PerchApi.AlertsApi alertsSuppressionsList GET /alerts/suppressions
PerchApi.AlertsApi alertsUpdate PUT /{version}/alerts/{id}
PerchApi.ApiUserApi apiUserPasswordSetUpdate PUT /api-user/password/set
PerchApi.AuthApi auth2faDisableUpdate PUT /auth/2fa/disable
PerchApi.AuthApi auth2faDisableUpdate_0 PUT /{version}/auth/2fa/disable
PerchApi.AuthApi auth2faEnableUpdate PUT /auth/2fa/enable
PerchApi.AuthApi auth2faEnableUpdate_0 PUT /{version}/auth/2fa/enable
PerchApi.AuthApi auth2faStatusList GET /auth/2fa/status
PerchApi.AuthApi auth2faStatusList_0 GET /{version}/auth/2fa/status
PerchApi.AuthApi authAccessTokenCreate POST /auth/access_token
PerchApi.AuthApi authAccessTokenCreate_0 POST /{version}/auth/access_token
PerchApi.AuthApi authAuth0JwksList GET /auth/auth0-jwks
PerchApi.AuthApi authAuth0JwksList_0 GET /{version}/auth/auth0-jwks
PerchApi.AuthApi authCannySsoTokenList GET /auth/canny_sso_token
PerchApi.AuthApi authCannySsoTokenList_0 GET /{version}/auth/canny_sso_token
PerchApi.AuthApi authDeviceTokenCreate POST /auth/device-token
PerchApi.AuthApi authDeviceTokenCreate_0 POST /{version}/auth/device-token
PerchApi.AuthApi authMfaList GET /auth/mfa/
PerchApi.AuthApi authMfaList_0 GET /{version}/auth/mfa/
PerchApi.AuthApi authMfaRegisterCreate POST /auth/mfa/register
PerchApi.AuthApi authMfaRegisterCreate_0 POST /{version}/auth/mfa/register
PerchApi.AuthApi authMfaRegisterList GET /auth/mfa/register
PerchApi.AuthApi authMfaRegisterList_0 GET /{version}/auth/mfa/register
PerchApi.AuthApi authMfaRemoveCreate POST /auth/mfa/remove
PerchApi.AuthApi authMfaRemoveCreate_0 POST /{version}/auth/mfa/remove
PerchApi.AuthApi authMfaRemoveDelete DELETE /auth/mfa/remove
PerchApi.AuthApi authMfaRemoveDelete_0 DELETE /{version}/auth/mfa/remove
PerchApi.AuthApi authMigrateDeviceCreate POST /auth/migrate-device
PerchApi.AuthApi authMigrateDeviceCreate_0 POST /{version}/auth/migrate-device
PerchApi.AuthApi authPasswordResetCreate POST /auth/password/reset
PerchApi.AuthApi authPasswordResetCreate_0 POST /{version}/auth/password/reset
PerchApi.BacktestApi backtestCreate POST /{version}/backtest
PerchApi.CommentsApi commentsIndicatorCreate POST /comments/indicator
PerchApi.CommentsApi commentsIndicatorDelete DELETE /comments/indicator/{id}
PerchApi.CommentsApi commentsIndicatorPartialUpdate PATCH /comments/indicator/{id}
PerchApi.CommentsApi commentsIndicatorUpdate PUT /comments/indicator/{id}
PerchApi.CommunitiesApi communitiesList GET /communities
PerchApi.CommunitiesApi communitiesList_0 GET /{version}/communities
PerchApi.CommunitiesApi communitiesRead GET /{version}/communities/{id}
PerchApi.CommunityApi communityFeedsCreate POST /community/{community_id}/feeds
PerchApi.CommunityApi communityFilesCommentsCreate POST /community/{community_id}/files/{file_id}/comments
PerchApi.CommunityApi communityFilesCommentsDelete DELETE /community/{community_id}/files/{file_id}/comments/{id}
PerchApi.CommunityApi communityFilesCommentsPartialUpdate PATCH /community/{community_id}/files/{file_id}/comments/{id}
PerchApi.CommunityApi communityFilesCommentsUpdate PUT /community/{community_id}/files/{file_id}/comments/{id}
PerchApi.CommunityApi communityFilesCreate POST /community/{community_id}/files
PerchApi.CommunityApi communityFilesDelete DELETE /community/{community_id}/files/{id}
PerchApi.CommunityApi communityFilesDownloadList GET /community/{community_id}/files/{file_id}/download
PerchApi.CommunityApi communityFilesList GET /community/{community_id}/files
PerchApi.CommunityApi communityFilesRead GET /community/{community_id}/files/{id}
PerchApi.CommunityApi communityIndicatorsList GET /community/{community_id}/indicators
PerchApi.CommunityApi communitySuppressionsList GET /community/{community_id}/suppressions
PerchApi.CommunityApi communitySuppressionsRead GET /community/{community_id}/suppressions/{id}
PerchApi.CompanyApi companyBpfUpdate PUT /company/{company_id}/bpf
PerchApi.CompanyApi companyCommunityCreate POST /company/{company_id}/community
PerchApi.CompanyApi companyCommunityCredentials PUT /company/{company_id}/community/{community_id}/credentials
PerchApi.CompanyApi companyCommunityDelete DELETE /company/{company_id}/community/{community_id}
PerchApi.CompanyApi companyCommunityFeeds PUT /company/{company_id}/community/{community_id}/feeds
PerchApi.CompanyApi companyCommunityList GET /company/{company_id}/community
PerchApi.CompanyApi companyCommunityPartialUpdate PATCH /company/{company_id}/community/{community_id}
PerchApi.CompanyApi companyCommunityRead GET /company/{company_id}/community/{community_id}
PerchApi.CompanyApi companyCommunityUpdate PUT /company/{company_id}/community/{community_id}
PerchApi.CompanyApi companyDefaultManagingTeamsList GET /company/default-managing-teams
PerchApi.CompanyApi companyDefaultManagingTeamsRead GET /company/default-managing-teams/{id}
PerchApi.CompanyApi companyDeviceInviteCreate POST /company/{company_id}/deviceInvite
PerchApi.CompanyApi companyDeviceInviteDelete DELETE /company/{company_id}/deviceInvite/{code}
PerchApi.CompanyApi companyDeviceInviteList GET /company/{company_id}/deviceInvite
PerchApi.CompanyApi companyDeviceInvitePartialUpdate PATCH /company/{company_id}/deviceInvite/{code}
PerchApi.CompanyApi companyDeviceInviteRead GET /company/{company_id}/deviceInvite/{code}
PerchApi.CompanyApi companyDeviceInviteUpdate PUT /company/{company_id}/deviceInvite/{code}
PerchApi.CompanyApi companyEnterpriseSsoCreate POST /company/{company_id}/enterprise-sso
PerchApi.CompanyApi companyEnterpriseSsoDelete DELETE /company/{company_id}/enterprise-sso
PerchApi.CompanyApi companyEnterpriseSsoPartialUpdate PATCH /company/{company_id}/enterprise-sso
PerchApi.CompanyApi companyEnterpriseSsoRead GET /company/{company_id}/enterprise-sso
PerchApi.CompanyApi companyIndicatorsCreate POST /company/{company_id}/indicators
PerchApi.CompanyApi companyIndicatorsDelete DELETE /company/{company_id}/indicators/{id}
PerchApi.CompanyApi companyIndicatorsList GET /company/{company_id}/indicators
PerchApi.CompanyApi companyIndicatorsPartialUpdate PATCH /company/{company_id}/indicators/{id}
PerchApi.CompanyApi companyIndicatorsRead GET /company/{company_id}/indicators/{id}
PerchApi.CompanyApi companyIndicatorsUpdate PUT /company/{company_id}/indicators/{id}
PerchApi.CompanyApi companyIntegrationHealthLogsLatest GET /company/{company_id}/integration-health-logs/latest
PerchApi.CompanyApi companyIntegrationHealthLogsList GET /company/{company_id}/integration-health-logs
PerchApi.CompanyApi companyIntegrationHealthLogsRead GET /company/{company_id}/integration-health-logs/{id}
PerchApi.CompanyApi companyIntegrationsCreate POST /company/{company_id}/integrations/{integration_type}
PerchApi.CompanyApi companyIntegrationsDelete DELETE /company/{company_id}/integrations/{integration_type}/{id}
PerchApi.CompanyApi companyIntegrationsList GET /company/{company_id}/integrations
PerchApi.CompanyApi companyIntegrationsList_0 GET /company/{company_id}/integrations/{integration_type}
PerchApi.CompanyApi companyIntegrationsPartialUpdate PATCH /company/{company_id}/integrations/{integration_type}/{id}
PerchApi.CompanyApi companyIntegrationsRead GET /company/{company_id}/integrations/{id}
PerchApi.CompanyApi companyIntegrationsRead_0 GET /company/{company_id}/integrations/{integration_type}/{id}
PerchApi.CompanyApi companyIntegrationsUpdate PUT /company/{company_id}/integrations/{integration_type}/{id}
PerchApi.CompanyApi companyLoginsList GET /company/{company_id}/logins
PerchApi.CompanyApi companyLoginsRead GET /company/{company_id}/logins/{id}
PerchApi.CompanyApi companyMemberDelete DELETE /company/{company_id}/member/{user_id}
PerchApi.CompanyApi companyMemberList GET /company/{company_id}/member
PerchApi.CompanyApi companyMemberPartialUpdate PATCH /company/{company_id}/member/{user_id}
PerchApi.CompanyApi companyMemberRead GET /company/{company_id}/member/{user_id}
PerchApi.CompanyApi companyMemberUpdate PUT /company/{company_id}/member/{user_id}
PerchApi.CompanyApi companyNamesList GET /company/names
PerchApi.CompanyApi companyNamesRead GET /company/names/{id}
PerchApi.CompanyApi companyRulesUpdate PUT /company/{company_id}/rules
PerchApi.CompanyApi companySensorHealthRead GET /company/{company_id}/sensor/health/{id}
PerchApi.CompanyApi companySoftwareApprovalsCreate POST /company/{company_id}/software-approvals
PerchApi.CompanyApi companySoftwareApprovalsDelete DELETE /company/{company_id}/software-approvals/{id}
PerchApi.CompanyApi companySoftwareApprovalsList GET /company/{company_id}/software-approvals
PerchApi.CompanyApi companySoftwareApprovalsPartialUpdate PATCH /company/{company_id}/software-approvals/{id}
PerchApi.CompanyApi companySoftwareApprovalsRead GET /company/{company_id}/software-approvals/{id}
PerchApi.CompanyApi companySoftwareApprovalsUpdate PUT /company/{company_id}/software-approvals/{id}
PerchApi.CompanyApi companySubnetsCreate POST /company/{company_id}/subnets
PerchApi.CompanyApi companySubnetsDelete DELETE /company/{company_id}/subnets/{id}
PerchApi.CompanyApi companySubnetsList GET /company/{company_id}/subnets
PerchApi.CompanyApi companySubnetsPartialUpdate PATCH /company/{company_id}/subnets/{id}
PerchApi.CompanyApi companySubnetsRead GET /company/{company_id}/subnets/{id}
PerchApi.CompanyApi companySubnetsUpdate PUT /company/{company_id}/subnets/{id}
PerchApi.CompanyApi companySuppressionsBulkCidrs POST /company/{company_id}/suppressions/bulk-cidrs
PerchApi.CompanyApi companySuppressionsCreate POST /company/{company_id}/suppressions
PerchApi.CompanyApi companySuppressionsDelete DELETE /company/{company_id}/suppressions/{id}
PerchApi.CompanyApi companySuppressionsList GET /company/{company_id}/suppressions
PerchApi.CompanyApi companyWebhooksCreate POST /company/{company_id}/webhooks
PerchApi.CompanyApi companyWebhooksDelete DELETE /company/{company_id}/webhooks/{id}
PerchApi.CompanyApi companyWebhooksList GET /company/{company_id}/webhooks
PerchApi.CompanyApi companyWebhooksPartialUpdate PATCH /company/{company_id}/webhooks/{id}
PerchApi.CompanyApi companyWebhooksRead GET /company/{company_id}/webhooks/{id}
PerchApi.CompanyApi companyWebhooksUpdate PUT /company/{company_id}/webhooks/{id}
PerchApi.CompanyDetailValuesApi companyDetailValuesList GET /companyDetailValues
PerchApi.ConfirmApi confirmCreate POST /confirm
PerchApi.ConfirmApi confirmSendCreate POST /confirm/send
PerchApi.EmailAvailabilityApi emailAvailabilityRead GET /email_availability/{email}
PerchApi.EventsApi eventsByHostList GET /events/by_host
PerchApi.EventsApi eventsBySensorList GET /events/by_sensor
PerchApi.EventsApi eventsHostsList GET /events/{event_id}/hosts
PerchApi.EventsApi eventsInstancesList GET /events/{event_id}/instances
PerchApi.EventsApi eventsLatestList GET /events/latest
PerchApi.EventsApi eventsPagedList GET /events/paged
PerchApi.EventsApi eventsRead GET /events/{event_id}
PerchApi.EventsApi eventsStatusCountsList GET /events/status/counts
PerchApi.EventsApi eventsStatusCreate POST /events/{event_id}/status
PerchApi.IndicatorsApi indicatorsCreate POST /{version}/indicators
PerchApi.IndustryListApi industryListList GET /industry_list
PerchApi.IndustryListApi industryListRead GET /industry_list/{id}
PerchApi.IntegrationsApi integrationsLatest GET /integrations/integration-health-logs
PerchApi.InviteApi inviteCreate POST /invite/{company_id}
PerchApi.LegacyApi legacyEmailAvailabilityRead GET /legacy/email_availability/{email}
PerchApi.MetricsApi metricsAlertProcessingList GET /metrics/alert-processing
PerchApi.MetricsApi metricsAlertProcessingNoisyTeamsList GET /metrics/alert-processing/noisy-teams
PerchApi.MetricsApi metricsAnalystActivityRead GET /metrics/analyst-activity/{user_id}/
PerchApi.MetricsApi metricsAnalystSummaryList GET /metrics/analyst-summary
PerchApi.MetricsApi metricsCommunityDailyEventsList GET /metrics/community/{community_id}/daily-events
PerchApi.MetricsApi metricsCommunitySuppressionsList GET /metrics/community/{community_id}/suppressions
PerchApi.MetricsApi metricsCommunityTrendingIndicatorsList GET /metrics/community/{community_id}/trending-indicators
PerchApi.MetricsApi metricsCustomerSuccessActivityList GET /metrics/customer-success/activity
PerchApi.MetricsApi metricsEventsClosedCountList GET /metrics/events/closed_count
PerchApi.MetricsApi metricsStatsIpCountsListAggregationsForAllTeams GET /metrics/stats/ip-counts/staff
PerchApi.MetricsApi metricsTeamsIndicatorsByCommunityList GET /metrics/teams/{company_id}/indicators/by-community
PerchApi.MetricsApi metricsTeamsSightingsByCommunityList GET /metrics/teams/{company_id}/sightings/by-community
PerchApi.MetricsApi metricsTeamsStatsIpCountsList GET /metrics/teams/{company_id}/stats/ip-counts
PerchApi.MetricsApi metricsTeamsStatsIpCountsListAggregationsForManagedTeams GET /metrics/teams/{company_id}/stats/ip-counts/managed-teams
PerchApi.MetricsApi metricsTeamsStatsList GET /metrics/teams/{company_id}/stats
PerchApi.MetricsApi metricsTeamsStatsNoisyHostsList GET /metrics/teams/{company_id}/stats/noisy-hosts
PerchApi.MetricsApi metricsTeamsStatsSummary GET /metrics/teams/{company_id}/stats/suppressions
PerchApi.MetricsApi metricsTeamsStatsSuppressionsByDay GET /metrics/teams/{company_id}/stats/suppressions/by-day
PerchApi.MetricsApi metricsTeamsSuppressionsByCommunityList GET /metrics/teams/{company_id}/suppressions/by-community
PerchApi.MetricsApi metricsTeamsSuppressionsList GET /metrics/teams/{company_id}/suppressions
PerchApi.MitreAttackTacticsApi mitreAttackTacticsList GET /mitre-attack-tactics
PerchApi.MitreAttackTacticsApi mitreAttackTacticsRead GET /mitre-attack-tactics/{id}
PerchApi.MspApi mspIntegrationHealthLogsList GET /msp/{company_id}/integration-health-logs
PerchApi.MspApi mspIntegrationHealthLogsRead GET /msp/{company_id}/integration-health-logs/{id}
PerchApi.MspApi mspIntegrationsCreate POST /msp/{company_id}/integrations/{integration_type}
PerchApi.MspApi mspIntegrationsDelete DELETE /msp/{company_id}/integrations/{integration_type}/{id}
PerchApi.MspApi mspIntegrationsList GET /msp/{company_id}/integrations/{integration_type}
PerchApi.MspApi mspIntegrationsPartialUpdate PATCH /msp/{company_id}/integrations/{integration_type}/{id}
PerchApi.MspApi mspIntegrationsRead GET /msp/{company_id}/integrations/{integration_type}/{id}
PerchApi.MspApi mspIntegrationsUpdate PUT /msp/{company_id}/integrations/{integration_type}/{id}
PerchApi.ObjectDetailApi objectDetailCommentsList GET /objectDetail/{indicator_id}/comments
PerchApi.ObjectDetailApi objectDetailHistoryList GET /objectDetail/{indicator_id}/history
PerchApi.ObjectDetailApi objectDetailRead GET /objectDetail/{indicator_id}
PerchApi.ObjectDetailApi objectDetailSightingsList GET /objectDetail/{indicator_id}/sightings
PerchApi.ObjectDetailApi objectDetailSuppressionsList GET /objectDetail/{indicator_id}/suppressions
PerchApi.PerchybanaApi perchybanaCheckUserList GET /perchybana/check-user
PerchApi.PerchybanaApi perchybanaEventNotificationsActivate POST /perchybana/{company_id}/event-notifications/{id}/activate
PerchApi.PerchybanaApi perchybanaEventNotificationsAlertableFieldsList GET /perchybana/event-notifications/alertable-fields
PerchApi.PerchybanaApi perchybanaEventNotificationsAlertableMappingsList GET /perchybana/event-notifications/alertable-mappings
PerchApi.PerchybanaApi perchybanaEventNotificationsClone POST /perchybana/{company_id}/event-notifications/{id}/clone
PerchApi.PerchybanaApi perchybanaEventNotificationsCreate POST /perchybana/{company_id}/event-notifications
PerchApi.PerchybanaApi perchybanaEventNotificationsDeactivate POST /perchybana/{company_id}/event-notifications/{id}/deactivate
PerchApi.PerchybanaApi perchybanaEventNotificationsDelete DELETE /perchybana/{company_id}/event-notifications/{id}
PerchApi.PerchybanaApi perchybanaEventNotificationsExecuteNow POST /perchybana/{company_id}/event-notifications/{id}/execute-now
PerchApi.PerchybanaApi perchybanaEventNotificationsGetDefaultActions GET /perchybana/{company_id}/event-notifications/default-actions
PerchApi.PerchybanaApi perchybanaEventNotificationsList GET /perchybana/{company_id}/event-notifications
PerchApi.PerchybanaApi perchybanaEventNotificationsNewTriggerEventCreate POST /perchybana/event-notifications/new-trigger-event
PerchApi.PerchybanaApi perchybanaEventNotificationsPartialUpdate PATCH /perchybana/{company_id}/event-notifications/{id}
PerchApi.PerchybanaApi perchybanaEventNotificationsRead GET /perchybana/{company_id}/event-notifications/{id}
PerchApi.PerchybanaApi perchybanaEventNotificationsTestQuery GET /perchybana/{company_id}/event-notifications/{id}/test-query
PerchApi.PerchybanaApi perchybanaEventNotificationsTriggeredNotificationsList GET /perchybana/{company_id}/event-notifications/{event_notification_id}/triggered-notifications
PerchApi.PerchybanaApi perchybanaEventNotificationsTriggeredNotificationsRead GET /perchybana/{company_id}/event-notifications/{event_notification_id}/triggered-notifications/{id}
PerchApi.PerchybanaApi perchybanaEventNotificationsUpdate PUT /perchybana/{company_id}/event-notifications/{id}
PerchApi.PerchybanaApi perchybanaEventNotificationsUpdateDefaultActions PUT /perchybana/{company_id}/event-notifications/update-default-actions
PerchApi.PerchybanaApi perchybanaMeltgardRolesList GET /perchybana/meltgard/roles
PerchApi.PerchybanaApi perchybanaMeltgardRolesRead GET /perchybana/meltgard/roles/{role_names}
PerchApi.PerchybanaApi perchybanaMeltgardUsersMeList GET /perchybana/meltgard/users/me
PerchApi.PerchybanaApi perchybanaMeltgardUsersRead GET /perchybana/meltgard/users/{username}
PerchApi.PerchybanaApi perchybanaScheduledReportsCreate POST /perchybana/{company_id}/scheduled-reports
PerchApi.PerchybanaApi perchybanaScheduledReportsDelete DELETE /perchybana/{company_id}/scheduled-reports/{id}
PerchApi.PerchybanaApi perchybanaScheduledReportsList GET /perchybana/{company_id}/scheduled-reports
PerchApi.PerchybanaApi perchybanaScheduledReportsPartialUpdate PATCH /perchybana/{company_id}/scheduled-reports/{id}
PerchApi.PerchybanaApi perchybanaScheduledReportsRead GET /perchybana/{company_id}/scheduled-reports/{id}
PerchApi.PerchybanaApi perchybanaScheduledReportsReportsDownload GET /perchybana/{company_id}/scheduled-reports/{scheduled_report_id}/reports/{id}/download
PerchApi.PerchybanaApi perchybanaScheduledReportsReportsList GET /perchybana/{company_id}/scheduled-reports/{scheduled_report_id}/reports
PerchApi.PerchybanaApi perchybanaScheduledReportsReportsRead GET /perchybana/{company_id}/scheduled-reports/{scheduled_report_id}/reports/{id}
PerchApi.PerchybanaApi perchybanaScheduledReportsSavedObjectsList GET /perchybana/scheduled-reports/saved-objects
PerchApi.PerchybanaApi perchybanaScheduledReportsTrigger POST /perchybana/{company_id}/scheduled-reports/{id}/trigger
PerchApi.PerchybanaApi perchybanaScheduledReportsUpdate PUT /perchybana/{company_id}/scheduled-reports/{id}
PerchApi.PostalcodeGeohashApi postalcodeGeohashRead GET /postalcode_geohash/{country_code}/{postal_code}
PerchApi.RegisterDeviceApi registerDeviceCreate POST /registerDevice
PerchApi.RegisterTeamApi registerTeamCreate POST /register_team
PerchApi.RegisterUserApi registerUserCreate POST /register_user
PerchApi.SearchApi searchRead GET /search
PerchApi.SecurityEventsApi securityEventsList GET /security_events
PerchApi.SecurityEventsApi securityEventsRead GET /security_events/{id}
PerchApi.SensorApi sensorCommandCreate POST /sensor/{sensor_id}/command
PerchApi.SensorApi sensorCommandResultsPartialUpdate PATCH /sensor/command/results/{id}
PerchApi.SensorApi sensorCommandResultsUpdate PUT /sensor/command/results/{id}
PerchApi.SensorApi sensorFilesDownloadList GET /sensor/files/{file_alias}/download
PerchApi.SensorApi sensorFilesDownloadList_0 GET /sensor/{sensor_id}/files/{file_alias}/download
PerchApi.SensorApi sensorFilesHashList GET /sensor/files/hash
PerchApi.SensorApi sensorFirewallBlacklistCreate POST /sensor/{company_id}/firewall/blacklist
PerchApi.SensorApi sensorFirewallBlacklistDelete DELETE /sensor/{company_id}/firewall/blacklist/{id}
PerchApi.SensorApi sensorFirewallBlacklistList GET /sensor/{company_id}/firewall/blacklist
PerchApi.SensorApi sensorFirewallBlacklistPartialUpdate PATCH /sensor/{company_id}/firewall/blacklist/{id}
PerchApi.SensorApi sensorFirewallBlacklistRead GET /sensor/{company_id}/firewall/blacklist/{id}
PerchApi.SensorApi sensorFirewallBlacklistUpdate PUT /sensor/{company_id}/firewall/blacklist/{id}
PerchApi.SensorApi sensorHealthMeCreate POST /sensor/health/me
PerchApi.SensorApi sensorImagesDirectList GET /sensor/images/direct
PerchApi.SensorApi sensorImagesHashList GET /sensor/images/hash
PerchApi.SensorApi sensorMogaList GET /sensor/moga Search indicators and sensor network trafic.
PerchApi.SensorApi sensorMogaRead GET /sensor/moga/{widget_name} Search indicators and sensor network trafic.
PerchApi.SensorApi sensorObservableBacktestCreate POST /sensor/observable/backtest
PerchApi.SiemAlertingApi siemAlertingAlertableMappingsFields GET /siem-alerting/alertable-mappings/{id}/fields
PerchApi.SiemAlertingApi siemAlertingAlertableMappingsList GET /siem-alerting/alertable-mappings
PerchApi.SiemAlertingApi siemAlertingAlertableMappingsRead GET /siem-alerting/alertable-mappings/{id}
PerchApi.SlackBotApi slackBotCreate POST /slack_bot
PerchApi.SoftwareWatchlistApi softwareWatchlistList GET /software-watchlist
PerchApi.SquawkboxApi squawkboxInviteCreate POST /squawkbox/invite Automatically invites qualified users to the Slack #squawkbox channel
PerchApi.SummaryApi summaryCommunityList GET /summary/community
PerchApi.SummaryApi summaryCommunityRead GET /summary/community/{id}
PerchApi.SuppressionApi suppressionStatsRead GET /suppression/stats/{indicator_id}
PerchApi.SuppressionsApi suppressionsRecentList GET /suppressions/recent
PerchApi.TeamsApi teamsBlacklistCreate POST /{version}/teams/{company_id}/blacklist
PerchApi.TeamsApi teamsBlacklistDelete DELETE /{version}/teams/{company_id}/blacklist/{id}
PerchApi.TeamsApi teamsBlacklistList GET /{version}/teams/{company_id}/blacklist
PerchApi.TeamsApi teamsBlacklistPartialUpdate PATCH /{version}/teams/{company_id}/blacklist/{id}
PerchApi.TeamsApi teamsBlacklistRead GET /{version}/teams/{company_id}/blacklist/{id}
PerchApi.TeamsApi teamsBlacklistUpdate PUT /{version}/teams/{company_id}/blacklist/{id}
PerchApi.TeamsApi teamsCommentsList GET /teams/{company_id}/comments
PerchApi.TeamsApi teamsCommentsRead GET /teams/{company_id}/comments/{id}
PerchApi.TeamsApi teamsContactsCreate POST /teams/{company_id}/contacts
PerchApi.TeamsApi teamsContactsDelete DELETE /teams/{company_id}/contacts/{id}
PerchApi.TeamsApi teamsContactsList GET /teams/{company_id}/contacts
PerchApi.TeamsApi teamsContactsPartialUpdate PATCH /teams/{company_id}/contacts/{id}
PerchApi.TeamsApi teamsContactsRead GET /teams/{company_id}/contacts/{id}
PerchApi.TeamsApi teamsContactsUpdate PUT /teams/{company_id}/contacts/{id}
PerchApi.UserApi userCompanyCreate POST /user/company
PerchApi.UserApi userCompanyDelete DELETE /user/company/{team}
PerchApi.UserApi userCompanyList GET /user/company
PerchApi.UserApi userCompanyRead GET /user/company/{team}
PerchApi.UserApi userIndicatorsList GET /user/indicators
PerchApi.UserApi userLoginsList GET /user/logins
PerchApi.UserApi userMePartialUpdate PUT /user/me
PerchApi.UserApi userMeRead GET /user/me
PerchApi.UserApi userMeSensorList GET /user/me/sensor
PerchApi.UserApi userPartialUpdate PUT /user/{user_id}
PerchApi.UserApi userPasswordChangeUpdate PUT /user/password/change
PerchApi.UserApi userPasswordForgotCreate POST /user/password/forgot
PerchApi.UserApi userPasswordResetUpdate PUT /user/password/reset
PerchApi.UserApi userRead GET /user/{user_id}
PerchApi.UserApi userSensorsList GET /user/sensors
PerchApi.UserApi userTourUpdate PUT /user/tour
PerchApi.V1Api v1AlertGroupingsByIpsCreate POST /v1/alert-groupings-by-ips
PerchApi.V1Api v1AlertGroupingsByIpsDelete DELETE /v1/alert-groupings-by-ips/{grouping_id}
PerchApi.V1Api v1AlertGroupingsByIpsList GET /v1/alert-groupings-by-ips
PerchApi.V1Api v1AlertGroupingsByIpsPartialUpdate PATCH /v1/alert-groupings-by-ips/{grouping_id}
PerchApi.V1Api v1AlertGroupingsByIpsRead GET /v1/alert-groupings-by-ips/{grouping_id}
PerchApi.V1Api v1AlertGroupingsByIpsUpdate PUT /v1/alert-groupings-by-ips/{grouping_id}
PerchApi.V1Api v1AlertsSuppressionsCreate POST /v1/alerts/suppressions
PerchApi.V1Api v1AlertsSuppressionsDelete DELETE /v1/alerts/suppressions/{id}
PerchApi.V1Api v1AlertsSuppressionsList GET /v1/alerts/suppressions
PerchApi.V1Api v1AlertsSuppressionsPartialUpdate PATCH /v1/alerts/suppressions/{id}
PerchApi.V1Api v1AlertsSuppressionsRead GET /v1/alerts/suppressions/{id}
PerchApi.V1Api v1AlertsSuppressionsUpdate PUT /v1/alerts/suppressions/{id}
PerchApi.V1Api v1CompanyDevicesCreate POST /v1/company/{company_id}/devices
PerchApi.V1Api v1CompanyDevicesDelete DELETE /v1/company/{company_id}/devices/{id}
PerchApi.V1Api v1CompanyDevicesList GET /v1/company/{company_id}/devices
PerchApi.V1Api v1CompanyDevicesPartialUpdate PATCH /v1/company/{company_id}/devices/{id}
PerchApi.V1Api v1CompanyDevicesRead GET /v1/company/{company_id}/devices/{id}
PerchApi.V1Api v1CompanyDevicesUpdate PUT /v1/company/{company_id}/devices/{id}
PerchApi.V1Api v1CompanyIndicatorsList GET /v1/company/{company_id}/indicators
PerchApi.V1Api v1CompanyIndicatorsRead GET /v1/company/{company_id}/indicators/{id}
PerchApi.V1Api v1CompanyIntegrationServiceCreate POST /v1/company/{company_id}/integration-service/{route}
PerchApi.V1Api v1CompanyIntegrationServiceRead GET /v1/company/{company_id}/integration-service/{route}
PerchApi.V1Api v1CompanyLoginsList GET /v1/company/{company_id}/logins
PerchApi.V1Api v1CompanyMemberDelete DELETE /v1/company/{company_id}/member/{user_id}
PerchApi.V1Api v1CompanyMemberList GET /v1/company/{company_id}/member
PerchApi.V1Api v1CompanyMemberPartialUpdate PATCH /v1/company/{company_id}/member/{user_id}
PerchApi.V1Api v1CompanyMemberRead GET /v1/company/{company_id}/member/{user_id}
PerchApi.V1Api v1CompanyMemberSensorsDelete DELETE /v1/company/{company_id}/member/sensors/{user_id}
PerchApi.V1Api v1CompanyMemberSensorsList GET /v1/company/{company_id}/member/sensors
PerchApi.V1Api v1CompanyMemberSensorsPartialUpdate PATCH /v1/company/{company_id}/member/sensors/{user_id}
PerchApi.V1Api v1CompanyMemberSensorsRead GET /v1/company/{company_id}/member/sensors/{user_id}
PerchApi.V1Api v1CompanyMemberSensorsUpdate PUT /v1/company/{company_id}/member/sensors/{user_id}
PerchApi.V1Api v1CompanyMemberUpdate PUT /v1/company/{company_id}/member/{user_id}
PerchApi.V1Api v1CompanyMfaSettingsPartialUpdate PATCH /v1/company/{company_id}/mfa-settings
PerchApi.V1Api v1CompanyMfaSettingsRead GET /v1/company/{company_id}/mfa-settings
PerchApi.V1Api v1CompanySubnetsCreate POST /v1/company/{company_id}/subnets
PerchApi.V1Api v1CompanySubnetsDelete DELETE /v1/company/{company_id}/subnets/{id}
PerchApi.V1Api v1CompanySubnetsList GET /v1/company/{company_id}/subnets
PerchApi.V1Api v1CompanySubnetsPartialUpdate PATCH /v1/company/{company_id}/subnets/{id}
PerchApi.V1Api v1CompanySubnetsRead GET /v1/company/{company_id}/subnets/{id}
PerchApi.V1Api v1CompanySubnetsUpdate PUT /v1/company/{company_id}/subnets/{id}
PerchApi.V1Api v1EscalationsCreate POST /v1/escalations
PerchApi.V1Api v1EscalationsDelete DELETE /v1/escalations/{security_event_id}
PerchApi.V1Api v1EscalationsList GET /v1/escalations
PerchApi.V1Api v1EscalationsPartialUpdate PATCH /v1/escalations/{security_event_id}
PerchApi.V1Api v1EscalationsRead GET /v1/escalations/{security_event_id}
PerchApi.V1Api v1EscalationsUpdate PUT /v1/escalations/{security_event_id}
PerchApi.V1Api v1EventsCommonHostsCreate POST /v1/events/common-hosts
PerchApi.V1Api v1EventsCommonValuesCreate POST /v1/events/common-values
PerchApi.V1Api v1MarketplaceCollectionsAdd POST /v1/marketplace/collections/{id}/add
PerchApi.V1Api v1MarketplaceCollectionsCreate POST /v1/marketplace/collections
PerchApi.V1Api v1MarketplaceCollectionsDelete DELETE /v1/marketplace/collections/{id}
PerchApi.V1Api v1MarketplaceCollectionsList GET /v1/marketplace/collections
PerchApi.V1Api v1MarketplaceCollectionsPartialUpdate PATCH /v1/marketplace/collections/{id}
PerchApi.V1Api v1MarketplaceCollectionsRead GET /v1/marketplace/collections/{id}
PerchApi.V1Api v1MarketplaceCollectionsRemoveCreate POST /v1/marketplace/collections/{id}/remove
PerchApi.V1Api v1MarketplaceCollectionsRemoveDelete DELETE /v1/marketplace/collections/{id}/remove
PerchApi.V1Api v1MarketplaceCollectionsUpdate PUT /v1/marketplace/collections/{id}
PerchApi.V1Api v1MarketplaceItemsAdd POST /v1/marketplace/items/{id}/add
PerchApi.V1Api v1MarketplaceItemsCreate POST /v1/marketplace/items
PerchApi.V1Api v1MarketplaceItemsDelete DELETE /v1/marketplace/items/{id}
PerchApi.V1Api v1MarketplaceItemsList GET /v1/marketplace/items
PerchApi.V1Api v1MarketplaceItemsPartialUpdate PATCH /v1/marketplace/items/{id}
PerchApi.V1Api v1MarketplaceItemsRead GET /v1/marketplace/items/{id}
PerchApi.V1Api v1MarketplaceItemsRemoveCreate POST /v1/marketplace/items/{id}/remove
PerchApi.V1Api v1MarketplaceItemsRemoveDelete DELETE /v1/marketplace/items/{id}/remove
PerchApi.V1Api v1MarketplaceItemsUpdate PUT /v1/marketplace/items/{id}
PerchApi.V1Api v1MarketplaceStoresCreate POST /v1/marketplace/{company_id}/stores
PerchApi.V1Api v1MarketplaceStoresCreate_0 POST /v1/marketplace/{company_id}/stores/{store_id}/{item_type}
PerchApi.V1Api v1MarketplaceStoresDelete DELETE /v1/marketplace/{company_id}/stores/{id}
PerchApi.V1Api v1MarketplaceStoresDelete_0 DELETE /v1/marketplace/{company_id}/stores/{store_id}/{item_type}/{id}
PerchApi.V1Api v1MarketplaceStoresList GET /v1/marketplace/{company_id}/stores
PerchApi.V1Api v1MarketplaceStoresList_0 GET /v1/marketplace/{company_id}/stores/{store_id}/{item_type}
PerchApi.V1Api v1MarketplaceStoresPartialUpdate PATCH /v1/marketplace/{company_id}/stores/{id}
PerchApi.V1Api v1MarketplaceStoresPartialUpdate_0 PATCH /v1/marketplace/{company_id}/stores/{store_id}/{item_type}/{id}
PerchApi.V1Api v1MarketplaceStoresRead GET /v1/marketplace/{company_id}/stores/{id}
PerchApi.V1Api v1MarketplaceStoresRead_0 GET /v1/marketplace/{company_id}/stores/{store_id}/{item_type}/{id}
PerchApi.V1Api v1MarketplaceStoresUpdate PUT /v1/marketplace/{company_id}/stores/{id}
PerchApi.V1Api v1MarketplaceStoresUpdate_0 PUT /v1/marketplace/{company_id}/stores/{store_id}/{item_type}/{id}
PerchApi.V1Api v1MetricsOrganizationsList GET /v1/metrics/organizations
PerchApi.V1Api v1MetricsOrganizationsRead GET /v1/metrics/organizations/{id}
PerchApi.V1Api v1MetricsSuppressionsAndEscalationsList GET /v1/metrics/suppressions-and-escalations
PerchApi.V1Api v1MetricsSuppressionsAndEscalationsRead GET /v1/metrics/suppressions-and-escalations/{id}
PerchApi.V1Api v1MetricsTeamsAllStatsList GET /v1/metrics/teams/all/stats
PerchApi.V1Api v1MsspsSlasCreate POST /v1/mssps/{company_id}/slas
PerchApi.V1Api v1MsspsSlasDelete DELETE /v1/mssps/{company_id}/slas/{id}
PerchApi.V1Api v1MsspsSlasList GET /v1/mssps/{company_id}/slas
PerchApi.V1Api v1MsspsTeamsDelete DELETE /v1/mssps/{mssp_id}/teams/{company_id}
PerchApi.V1Api v1NewTeamRegistrationCreate POST /v1/new-team-registration
PerchApi.V1Api v1SecurityEventsCommentsCreate POST /v1/security-events/comments
PerchApi.V1Api v1SecurityEventsCommentsDelete DELETE /v1/security-events/comments/{id}
PerchApi.V1Api v1SecurityEventsCommentsList GET /v1/security-events/comments
PerchApi.V1Api v1SecurityEventsCommentsPartialUpdate PATCH /v1/security-events/comments/{id}
PerchApi.V1Api v1SecurityEventsCommentsUpdate PUT /v1/security-events/comments/{id}
PerchApi.V1Api v1SecurityEventsCreate POST /v1/security-events
PerchApi.V1Api v1SecurityEventsDelete DELETE /v1/security-events/{security_event_id}
PerchApi.V1Api v1SecurityEventsList GET /v1/security-events
PerchApi.V1Api v1SecurityEventsPartialUpdate PATCH /v1/security-events/{security_event_id}
PerchApi.V1Api v1SecurityEventsRead GET /v1/security-events/{security_event_id}
PerchApi.V1Api v1SecurityEventsStatusStatusCounts GET /v1/security-events/status/counts
PerchApi.V1Api v1SecurityEventsUpdate PUT /v1/security-events/{security_event_id}
PerchApi.V1Api v1SensorFilesDownloadList GET /v1/sensor/files/{file_name}/download
PerchApi.V1Api v1SensorFilesDownloadList_0 GET /v1/sensor/{sensor_id}/files/{file_name}/download
PerchApi.V1Api v1SensorFilesHashList GET /v1/sensor/files/hash
PerchApi.V1Api v1SensorHealthRead GET /v1/sensor/health/{id}
PerchApi.V1Api v1SingleTeam GET /v1/usage/{company_id}
PerchApi.V1Api v1SupportedDevicesList GET /v1/supported_devices
PerchApi.V1Api v1SupportedDevicesRead GET /v1/supported_devices/{id}
PerchApi.V1Api v1TeamsHealthList GET /v1/teams/health
PerchApi.V1Api v1TeamsHealthRead GET /v1/teams/health/{id}
PerchApi.V1Api v1TeamsSensorsSummaryCreate POST /v1/teams/sensors/summary
PerchApi.V1Api v1TeamsSensorsSummaryDelete DELETE /v1/teams/sensors/summary/{id}
PerchApi.V1Api v1TeamsSensorsSummaryList GET /v1/teams/sensors/summary
PerchApi.V1Api v1TeamsSensorsSummaryPartialUpdate PATCH /v1/teams/sensors/summary/{id}
PerchApi.V1Api v1TeamsSensorsSummaryRead GET /v1/teams/sensors/summary/{id}
PerchApi.V1Api v1TeamsSensorsSummaryUpdate PUT /v1/teams/sensors/summary/{id}
PerchApi.V1Api v1UsageAllTeamsForUser GET /v1/usage/all
PerchApi.V1Api v1UsageManagedTeams GET /v1/usage/{company_id}/managed-teams
PerchApi.V1Api v1UserLoginsList GET /v1/user/logins/{user_id}
PerchApi.V1Api v1UserMePartialUpdate PUT /v1/user/me
PerchApi.V1Api v1UserMeRead GET /v1/user/me
PerchApi.V1Api v1UserPartialUpdate PUT /v1/user/{user_id}
PerchApi.V1Api v1UserRead GET /v1/user/{user_id}
PerchApi.V2Api v2AlertGroupingsByCustomValueCreate POST /v2/alert-groupings-by-custom-value
PerchApi.V2Api v2AlertGroupingsByCustomValueDelete DELETE /v2/alert-groupings-by-custom-value/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByCustomValueList GET /v2/alert-groupings-by-custom-value
PerchApi.V2Api v2AlertGroupingsByCustomValuePartialUpdate PATCH /v2/alert-groupings-by-custom-value/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByCustomValueRead GET /v2/alert-groupings-by-custom-value/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByCustomValueUpdate PUT /v2/alert-groupings-by-custom-value/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByIpsCreate POST /v2/alert-groupings-by-ips
PerchApi.V2Api v2AlertGroupingsByIpsDelete DELETE /v2/alert-groupings-by-ips/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByIpsList GET /v2/alert-groupings-by-ips
PerchApi.V2Api v2AlertGroupingsByIpsPartialUpdate PATCH /v2/alert-groupings-by-ips/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByIpsRead GET /v2/alert-groupings-by-ips/{grouping_id}
PerchApi.V2Api v2AlertGroupingsByIpsUpdate PUT /v2/alert-groupings-by-ips/{grouping_id}
PerchApi.V2Api v2AlertsSuppressionsBulkSuppressions POST /v2/alerts/suppressions/bulk-suppressions
PerchApi.V2Api v2AlertsSuppressionsCreate POST /v2/alerts/suppressions
PerchApi.V2Api v2AlertsSuppressionsDelete DELETE /v2/alerts/suppressions/{id}
PerchApi.V2Api v2AlertsSuppressionsList GET /v2/alerts/suppressions
PerchApi.V2Api v2AlertsSuppressionsRead GET /v2/alerts/suppressions/{id}
PerchApi.V2Api v2RegisterDeviceCreate POST /v2/register-device
PerchApi.V2Api v2RegisterUserCreate POST /v2/register_user
PerchApi.VersionApi versionList GET /version

Documentation for Models

Documentation for Authorization

Basic

  • Type: HTTP basic authentication

About


Languages

Language:JavaScript 99.9%Language:Shell 0.1%