Access Key management API. Access Keys allow you to securely register new Collectors and access Sumo Logic APIs. For more information, see [Access Keys](https://help.sumologic.com/?cid=6690).
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo 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](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf 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:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> 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/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome 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.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome 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.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous 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.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: accessKeyManagement
description: 'Access Key management API.
Access Keys allow you to securely register new Collectors and access Sumo Logic APIs. For more information, see [Access Keys](https://help.sumologic.com/?cid=6690).
'
x-displayName: Access Keys
paths:
/v1/accessKeys:
get:
tags:
- accessKeyManagement
summary: List All Access Keys.
description: List all access keys in your account.
operationId: listAccessKeys
parameters:
- name: limit
in: query
description: Limit the number of access keys returned in the response. The number of access keys returned may be less than the `limit`.
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 100
- name: token
in: query
description: Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left.
required: false
schema:
type: string
responses:
'200':
description: A list of all access keys in your account.
content:
application/json:
schema:
$ref: '#/components/schemas/PaginatedListAccessKeysResult'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- accessKeyManagement
summary: Create An Access Key.
description: "Creates a new access ID and key pair. The new access key can be used from the domains specified in corsHeaders field. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:\n 1. Requests with an ORIGIN header but the allowlist is empty.\n 2. Requests with an ORIGIN header that don't match any entry in the allowlist."
operationId: createAccessKey
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccessKeyCreateRequest'
required: true
responses:
'200':
description: Access key created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AccessKey'
default:
description: Access key creation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/accessKeys/personal:
get:
tags:
- accessKeyManagement
summary: List Personal Keys.
description: List all access keys that belong to your user.
operationId: listPersonalAccessKeys
responses:
'200':
description: A list of all access keys that belong to the user making the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccessKeysResult'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/accessKeys/scopes:
get:
tags:
- accessKeyManagement
summary: Get All Scopes.
description: Get a list of all of the scopes that can be added to an access key.
operationId: listScopes
responses:
'200':
description: A list of scopes that can be added to an access key.
content:
application/json:
schema:
$ref: '#/components/schemas/ScopesList'
default:
description: Operation failed with an error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/accessKeys/{id}:
put:
tags:
- accessKeyManagement
summary: Update An Access Key.
description: Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list.
operationId: updateAccessKey
parameters:
- name: id
in: path
description: The accessId of the access key to update.
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccessKeyUpdateRequest'
required: true
responses:
'200':
description: Access key updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AccessKeyPublic'
default:
description: Access key update failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- accessKeyManagement
summary: Delete An Access Key.
description: Deletes the access key with the given accessId.
operationId: deleteAccessKey
parameters:
- name: id
in: path
description: The accessId of the access key to delete.
required: true
schema:
type: string
responses:
'204':
description: Access key deletion completed successfully.
default:
description: Access key deletion failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/accessKeys/{id}/rotate:
put:
tags:
- accessKeyManagement
summary: Rotate The Access Key Secret
description: Generates a new secret for the access key that is passed in the call, keeping the same access ID.
operationId: rotateAccessKeySecret
parameters:
- name: id
in: path
description: The accessId of the access key to rotate the secret for.
required: true
schema:
type: string
responses:
'200':
description: Access key secret rotated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/AccessKey'
default:
description: Access key secret rotation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
ScopeDefinition:
required:
- dependsOn
- group
- id
- label
- type
type: object
properties:
id:
type: string
description: The name of the scope.
example: managePartitions
label:
type: string
description: The UI label for the scope.
example: Manage Partitions
type:
type: string
description: Type of scope.
example: Manage
dependsOn:
type: array
description: Any scopes that are required for this scope to be enabled.
example:
- viewPartitions
items:
type: string
group:
required:
- id
- label
type: object
properties:
id:
type: string
description: The name of the scope group
example: dataManagement
label:
type: string
description: The label for the scope group
example: Data Management
parentId:
type: string
description: The ID of the parent scope group
description: The group that the scope belongs to.
ScopesList:
required:
- data
type: object
properties:
data:
type: array
description: List of scopes
items:
$ref: '#/components/schemas/ScopeDefinition'
AccessKeyUpdateRequest:
required:
- disabled
type: object
properties:
disabled:
type: boolean
description: Indicates whether the access key is disabled or not.
example: true
corsHeaders:
maxItems: 20
type: array
description: "An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:\n 1. Requests with an ORIGIN header but the allowlist is empty.\n 2. Requests with an ORIGIN header that don't match any entry in the allowlist."
example:
- https://my-app.com
- https://mail.my-app.com
items:
type: string
scopes:
type: array
description: "Scopes assigned to the key. <br><br> Note: Updates to scopes will take up to 5m to reflect due to caching in the system.\n### Alerting\n - adminMonitorsV2\n - viewMonitorsV2\n - manageMonitorsV2\n\n### Data Management\n - manageApps\n - viewCollectors\n - manageCollectors\n - viewConnections\n - manageConnections\n - contentAdmin\n - viewFieldExtractionRules\n - manageFieldExtractionRules \n - viewFields\n - manageFields\n - manageBudgets\n - viewLibrary\n - manageLibrary\n - viewPartitions\n - managePartitions\n - manageS3DataForwarding\n - viewScheduledViews\n - manageScheduledViews\n - manageTokens\n\n### Logs\n - runLogSearch\n\n### Metrics\n - runMetricsQuery \n\n### Reliability Management\n - viewSlos\n - manageSlos\n\n### Security\n - manageAccessKeys\n - viewPersonalAccessKeys\n - managePersonalAccessKeys\n\n### UserManagement\n - viewUsersAndRoles\n - manageUsersAndRoles"
example:
- manageUsersAndRoles
- viewCollectors
items:
type: string
AccessKey:
allOf:
- $ref: '#/components/schemas/AccessKeyPublic'
- required:
- key
type: object
properties:
key:
type: string
description: The key for the created access key. This field will have values only in the response for an access key create request. The value will be an empty string while listing all keys.
example: F9GZvb4fISxUZHM7pqHCsGXGWf4OArgmt9Tz8ewZ
AccessKeyPublic:
required:
- createdAt
- createdBy
- disabled
- id
- label
- modifiedAt
- modifiedBy
type: object
properties:
id:
type: string
description: Identifier of the access key.
example: su0w3Q37CBzHUM
label:
type: string
description: The name of the access key.
example: collector access key
corsHeaders:
type: array
description: "An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:\n 1. Requests with an ORIGIN header but the allowlist is empty.\n 2. Requests with an ORIGIN header that don't match any entry in the allowlist."
example:
- https://my-app.com
- https://mail.my-app.com
items:
type: string
disabled:
type: boolean
description: Indicates whether the access key is disabled or not.
example: false
createdAt:
type: string
description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
example: 2018-10-16 09:10:00+00:00
createdBy:
type: string
description: Identifier of the user who created the access key.
example: 0000000006743FDD
modifiedAt:
type: string
description: Last modification timestamp in UTC.
format: date-time
example: 2018-10-16 09:10:00+00:00
modifiedBy:
type: string
description: Identifier of the user who modified the access key.
example: 0000000006743FDD
serviceAccountId:
type: string
description: Identifier of the service account who owns the access key.
example: 0000000006743FDA
lastUsed:
type: string
description: Last used timestamp in UTC. <br> **Note:** Property not in use, it is part of an upcoming feature.
format: date-time
example: 2018-10-16 09:10:00+00:00
scopes:
type: array
description: "Scopes assigned to the key.\n### Alerting\n - adminMonitorsV2\n - viewMonitorsV2\n - manageMonitorsV2\n\n### Data Management\n - manageApps\n - viewCollectors\n - manageCollectors\n - viewConnections\n - manageConnections\n - contentAdmin\n - viewFieldExtractionRules\n - manageFieldExtractionRules \n - viewFields\n - manageFields\n - manageBudgets\n - viewLibrary\n - manageLibrary\n - viewPartitions\n - managePartitions \n - manageS3DataForwarding\n - viewScheduledViews\n - manageScheduledViews\n - manageTokens\n\n### Logs\n - runLogSearch\n\n### Metrics\n - runMetricsQuery \n\n### Reliability Management\n - viewSlos\n - manageSlos\n\n### Security\n - manageAccessKeys\n - viewPersonalAccessKeys\n - managePersonalAccessKeys\n\n### UserManagement\n - viewUsersAndRoles\n - manageUsersAndRoles"
example:
- manageUsersAndRoles
- viewCollectors
items:
type: string
effectiveScopes:
type: array
description: Effective scopes based on the intersection of the user's RBAC capabilities and the assigned scopes.
example:
- manageUsersAndRoles
- viewCollectors
items:
type: string
PaginatedListAccessKeysResult:
required:
- data
type: object
properties:
data:
type: array
description: An array of access keys.
items:
$ref: '#/components/schemas/AccessKeyPublic'
next:
type: string
description: Next continuation token.
example: GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc
description: List of access keys.
ListAccessKeysResult:
required:
- data
type: object
properties:
data:
type: array
description: An array of access keys.
items:
$ref: '#/components/schemas/AccessKeyPublic'
description: List of access keys.
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
AccessKeyCreateRequest:
required:
- label
type: object
properties:
label:
maxLength: 128
type: string
description: A name for the access key to be created.
example: automation access key
corsHeaders:
maxItems: 20
type: array
description: "An array of domains for which the access key is valid. Whether Sumo Logic accepts or rejects an API request\ndepends on whether it contains an ORIGIN header and the entries in the allowlist.\nSumo Logic will reject:\n 1. Requests with an ORIGIN header but the allowlist is empty.\n 2. Requests with an ORIGIN header that don't match any entry in the allowlist."
example:
- https://my-app.com
- https://mail.my-app.com
items:
type: string
scopes:
type: array
description: "Scopes assigned to the key.\n### Alerting\n - adminMonitorsV2\n - viewMonitorsV2\n - manageMonitorsV2\n\n### Data Management\n - manageApps\n - viewCollectors\n - manageCollectors\n - viewConnections\n - manageConnections\n - contentAdmin\n - viewFieldExtractionRules\n - manageFieldExtractionRules \n - viewFields\n - manageFields\n - manageBudgets\n - viewLibrary\n - manageLibrary\n - viewPartitions\n - managePartitions\n - manageS3DataForwarding\n - viewScheduledViews\n - manageScheduledViews\n - manageTokens\n\n### Logs\n - runLogSearch\n\n### Metrics\n - runMetricsQuery \n\n### Reliability Management\n - viewSlos\n - manageSlos\n\n### Security\n - manageAccessKeys\n - viewPersonalAccessKeys\n - managePersonalAccessKeys\n\n### UserManagement\n - viewUsersAndRoles\n - manageUsersAndRoles"
example:
- manageUsersAndRoles
- viewCollectors
items:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
- logSearchesManagement
- parsersLibraryManagement
- name: Metrics
tags:
- metricsSearchesManagement
- transformationRuleManagement
- metricsQuery
- metricsSearchesManagementV2
- name: Security Management
tags:
- accessKeyManagement
- oauthManagement
- accountManagement
- passwordPolicy
- policiesManagement
- samlConfigurationManagement
- serviceAllowlistManagement
- serviceAccountManagement
- scimUserManagement
- name: Organizations Management
tags:
- orgsManagement
- name: Settings Management
tags:
- connectionManagement
- dynamicParsingRuleManagement
- extractionRuleManagement
- fieldManagementV1
- partitionManagement
- scheduledViewManagement
- logsDataForwardingManagement
- dataDeletionRules
- name: Tokens Management
tags:
- tokensLibraryManagement
- name: Tracing
tags:
- traces
- spanAnalytics
- serviceMap
- name: Users and Roles Management
tags:
- roleManagement
- roleManagementV2
- userManagement
- name: Threat Intel Ingest Management
tags:
- threatIntelIngest
- threatIntelIngestProducer
- name: OpenTelemetry Collector Management
tags:
- otCollectorManagementExternal
- name: Source Template Management
tags:
- sourceTemplateManagementExternal
- name: Schema Base Management
tags:
- schemaBaseManagement
- name: Event Analytics Management
tags:
- eventAnalytics
- name: Budget Management
tags:
- budgetManagement
- name: Macro Management
tags:
- macroManagement
- name: Muting Schedules Management
tags:
- mutingSchedulesLibraryManagement
- name: SLO Management
tags:
- slosLibraryManagement
- name: Monitor Management
tags:
- monitorsLibraryManagement