Skip to content

ofthomas76/sumologic-client

BranchesTags

Repository files navigation

sumologic-client

Getting Started

Welcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on the collector and search APIs see our API home page.

API Endpoints

Sumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment see API endpoints.

Deployment Endpoint
AU https://api.au.sumologic.com/api/
CA https://api.ca.sumologic.com/api/
DE https://api.de.sumologic.com/api/
EU https://api.eu.sumologic.com/api/
FED https://api.fed.sumologic.com/api/
IN https://api.in.sumologic.com/api/
JP https://api.jp.sumologic.com/api/
US1 https://api.sumologic.com/api/
US2 https://api.us2.sumologic.com/api/

Authentication

Sumo Logic supports the following options for API authentication:

  • Access ID and Access Key
  • Base64 encoded Access ID and Access Key

See Access Keys to generate an Access Key. Make sure to copy the key you create, because it is displayed only once. When you have an Access ID and Access Key you can execute requests such as the following:

curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users

Where deployment is either au, ca, de, eu, fed, in, jp, us1, or us2. See API endpoints for details.

If you prefer to use basic access authentication, you can do a Base64 encoding of your <accessId>:<accessKey> to authenticate your HTTPS request. The following is an example request, replace the placeholder <encoded> with your encoded Access ID and Access Key string:

curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users

Refer to API Authentication for a Base64 example.

Status Codes

Generic status codes that apply to all our APIs. See the HTTP status code registry for reference.

HTTP Status Code Error Code Description
301 moved The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/APIs/Troubleshooting-APIs/API-301-Error-Moved) for details.
401 unauthorized Credential could not be verified.
403 forbidden This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/APIs/Troubleshooting-APIs/API-403-Error-This-operation-is-not-allowed-for-your-account-type) for details.
404 notfound Requested resource could not be found.
405 method.unsupported Unsupported method for URL.
415 contenttype.invalid Invalid content type.
429 rate.limit.exceeded The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second.
500 internal.error Internal server error.
503 service.unavailable Service is currently unavailable.

Filtering

Some API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand & character.

For example, to get 20 users whose firstName is John and lastName is Doe:

api.sumologic.com/v1/users?limit=20&firstName=John&lastName=Doe

Sorting

Some API endpoints support sorting fields by using the sortBy query parameter. The default sort order is ascending. Prefix the field with a minus sign - to sort in descending order.

For example, to get 20 users sorted by their email in descending order:

api.sumologic.com/v1/users?limit=20&sort=-email

Asynchronous Request

Asynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.

  1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies your asynchronous job.

  2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous request will typically provide an endpoint to poll for the status of asynchronous job. A successful response from the status endpoint will have the following structure:

{
    \"status\": \"Status of asynchronous request\",
    \"statusMessage\": \"Optional message with additional information in case request succeeds\",
    \"error\": \"Error object in case request fails\"
}

The status field can have one of the following values: 1. Success: The job succeeded. The statusMessage field might have additional information. 2. InProgress: The job is still running. 3. Failed: The job failed. The error field in the response will have more information about the failure.

  1. Some asynchronous APIs may provide a third endpoint (like export result) to fetch the result of an asynchronous job.

Example

Let's say we want to export a folder with the identifier 0000000006A2E86F. We will use the async export API to export all the content under the folder with id=0000000006A2E86F.

  1. Start an export job for the folder
curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export

See authentication section for more details about accessId, accessKey, and deployment. On success, you will get back a job identifier. In the response below, C03E086C137F38B4 is the job identifier.

{
    \"id\": \"C03E086C137F38B4\"
}
  1. Now poll for the status of the asynchronous job with the status endpoint.
curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status

You may get a response like

{
    \"status\": \"InProgress\",
    \"statusMessage\": null,
    \"error\": null
}

