Sumo Logic — API
Sumo Logic APIv1.0.0 Read the vendor's spec ↗
- 441 endpoints
- 7 deprecated
- 11 versions archived since Jul 20, 2026
- Last checked Nov 2, 2026
Using curl:
Get started
$ curl "https://api.au.sumologic.com/api/v1/account/status" \
-u "$USERNAME:$PASSWORD"
Set $USERNAME and $PASSWORD first, then paste.
- Base URL
-
https://api.au.sumologic.com/api/10 more
https://api.ca.sumologic.com/api/CA deployment API serverhttps://api.ch.sumologic.com/api/CH deployment API serverhttps://api.de.sumologic.com/api/DE deployment API serverhttps://api.eu.sumologic.com/api/EU deployment API serverhttps://api.fed.sumologic.com/api/FED deployment API serverhttps://api.jp.sumologic.com/api/JP deployment API serverhttps://api.kr.sumologic.com/api/KR deployment API serverhttps://api.in.sumologic.com/api/IN deployment API serverhttps://api.sumologic.com/api/US1 deployment API serverhttps://api.us2.sumologic.com/api/US2 deployment API server
- Authenticate
- HTTP basic: username and password
What it covers
- Monitors 22 Monitor Management API.
- Policies 20 Policies management API.
- Parsers Library Management 18 Parsers Library Management API Customize the Parsers via this API.
- Dashboard (New) 17 Dashboard (New) management API.
- SLOs 16 SLO Management API.
- Source Template Management 16 Source Template Management APIs.
- Traces 15 Traces API The Traces API allows you to browse traces collected in the system.
- Content 13 Content management API.
- Folders 13 Folder management API.
- Account 12 Account Management API.
- Muting Schedules 12 Muting Schedules Management API.
- Apps V2 (Beta) 11 App installation API (V2).
46 more areas
- Field Management 10 Field management API.
- Logs Data Forwarding 10 Logs Data Forwarding management API.
- SAML Configuration 10 SAML configuration management API Organizations with Enterprise accounts can provision Security Assertion Markup Language (SAML) 2.0 to enable Single Sign-On (SSO) for user access to Sumo Logic.
- Service Accounts 10 APIs to manage service accounts
- Span Analytics 10 Span Analytics API The Span Analytics API allows you to browse spans collected in the system.
- Users 10 User management API.
- Lookup Tables 9 Lookup Table management API.
- OAuth Management (Beta) 9 Only available to Beta customers.
- Scheduled Views 8 Scheduled View management API.
- Access Keys 7 Access Key management API.
- Budget Management 7 Budget Management API.
- Connections 7 Connection management API.
- Content and Configuration Management 7 Content and Configuration Management API.
- Partitions 7 Partition management API.
- Roles 7 Role management API.
- Roles V2 7 Role management API (V2).
- Data Masking Rules (Beta) 6 Data Masking Rules (Beta) API.
- Event Analytics (Beta) 6 Event Analytics (Beta) API.
- Ingest Budgets V2 6 Ingest Budget management API V2.
- OpenTelemetry Collector Management 6 OT Collector Management API External.
- SCIM User Management 6 APIs to manage scim based users.
- Service Allowlist 6 Service Allowlist management API Service Allowlist Settings allow you to explicitly grant access to specific IP addresses and/or CIDR notations for logins, APIs, and dashboard access.
- Data Archiving 5 Data Archiving API.
- Data Deletion Rules (Beta) 5 Data Deletion Rules (Beta) API.
- Dynamic Parsing 5 Dynamic Parsing management API.
- Field Extraction Rules 5 Field Extraction Rule management API.
- Log Searches 5 Log Searches Management API.
- Macro Management APIs 5 Macro Management APIs.
- Metrics Searches (New) 5 New Metrics Searches Management API.
- Search Job 5 Search Job API.
- Tokens 5 Tokens management API.
- Transformation Rules 5 Transformation Rule management API.
- Apps (Beta) 4 App installation API.
- Archive Ingestion Management 4 Archive Ingestion Management API.
- Log Search Estimated Usage 4 Log Search Estimated Usage API.
- Metrics Searches (Beta) 4 Metrics Search management API.
- Permissions 3 Content permissions API.
- Threat Intel Datastore Management 3 Threat Intel Datastore Management API The Threat Intel Datastore Management API allows you to: Get information about the threat indicator datastore and sources.
- Threat Intel Ingestion 3 Threat Intel Ingestion API The Threat Intel Ingestion API allows you to: Upload threat intel indicators in STIX 2.x or Sumo normalized format.
- Health Events 2 Health Events management API.
- Org Feature Settings 2 Org Feature Settings API The APIs allow you to view and update settings of some features for the Org.
- Password Policy 2 Password Policy Management API The password policy controls how user passwords are managed.
- Metrics Query 1 Metrics Query API.
- Organizations Management 1 Organizations Management API.
- Schema Base Management 1 Schema Base Management APIs.
- Service Map 1 Service Map API The Service Map API allows you to fetch a graph representation of the Services Map, which is a high-level view of your application environment, automatically derived from tracing data.
Open an endpoint for a runnable command, its inputs and what it returns.
Monitors 22
-
DELETE
/v1/monitorsBulk delete a monitor or folder.Loading…
-
DELETE
/v1/monitors/{id}Delete a monitor or folder.Loading…
-
GET
/v1/monitorsBulk read a monitor or folder.Loading…
-
GET
/v1/monitors/pathRead a monitor or folder by its path.Loading…
-
GET
/v1/monitors/playbooksList all playbooks.Loading…
-
GET
/v1/monitors/playbooksDetailsGet playbook details.Loading…
-
GET
/v1/monitors/rootGet the root monitors folder.Loading…
-
GET
/v1/monitors/searchSearch for a monitor or folder.Loading…
-
GET
/v1/monitors/usageInfoUsage info of monitors.Loading…
-
GET
/v1/monitors/{id}Get a monitor or folder.Loading…
-
GET
/v1/monitors/{id}/exportExport a monitor or folder.Loading…
-
GET
/v1/monitors/{id}/pathGet the path of a monitor or folder.Loading…
-
GET
/v1/monitors/{id}/permissionSummariesBySubjectsList permission summaries for a monitor or folder.Loading…
-
GET
/v1/monitors/{id}/permissionsList explicit permissions on monitor or folder.Loading…
-
POST
/v1/monitorsCreate a monitor or folder.Loading…
-
POST
/v1/monitors/{id}/copyCopy a monitor or folder.Loading…
-
POST
/v1/monitors/{id}/moveMove a monitor or folder.Loading…
-
POST
/v1/monitors/{parentId}/importImport a monitor or folder.Loading…
-
PUT
/v1/monitors/disableDisable monitors.Loading…
-
PUT
/v1/monitors/permissions/revokeRevoke all permissions on monitor or folder.Loading…
-
PUT
/v1/monitors/permissions/setSet permissions on monitor or folder.Loading…
-
PUT
/v1/monitors/{id}Update a monitor or folder.Loading…
Policies 20
-
GET
/v1/policies/accessKeysLifetimeGet access key lifetime policy.Loading…
-
GET
/v1/policies/auditGet Audit policy.Loading…
-
GET
/v1/policies/dataAccessLevelGet Data Access Level policy.Loading…
-
GET
/v1/policies/dataDeletionGet Data Deletion policy.Loading…
-
GET
/v1/policies/maxUserSessionTimeoutGet Max User Session Timeout policy.Loading…
-
GET
/v1/policies/oAuthCimdGet OAuth policy for Client ID Metadata Documents (CIMD) authentication.Loading…
-
GET
/v1/policies/searchAuditGet Search Audit policy.Loading…
-
GET
/v1/policies/timestampFormatGet Alert Timestamp Format policy.Loading…
-
GET
/v1/policies/userConcurrentSessionsLimitGet User Concurrent Sessions Limit policy.Loading…
-
PUT
/v1/policies/accessKeysLifetimeSet access keys lifetime policy.Loading…
-
PUT
/v1/policies/auditSet Audit policy.Loading…
-
PUT
/v1/policies/dataAccessLevelSet Data Access Level policy.Loading…
-
PUT
/v1/policies/dataDeletionSet Data Deletion policy.Loading…
-
PUT
/v1/policies/maxUserSessionTimeoutSet Max User Session Timeout policy.Loading…
-
PUT
/v1/policies/oAuthCimdSet OAuth policy for Client ID Metadata Documents (CIMD) authentication.Loading…
-
PUT
/v1/policies/searchAuditSet Search Audit policy.Loading…
-
PUT
/v1/policies/timestampFormatSet Alert Timestamp Format policy.Loading…
-
PUT
/v1/policies/userConcurrentSessionsLimitSet User Concurrent Sessions Limit policy.Loading…
Parsers Library Management 18
-
DELETE
/v1/parsersBulk delete folders and parsers.Loading…
-
DELETE
/v1/parsers/{id}Delete a folder or parser.Loading…
-
GET
/v1/parsersBulk read folders and parsers.Loading…
-
GET
/v1/parsers/pathRead a folder or parser by its path.Loading…
-
GET
/v1/parsers/rootGet the root folder in the library.Loading…
-
GET
/v1/parsers/searchSearch for folders or parsers.Loading…
-
GET
/v1/parsers/{id}Read a folder or parser.Loading…
-
GET
/v1/parsers/{id}/exportExport a folder or parser.Loading…
-
GET
/v1/parsers/{id}/pathGet full path of folder or parser.Loading…
-
POST
/v1/parsersCreate a folder or parser.Loading…
-
POST
/v1/parsers/{id}/copyCopy a folder or parser.Loading…
-
POST
/v1/parsers/{id}/lockLock a folder or a parser.Loading…
-
POST
/v1/parsers/{id}/moveMove a folder or parser.Loading…
-
POST
/v1/parsers/{id}/unlockUnlock a folder or a parser.Loading…
-
POST
/v1/parsers/{parentId}/importImport a folder or parserLoading…
-
POST
/v1/system/parsers/{id}/lockLock a folder or a parser.Loading…
-
POST
/v1/system/parsers/{id}/unlockUnlock a folder or a parser.Loading…
-
PUT
/v1/parsers/{id}Update a folder or parser.Loading…
Dashboard (New) 17
-
DELETE
/v1/dashboards/reportSchedules/{scheduleId}Delete dashboard report schedule.Loading…
-
DELETE
/v2/dashboards/{id}Delete a dashboard.Loading…
-
GET
/v1/dashboards/reportSchedulesList all dashboard report schedules.Loading…
-
GET
/v1/dashboards/reportSchedules/{scheduleId}Get dashboard report schedule.Loading…
-
GET
/v2/dashboardsList all dashboards.Loading…
-
GET
/v2/dashboards/migrate/{jobId}/resultGet dashboard migration result.Loading…
-
GET
/v2/dashboards/migrate/{jobId}/statusGet dashboard migration status.Loading…
-
GET
/v2/dashboards/reportJobs/{jobId}/resultGet report generation job resultLoading…
-
GET
/v2/dashboards/reportJobs/{jobId}/statusGet report generation job statusLoading…
-
GET
/v2/dashboards/{id}Get a dashboard.Loading…
-
POST
/v1/dashboards/reportSchedulesSchedule dashboard reportLoading…
-
POST
/v2/dashboardsCreate a new dashboard.Loading…
-
POST
/v2/dashboards/migrateMigrate Legacy Dashboards to Dashboards(New)Loading…
-
POST
/v2/dashboards/migrate/previewPreview of Migrating Legacy Dashboards to Dashboards(New)Loading…
-
POST
/v2/dashboards/reportJobsStart a report jobLoading…
-
PUT
/v1/dashboards/reportSchedules/{scheduleId}Update dashboard report schedule.Loading…
-
PUT
/v2/dashboards/{id}Update a dashboard.Loading…
SLOs 16
-
DELETE
/v1/slosBulk delete a slo or folder.Loading…
-
DELETE
/v1/slos/{id}Delete a slo or folder.Loading…
-
GET
/v1/slosBulk read a slo or folder.Loading…
-
GET
/v1/slos/pathRead a slo or folder by its path.Loading…
-
GET
/v1/slos/rootGet the root slos folder.Loading…
-
GET
/v1/slos/searchSearch for a slo or folder.Loading…
-
GET
/v1/slos/sliBulk fetch SLI values, error budget remaining and SLI computation status for the current compliance period.Loading…
-
GET
/v1/slos/usageInfoUsage info of SLOs.Loading…
-
GET
/v1/slos/{id}Get a slo or folder.Loading…
-
GET
/v1/slos/{id}/exportExport a slo or folder.Loading…
-
GET
/v1/slos/{id}/pathGet the path of a slo or folder.Loading…
-
POST
/v1/slosCreate a slo or folder.Loading…
-
POST
/v1/slos/{id}/copyCopy a slo or folder.Loading…
-
POST
/v1/slos/{id}/moveMove a slo or folder.Loading…
-
POST
/v1/slos/{parentId}/importImport a slo or folder.Loading…
-
PUT
/v1/slos/{id}Update a slo or folder.Loading…
Source Template Management 16
-
DELETE
/v1/sourceTemplate/{id}Delete a source template (deprecated). deprecatedLoading…
-
DELETE
/v1/sourceTemplates/{id}Delete a source template.Loading…
-
GET
/v1/sourceTemplateReturn all source templates of a customer (deprecated). deprecatedLoading…
-
GET
/v1/sourceTemplate/{id}Get a source template by Id (deprecated). deprecatedLoading…
-
GET
/v1/sourceTemplatesList all source templates.Loading…
-
GET
/v1/sourceTemplates/{id}Get a source template by Id.Loading…
-
POST
/v1/sourceTemplateCreate source template (deprecated). deprecatedLoading…
-
POST
/v1/sourceTemplate/getLinkedSourceTemplatesImpactGet linked source templates update based on the ot-collector tags user is wants to update.Loading…
-
POST
/v1/sourceTemplate/{id}Update source template (deprecated). deprecatedLoading…
-
POST
/v1/sourceTemplatesCreate source template.Loading…
-
POST
/v1/sourceTemplates/getLinkedSourceTemplatesImpactPreview source template linking changes.Loading…
-
POST
/v1/sourceTemplates/{id}Update source template.Loading…
-
POST
/v1/sourceTemplates/{id}/upgradeUpgrade source template.Loading…
-
POST
/v1/upgrade/sourceTemplate/{id}Upgrade source template (deprecated). deprecatedLoading…
-
PUT
/v1/sourceTemplate/{id}/statusUpdate status of source template (deprecated) deprecatedLoading…
-
PUT
/v1/sourceTemplates/{id}/statusUpdate status of source templateLoading…
Traces 15
-
DELETE
/v1/tracing/tracequery/{queryId}Cancel a trace search query.Loading…
-
GET
/v1/tracing/metricsGet trace search query metrics.Loading…
-
GET
/v1/tracing/tracequery/fieldsGet filter fields for trace search queries.Loading…
-
GET
/v1/tracing/tracequery/fields/{field}/valuesGet trace search query filter field values.Loading…
-
GET
/v1/tracing/tracequery/{queryId}/rows/{rowId}/tracesGet results of a trace search query.Loading…
-
GET
/v1/tracing/tracequery/{queryId}/statusGet a trace search query status.Loading…
-
GET
/v1/tracing/traces/{traceId}Get trace details.Loading…
-
GET
/v1/tracing/traces/{traceId}/criticalPathGet a critical path of a trace.Loading…
-
GET
/v1/tracing/traces/{traceId}/criticalPath/breakdown/serviceGet a critical path service breakdown of a trace.Loading…
-
GET
/v1/tracing/traces/{traceId}/existsCheck if the trace exists.Loading…
-
GET
/v1/tracing/traces/{traceId}/spansGet a list of trace spans.Loading…
-
GET
/v1/tracing/traces/{traceId}/spans/{spanId}Get span details.Loading…
-
GET
/v1/tracing/traces/{traceId}/spans/{spanId}/billingInfoGet span billing details.Loading…
-
GET
/v1/tracing/traces/{traceId}/traceEventsGet a list of events (without their attributes) per span for a trace.Loading…
-
POST
/v1/tracing/tracequeryRun a trace search query asynchronously.Loading…
Content 13
-
DELETE
/v2/content/{id}/deleteStart a content deletion job.Loading…
-
GET
/v2/content/folders/{folderId}/import/{jobId}/resultContent import job result.Loading…
-
GET
/v2/content/folders/{folderId}/import/{jobId}/statusContent import job status.Loading…
-
GET
/v2/content/pathGet content item by path.Loading…
-
GET
/v2/content/{contentId}/export/{jobId}/resultContent export job result.Loading…
-
GET
/v2/content/{contentId}/export/{jobId}/statusContent export job status.Loading…
-
GET
/v2/content/{contentId}/pathGet path of an item.Loading…
-
GET
/v2/content/{id}/copy/{jobId}/statusContent copy job status.Loading…
-
GET
/v2/content/{id}/delete/{jobId}/statusContent deletion job status.Loading…
-
POST
/v2/content/folders/{folderId}/importStart a content import job.Loading…
-
POST
/v2/content/{id}/copyStart a content copy job.Loading…
-
POST
/v2/content/{id}/exportStart a content export job.Loading…
-
POST
/v2/content/{id}/moveMove an item.Loading…
Folders 13
-
GET
/v2/content/folders/adminRecommendedSchedule Admin Recommended folder jobLoading…
-
GET
/v2/content/folders/adminRecommended/{jobId}/resultGet Admin Recommended folder job resultLoading…
-
GET
/v2/content/folders/adminRecommended/{jobId}/statusGet Admin Recommended folder job statusLoading…
-
GET
/v2/content/folders/globalSchedule Global View jobLoading…
-
GET
/v2/content/folders/global/{jobId}/resultGet Global View job resultLoading…
-
GET
/v2/content/folders/global/{jobId}/statusGet Global View job statusLoading…
-
GET
/v2/content/folders/installedAppsSchedule Installed Apps folder jobLoading…
-
GET
/v2/content/folders/installedApps/{jobId}/resultGet Installed Apps folder job resultLoading…
-
GET
/v2/content/folders/installedApps/{jobId}/statusGet Installed Apps folder job statusLoading…
-
GET
/v2/content/folders/personalGet personal folder.Loading…
-
GET
/v2/content/folders/{id}Get a folder.Loading…
-
POST
/v2/content/foldersCreate a new folder.Loading…
-
PUT
/v2/content/folders/{id}Update a folder.Loading…
Account 12
-
DELETE
/v1/account/subdomainDelete the configured subdomain.Loading…
-
DELETE
/v1/plan/pendingUpdateRequestDelete the pending plan update request, if any.Loading…
-
GET
/v1/account/accountOwnerGet the owner of an account.Loading…
-
GET
/v1/account/statusGet overview of the account status.Loading…
-
GET
/v1/account/subdomainGet the configured subdomain.Loading…
-
GET
/v1/account/usage/report/{jobId}/statusGet report generation status.Loading…
-
GET
/v1/account/usageForecastGet usage forecast with respect to last number of days specified.Loading…
-
GET
/v1/plan/pendingUpdateRequestGet the pending plan update request, if any.Loading…
-
POST
/v1/account/subdomainCreate account subdomain.Loading…
-
POST
/v1/account/subdomain/recoverRecover subdomains for a user.Loading…
-
POST
/v1/account/usage/reportExport credits usage details as CSV.Loading…
-
PUT
/v1/account/subdomainUpdate account subdomain.Loading…
Muting Schedules 12
-
DELETE
/v1/mutingSchedulesBulk delete a mutingschedule or folder.Loading…
-
DELETE
/v1/mutingSchedules/{id}Delete a mutingschedule or folder.Loading…
-
GET
/v1/mutingSchedulesBulk read a mutingschedule or folder.Loading…
-
GET
/v1/mutingSchedules/rootGet the root mutingSchedules folder.Loading…
-
GET
/v1/mutingSchedules/searchSearch for a mutingschedule or folder.Loading…
-
GET
/v1/mutingSchedules/{id}Get a mutingschedule or folder.Loading…
-
GET
/v1/mutingSchedules/{id}/exportExport a mutingschedule or folder.Loading…
-
GET
/v1/mutingSchedules/{id}/pathGet the path of a mutingschedule or folder.Loading…
-
POST
/v1/mutingSchedulesCreate a mutingschedule or folder.Loading…
-
POST
/v1/mutingSchedules/{id}/copyCopy a mutingschedule or folder.Loading…
-
POST
/v1/mutingSchedules/{parentId}/importImport a mutingschedule or folder.Loading…
-
PUT
/v1/mutingSchedules/{id}Update a mutingschedule or folder.Loading…
Apps V2 (Beta) 11
-
DELETE
/v2/apps/{uuid}/subscriptionUnsubscribe from an app upgrade notificationLoading…
-
GET
/v2/appsList appsLoading…
-
GET
/v2/apps/install/{jobId}/statusApp install job statusLoading…
-
GET
/v2/apps/uninstall/{jobId}/statusApp uninstall job statusLoading…
-
GET
/v2/apps/upgrade/{jobId}/statusApp upgrade job statusLoading…
-
GET
/v2/apps/{uuid}/detailsGet details of an app version.Loading…
-
GET
/v2/apps/{uuid}/subscriptionGet subscription status for the userLoading…
-
POST
/v2/apps/{uuid}/installStart app install jobLoading…
-
POST
/v2/apps/{uuid}/subscriptionSubscribe to an app upgrade notificationLoading…
-
POST
/v2/apps/{uuid}/uninstallStart app uninstall jobLoading…
-
POST
/v2/apps/{uuid}/upgradeStart app upgrade jobLoading…
Field Management 10
-
DELETE
/v1/fields/{id}Delete a custom field.Loading…
-
DELETE
/v1/fields/{id}/disableDisable a custom field.Loading…
-
GET
/v1/fieldsGet a list of all custom fields.Loading…
-
GET
/v1/fields/builtinGet a list of built-in fields.Loading…
-
GET
/v1/fields/builtin/{id}Get a built-in field.Loading…
-
GET
/v1/fields/droppedGet a list of dropped fields.Loading…
-
GET
/v1/fields/quotaGet capacity information.Loading…
-
GET
/v1/fields/{id}Get a custom field.Loading…
-
POST
/v1/fieldsCreate a new field.Loading…
-
PUT
/v1/fields/{id}/enableEnable custom field with a specified identifier.Loading…
Logs Data Forwarding 10
-
DELETE
/v1/logsDataForwarding/destinations/{id}Delete an S3 data forwarding destination.Loading…
-
DELETE
/v1/logsDataForwarding/rules/{indexId}Delete an S3 data forwarding rule by its index.Loading…
-
GET
/v1/logsDataForwarding/destinationsGet Amazon S3 data forwarding destinations.Loading…
-
GET
/v1/logsDataForwarding/destinations/{id}Get an S3 data forwarding destination.Loading…
-
GET
/v1/logsDataForwarding/rulesGet all S3 data forwarding rules.Loading…
-
GET
/v1/logsDataForwarding/rules/{indexId}Get an S3 data forwarding rule by its index.Loading…
-
POST
/v1/logsDataForwarding/destinationsCreate an S3 data forwarding destination.Loading…
-
POST
/v1/logsDataForwarding/rulesCreate an S3 data forwarding rule.Loading…
-
PUT
/v1/logsDataForwarding/destinations/{id}Update an S3 data forwarding destination.Loading…
-
PUT
/v1/logsDataForwarding/rules/{indexId}Update an S3 data forwarding rule by its index.Loading…
SAML Configuration 10
-
DELETE
/v1/saml/allowlistedUsers/{userId}Remove an allowlisted user.Loading…
-
DELETE
/v1/saml/identityProviders/{id}Delete a SAML configuration.Loading…
-
GET
/v1/saml/allowlistedUsersGet list of allowlisted users.Loading…
-
GET
/v1/saml/identityProvidersGet a list of SAML configurations.Loading…
-
GET
/v1/saml/identityProviders/{id}/metadataGet SAML configuration metadata XML.Loading…
-
POST
/v1/saml/allowlistedUsers/{userId}Allowlist a user.Loading…
-
POST
/v1/saml/identityProvidersCreate a new SAML configuration.Loading…
-
POST
/v1/saml/lockdown/disableDisable SAML lockdown.Loading…
-
POST
/v1/saml/lockdown/enableRequire SAML for sign-in.Loading…
-
PUT
/v1/saml/identityProviders/{id}Update a SAML configuration.Loading…
Service Accounts 10
-
DELETE
/v1/serviceAccounts/{id}Delete a service account.Loading…
-
DELETE
/v1/serviceAccounts/{serviceAccountId}/accessKeys/{accessId}Delete an access key of a service account.Loading…
-
GET
/v1/serviceAccountsGet a list of service accounts.Loading…
-
GET
/v1/serviceAccounts/{id}Get a service account.Loading…
-
GET
/v1/serviceAccounts/{serviceAccountId}/accessKeysList access keys for a service account.Loading…
-
GET
/v1/serviceAccounts/{serviceAccountId}/accessKeys/{accessId}Get an access key of a service account.Loading…
-
POST
/v1/serviceAccountsCreate a new service account.Loading…
-
POST
/v1/serviceAccounts/{serviceAccountId}/accessKeysCreate a new access key for a service account.Loading…
-
PUT
/v1/serviceAccounts/{id}Update a service account.Loading…
-
PUT
/v1/serviceAccounts/{serviceAccountId}/accessKeys/{accessId}Update an access key of a service account.Loading…
Span Analytics 10
-
DELETE
/v1/tracing/spanquery/{queryId}Cancel a span analytics query.Loading…
-
GET
/v1/tracing/spanquery/fieldsGet filter fields for span analytics queries.Loading…
-
GET
/v1/tracing/spanquery/fields/{field}/valuesGet span analytics query filter field values.Loading…
-
GET
/v1/tracing/spanquery/{queryId}/aggregatesGet span analytics query aggregated results.Loading…
-
GET
/v1/tracing/spanquery/{queryId}/rows/{rowId}/facetsGet a list of facets of a span analytics query.Loading…
-
GET
/v1/tracing/spanquery/{queryId}/rows/{rowId}/spansGet results of a span analytics query.Loading…
-
GET
/v1/tracing/spanquery/{queryId}/statusGet a span analytics query status.Loading…
-
POST
/v1/tracing/spanqueryRun a span analytics query asynchronously.Loading…
-
PUT
/v1/tracing/spanquery/{queryId}/pausePause a span analytics query.Loading…
-
PUT
/v1/tracing/spanquery/{queryId}/resumeResume a span analytics query.Loading…
Users 10
-
DELETE
/v1/users/{id}Delete a user.Loading…
-
GET
/v1/usersGet a list of users.Loading…
-
GET
/v1/users/{id}Get a user.Loading…
-
POST
/v1/usersCreate a new user.Loading…
-
POST
/v1/users/{id}/email/requestChangeChange email address.Loading…
-
POST
/v1/users/{id}/password/resetReset password.Loading…
-
POST
/v1/users/{id}/resendWelcomeEmailResend verification email.Loading…
-
POST
/v1/users/{id}/unlockUnlock a user.Loading…
-
PUT
/v1/users/{id}Update a user.Loading…
-
PUT
/v1/users/{id}/mfa/disableDisable MFA for user.Loading…
Lookup Tables 9
-
DELETE
/v1/lookupTables/{id}Delete a lookup table.Loading…
-
GET
/v1/lookupTables/jobs/{jobId}/statusGet the status of an async job.Loading…
-
GET
/v1/lookupTables/{id}Get a lookup table.Loading…
-
POST
/v1/lookupTablesCreate a lookup table.Loading…
-
POST
/v1/lookupTables/{id}/truncateEmpty a lookup table.Loading…
-
POST
/v1/lookupTables/{id}/uploadUpload a CSV file.Loading…
-
PUT
/v1/lookupTables/{id}Edit a lookup table.Loading…
-
PUT
/v1/lookupTables/{id}/deleteTableRowDelete a lookup table row.Loading…
-
PUT
/v1/lookupTables/{id}/rowInsert or Update a lookup table row.Loading…
OAuth Management (Beta) 9
-
DELETE
/v1/oauth/clients/{id}Delete an OAuth client.Loading…
-
DELETE
/v1/oauth/consents/{consentId}Delete an OAuth consent.Loading…
-
GET
/v1/oauth/clientsList the OAuth clients.Loading…
-
GET
/v1/oauth/clients/{id}Get an OAuth client.Loading…
-
GET
/v1/oauth/consentsList OAuth consents.Loading…
-
GET
/v1/oauth/scopesGet all scopes.Loading…
-
POST
/v1/oauth/clientsCreate a new OAuth client.Loading…
-
PUT
/v1/oauth/clients/{id}Update an OAuth client.Loading…
-
PUT
/v1/oauth/clients/{id}/rotateRotate the oauth client secretLoading…
Scheduled Views 8
-
DELETE
/v1/scheduledViews/{id}/disableDisable a scheduled view.Loading…
-
GET
/v1/scheduledViewsGet a list of scheduled views.Loading…
-
GET
/v1/scheduledViews/quotaProvides information about scheduled views quota.Loading…
-
GET
/v1/scheduledViews/{id}Get a scheduled view.Loading…
-
POST
/v1/scheduledViewsCreate a new scheduled view.Loading…
-
POST
/v1/scheduledViews/{id}/pausePause a scheduled view.Loading…
-
POST
/v1/scheduledViews/{id}/startStart a scheduled view.Loading…
-
PUT
/v1/scheduledViews/{id}Update a scheduled view.Loading…
Access Keys 7
-
DELETE
/v1/accessKeys/{id}Delete an access key.Loading…
-
GET
/v1/accessKeysList all access keys.Loading…
-
GET
/v1/accessKeys/personalList personal keys.Loading…
-
GET
/v1/accessKeys/scopesGet all scopes.Loading…
-
POST
/v1/accessKeysCreate an access key.Loading…
-
PUT
/v1/accessKeys/{id}Update an access key.Loading…
-
PUT
/v1/accessKeys/{id}/rotateRotate the access key secretLoading…
Budget Management 7
-
DELETE
/v1/budgets/{budgetId}Delete budgetLoading…
-
GET
/v1/budgetsGet budgetsLoading…
-
GET
/v1/budgets/usageGet budget usagesLoading…
-
GET
/v1/budgets/{budgetId}Get budgetLoading…
-
GET
/v1/budgets/{budgetId}/usageGet budget usageLoading…
-
POST
/v1/budgetsCreates a budget definitionLoading…
-
PUT
/v1/budgets/{budgetId}Update budgetLoading…
Connections 7
-
DELETE
/v1/connections/{id}Delete a connection.Loading…
-
GET
/v1/connectionsGet a list of connections.Loading…
-
GET
/v1/connections/{id}Get a connection.Loading…
-
POST
/v1/connectionsCreate a new connection.Loading…
-
POST
/v1/connections/incidentTemplatesGet incident templates for CloudSOAR connections.Loading…
-
POST
/v1/connections/testTest a new connection url.Loading…
-
PUT
/v1/connections/{id}Update a connection.Loading…
Content and Configuration Management 7
-
GET
/v1/multi-account-management/content/syncGet Content Sync Job Id.Loading…
-
GET
/v1/multi-account-management/content/sync/{jobId}/infoGet Information of Content Sync Job by ID.Loading…
-
GET
/v1/multi-account-management/content/sync/{jobId}/resultGet Result of Content Sync Job by ID.Loading…
-
GET
/v1/multi-account-management/content/sync/{jobId}/statusGet Status of Content Sync Job.Loading…
-
POST
/v1/multi-account-management/content/syncSync Content and Configuration across Organization.Loading…
-
POST
/v1/multi-account-management/content/sync/{jobId}/cancelCancel Content Sync Job by IDLoading…
-
POST
/v1/multi-account-management/content/sync/{jobId}/retryRetry Content Sync Job by IDLoading…
Partitions 7
-
GET
/v1/partitionsGet a list of partitions.Loading…
-
GET
/v1/partitions/quotaProvides information about partitions quota.Loading…
-
GET
/v1/partitions/{id}Get a partition.Loading…
-
POST
/v1/partitionsCreate a new partition.Loading…
-
POST
/v1/partitions/{id}/cancelRetentionUpdateCancel a retention update for a partitionLoading…
-
POST
/v1/partitions/{id}/decommissionDecommission a partition.Loading…
-
PUT
/v1/partitions/{id}Update a partition.Loading…
Roles 7
-
DELETE
/v1/roles/{id}Delete a role.Loading…
-
DELETE
/v1/roles/{roleId}/users/{userId}Remove role from a user.Loading…
-
GET
/v1/rolesGet a list of roles.Loading…
-
GET
/v1/roles/{id}Get a role.Loading…
-
POST
/v1/rolesCreate a new role.Loading…
-
PUT
/v1/roles/{id}Update a role.Loading…
-
PUT
/v1/roles/{roleId}/users/{userId}Assign a role to a user.Loading…
Roles V2 7
-
DELETE
/v2/roles/{id}Delete a role.Loading…
-
DELETE
/v2/roles/{roleId}/users/{userId}Remove role from a user.Loading…
-
GET
/v2/rolesGet a list of roles.Loading…
-
GET
/v2/roles/{id}Get a role.Loading…
-
POST
/v2/rolesCreate a new role.Loading…
-
PUT
/v2/roles/{id}Update a role.Loading…
-
PUT
/v2/roles/{roleId}/users/{userId}Assign a role to a user.Loading…
Data Masking Rules (Beta) 6
-
DELETE
/v1/dataMaskingRules/{id}Delete a data masking rule.Loading…
-
GET
/v1/dataMaskingRulesGet a list of data masking rules.Loading…
-
GET
/v1/dataMaskingRules/{id}Get a data masking rule.Loading…
-
POST
/v1/dataMaskingRulesCreate a new data masking rule.Loading…
-
POST
/v1/dataMaskingRules/evaluateTest and preview a regex pattern by evaluating it against sample input text.Loading…
-
PUT
/v1/dataMaskingRules/{id}Update a data masking rule.Loading…
Event Analytics (Beta) 6
-
DELETE
/v1/eventExtractionRules/{id}Delete an event extraction rule.Loading…
-
GET
/v1/eventExtractionRulesGet all event extraction rules.Loading…
-
GET
/v1/eventExtractionRules/quotaGet event extraction rules quota.Loading…
-
GET
/v1/eventExtractionRules/{id}Get an event extraction rule.Loading…
-
POST
/v1/eventExtractionRulesCreate event extraction rule.Loading…
-
PUT
/v1/eventExtractionRules/{id}Update an event extraction rule.Loading…
Ingest Budgets V2 6
-
DELETE
/v2/ingestBudgets/{id}Delete an ingest budget.Loading…
-
GET
/v2/ingestBudgetsGet a list of ingest budgets.Loading…
-
GET
/v2/ingestBudgets/{id}Get an ingest budget.Loading…
-
POST
/v2/ingestBudgetsCreate a new ingest budget.Loading…
-
POST
/v2/ingestBudgets/{id}/usage/resetReset usage.Loading…
-
PUT
/v2/ingestBudgets/{id}Update an ingest budget.Loading…
OpenTelemetry Collector Management 6
-
DELETE
/v1/otCollectors/offlineDelete all Offline OT CollectorsLoading…
-
DELETE
/v1/otCollectors/{id}Delete an OT Collector.Loading…
-
GET
/v1/otCollectors/otCollectorsByNameGet OT Collectors by name.Loading…
-
GET
/v1/otCollectors/totalCountGet a count of OT Collectors.Loading…
-
GET
/v1/otCollectors/{id}Get OT Collector by ID.Loading…
-
POST
/v1/otCollectorsGet paginated list of OT CollectorsLoading…
SCIM User Management 6
-
DELETE
/v1/scim/Users/{id}Delete SCIM UserLoading…
-
GET
/v1/scim/UsersList SCIM UsersLoading…
-
GET
/v1/scim/Users/{id}Get a SCIM UserLoading…
-
PATCH
/v1/scim/Users/{id}Update SCIM User AttributesLoading…
-
POST
/v1/scim/UsersCreate SCIM UserLoading…
-
PUT
/v1/scim/Users/{id}Update SCIM UserLoading…
Service Allowlist 6
-
GET
/v1/serviceAllowlist/addressesList all allowlisted CIDRs/IP addresses.Loading…
-
GET
/v1/serviceAllowlist/statusGet the allowlisting status.Loading…
-
POST
/v1/serviceAllowlist/addresses/addAllowlist CIDRs/IP addresses.Loading…
-
POST
/v1/serviceAllowlist/addresses/removeRemove allowlisted CIDRs/IP addresses.Loading…
-
POST
/v1/serviceAllowlist/disableDisable service allowlisting.Loading…
-
POST
/v1/serviceAllowlist/enableEnable service allowlisting.Loading…
Data Archiving 5
-
DELETE
/v1/dataarchiving/destinations/{id}Delete a data archiving destination.Loading…
-
GET
/v1/dataarchiving/destinationsGet all data archiving destinations.Loading…
-
GET
/v1/dataarchiving/destinations/{id}Get a data archiving destination.Loading…
-
POST
/v1/dataarchiving/destinationsCreate a data archiving destination.Loading…
-
PUT
/v1/dataarchiving/destinations/{id}Update a data archiving destination.Loading…
Data Deletion Rules (Beta) 5
-
DELETE
/v1/dataDeletionRules/{id}/deleteDelete the data Deletion Rule with the given Id.Loading…
-
GET
/v1/dataDeletionRulesGet a list of Data Deletion RulesLoading…
-
GET
/v1/dataDeletionRules/{id}Get Data Deletion Rule information for the given Id.Loading…
-
POST
/v1/dataDeletionRulesCreate a new Data Deletion RuleLoading…
-
POST
/v1/dataDeletionRules/{id}/cancelCancel the data Deletion Rule with the given Id.Loading…
Dynamic Parsing 5
-
DELETE
/v1/dynamicParsingRules/{id}Delete a dynamic parsing rule.Loading…
-
GET
/v1/dynamicParsingRulesGet a list of dynamic parsing rules.Loading…
-
GET
/v1/dynamicParsingRules/{id}Get a dynamic parsing rule.Loading…
-
POST
/v1/dynamicParsingRulesCreate a new dynamic parsing rule.Loading…
-
PUT
/v1/dynamicParsingRules/{id}Update a dynamic parsing rule.Loading…
Field Extraction Rules 5
-
DELETE
/v1/extractionRules/{id}Delete a field extraction rule.Loading…
-
GET
/v1/extractionRulesGet a list of field extraction rules.Loading…
-
GET
/v1/extractionRules/{id}Get a field extraction rule.Loading…
-
POST
/v1/extractionRulesCreate a new field extraction rule.Loading…
-
PUT
/v1/extractionRules/{id}Update a field extraction rule.Loading…
Log Searches 5
-
DELETE
/v1/logSearches/{id}Delete the saved log search.Loading…
-
GET
/v1/logSearchesList all saved log searches.Loading…
-
GET
/v1/logSearches/{id}Get the saved log search.Loading…
-
POST
/v1/logSearchesSave a log search.Loading…
-
PUT
/v1/logSearches/{id}Update the saved log Search.Loading…
Macro Management APIs 5
-
DELETE
/v2/macros/{id}Delete a macro.Loading…
-
GET
/v2/macrosList all macros.Loading…
-
GET
/v2/macros/{id}Get a macro.Loading…
-
POST
/v2/macrosCreate a new macro.Loading…
-
PUT
/v2/macros/{id}Edit a macro.Loading…
Metrics Searches (New) 5
-
DELETE
/v2/metricsSearches/{id}Delete a metrics search page.Loading…
-
GET
/v2/metricsSearchesList all metrics search pages.Loading…
-
GET
/v2/metricsSearches/{id}Get a metrics search page.Loading…
-
POST
/v2/metricsSearchesCreate a new metrics search page.Loading…
-
PUT
/v2/metricsSearches/{id}Update a metrics search page.Loading…
Search Job 5
-
DELETE
/v2/search/jobs/{jobId}Delete a search job.Loading…
-
GET
/v2/search/jobs/{jobId}Get a search job's status.Loading…
-
GET
/v2/search/jobs/{jobId}/messagesGet paginated messages from an offset.Loading…
-
GET
/v2/search/jobs/{jobId}/recordsGet aggregated records.Loading…
-
POST
/v2/search/jobsCreate a search job.Loading…
Tokens 5
-
DELETE
/v1/tokens/{id}Delete a token.Loading…
-
GET
/v1/tokensGet a list of tokens.Loading…
-
GET
/v1/tokens/{id}Get a token.Loading…
-
POST
/v1/tokensCreate a token.Loading…
-
PUT
/v1/tokens/{id}Update a token.Loading…
Transformation Rules 5
-
DELETE
/v1/transformationRules/{id}Delete a transformation rule.Loading…
-
GET
/v1/transformationRulesGet a list of transformation rules.Loading…
-
GET
/v1/transformationRules/{id}Get a transformation rule.Loading…
-
POST
/v1/transformationRulesCreate a new transformation rule.Loading…
-
PUT
/v1/transformationRules/{id}Update a transformation rule.Loading…
Apps (Beta) 4
-
GET
/v1/appsList available apps.Loading…
-
GET
/v1/apps/install/{jobId}/statusApp install job status.Loading…
-
GET
/v1/apps/{uuid}Get an app by UUID.Loading…
-
POST
/v1/apps/{uuid}/installInstall an app by UUID.Loading…
Archive Ingestion Management 4
-
DELETE
/v1/archive/{sourceId}/jobs/{id}Delete an ingestion job.Loading…
-
GET
/v1/archive/jobs/countList ingestion jobs for all Archive Sources.Loading…
-
GET
/v1/archive/{sourceId}/jobsGet ingestion jobs for an Archive Source.Loading…
-
POST
/v1/archive/{sourceId}/jobsCreate an ingestion job.Loading…
Log Search Estimated Usage 4
-
POST
/v1/logSearches/estimatedUsageGets estimated usage details.Loading…
-
POST
/v1/logSearches/estimatedUsageByMeteringTypeGets estimated usage details per metering type.Loading…
-
POST
/v1/logSearches/estimatedUsageByTierGets Tier Wise estimated usage details.Loading…
-
POST
/v1/logSearches/estimatedUsageByViewGets estimated usage details per view.Loading…
Metrics Searches (Beta) 4
-
DELETE
/v1/metricsSearches/{id}Deletes a metrics search.Loading…
-
GET
/v1/metricsSearches/{id}Get a metrics search.Loading…
-
POST
/v1/metricsSearchesSave a metrics search.Loading…
-
PUT
/v1/metricsSearches/{id}Updates a metrics search.Loading…
Permissions 3
-
GET
/v2/content/{id}/permissionsGet permissions of a content itemLoading…
-
PUT
/v2/content/{id}/permissions/addAdd permissions to a content item.Loading…
-
PUT
/v2/content/{id}/permissions/removeRemove permissions from a content item.Loading…
Threat Intel Datastore Management 3
-
DELETE
/v1/threatIntel/datastore/dbRemove the threat intel indicators DBLoading…
-
GET
/v1/threatIntel/datastore/dbGet threat intel indicators DB informationLoading…
-
PUT
/v1/threatIntel/datastore/dataSource/{dataSourceName}Updates source propertiesLoading…
Threat Intel Ingestion 3
-
DELETE
/v1/threatIntel/datastore/indicatorsRemoves indicators by their IDSLoading…
-
POST
/v1/threatIntel/datastore/indicators/normalizedUploads indicators in a Sumo normalized format.Loading…
-
POST
/v1/threatIntel/datastore/indicators/stixUploads indicators in a STIX 2.x json format.Loading…
Health Events 2
-
GET
/v1/healthEventsGet a list of health events.Loading…
-
POST
/v1/healthEvents/resourcesHealth events for specific resources.Loading…
Org Feature Settings 2
-
GET
/v1/featureSettingsGet a list of opt-in/out features.Loading…
-
PUT
/v1/featureSettingsUpdate one or more feature settings.Loading…
Password Policy 2
-
GET
/v1/passwordPolicyGet the current password policy.Loading…
-
PUT
/v1/passwordPolicyUpdate password policy.Loading…
Metrics Query 1
-
POST
/v1/metricsQueriesRun metrics queriesLoading…
Organizations Management 1
-
POST
/v1/organizations/usagesGet usages for child orgs.Loading…
Schema Base Management 1
-
GET
/v1/schemaIdentitiesGroupedGet schema base identities grouped by type and sorted by version.Loading…
Service Map 1
-
GET
/v1/tracing/serviceMapGet a service map.Loading…
No endpoint matches. Clear the filter to see all 441.
Change log
-
- −GET /v1/threatIntel/datastore/retentionPeriod
- −POST /v1/threatIntel/datastore/retentionPeriod
-
- +GET /v1/multi-account-management/content/sync
- +GET /v1/multi-account-management/content/sync/{jobId}/info
- +GET /v1/multi-account-management/content/sync/{jobId}/result
- +GET /v1/multi-account-management/content/sync/{jobId}/status
- +POST /v1/multi-account-management/content/sync
- +POST /v1/multi-account-management/content/sync/{jobId}/cancel
- +POST /v1/multi-account-management/content/sync/{jobId}/retry
-
- +DELETE /v2/search/jobs/{jobId}
- +GET /v2/search/jobs/{jobId}
- +GET /v2/search/jobs/{jobId}/messages
- +GET /v2/search/jobs/{jobId}/records
- +POST /v2/search/jobs
-
- +GET /v1/featureSettings
- +PUT /v1/featureSettings
-
- ⚠DELETE /v1/sourceTemplate/{id}
- ⚠GET /v1/sourceTemplate
- ⚠GET /v1/sourceTemplate/{id}
- ⚠POST /v1/sourceTemplate
- ⚠POST /v1/sourceTemplate/{id}
- ⚠POST /v1/upgrade/sourceTemplate/{id}
- ⚠PUT /v1/sourceTemplate/{id}/status
-
- +DELETE /v1/dataarchiving/destinations/{id}
- +GET /v1/dataarchiving/destinations
- +GET /v1/dataarchiving/destinations/{id}
- +POST /v1/dataarchiving/destinations
- +PUT /v1/dataarchiving/destinations/{id}