Field Management APIs

The Field Management API allows you to configure fields from HTTP endpoints. 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. For more information, see Fields.

Documentation

To get started with Sumo Logic APIs, see API Authentication, Endpoints, and Security.

Our APIs are built with OpenAPI. You can generate client libraries in several languages and explore automated testing.

To access our API documentation, navigate to the appropriate link based on your Sumo Logic deployment. Deployment types differ based on geographic location and account creation date. If unsure, see Which endpoint should I use?

Region code	Region name	AWS region	API endpoint
AU	Asia Pacific (Sydney)	ap-southeast-2	https://api.au.sumologic.com/docs/#tag/fieldManagementV1
CA	Canada (Central)	ca-central-1	https://api.ca.sumologic.com/docs/#tag/fieldManagementV1
CH	Switzerland (Zurich)	eu-central-2	https://api.ch.sumologic.com/docs/#tag/fieldManagementV1
DE	EU (Frankfurt)	eu-central-1	https://api.de.sumologic.com/docs/#tag/fieldManagementV1
EU	EU (Ireland)	eu-west-1	https://api.eu.sumologic.com/docs/#tag/fieldManagementV1
FED	US East (N. Virginia)	us-east-1	https://api.fed.sumologic.com/docs/#tag/fieldManagementV1
JP	Asia Pacific (Tokyo)	ap-northeast-1	https://api.jp.sumologic.com/docs/#tag/fieldManagementV1
KR	Asia Pacific (Seoul)	ap-northeast-2	https://api.kr.sumologic.com/docs/#tag/fieldManagementV1
US1	US East (N. Virginia)	us-east-1	https://api.sumologic.com/docs/#tag/fieldManagementV1
US2	US West (Oregon)	us-west-2	https://api.us2.sumologic.com/docs/#tag/fieldManagementV1

Required role capabilities

To use the APIs in this resource, the user or account executing APIs must have the following role capabilities:

• Data Management
  • Manage Field Extraction Rules
  • Manage Fields
  • View Field Extraction Rules
  • View Fields