It implies the job is still in progress. Keep polling till the status is either Success or Failed.

  1. When the asynchronous job completes (status != \"InProgress\"), you can fetch the results with the export result endpoint.
curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result

The asynchronous job may fail (status == \"Failed\"). You can look at the error field for more details.

{
    \"status\": \"Failed\",
    \"errors\": {
        \"code\": \"content1:too_many_items\",
        \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"
    }
}

Rate Limiting

  • A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.
  • A rate limit of 10 concurrent requests to any API endpoint applies to an access key.

If a rate is exceeded, a rate limit exceeded 429 status code is returned.

Generating Clients

You can use OpenAPI Generator to generate clients from the YAML file to access the API.

Using NPM

  1. Install NPM package wrapper globally, exposing the CLI on the command line:
npm install @openapitools/openapi-generator-cli -g

You can see detailed instructions here.

  1. Download the YAML file and save it locally. Let's say the file is saved as sumologic-api.yaml.
  2. Use the following command to generate python client inside the sumo/client/python directory:
openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python

Using Homebrew

  1. Install OpenAPI Generator
brew install openapi-generator
  1. Download the YAML file and save it locally. Let's say the file is saved as sumologic-api.yaml.
  2. Use the following command to generate python client side code inside the sumo/client/python directory:
openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/craigsands/sumologic-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/craigsands/sumologic-client.git)

Then import the package:

import sumologic_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import sumologic_client

Getting Started

Please follow the installation procedure and then run the following:

import time
import sumologic_client
from pprint import pprint
from sumologic_client.api import access_key_management_api
from sumologic_client.model.access_key import AccessKey
from sumologic_client.model.access_key_create_request import AccessKeyCreateRequest
from sumologic_client.model.access_key_public import AccessKeyPublic
from sumologic_client.model.access_key_update_request import AccessKeyUpdateRequest
from sumologic_client.model.error_response import ErrorResponse
from sumologic_client.model.list_access_keys_result import ListAccessKeysResult
from sumologic_client.model.paginated_list_access_keys_result import PaginatedListAccessKeysResult
# Defining the host is optional and defaults to https://api.au.sumologic.com/api
# See configuration.py for a list of all supported configuration parameters.
configuration = sumologic_client.Configuration(
    host = "https://api.au.sumologic.com/api"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = sumologic_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)


