openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement fieldManagementV1 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: fieldManagementV1
description: 'Field management API.
Fields allow you to reference log data based on meaningful associations. They act as metadata tags that are assigned to your logs so you can search with them. Each field contains a key-value pair, where the field name is the key. Fields may be referred to as Log Metadata Fields. For more information, see [Fields](https://help.sumologic.com/?cid=10116).
'
x-displayName: Field Management
paths:
/v1/fields:
get:
tags:
- fieldManagementV1
summary: Get A List Of All Custom Fields.
description: Request a list of all the custom fields configured in your account.
operationId: listCustomFields
responses:
'200':
description: List of all custom fields.
content:
application/json:
schema:
$ref: '#/components/schemas/ListCustomFieldsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- fieldManagementV1
summary: Create A New Field.
description: Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs.
operationId: createField
parameters: []
requestBody:
description: Name of a field to add. The name is used as the key in the key-value pair.
content:
application/json:
schema:
$ref: '#/components/schemas/FieldName'
required: true
responses:
'200':
description: The field was created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/{id}:
get:
tags:
- fieldManagementV1
summary: Get A Custom Field.
description: Get the details of a custom field.
operationId: getCustomField
parameters:
- name: id
in: path
description: Identifier of a field.
required: true
schema:
type: string
example: 00000000031D02DA
responses:
'200':
description: The details of the custom field.
content:
application/json:
schema:
$ref: '#/components/schemas/CustomField'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- fieldManagementV1
summary: Delete A Custom Field.
description: Deleting a field does not delete historical data assigned with that field. If you delete a field by mistake and one or more of those dependencies break, you can re-add the field to get things working properly again. You should always disable a field and ensure things are behaving as expected before deleting a field.
operationId: deleteField
parameters:
- name: id
in: path
description: Identifier of a field to delete.
required: true
schema:
type: string
example: 00000000031D02DA
responses:
'204':
description: The field was successfully deleted.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/{id}/enable:
put:
tags:
- fieldManagementV1
summary: Enable Custom Field With A Specified Identifier.
description: Fields have to be enabled to be assigned to your data. This operation ensures that a specified field is enabled and Sumo Logic will treat it as safe to process. All manually created custom fields are enabled by default.
operationId: enableField
parameters:
- name: id
in: path
description: Identifier of a field to enable.
required: true
schema:
type: string
example: 00000000031D02DA
responses:
'204':
description: Field has been enabled.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/{id}/disable:
delete:
tags:
- fieldManagementV1
summary: Disable A Custom Field.
description: After disabling a field Sumo Logic will start dropping its incoming values at ingest. As a result, they won't be searchable or usable. Historical values are not removed and remain searchable.
operationId: disableField
parameters:
- name: id
in: path
description: Identifier of a field to disable.
required: true
schema:
type: string
example: 00000000031D02DA
responses:
'204':
description: Field has been disabled.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/dropped:
get:
tags:
- fieldManagementV1
summary: Get A List Of Dropped Fields.
description: Dropped fields are fields sent to Sumo Logic, but are ignored since they are not defined in your Fields schema. In order to save these values a field must both exist and be enabled.
operationId: listDroppedFields
responses:
'200':
description: 'List of dropped fields.
'
content:
application/json:
schema:
$ref: '#/components/schemas/ListDroppedFieldsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/builtin:
get:
tags:
- fieldManagementV1
summary: Get A List Of Built-in Fields.
description: Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include `_sourceHost` and `_sourceCategory`. Built-in fields can't be deleted or disabled.
operationId: listBuiltInFields
responses:
'200':
description: List of all built-in fields.
content:
application/json:
schema:
$ref: '#/components/schemas/ListBuiltinFieldsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/builtin/{id}:
get:
tags:
- fieldManagementV1
summary: Get A Built-in Field.
description: Get the details of a built-in field.
operationId: getBuiltInField
parameters:
- name: id
in: path
description: Identifier of a built-in field.
required: true
schema:
type: string
example: 000000000000000A
responses:
'200':
description: The details of the built-in field.
content:
application/json:
schema:
$ref: '#/components/schemas/BuiltinField'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/fields/quota:
get:
tags:
- fieldManagementV1
summary: Get Capacity Information.
description: Every account has a limited number of fields available. This endpoint returns your account limitations and remaining quota.
operationId: getFieldQuota
responses:
'200':
description: Current fields capacity usage (fields count).
content:
application/json:
schema:
$ref: '#/components/schemas/FieldQuotaUsage'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
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'
CustomField:
allOf:
- $ref: '#/components/schemas/FieldName'
- required:
- dataType
- fieldId
- state
type: object
properties:
fieldId:
type: string
description: Identifier of the field.
example: 00000000031D02DA
dataType:
pattern: ^(String|Long|Int|Double|Boolean)$
type: string
description: Field type. Possible values are `String`, `Long`, `Int`, `Double`, and `Boolean`.
example: String
x-pattern-message: Must be `String`, `Long`, `Int`, `Double` or `Boolean`
state:
pattern: ^(Enabled|Disabled)$
type: string
description: Indicates whether the field is enabled and its values are being accepted. Possible values are `Enabled` and `Disabled`.
example: Enabled
x-pattern-message: Must be `Enabled` or `Disabled`
ListDroppedFieldsResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of dropped fields.
items:
$ref: '#/components/schemas/DroppedField'
ListCustomFieldsResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of custom fields.
items:
$ref: '#/components/schemas/CustomField'
ListBuiltinFieldsResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of built-in fields.
items:
$ref: '#/components/schemas/BuiltinField'
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
FieldName:
required:
- fieldName
type: object
properties:
fieldName:
maxLength: 255
minLength: 1
type: string
description: Field name.
example: hostIP
DroppedField:
allOf:
- $ref: '#/components/schemas/FieldName'
BuiltinField:
allOf:
- $ref: '#/components/schemas/FieldName'
- required:
- dataType
- fieldId
- state
type: object
properties:
fieldId:
type: string
description: Identifier of the field.
example: 00000000031D02DA
dataType:
pattern: ^(String|Long|Int|Double|Boolean)$
type: string
description: Field type. Possible values are `String`, `Long`, `Int`, `Double`, and `Boolean`.
example: String
x-pattern-message: Must be `String`, `Long`, `Int`, `Double` or `Boolean`
state:
pattern: ^(Enabled|Disabled)$
type: string
description: Indicates whether the field is enabled and its values are being accepted. Possible values are `Enabled` and `Disabled`.
example: Enabled
x-pattern-message: Must be `Enabled` or `Disabled`
FieldQuotaUsage:
required:
- quota
- remaining
type: object
properties:
quota:
type: integer
description: Maximum number of fields available.
format: int32
example: 200
remaining:
type: integer
description: Current number of fields available.
format: int32
example: 121
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