# Enter a context with an instance of the API client
with sumologic_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = access_key_management_api.AccessKeyManagementApi(api_client)
    access_key_create_request = AccessKeyCreateRequest(
        label="automation access key",
        cors_headers=["https://my-app.com","https://mail.my-app.com"],
    ) # AccessKeyCreateRequest | 

    try:
        # Create an access key.
        api_response = api_instance.create_access_key(access_key_create_request)
        pprint(api_response)
    except sumologic_client.ApiException as e:
        print("Exception when calling AccessKeyManagementApi->create_access_key: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.au.sumologic.com/api

Class Method HTTP request Description
AccessKeyManagementApi create_access_key POST /v1/accessKeys Create an access key.
AccessKeyManagementApi delete_access_key DELETE /v1/accessKeys/{id} Delete an access key.
AccessKeyManagementApi list_access_keys GET /v1/accessKeys List all access keys.
AccessKeyManagementApi list_personal_access_keys GET /v1/accessKeys/personal List personal keys.
AccessKeyManagementApi update_access_key PUT /v1/accessKeys/{id} Update an access key.
AccountManagementApi create_subdomain POST /v1/account/subdomain Create account subdomain.
AccountManagementApi delete_subdomain DELETE /v1/account/subdomain Delete the configured subdomain.
AccountManagementApi get_account_owner GET /v1/account/accountOwner Get the owner of an account.
AccountManagementApi get_status GET /v1/account/status Get overview of the account status.
AccountManagementApi get_subdomain GET /v1/account/subdomain Get the configured subdomain.
AccountManagementApi recover_subdomains POST /v1/account/subdomain/recover Recover subdomains for a user.
AccountManagementApi update_subdomain PUT /v1/account/subdomain Update account subdomain.
AppManagementApi get_app GET /v1/apps/{uuid} Get an app by UUID.
AppManagementApi get_async_install_status GET /v1/apps/install/{jobId}/status App install job status.
AppManagementApi install_app POST /v1/apps/{uuid}/install Install an app by UUID.
AppManagementApi list_apps GET /v1/apps List available apps.
ArchiveManagementApi create_archive_job POST /v1/archive/{sourceId}/jobs Create an ingestion job.
ArchiveManagementApi delete_archive_job DELETE /v1/archive/{sourceId}/jobs/{id} Delete an ingestion job.
ArchiveManagementApi list_archive_jobs_by_source_id GET /v1/archive/{sourceId}/jobs Get ingestion jobs for an Archive Source.
ArchiveManagementApi list_archive_jobs_count_per_source GET /v1/archive/jobs/count List ingestion jobs for all Archive Sources.
ConnectionManagementApi create_connection POST /v1/connections Create a new connection.
ConnectionManagementApi delete_connection DELETE /v1/connections/{id} Delete a connection.
ConnectionManagementApi get_connection GET /v1/connections/{id} Get a connection.
ConnectionManagementApi list_connections GET /v1/connections Get a list of connections.
ConnectionManagementApi test_connection POST /v1/connections/test Test a new connection url.
ConnectionManagementApi update_connection PUT /v1/connections/{id} Update a connection.
ContentManagementApi async_copy_status GET /v2/content/{id}/copy/{jobId}/status Content copy job status.
ContentManagementApi begin_async_copy POST /v2/content/{id}/copy Start a content copy job.
ContentManagementApi begin_async_delete DELETE /v2/content/{id}/delete Start a content deletion job.
ContentManagementApi begin_async_export POST /v2/content/{id}/export Start a content export job.
ContentManagementApi begin_async_import POST /v2/content/folders/{folderId}/import Start a content import job.
ContentManagementApi get_async_delete_status GET /v2/content/{id}/delete/{jobId}/status Content deletion job status.
ContentManagementApi get_async_export_result GET /v2/content/{contentId}/export/{jobId}/result Content export job result.
ContentManagementApi get_async_export_status GET /v2/content/{contentId}/export/{jobId}/status Content export job status.
ContentManagementApi get_async_import_status GET /v2/content/folders/{folderId}/import/{jobId}/status Content import job status.
ContentManagementApi get_item_by_path GET /v2/content/path Get content item by path.
ContentManagementApi get_path_by_id GET /v2/content/{contentId}/path Get path of an item.
ContentManagementApi move_item POST /v2/content/{id}/move Move an item.
ContentPermissionsApi add_content_permissions PUT /v2/content/{id}/permissions/add Add permissions to a content item.
ContentPermissionsApi get_content_permissions GET /v2/content/{id}/permissions Get permissions of a content item
ContentPermissionsApi remove_content_permissions PUT /v2/content/{id}/permissions/remove Remove permissions from a content item.
DashboardManagementApi create_dashboard POST /v2/dashboards Create a new dashboard.
DashboardManagementApi delete_dashboard DELETE /v2/dashboards/{id} Delete a dashboard.
DashboardManagementApi generate_dashboard_report POST /v2/dashboards/reportJobs Start a report job
DashboardManagementApi get_async_report_generation_result GET /v2/dashboards/reportJobs/{jobId}/result Get report generation job result
DashboardManagementApi get_async_report_generation_status GET /v2/dashboards/reportJobs/{jobId}/status Get report generation job status
DashboardManagementApi get_dashboard GET /v2/dashboards/{id} Get a dashboard.
DashboardManagementApi update_dashboard PUT /v2/dashboards/{id} Update a dashboard.
DynamicParsingRuleManagementApi create_dynamic_parsing_rule POST /v1/dynamicParsingRules Create a new dynamic parsing rule.
DynamicParsingRuleManagementApi delete_dynamic_parsing_rule DELETE /v1/dynamicParsingRules/{id} Delete a dynamic parsing rule.
DynamicParsingRuleManagementApi get_dynamic_parsing_rule GET /v1/dynamicParsingRules/{id} Get a dynamic parsing rule.
DynamicParsingRuleManagementApi list_dynamic_parsing_rules GET /v1/dynamicParsingRules Get a list of dynamic parsing rules.
DynamicParsingRuleManagementApi update_dynamic_parsing_rule PUT /v1/dynamicParsingRules/{id} Update a dynamic parsing rule.
ExtractionRuleManagementApi create_extraction_rule POST /v1/extractionRules Create a new field extraction rule.
ExtractionRuleManagementApi delete_extraction_rule DELETE /v1/extractionRules/{id} Delete a field extraction rule.
ExtractionRuleManagementApi get_extraction_rule GET /v1/extractionRules/{id} Get a field extraction rule.
ExtractionRuleManagementApi list_extraction_rules GET /v1/extractionRules Get a list of field extraction rules.
ExtractionRuleManagementApi update_extraction_rule PUT /v1/extractionRules/{id} Update a field extraction rule.
FieldManagementV1Api create_field POST /v1/fields Create a new field.
FieldManagementV1Api delete_field DELETE /v1/fields/{id} Delete a custom field.
FieldManagementV1Api disable_field DELETE /v1/fields/{id}/disable Disable a custom field.
FieldManagementV1Api enable_field PUT /v1/fields/{id}/enable Enable custom field with a specified identifier.
FieldManagementV1Api get_built_in_field GET /v1/fields/builtin/{id} Get a built-in field.
FieldManagementV1Api get_custom_field GET /v1/fields/{id} Get a custom field.
FieldManagementV1Api get_field_quota GET /v1/fields/quota Get capacity information.
FieldManagementV1Api list_built_in_fields GET /v1/fields/builtin Get a list of built-in fields.
FieldManagementV1Api list_custom_fields GET /v1/fields Get a list of all custom fields.
FieldManagementV1Api list_dropped_fields GET /v1/fields/dropped Get a list of dropped fields.
FolderManagementApi create_folder POST /v2/content/folders Create a new folder.
FolderManagementApi get_admin_recommended_folder_async GET /v2/content/folders/adminRecommended Schedule Admin Recommended folder job
FolderManagementApi get_admin_recommended_folder_async_result GET /v2/content/folders/adminRecommended/{jobId}/result Get Admin Recommended folder job result
FolderManagementApi get_admin_recommended_folder_async_status GET /v2/content/folders/adminRecommended/{jobId}/status Get Admin Recommended folder job status
FolderManagementApi get_folder GET /v2/content/folders/{id} Get a folder.
FolderManagementApi get_global_folder_async GET /v2/content/folders/global Schedule Global View job
FolderManagementApi get_global_folder_async_result GET /v2/content/folders/global/{jobId}/result Get Global View job result
FolderManagementApi get_global_folder_async_status GET /v2/content/folders/global/{jobId}/status Get Global View job status
FolderManagementApi get_personal_folder GET /v2/content/folders/personal Get personal folder.
FolderManagementApi update_folder PUT /v2/content/folders/{id} Update a folder.
HealthEventsApi list_all_health_events GET /v1/healthEvents Get a list of health events.
HealthEventsApi list_all_health_events_for_resources POST /v1/healthEvents/resources Health events for specific resources.
IngestBudgetManagementV1Api assign_collector_to_budget PUT /v1/ingestBudgets/{id}/collectors/{collectorId} Assign a Collector to a budget.
IngestBudgetManagementV1Api create_ingest_budget POST /v1/ingestBudgets Create a new ingest budget.
IngestBudgetManagementV1Api delete_ingest_budget DELETE /v1/ingestBudgets/{id} Delete an ingest budget.
IngestBudgetManagementV1Api get_assigned_collectors GET /v1/ingestBudgets/{id}/collectors Get a list of Collectors.
IngestBudgetManagementV1Api get_ingest_budget GET /v1/ingestBudgets/{id} Get an ingest budget.
IngestBudgetManagementV1Api list_ingest_budgets GET /v1/ingestBudgets Get a list of ingest budgets.
IngestBudgetManagementV1Api remove_collector_from_budget DELETE /v1/ingestBudgets/{id}/collectors/{collectorId} Remove Collector from a budget.
IngestBudgetManagementV1Api reset_usage POST /v1/ingestBudgets/{id}/usage/reset Reset usage.
IngestBudgetManagementV1Api update_ingest_budget PUT /v1/ingestBudgets/{id} Update an ingest budget.
IngestBudgetManagementV2Api create_ingest_budget_v2 POST /v2/ingestBudgets Create a new ingest budget.
IngestBudgetManagementV2Api delete_ingest_budget_v2 DELETE /v2/ingestBudgets/{id} Delete an ingest budget.
IngestBudgetManagementV2Api get_ingest_budget_v2 GET /v2/ingestBudgets/{id} Get an ingest budget.
IngestBudgetManagementV2Api list_ingest_budgets_v2 GET /v2/ingestBudgets Get a list of ingest budgets.
IngestBudgetManagementV2Api reset_usage_v2 POST /v2/ingestBudgets/{id}/usage/reset Reset usage.
IngestBudgetManagementV2Api update_ingest_budget_v2 PUT /v2/ingestBudgets/{id} Update an ingest budget.
LogSearchesEstimatedUsageApi get_log_search_estimated_usage POST /v1/logSearches/estimatedUsage Gets estimated usage details.
LogSearchesEstimatedUsageApi get_log_search_estimated_usage_by_tier POST /v1/logSearches/estimatedUsageByTier Gets Tier Wise estimated usage details.
LookupManagementApi create_table POST /v1/lookupTables Create a lookup table.
LookupManagementApi delete_table DELETE /v1/lookupTables/{id} Delete a lookup table.
LookupManagementApi delete_table_row PUT /v1/lookupTables/{id}/deleteTableRow Delete a lookup table row.
LookupManagementApi lookup_table_by_id GET /v1/lookupTables/{id} Get a lookup table.
LookupManagementApi request_job_status GET /v1/lookupTables/jobs/{jobId}/status Get the status of an async job.
LookupManagementApi truncate_table POST /v1/lookupTables/{id}/truncate Empty a lookup table.
LookupManagementApi update_table PUT /v1/lookupTables/{id} Edit a lookup table.
LookupManagementApi update_table_row PUT /v1/lookupTables/{id}/row Insert or Update a lookup table row.
LookupManagementApi upload_file POST /v1/lookupTables/{id}/upload Upload a CSV file.
MetricsQueryApi run_metrics_queries POST /v1/metricsQueries Run metrics queries
MetricsSearchesManagementApi create_metrics_search POST /v1/metricsSearches Save a metrics search.
MetricsSearchesManagementApi delete_metrics_search DELETE /v1/metricsSearches/{id} Deletes a metrics search.
MetricsSearchesManagementApi get_metrics_search GET /v1/metricsSearches/{id} Get a metrics search.
MetricsSearchesManagementApi update_metrics_search PUT /v1/metricsSearches/{id} Updates a metrics search.
MonitorsLibraryManagementApi disable_monitor_by_ids PUT /v1/monitors/disable Disable monitors.
MonitorsLibraryManagementApi get_monitor_usage_info GET /v1/monitors/usageInfo Usage info of monitors.
MonitorsLibraryManagementApi get_monitors_full_path GET /v1/monitors/{id}/path Get the path of a monitor or folder.
MonitorsLibraryManagementApi get_monitors_library_root GET /v1/monitors/root Get the root monitors folder.
MonitorsLibraryManagementApi monitors_copy POST /v1/monitors/{id}/copy Copy a monitor or folder.
MonitorsLibraryManagementApi monitors_create POST /v1/monitors Create a monitor or folder.
MonitorsLibraryManagementApi monitors_delete_by_id DELETE /v1/monitors/{id} Delete a monitor or folder.
MonitorsLibraryManagementApi monitors_delete_by_ids DELETE /v1/monitors Bulk delete a monitor or folder.
MonitorsLibraryManagementApi monitors_export_item GET /v1/monitors/{id}/export Export a monitor or folder.
MonitorsLibraryManagementApi monitors_get_by_path GET /v1/monitors/path Read a monitor or folder by its path.
MonitorsLibraryManagementApi monitors_import_item POST /v1/monitors/{parentId}/import Import a monitor or folder.
MonitorsLibraryManagementApi monitors_move POST /v1/monitors/{id}/move Move a monitor or folder.
MonitorsLibraryManagementApi monitors_read_by_id GET /v1/monitors/{id} Get a monitor or folder.
MonitorsLibraryManagementApi monitors_read_by_ids GET /v1/monitors Bulk read a monitor or folder.
MonitorsLibraryManagementApi monitors_search GET /v1/monitors/search Search for a monitor or folder.
MonitorsLibraryManagementApi monitors_update_by_id PUT /v1/monitors/{id} Update a monitor or folder.
PartitionManagementApi cancel_retention_update POST /v1/partitions/{id}/cancelRetentionUpdate Cancel a retention update for a partition
PartitionManagementApi create_partition POST /v1/partitions Create a new partition.
PartitionManagementApi decommission_partition POST /v1/partitions/{id}/decommission Decommission a partition.
PartitionManagementApi get_partition GET /v1/partitions/{id} Get a partition.
PartitionManagementApi list_partitions GET /v1/partitions Get a list of partitions.
PartitionManagementApi update_partition PUT /v1/partitions/{id} Update a partition.
PasswordPolicyApi get_password_policy GET /v1/passwordPolicy Get the current password policy.
PasswordPolicyApi set_password_policy PUT /v1/passwordPolicy Update password policy.
PoliciesManagementApi get_audit_policy GET /v1/policies/audit Get Audit policy.
PoliciesManagementApi get_data_access_level_policy GET /v1/policies/dataAccessLevel Get Data Access Level policy.
PoliciesManagementApi get_max_user_session_timeout_policy GET /v1/policies/maxUserSessionTimeout Get Max User Session Timeout policy.
PoliciesManagementApi get_search_audit_policy GET /v1/policies/searchAudit Get Search Audit policy.
PoliciesManagementApi get_share_dashboards_outside_organization_policy GET /v1/policies/shareDashboardsOutsideOrganization Get Share Dashboards Outside Organization policy.
PoliciesManagementApi get_user_concurrent_sessions_limit_policy GET /v1/policies/userConcurrentSessionsLimit Get User Concurrent Sessions Limit policy.
PoliciesManagementApi set_audit_policy PUT /v1/policies/audit Set Audit policy.
PoliciesManagementApi set_data_access_level_policy PUT /v1/policies/dataAccessLevel Set Data Access Level policy.
PoliciesManagementApi set_max_user_session_timeout_policy PUT /v1/policies/maxUserSessionTimeout Set Max User Session Timeout policy.
PoliciesManagementApi set_search_audit_policy PUT /v1/policies/searchAudit Set Search Audit policy.
PoliciesManagementApi set_share_dashboards_outside_organization_policy PUT /v1/policies/shareDashboardsOutsideOrganization Set Share Dashboards Outside Organization policy.
PoliciesManagementApi set_user_concurrent_sessions_limit_policy PUT /v1/policies/userConcurrentSessionsLimit Set User Concurrent Sessions Limit policy.
RoleManagementApi assign_role_to_user PUT /v1/roles/{roleId}/users/{userId} Assign a role to a user.
RoleManagementApi create_role POST /v1/roles Create a new role.
RoleManagementApi delete_role DELETE /v1/roles/{id} Delete a role.
RoleManagementApi get_role GET /v1/roles/{id} Get a role.
RoleManagementApi list_roles GET /v1/roles Get a list of roles.
RoleManagementApi remove_role_from_user DELETE /v1/roles/{roleId}/users/{userId} Remove role from a user.
RoleManagementApi update_role PUT /v1/roles/{id} Update a role.
SamlConfigurationManagementApi create_allowlisted_user POST /v1/saml/allowlistedUsers/{userId} Allowlist a user.
SamlConfigurationManagementApi create_identity_provider POST /v1/saml/identityProviders Create a new SAML configuration.
SamlConfigurationManagementApi delete_allowlisted_user DELETE /v1/saml/allowlistedUsers/{userId} Remove an allowlisted user.
SamlConfigurationManagementApi delete_identity_provider DELETE /v1/saml/identityProviders/{id} Delete a SAML configuration.
SamlConfigurationManagementApi disable_saml_lockdown POST /v1/saml/lockdown/disable Disable SAML lockdown.
SamlConfigurationManagementApi enable_saml_lockdown POST /v1/saml/lockdown/enable Require SAML for sign-in.
SamlConfigurationManagementApi get_allowlisted_users GET /v1/saml/allowlistedUsers Get list of allowlisted users.
SamlConfigurationManagementApi get_identity_providers GET /v1/saml/identityProviders Get a list of SAML configurations.
SamlConfigurationManagementApi update_identity_provider PUT /v1/saml/identityProviders/{id} Update a SAML configuration.
ScheduledViewManagementApi create_scheduled_view POST /v1/scheduledViews Create a new scheduled view.
ScheduledViewManagementApi disable_scheduled_view DELETE /v1/scheduledViews/{id}/disable Disable a scheduled view.
ScheduledViewManagementApi get_scheduled_view GET /v1/scheduledViews/{id} Get a scheduled view.
ScheduledViewManagementApi list_scheduled_views GET /v1/scheduledViews Get a list of scheduled views.
ScheduledViewManagementApi pause_scheduled_view POST /v1/scheduledViews/{id}/pause Pause a scheduled view.
ScheduledViewManagementApi start_scheduled_view POST /v1/scheduledViews/{id}/start Start a scheduled view.
ScheduledViewManagementApi update_scheduled_view PUT /v1/scheduledViews/{id} Update a scheduled view.
ServiceAllowlistManagementApi add_allowlisted_cidrs POST /v1/serviceAllowlist/addresses/add Allowlist CIDRs/IP addresses.
ServiceAllowlistManagementApi delete_allowlisted_cidrs POST /v1/serviceAllowlist/addresses/remove Remove allowlisted CIDRs/IP addresses.
ServiceAllowlistManagementApi disable_allowlisting POST /v1/serviceAllowlist/disable Disable service allowlisting.
ServiceAllowlistManagementApi enable_allowlisting POST /v1/serviceAllowlist/enable Enable service allowlisting.
ServiceAllowlistManagementApi get_allowlisting_status GET /v1/serviceAllowlist/status Get the allowlisting status.
ServiceAllowlistManagementApi list_allowlisted_cidrs GET /v1/serviceAllowlist/addresses List all allowlisted CIDRs/IP addresses.
TokensLibraryManagementApi create_token POST /v1/tokens Create a token.
TokensLibraryManagementApi delete_token DELETE /v1/tokens/{id} Delete a token.
TokensLibraryManagementApi get_token GET /v1/tokens/{id} Get a token.
TokensLibraryManagementApi list_tokens GET /v1/tokens Get a list of tokens.
TokensLibraryManagementApi update_token PUT /v1/tokens/{id} Update a token.
TransformationRuleManagementApi create_rule POST /v1/transformationRules Create a new transformation rule.
TransformationRuleManagementApi delete_rule DELETE /v1/transformationRules/{id} Delete a transformation rule.
TransformationRuleManagementApi get_transformation_rule GET /v1/transformationRules/{id} Get a transformation rule.
TransformationRuleManagementApi get_transformation_rules GET /v1/transformationRules Get a list of transformation rules.
TransformationRuleManagementApi update_transformation_rule PUT /v1/transformationRules/{id} Update a transformation rule.
UserManagementApi create_user POST /v1/users Create a new user.
UserManagementApi delete_user DELETE /v1/users/{id} Delete a user.
UserManagementApi disable_mfa PUT /v1/users/{id}/mfa/disable Disable MFA for user.
UserManagementApi get_user GET /v1/users/{id} Get a user.
UserManagementApi list_users GET /v1/users Get a list of users.
UserManagementApi request_change_email POST /v1/users/{id}/email/requestChange Change email address.
UserManagementApi reset_password POST /v1/users/{id}/password/reset Reset password.
UserManagementApi unlock_user POST /v1/users/{id}/unlock Unlock a user.
UserManagementApi update_user PUT /v1/users/{id} Update a user.

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in sumologic_client.apis and sumologic_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from sumologic_client.api.default_api import DefaultApi
  • from sumologic_client.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import sumologic_client
from sumologic_client.apis import *
from sumologic_client.models import *

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages