openapi: 3.0.3 info: title: Splunk Observability Cloud — Navigators version: 3.0.1 description: 'API for creating, updating, retrieving, and deleting custom navigators. Requirements You must have an organization access token with the API permission or a session token to use the API. You have to have the Splunk Observability Cloud admin role to use the POST /navigator, PUT /navigator/{id}, DELETE /navigator/{id}, POST /navigator/{id}/navigatorcustomization, PUT /navigator/{id}/navigatorcustomization/{customizationId}, and DELETE /navigator/{id}/navigatorcustomization/{customizationId} operations. You have to have the Splunk Observability Cloud admin, power, or read_only role to use the GET /navigator, GET /navigator/{id}, GET /navigator/{id}/dashboards, GET /navigator/{id}/navigatorcustomization, and GET /navigator/{id}/navigatorcustomization/{customizationId} operations.' x-provenance: method: reconstructed authored_by: Splunk (content) / API Evangelist (assembly) reconstructed_by: API Evangelist reconstructed_on: '2026-08-19' first_party: false provider_published: false note: Splunk's own OpenAPI objects, extracted from the React Server Component payload embedded in each of the 48 API reference pages at dev.splunk.com. The operations and schemas are Splunk's; the assembly into standalone documents is API Evangelist's. Splunk serves no fetchable spec file — dev.splunk.com answers 200 with an identical 6,638-byte shell for every asset path, including invented control paths — so this is NOT first-party publication and is not graded as such. x-evidence: - type: source url: https://dev.splunk.com/observability/reference/ - type: source url: https://dev.splunk.com/observability/docs/apibasics/api_list/ servers: - url: https://api.{REALM}.observability.splunkcloud.com/v2 description: Base API endpoint URL for custom navigator variables: REALM: default: us0 description: Splunk Observability Cloud realm the organization is provisioned in (for example us0, us1, eu0, jp0, au0). security: - SessionToken: [] components: securitySchemes: SessionToken: type: apiKey in: header name: X-SF-Token description: Splunk Observability Cloud session token or org access token. paths: /navigator: get: summary: Retrieve Navigators Query description: 'Retrieves the properties of one or more navigators. If you don''t specify any query parameters, the API returns up to the first 200 navigator objects that you have access to. Note: Splunk Observability Cloud returns a maximum of 10,000 navigators, even if your organization contains more than 10,000 navigators. To learn more, see the Considerations for retrieve operations section in the developer guide.' parameters: - name: limit in: query description: Number of navigators to retrieve from the list of navigators that match your search criteria. schema: type: integer format: int32 default: 200 example: 100 - name: displayName in: query description: 'Search string that the system compares to existing navigator names. A match occurs if the string matches any part of the navigator name. For example, the query specification displayName="per" matches the following (ellipses represent other parts of the name): "...dropped per day..." "...95th percentile" "personal disk usage..." The string can contain only ASCII characters.' schema: type: string - name: offset in: query description: 0-based index of the point in the query results where the system starts returning navigators. If the offset value is greater than the size of the result set, you don't receive any results. schema: type: integer format: int32 - name: Accept in: header description: Format of the response body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/vnd.splunk.observability.navigator+json: schema: title: Valid Get Navigators Response type: object properties: count: type: integer format: int32 description: 'Number of navigators that matched the provided search criteria. Note: This value is the total number of matches, not the number of navigators returned. The number of navigators that the system returns is affected by the limit and offset query parameters. In summary: sizeOf(results): Number of navigators returned in the response body. count: Number of navigators that match the search criteria.' results: type: array items: type: object properties: aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - DiVWXF8AgAA - DiVV1eUAgAA - DiVWbW3AgAA description: List of dashboard IDs you want to show in the aggregate view of this navigator. Aggregate view is the view when you first open a navigator. In the aggregate view, you can see all instances of the integration represented by this navigator, in the form of a heatmap or a table. alertQuery: title: Navigator alert query type: string example: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) description: Query that retrieves alerts associated with this navigator. categories: title: Navigator categories list type: array maxItems: 1 items: title: Navigator category type: object required: - categoryName properties: categoryName: title: Category display name type: string maxLength: 50 example: Amazon Web Services description: 'Display name for the category. Note: If this parameter is empty, the display name is "Other".' categoryGroupName: title: Category group name type: string maxLength: 50 example: Public Clouds description: 'Name of the group where this category belongs. Note: If this parameter is empty, the display name is "Other".' categoryInstanceLabel: title: Category instance label type: string maxLength: 50 example: service description: General name for each navigator in this category. description: Details about a category for this navigator. description: 'List of categories where this navigator belongs, in the form of a JSON array. Each element is a single category. Note: If you specify a category object with the same categoryName as the categoryName of an existing category object, the navigator is put into the existing category object and all other fields of the new category object are ignored.' created: title: Date and time when this navigator was created type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator creator user ID type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who created this navigator. This property is read-only and is generated by the system. defaultGroupBy: title: Navigator default group by type: string description: A property that indicates how you want to group the instances in the navigator by default. If defaultGroupBy is set then by default, the instances are grouped by this property when you view the navigator. displayName: title: Navigator display name type: string maxLength: 50 example: Elastic Load Balancers description: A short name for the navigator that appears in the UI. id: title: Navigator system ID type: string readOnly: true example: DzUCanSAEu8 description: Unique ID of a navigator. This property is read-only and is generated by the system. idDisplayName: title: Navigator ID display name type: string example: '{{aws_tag_Name}}' description: 'This property value appears as the tooltip title when you hover over the navigator in the UI. Note: If idDisplayName is empty, the navigator ID appears instead.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - DiVWWU5AYAA - DiVWZODAgAA description: List of dashboard IDs you want to show in the instance display of this navigator. Instance view is the view you get when you select an individual instance of the integration from the heatmap or table in the aggregate view of this navigator. instanceDisplayText: title: Instance display text type: string maxLength: 100 example: Elastic Load Balancer description: Description for a single instance of this navigator. This description is used when displaying the long name of a single instance in this navigator. instanceLabel: title: Navigator instance label type: string maxLength: 50 example: Load Balancer description: Label for a single instance of this navigator in the UI. lastUpdated: title: Navigator last updated time type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who last updated this navigator. This property is read-only and is generated by the system. listColumns: title: Navigator column list type: array maxItems: 10 items: title: List column items type: object required: - displayName - property properties: displayName: title: Column display name type: string maxLength: 100 example: Availability Zone description: Column display name format: title: Column format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this column. Note: If format is empty, the format defaults to string.' property: title: Property to display in this column type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to display in this column description: A single column you want to see in the table view of this navigator. description: List of columns you want to see in the table view of this navigator, in the form of a JSON array. Each element is a single column. navigatorCode: title: Navigator unique code type: string example: elb readOnly: true description: Unique code used to identify a built-in navigator. This property appears in the navigator URL. ownerScope: title: How the navigator was created type: string enum: - splunk - organization readOnly: true example: organization description: 'Indicates how the navigator was created. These are the possible values: splunk: Navigator is a built-in navigator. organization: Navigator was created by a user using the API. Note: You can only use organization when creating or updating navigators. If you try to pass an invalid value for ownerScope when creating or updating detectors, you will receive a 403 response and an error message saying "Cannot change or export built-in navigators in this org".' propertyIdentifierTemplate: title: Template for ID construction type: string example: '{{LoadBalancerName}} | {{AvailabilityZone}}' description: A template used for constructing IDs for the instances in this navigator. Properties inside the left braces and right braces ({{ }}) will be evaluated from the instance and populated with the property value. For example, if you use load balancer name and availability zone to construct an instance ID, an instance ID might look like i-00ddab733ad2a6d47_us-west-1. entityMetrics: title: Navigator metric information type: array maxItems: 30 items: title: Metric to display on a navigator type: object required: - id - metricSelectors - job - type properties: coloringScheme: title: Metric coloring scheme type: object properties: minValue: title: Minimum value type: integer format: int64 example: 0 description: 'Optional lower bound used for default coloring. Null value indicates that there is no logical lower bound and the minimum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' maxValue: title: Maximum value type: integer format: int64 example: 50 description: 'Optional upper bound used for default coloring. Null value indicates that there is no logical upper bound and the maximum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' palette: title: Coloring palette type: string enum: - RED_GREEN - GREEN_RED - PURPLE_BLUE - BLUE_PURPLE - LEGACY example: RED_GREEN description: 'Color palette for the coloring scheme. These are gradient palettes that flow from one color to the other, based on data points distribution. These are the possible values: RED_GREEN: The palette is a gradient from red to green, with lower values colored in red and higher values colored in green. GREEN_RED: The palette is a gradient from green to red, with lower values colored in green and higher values colored in red. PURPLE_BLUE: The palette is a gradient from purple to blue, with lower values colored in purple and higher values colored in blue. BLUE_PURPLE: The palette is a gradient from blue to purple, with lower values colored in blue and higher values colored in purple. LEGACY: Only available for navigators with ownerScope: splunk. You can''t use this value when creating or updating a navigator with ownerScope: organization.' thresholds: title: Coloring thresholds type: array maxItems: 5 items: title: Coloring threshold properties: lowerLimit: title: Lower limit type: integer format: double description: Lower limit of the threshold paletteIndex: title: Palette index type: integer format: int64 description: 0-based index that specifies which color in the gradient is assigned to the range bounded at the lower limit by this threshold. Possible values are 0 to 4, inclusive. description: Single coloring threshold example: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: Optional list of thresholds to determine colors, in the form of a JSON array. Each element is an individual coloring threshold. description: 'How the heatmap or table nodes are colored for a particular metric. By default, the navigator uses automatic coloring based on the dataset. The default coloring scheme divides the dataset into five segments, defined by the range of colors. If you provide a list of thresholds, then specific thresholds are used to determine coloring. You can provide either minValue and maxValue, or a list of thresholds, but not both.' description: title: Metric description type: string maxLength: 300 example: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' description: Explanation for the coloring scheme of the metric. displayName: title: Metric display name type: string maxLength: 100 example: CPU Utilization description: Metric display name job: title: Metric job type: object required: - resolution - template - varName properties: resolution: title: Resolution of the job type: integer format: int64 example: 300000 description: Resolution of the job in milliseconds template: title: SignaFlow template type: string example: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) description: SignalFlow template that generates the heatmap or list of metrics for display on a navigator varName: title: Variable name type: string example: CPU_UTILIZATION description: Variable name used in the template filters: title: Filter list type: array items: title: Filter for a metric job type: object required: - property properties: property: title: Property key to filter type: string example: _exists_ description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the entity metrics for the navigator, and JobFilter.NOT is true, the system doesn''t display any metric in the navigator.' propertyValue: title: Property values to filter oneOf: - type: string - type: array example: AWSUniqueId description: Property values to filter not: title: Indicates of the property is included or excluded type: boolean default: false example: false description: Flag that indicates how the filter operates. If true, data that matches the criteria is excluded from the filter; otherwise, data that matches the criteria is included. type: title: Property type type: string example: property description: Indicates if this is a custom property or a dimension description: A single filter for a metric job. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches this dimension or custom property. description: List of filters for the job, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property. description: Metric job id: title: Metric name type: string example: aws.ec2.cpu.utilization description: Unique name of the metric type: title: Metric type type: string enum: - event - metric example: metric description: Metric type valueLabel: title: Metric value label type: string maxLength: 100 description: Metric value label valueFormat: title: Metric value format type: string enum: - id - Number - aws_state - Kilobytes - Percentage - AlertSeverity - Seconds - Bytes - Boolean example: Percentage description: Metric value format metricSelectors: title: List of metric selectors type: array items: type: string example: aws.ec2.cpu.utilization description: List of metric selectors description: Metric to display on a navigator description: List of metrics to retrieve and display for the aggregated view of instances in this navigator. systemTypes: title: Navigator system types type: array maxItems: 10 items: type: string example: - redis description: A list of values for the Splunk Distribution of OpenTelemetry system.type variable associated with this navigator, in the form of an array. Each element is a single system type. This list is used to link the navigator with other navigators. An example of this is the associated dependencies shown in the navigator sidebar in the UI. summaryMetricLabel: title: Label for a summary metric type: string maxLength: 100 example: Active Load Balancers description: Label for the summary metric of this navigator. In the UI, summary metric is the value that appears on the card representing the navigator on the Infrastructure Monitoring landing page. Summary metric label indicates what the summary metric value measures. summaryMetricProgramText: title: SignalFlow program for summary metric type: string example: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') description: SignalFlow program that calculates and displays the current value for the summary metric. tooltipKeyList: title: List of tooltip keys type: array maxItems: 10 example: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value items: type: object title: Tooltip Key required: - property - displayName properties: displayName: title: Tooltip key display name type: string maxLength: 100 example: Availability Zone description: Display name for this tooltip key property format: title: Tooltip key format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this tooltip key. Note: If format is empty, the format defaults to string.' property: title: Property to display for this tooltip key type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to use for the value of this tooltip key description: Tooltip key properties description: A list of keys that appears in a tooltip when you hover over an instance of the integration in this navigator, in the form of a JSON array. Each array element is a single tooltip key. title: GetNavigatorsResult description: Results of a query to retrieve all navigators, in the form of a JSON array of objects. Each element is a navigator object. description: Properties in the response body of a successful retrieval of navigators examples: example: value: count: 0 results: - aggregateDashboards: - DiVWXF8AgAA - DiVV1eUAgAA - DiVWbW3AgAA alertQuery: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) categories: - categoryGroupName: Public Clouds categoryInstanceLabel: service categoryName: Amazon Web Services created: 1550097801307 creator: AAAAAAAAAAA defaultGroupBy: string displayName: Elastic Load Balancers entityMetrics: - coloringScheme: maxValue: 50 minValue: 0 palette: RED_GREEN thresholds: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' displayName: CPU Utilization id: aws.ec2.cpu.utilization job: filters: - not: false property: _exists_ propertyValue: AWSUniqueId type: property resolution: 300000 template: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) varName: CPU_UTILIZATION metricSelectors: - aws.ec2.cpu.utilization type: metric valueFormat: Percentage valueLabel: string id: DzUCanSAEu8 idDisplayName: '{{aws_tag_Name}}' instanceDashboards: - DiVWWU5AYAA - DiVWZODAgAA instanceDisplayText: Elastic Load Balancer instanceLabel: Load Balancer lastUpdated: 1550097801307 lastUpdatedBy: AAAAAAAAAAA listColumns: - displayName: Availability Zone format: Number property: AvailabilityZone navigatorCode: elb ownerScope: organization propertyIdentifierTemplate: '{{LoadBalancerName}} | {{AvailabilityZone}}' summaryMetricLabel: Active Load Balancers summaryMetricProgramText: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') systemTypes: - redis tooltipKeyList: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value security: - SessionToken: [] tags: - Navigators post: summary: Create Single Navigator description: 'Creates a new navigator object. Note: You need to be an admin to create a new navigator.' parameters: - name: Accept in: header description: Format of the response body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string requestBody: required: true content: application/vnd.splunk.observability.navigator+json: schema: title: Properties for creating a navigator type: object required: - displayName - propertyIdentifierTemplate - entityMetrics - categories - requiredProperties properties: alertQuery: title: Navigator alert query type: string example: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) description: Query that retrieves alerts associated with this navigator. categories: title: Navigator categories list type: array maxItems: 1 items: title: Navigator category type: object required: - categoryName properties: categoryName: title: Category display name type: string maxLength: 50 example: Amazon Web Services description: 'Display name for the category. Note: If this parameter is empty, the display name is "Other".' categoryGroupName: title: Category group name type: string maxLength: 50 example: Public Clouds description: 'Name of the group where this category belongs. Note: If this parameter is empty, the display name is "Other".' categoryInstanceLabel: title: Category instance label type: string maxLength: 50 example: service description: General name for each navigator in this category. description: Details about a category for this navigator. description: 'List of categories where this navigator belongs, in the form of a JSON array. Each element is a single category. Note: If you specify a category object with the same categoryName as the categoryName of an existing category object, the navigator is put into the existing category object and all other fields of the new category object are ignored.' defaultGroupBy: title: Navigator default group by type: string description: A property that indicates how you want to group the instances in the navigator by default. If defaultGroupBy is set then by default, the instances are grouped by this property when you view the navigator. displayName: title: Navigator display name type: string maxLength: 50 example: Elastic Load Balancers description: A short name for the navigator that appears in the UI. entityMetrics: title: Navigator metric information type: array maxItems: 30 items: title: Metric to display on a navigator type: object required: - id - metricSelectors - job - type properties: coloringScheme: title: Metric coloring scheme type: object properties: minValue: title: Minimum value type: integer format: int64 example: 0 description: 'Optional lower bound used for default coloring. Null value indicates that there is no logical lower bound and the minimum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' maxValue: title: Maximum value type: integer format: int64 example: 50 description: 'Optional upper bound used for default coloring. Null value indicates that there is no logical upper bound and the maximum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' palette: title: Coloring palette type: string enum: - RED_GREEN - GREEN_RED - PURPLE_BLUE - BLUE_PURPLE - LEGACY example: RED_GREEN description: 'Color palette for the coloring scheme. These are gradient palettes that flow from one color to the other, based on data points distribution. These are the possible values: RED_GREEN: The palette is a gradient from red to green, with lower values colored in red and higher values colored in green. GREEN_RED: The palette is a gradient from green to red, with lower values colored in green and higher values colored in red. PURPLE_BLUE: The palette is a gradient from purple to blue, with lower values colored in purple and higher values colored in blue. BLUE_PURPLE: The palette is a gradient from blue to purple, with lower values colored in blue and higher values colored in purple. LEGACY: Only available for navigators with ownerScope: splunk. You can''t use this value when creating or updating a navigator with ownerScope: organization.' thresholds: title: Coloring thresholds type: array maxItems: 5 items: title: Coloring threshold properties: lowerLimit: title: Lower limit type: integer format: double description: Lower limit of the threshold paletteIndex: title: Palette index type: integer format: int64 description: 0-based index that specifies which color in the gradient is assigned to the range bounded at the lower limit by this threshold. Possible values are 0 to 4, inclusive. description: Single coloring threshold example: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: Optional list of thresholds to determine colors, in the form of a JSON array. Each element is an individual coloring threshold. description: 'How the heatmap or table nodes are colored for a particular metric. By default, the navigator uses automatic coloring based on the dataset. The default coloring scheme divides the dataset into five segments, defined by the range of colors. If you provide a list of thresholds, then specific thresholds are used to determine coloring. You can provide either minValue and maxValue, or a list of thresholds, but not both.' description: title: Metric description type: string maxLength: 300 example: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' description: Explanation for the coloring scheme of the metric. displayName: title: Metric display name type: string maxLength: 100 example: CPU Utilization description: Metric display name job: title: Metric job type: object required: - resolution - template - varName properties: resolution: title: Resolution of the job type: integer format: int64 example: 300000 description: Resolution of the job in milliseconds template: title: SignaFlow template type: string example: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) description: SignalFlow template that generates the heatmap or list of metrics for display on a navigator varName: title: Variable name type: string example: CPU_UTILIZATION description: Variable name used in the template filters: title: Filter list type: array items: title: Filter for a metric job type: object required: - property properties: property: title: Property key to filter type: string example: _exists_ description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the entity metrics for the navigator, and JobFilter.NOT is true, the system doesn''t display any metric in the navigator.' propertyValue: title: Property values to filter oneOf: - type: string - type: array example: AWSUniqueId description: Property values to filter not: title: Indicates of the property is included or excluded type: boolean default: false example: false description: Flag that indicates how the filter operates. If true, data that matches the criteria is excluded from the filter; otherwise, data that matches the criteria is included. type: title: Property type type: string example: property description: Indicates if this is a custom property or a dimension description: A single filter for a metric job. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches this dimension or custom property. description: List of filters for the job, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property. description: Metric job id: title: Metric name type: string example: aws.ec2.cpu.utilization description: Unique name of the metric type: title: Metric type type: string enum: - event - metric example: metric description: Metric type valueLabel: title: Metric value label type: string maxLength: 100 description: Metric value label valueFormat: title: Metric value format type: string enum: - id - Number - aws_state - Kilobytes - Percentage - AlertSeverity - Seconds - Bytes - Boolean example: Percentage description: Metric value format metricSelectors: title: List of metric selectors type: array items: type: string example: aws.ec2.cpu.utilization description: List of metric selectors description: Metric to display on a navigator description: List of metrics to retrieve and display for the aggregated view of instances in this navigator. id: title: Navigator system ID type: string readOnly: true example: DzUCanSAEu8 description: Unique ID of a navigator. This property is read-only and is generated by the system. idDisplayName: title: Navigator ID display name type: string example: '{{aws_tag_Name}}' description: 'This property value appears as the tooltip title when you hover over the navigator in the UI. Note: If idDisplayName is empty, the navigator ID appears instead.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - DiVWWU5AYAA - DiVWZODAgAA description: List of dashboard IDs you want to show in the instance display of this navigator. Instance view is the view you get when you select an individual instance of the integration from the heatmap or table in the aggregate view of this navigator. instanceDisplayText: title: Instance display text type: string maxLength: 100 example: Elastic Load Balancer description: Description for a single instance of this navigator. This description is used when displaying the long name of a single instance in this navigator. instanceLabel: title: Navigator instance label type: string maxLength: 50 example: Load Balancer description: Label for a single instance of this navigator in the UI. listColumns: title: Navigator column list type: array maxItems: 10 items: title: List column items type: object required: - displayName - property properties: displayName: title: Column display name type: string maxLength: 100 example: Availability Zone description: Column display name format: title: Column format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this column. Note: If format is empty, the format defaults to string.' property: title: Property to display in this column type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to display in this column description: A single column you want to see in the table view of this navigator. description: List of columns you want to see in the table view of this navigator, in the form of a JSON array. Each element is a single column. propertyIdentifierTemplate: title: Template for ID construction type: string example: '{{LoadBalancerName}} | {{AvailabilityZone}}' description: A template used for constructing IDs for the instances in this navigator. Properties inside the left braces and right braces ({{ }}) will be evaluated from the instance and populated with the property value. For example, if you use load balancer name and availability zone to construct an instance ID, an instance ID might look like i-00ddab733ad2a6d47_us-west-1. requiredProperties: title: Properties shared by all instances type: array maxItems: 10 items: type: string example: - LoadBalancerName description: A list of properties shared by all instances of the integration in this navigator. When you select an individual instance to view, each property in the requiredProperties list is used to query for metric time series (MTS) related to that instance. systemTypes: title: Navigator system types type: array maxItems: 10 items: type: string example: - redis description: A list of values for the Splunk Distribution of OpenTelemetry system.type variable associated with this navigator, in the form of an array. Each element is a single system type. This list is used to link the navigator with other navigators. An example of this is the associated dependencies shown in the navigator sidebar in the UI. summaryMetricLabel: title: Label for a summary metric type: string maxLength: 100 example: Active Load Balancers description: Label for the summary metric of this navigator. In the UI, summary metric is the value that appears on the card representing the navigator on the Infrastructure Monitoring landing page. Summary metric label indicates what the summary metric value measures. summaryMetricProgramText: title: SignalFlow program for summary metric type: string example: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') description: SignalFlow program that calculates and displays the current value for the summary metric. tooltipKeyList: title: List of tooltip keys type: array maxItems: 10 example: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value items: type: object title: Tooltip Key required: - property - displayName properties: displayName: title: Tooltip key display name type: string maxLength: 100 example: Availability Zone description: Display name for this tooltip key property format: title: Tooltip key format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this tooltip key. Note: If format is empty, the format defaults to string.' property: title: Property to display for this tooltip key type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to use for the value of this tooltip key description: Tooltip key properties description: A list of keys that appears in a tooltip when you hover over an instance of the integration in this navigator, in the form of a JSON array. Each array element is a single tooltip key. description: Properties to use in creating a new navigator using the API examples: example: value: alertQuery: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) categories: - categoryGroupName: Public Clouds categoryInstanceLabel: service categoryName: Amazon Web Services defaultGroupBy: string displayName: Elastic Load Balancers entityMetrics: - coloringScheme: maxValue: 50 minValue: 0 palette: RED_GREEN thresholds: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' displayName: CPU Utilization id: aws.ec2.cpu.utilization job: filters: - not: false property: _exists_ propertyValue: AWSUniqueId type: property resolution: 300000 template: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) varName: CPU_UTILIZATION metricSelectors: - aws.ec2.cpu.utilization type: metric valueFormat: Percentage valueLabel: string id: DzUCanSAEu8 idDisplayName: '{{aws_tag_Name}}' instanceDashboards: - DiVWWU5AYAA - DiVWZODAgAA instanceDisplayText: Elastic Load Balancer instanceLabel: Load Balancer listColumns: - displayName: Availability Zone format: Number property: AvailabilityZone propertyIdentifierTemplate: '{{LoadBalancerName}} | {{AvailabilityZone}}' requiredProperties: - LoadBalancerName summaryMetricLabel: Active Load Balancers summaryMetricProgramText: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') systemTypes: - redis tooltipKeyList: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value responses: '201': description: HTTP 201 response content: application/vnd.splunk.observability.navigator+json: schema: title: Create Navigator Response Body type: object properties: alertQuery: title: Navigator alert query type: string example: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) description: Query that retrieves alerts associated with this navigator. categories: title: Navigator categories list type: array maxItems: 1 items: title: Navigator category type: object required: - categoryName properties: categoryName: title: Category display name type: string maxLength: 50 example: Amazon Web Services description: 'Display name for the category. Note: If this parameter is empty, the display name is "Other".' categoryGroupName: title: Category group name type: string maxLength: 50 example: Public Clouds description: 'Name of the group where this category belongs. Note: If this parameter is empty, the display name is "Other".' categoryInstanceLabel: title: Category instance label type: string maxLength: 50 example: service description: General name for each navigator in this category. description: Details about a category for this navigator. description: 'List of categories where this navigator belongs, in the form of a JSON array. Each element is a single category. Note: If you specify a category object with the same categoryName as the categoryName of an existing category object, the navigator is put into the existing category object and all other fields of the new category object are ignored.' created: title: Date and time when this navigator was created type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator creator user ID type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who created this navigator. This property is read-only and is generated by the system. defaultGroupBy: title: Navigator default group by type: string description: A property that indicates how you want to group the instances in the navigator by default. If defaultGroupBy is set then by default, the instances are grouped by this property when you view the navigator. displayName: title: Navigator display name type: string maxLength: 50 example: Elastic Load Balancers description: A short name for the navigator that appears in the UI. entityMetrics: title: Navigator metric information type: array maxItems: 30 items: title: Metric to display on a navigator type: object required: - id - metricSelectors - job - type properties: coloringScheme: title: Metric coloring scheme type: object properties: minValue: title: Minimum value type: integer format: int64 example: 0 description: 'Optional lower bound used for default coloring. Null value indicates that there is no logical lower bound and the minimum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' maxValue: title: Maximum value type: integer format: int64 example: 50 description: 'Optional upper bound used for default coloring. Null value indicates that there is no logical upper bound and the maximum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' palette: title: Coloring palette type: string enum: - RED_GREEN - GREEN_RED - PURPLE_BLUE - BLUE_PURPLE - LEGACY example: RED_GREEN description: 'Color palette for the coloring scheme. These are gradient palettes that flow from one color to the other, based on data points distribution. These are the possible values: RED_GREEN: The palette is a gradient from red to green, with lower values colored in red and higher values colored in green. GREEN_RED: The palette is a gradient from green to red, with lower values colored in green and higher values colored in red. PURPLE_BLUE: The palette is a gradient from purple to blue, with lower values colored in purple and higher values colored in blue. BLUE_PURPLE: The palette is a gradient from blue to purple, with lower values colored in blue and higher values colored in purple. LEGACY: Only available for navigators with ownerScope: splunk. You can''t use this value when creating or updating a navigator with ownerScope: organization.' thresholds: title: Coloring thresholds type: array maxItems: 5 items: title: Coloring threshold properties: lowerLimit: title: Lower limit type: integer format: double description: Lower limit of the threshold paletteIndex: title: Palette index type: integer format: int64 description: 0-based index that specifies which color in the gradient is assigned to the range bounded at the lower limit by this threshold. Possible values are 0 to 4, inclusive. description: Single coloring threshold example: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: Optional list of thresholds to determine colors, in the form of a JSON array. Each element is an individual coloring threshold. description: 'How the heatmap or table nodes are colored for a particular metric. By default, the navigator uses automatic coloring based on the dataset. The default coloring scheme divides the dataset into five segments, defined by the range of colors. If you provide a list of thresholds, then specific thresholds are used to determine coloring. You can provide either minValue and maxValue, or a list of thresholds, but not both.' description: title: Metric description type: string maxLength: 300 example: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' description: Explanation for the coloring scheme of the metric. displayName: title: Metric display name type: string maxLength: 100 example: CPU Utilization description: Metric display name job: title: Metric job type: object required: - resolution - template - varName properties: resolution: title: Resolution of the job type: integer format: int64 example: 300000 description: Resolution of the job in milliseconds template: title: SignaFlow template type: string example: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) description: SignalFlow template that generates the heatmap or list of metrics for display on a navigator varName: title: Variable name type: string example: CPU_UTILIZATION description: Variable name used in the template filters: title: Filter list type: array items: title: Filter for a metric job type: object required: - property properties: property: title: Property key to filter type: string example: _exists_ description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the entity metrics for the navigator, and JobFilter.NOT is true, the system doesn''t display any metric in the navigator.' propertyValue: title: Property values to filter oneOf: - type: string - type: array example: AWSUniqueId description: Property values to filter not: title: Indicates of the property is included or excluded type: boolean default: false example: false description: Flag that indicates how the filter operates. If true, data that matches the criteria is excluded from the filter; otherwise, data that matches the criteria is included. type: title: Property type type: string example: property description: Indicates if this is a custom property or a dimension description: A single filter for a metric job. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches this dimension or custom property. description: List of filters for the job, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property. description: Metric job id: title: Metric name type: string example: aws.ec2.cpu.utilization description: Unique name of the metric type: title: Metric type type: string enum: - event - metric example: metric description: Metric type valueLabel: title: Metric value label type: string maxLength: 100 description: Metric value label valueFormat: title: Metric value format type: string enum: - id - Number - aws_state - Kilobytes - Percentage - AlertSeverity - Seconds - Bytes - Boolean example: Percentage description: Metric value format metricSelectors: title: List of metric selectors type: array items: type: string example: aws.ec2.cpu.utilization description: List of metric selectors description: Metric to display on a navigator description: List of metrics to retrieve and display for the aggregated view of instances in this navigator. id: title: Navigator system ID type: string readOnly: true example: DzUCanSAEu8 description: Unique ID of a navigator. This property is read-only and is generated by the system. idDisplayName: title: Navigator ID display name type: string example: '{{aws_tag_Name}}' description: 'This property value appears as the tooltip title when you hover over the navigator in the UI. Note: If idDisplayName is empty, the navigator ID appears instead.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - DiVWWU5AYAA - DiVWZODAgAA description: List of dashboard IDs you want to show in the instance display of this navigator. Instance view is the view you get when you select an individual instance of the integration from the heatmap or table in the aggregate view of this navigator. instanceDisplayText: title: Instance display text type: string maxLength: 100 example: Elastic Load Balancer description: Description for a single instance of this navigator. This description is used when displaying the long name of a single instance in this navigator. instanceLabel: title: Navigator instance label type: string maxLength: 50 example: Load Balancer description: Label for a single instance of this navigator in the UI. lastUpdated: title: Navigator last updated time type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who last updated this navigator. This property is read-only and is generated by the system. listColumns: title: Navigator column list type: array maxItems: 10 items: title: List column items type: object required: - displayName - property properties: displayName: title: Column display name type: string maxLength: 100 example: Availability Zone description: Column display name format: title: Column format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this column. Note: If format is empty, the format defaults to string.' property: title: Property to display in this column type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to display in this column description: A single column you want to see in the table view of this navigator. description: List of columns you want to see in the table view of this navigator, in the form of a JSON array. Each element is a single column. ownerScope: title: How the navigator was created type: string enum: - splunk - organization readOnly: true example: organization description: 'Indicates how the navigator was created. These are the possible values: splunk: Navigator is a built-in navigator. organization: Navigator was created by a user using the API. Note: You can only use organization when creating or updating navigators. If you try to pass an invalid value for ownerScope when creating or updating detectors, you will receive a 403 response and an error message saying "Cannot change or export built-in navigators in this org".' propertyIdentifierTemplate: title: Template for ID construction type: string example: '{{LoadBalancerName}} | {{AvailabilityZone}}' description: A template used for constructing IDs for the instances in this navigator. Properties inside the left braces and right braces ({{ }}) will be evaluated from the instance and populated with the property value. For example, if you use load balancer name and availability zone to construct an instance ID, an instance ID might look like i-00ddab733ad2a6d47_us-west-1. requiredProperties: title: Properties shared by all instances type: array maxItems: 10 items: type: string example: - LoadBalancerName description: A list of properties shared by all instances of the integration in this navigator. When you select an individual instance to view, each property in the requiredProperties list is used to query for metric time series (MTS) related to that instance. systemTypes: title: Navigator system types type: array maxItems: 10 items: type: string example: - redis description: A list of values for the Splunk Distribution of OpenTelemetry system.type variable associated with this navigator, in the form of an array. Each element is a single system type. This list is used to link the navigator with other navigators. An example of this is the associated dependencies shown in the navigator sidebar in the UI. summaryMetricLabel: title: Label for a summary metric type: string maxLength: 100 example: Active Load Balancers description: Label for the summary metric of this navigator. In the UI, summary metric is the value that appears on the card representing the navigator on the Infrastructure Monitoring landing page. Summary metric label indicates what the summary metric value measures. summaryMetricProgramText: title: SignalFlow program for summary metric type: string example: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') description: SignalFlow program that calculates and displays the current value for the summary metric. tooltipKeyList: title: List of tooltip keys type: array maxItems: 10 example: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value items: type: object title: Tooltip Key required: - property - displayName properties: displayName: title: Tooltip key display name type: string maxLength: 100 example: Availability Zone description: Display name for this tooltip key property format: title: Tooltip key format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this tooltip key. Note: If format is empty, the format defaults to string.' property: title: Property to display for this tooltip key type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to use for the value of this tooltip key description: Tooltip key properties description: A list of keys that appears in a tooltip when you hover over an instance of the integration in this navigator, in the form of a JSON array. Each array element is a single tooltip key. description: Response body returned when the Create Single Navigator operation (POST /navigator) successfully creates a navigator. examples: example: value: alertQuery: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) categories: - categoryGroupName: Public Clouds categoryInstanceLabel: service categoryName: Amazon Web Services created: 1550097801307 creator: AAAAAAAAAAA defaultGroupBy: string displayName: Elastic Load Balancers entityMetrics: - coloringScheme: maxValue: 50 minValue: 0 palette: RED_GREEN thresholds: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' displayName: CPU Utilization id: aws.ec2.cpu.utilization job: filters: - not: false property: _exists_ propertyValue: AWSUniqueId type: property resolution: 300000 template: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) varName: CPU_UTILIZATION metricSelectors: - aws.ec2.cpu.utilization type: metric valueFormat: Percentage valueLabel: string id: DzUCanSAEu8 idDisplayName: '{{aws_tag_Name}}' instanceDashboards: - DiVWWU5AYAA - DiVWZODAgAA instanceDisplayText: Elastic Load Balancer instanceLabel: Load Balancer lastUpdated: 1550097801307 lastUpdatedBy: AAAAAAAAAAA listColumns: - displayName: Availability Zone format: Number property: AvailabilityZone ownerScope: organization propertyIdentifierTemplate: '{{LoadBalancerName}} | {{AvailabilityZone}}' requiredProperties: - LoadBalancerName summaryMetricLabel: Active Load Balancers summaryMetricProgramText: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') systemTypes: - redis tooltipKeyList: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value '400': description: HTTP 400 response content: application/vnd.splunk.observability.navigator+json: schema: type: object properties: code: type: integer format: int32 example: 400 description: HTTP response code. Always '400' message: type: string description: Error explanation examples: example: value: code: 400 message: string security: - SessionToken: [] tags: - Navigators /navigator/{id}: get: summary: Retrieve Navigator ID description: Retrieves the properties of the navigator that has the ID specified in the {id} path parameter. parameters: - name: id in: path description: ID of the navigator you want to retrieve. required: true schema: type: string - name: Accept in: header description: Format of the response body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/vnd.splunk.observability.navigator+json: schema: title: Valid Get Navigator Response type: object properties: aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - DiVWXF8AgAA - DiVV1eUAgAA - DiVWbW3AgAA description: List of dashboard IDs you want to show in the aggregate view of this navigator. Aggregate view is the view when you first open a navigator. In the aggregate view, you can see all instances of the integration represented by this navigator, in the form of a heatmap or a table. alertQuery: title: Navigator alert query type: string example: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) description: Query that retrieves alerts associated with this navigator. categories: title: Navigator categories list type: array maxItems: 1 items: title: Navigator category type: object required: - categoryName properties: categoryName: title: Category display name type: string maxLength: 50 example: Amazon Web Services description: 'Display name for the category. Note: If this parameter is empty, the display name is "Other".' categoryGroupName: title: Category group name type: string maxLength: 50 example: Public Clouds description: 'Name of the group where this category belongs. Note: If this parameter is empty, the display name is "Other".' categoryInstanceLabel: title: Category instance label type: string maxLength: 50 example: service description: General name for each navigator in this category. description: Details about a category for this navigator. description: 'List of categories where this navigator belongs, in the form of a JSON array. Each element is a single category. Note: If you specify a category object with the same categoryName as the categoryName of an existing category object, the navigator is put into the existing category object and all other fields of the new category object are ignored.' created: title: Date and time when this navigator was created type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator creator user ID type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who created this navigator. This property is read-only and is generated by the system. defaultGroupBy: title: Navigator default group by type: string description: A property that indicates how you want to group the instances in the navigator by default. If defaultGroupBy is set then by default, the instances are grouped by this property when you view the navigator. displayName: title: Navigator display name type: string maxLength: 50 example: Elastic Load Balancers description: A short name for the navigator that appears in the UI. id: title: Navigator system ID type: string readOnly: true example: DzUCanSAEu8 description: Unique ID of a navigator. This property is read-only and is generated by the system. idDisplayName: title: Navigator ID display name type: string example: '{{aws_tag_Name}}' description: 'This property value appears as the tooltip title when you hover over the navigator in the UI. Note: If idDisplayName is empty, the navigator ID appears instead.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - DiVWWU5AYAA - DiVWZODAgAA description: List of dashboard IDs you want to show in the instance display of this navigator. Instance view is the view you get when you select an individual instance of the integration from the heatmap or table in the aggregate view of this navigator. instanceDisplayText: title: Instance display text type: string maxLength: 100 example: Elastic Load Balancer description: Description for a single instance of this navigator. This description is used when displaying the long name of a single instance in this navigator. instanceLabel: title: Navigator instance label type: string maxLength: 50 example: Load Balancer description: Label for a single instance of this navigator in the UI. lastUpdated: title: Navigator last updated time type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who last updated this navigator. This property is read-only and is generated by the system. listColumns: title: Navigator column list type: array maxItems: 10 items: title: List column items type: object required: - displayName - property properties: displayName: title: Column display name type: string maxLength: 100 example: Availability Zone description: Column display name format: title: Column format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this column. Note: If format is empty, the format defaults to string.' property: title: Property to display in this column type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to display in this column description: A single column you want to see in the table view of this navigator. description: List of columns you want to see in the table view of this navigator, in the form of a JSON array. Each element is a single column. navigatorCode: title: Navigator unique code type: string example: elb readOnly: true description: Unique code used to identify a built-in navigator. This property appears in the navigator URL. ownerScope: title: How the navigator was created type: string enum: - splunk - organization readOnly: true example: organization description: 'Indicates how the navigator was created. These are the possible values: splunk: Navigator is a built-in navigator. organization: Navigator was created by a user using the API. Note: You can only use organization when creating or updating navigators. If you try to pass an invalid value for ownerScope when creating or updating detectors, you will receive a 403 response and an error message saying "Cannot change or export built-in navigators in this org".' propertyIdentifierTemplate: title: Template for ID construction type: string example: '{{LoadBalancerName}} | {{AvailabilityZone}}' description: A template used for constructing IDs for the instances in this navigator. Properties inside the left braces and right braces ({{ }}) will be evaluated from the instance and populated with the property value. For example, if you use load balancer name and availability zone to construct an instance ID, an instance ID might look like i-00ddab733ad2a6d47_us-west-1. entityMetrics: title: Navigator metric information type: array maxItems: 30 items: title: Metric to display on a navigator type: object required: - id - metricSelectors - job - type properties: coloringScheme: title: Metric coloring scheme type: object properties: minValue: title: Minimum value type: integer format: int64 example: 0 description: 'Optional lower bound used for default coloring. Null value indicates that there is no logical lower bound and the minimum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' maxValue: title: Maximum value type: integer format: int64 example: 50 description: 'Optional upper bound used for default coloring. Null value indicates that there is no logical upper bound and the maximum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' palette: title: Coloring palette type: string enum: - RED_GREEN - GREEN_RED - PURPLE_BLUE - BLUE_PURPLE - LEGACY example: RED_GREEN description: 'Color palette for the coloring scheme. These are gradient palettes that flow from one color to the other, based on data points distribution. These are the possible values: RED_GREEN: The palette is a gradient from red to green, with lower values colored in red and higher values colored in green. GREEN_RED: The palette is a gradient from green to red, with lower values colored in green and higher values colored in red. PURPLE_BLUE: The palette is a gradient from purple to blue, with lower values colored in purple and higher values colored in blue. BLUE_PURPLE: The palette is a gradient from blue to purple, with lower values colored in blue and higher values colored in purple. LEGACY: Only available for navigators with ownerScope: splunk. You can''t use this value when creating or updating a navigator with ownerScope: organization.' thresholds: title: Coloring thresholds type: array maxItems: 5 items: title: Coloring threshold properties: lowerLimit: title: Lower limit type: integer format: double description: Lower limit of the threshold paletteIndex: title: Palette index type: integer format: int64 description: 0-based index that specifies which color in the gradient is assigned to the range bounded at the lower limit by this threshold. Possible values are 0 to 4, inclusive. description: Single coloring threshold example: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: Optional list of thresholds to determine colors, in the form of a JSON array. Each element is an individual coloring threshold. description: 'How the heatmap or table nodes are colored for a particular metric. By default, the navigator uses automatic coloring based on the dataset. The default coloring scheme divides the dataset into five segments, defined by the range of colors. If you provide a list of thresholds, then specific thresholds are used to determine coloring. You can provide either minValue and maxValue, or a list of thresholds, but not both.' description: title: Metric description type: string maxLength: 300 example: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' description: Explanation for the coloring scheme of the metric. displayName: title: Metric display name type: string maxLength: 100 example: CPU Utilization description: Metric display name job: title: Metric job type: object required: - resolution - template - varName properties: resolution: title: Resolution of the job type: integer format: int64 example: 300000 description: Resolution of the job in milliseconds template: title: SignaFlow template type: string example: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) description: SignalFlow template that generates the heatmap or list of metrics for display on a navigator varName: title: Variable name type: string example: CPU_UTILIZATION description: Variable name used in the template filters: title: Filter list type: array items: title: Filter for a metric job type: object required: - property properties: property: title: Property key to filter type: string example: _exists_ description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the entity metrics for the navigator, and JobFilter.NOT is true, the system doesn''t display any metric in the navigator.' propertyValue: title: Property values to filter oneOf: - type: string - type: array example: AWSUniqueId description: Property values to filter not: title: Indicates of the property is included or excluded type: boolean default: false example: false description: Flag that indicates how the filter operates. If true, data that matches the criteria is excluded from the filter; otherwise, data that matches the criteria is included. type: title: Property type type: string example: property description: Indicates if this is a custom property or a dimension description: A single filter for a metric job. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches this dimension or custom property. description: List of filters for the job, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property. description: Metric job id: title: Metric name type: string example: aws.ec2.cpu.utilization description: Unique name of the metric type: title: Metric type type: string enum: - event - metric example: metric description: Metric type valueLabel: title: Metric value label type: string maxLength: 100 description: Metric value label valueFormat: title: Metric value format type: string enum: - id - Number - aws_state - Kilobytes - Percentage - AlertSeverity - Seconds - Bytes - Boolean example: Percentage description: Metric value format metricSelectors: title: List of metric selectors type: array items: type: string example: aws.ec2.cpu.utilization description: List of metric selectors description: Metric to display on a navigator description: List of metrics to retrieve and display for the aggregated view of instances in this navigator. systemTypes: title: Navigator system types type: array maxItems: 10 items: type: string example: - redis description: A list of values for the Splunk Distribution of OpenTelemetry system.type variable associated with this navigator, in the form of an array. Each element is a single system type. This list is used to link the navigator with other navigators. An example of this is the associated dependencies shown in the navigator sidebar in the UI. summaryMetricLabel: title: Label for a summary metric type: string maxLength: 100 example: Active Load Balancers description: Label for the summary metric of this navigator. In the UI, summary metric is the value that appears on the card representing the navigator on the Infrastructure Monitoring landing page. Summary metric label indicates what the summary metric value measures. summaryMetricProgramText: title: SignalFlow program for summary metric type: string example: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') description: SignalFlow program that calculates and displays the current value for the summary metric. tooltipKeyList: title: List of tooltip keys type: array maxItems: 10 example: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value items: type: object title: Tooltip Key required: - property - displayName properties: displayName: title: Tooltip key display name type: string maxLength: 100 example: Availability Zone description: Display name for this tooltip key property format: title: Tooltip key format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this tooltip key. Note: If format is empty, the format defaults to string.' property: title: Property to display for this tooltip key type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to use for the value of this tooltip key description: Tooltip key properties description: A list of keys that appears in a tooltip when you hover over an instance of the integration in this navigator, in the form of a JSON array. Each array element is a single tooltip key. description: Properties of a navigator retrieved by a successful GET /navigator/{id}, in the form of a JSON object. examples: example: value: aggregateDashboards: - DiVWXF8AgAA - DiVV1eUAgAA - DiVWbW3AgAA alertQuery: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) categories: - categoryGroupName: Public Clouds categoryInstanceLabel: service categoryName: Amazon Web Services created: 1550097801307 creator: AAAAAAAAAAA defaultGroupBy: string displayName: Elastic Load Balancers entityMetrics: - coloringScheme: maxValue: 50 minValue: 0 palette: RED_GREEN thresholds: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' displayName: CPU Utilization id: aws.ec2.cpu.utilization job: filters: - not: false property: _exists_ propertyValue: AWSUniqueId type: property resolution: 300000 template: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) varName: CPU_UTILIZATION metricSelectors: - aws.ec2.cpu.utilization type: metric valueFormat: Percentage valueLabel: string id: DzUCanSAEu8 idDisplayName: '{{aws_tag_Name}}' instanceDashboards: - DiVWWU5AYAA - DiVWZODAgAA instanceDisplayText: Elastic Load Balancer instanceLabel: Load Balancer lastUpdated: 1550097801307 lastUpdatedBy: AAAAAAAAAAA listColumns: - displayName: Availability Zone format: Number property: AvailabilityZone navigatorCode: elb ownerScope: organization propertyIdentifierTemplate: '{{LoadBalancerName}} | {{AvailabilityZone}}' summaryMetricLabel: Active Load Balancers summaryMetricProgramText: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') systemTypes: - redis tooltipKeyList: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value '404': description: HTTP 404 response content: application/vnd.splunk.observability.navigator+json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators put: summary: Update Single Navigator description: 'Updates the properties of the navigator with the ID specified in the {id} path parameter. The PUT /navigator/{id} operation has overwrite semantics: For read-write properties, if the value is already specified, a new value in the request body overwrites it. For read-write properties, if the value is already specified, and you don''t specify a value for it, the API updates the property with the default value. For example, if you don''t provide values for listColumns, the updated navigator has an empty array for listColumns. Because of these semantics, follow these steps to explicitly preserve existing values: Send a GET /navigator/{id} request to retrieve the existing navigator property values. Update any read-write properties in the response body with the new values you want to use. Use the response body as the request body in the PUT /navigator/{id} operation to update the navigator. Note: You must be an admin to update a navigator.' parameters: - name: id in: path description: ID of the navigator you want to update. required: true schema: type: string - name: Accept in: header description: Format of the response body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string requestBody: required: true content: application/vnd.splunk.observability.navigator+json: schema: title: Update Navigator Request Body type: object properties: alertQuery: title: Navigator alert query type: string example: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) description: Query that retrieves alerts associated with this navigator. categories: title: Navigator categories list type: array maxItems: 1 items: title: Navigator category type: object required: - categoryName properties: categoryName: title: Category display name type: string maxLength: 50 example: Amazon Web Services description: 'Display name for the category. Note: If this parameter is empty, the display name is "Other".' categoryGroupName: title: Category group name type: string maxLength: 50 example: Public Clouds description: 'Name of the group where this category belongs. Note: If this parameter is empty, the display name is "Other".' categoryInstanceLabel: title: Category instance label type: string maxLength: 50 example: service description: General name for each navigator in this category. description: Details about a category for this navigator. description: 'List of categories where this navigator belongs, in the form of a JSON array. Each element is a single category. Note: If you specify a category object with the same categoryName as the categoryName of an existing category object, the navigator is put into the existing category object and all other fields of the new category object are ignored.' defaultGroupBy: title: Navigator default group by type: string description: A property that indicates how you want to group the instances in the navigator by default. If defaultGroupBy is set then by default, the instances are grouped by this property when you view the navigator. displayName: title: Navigator display name type: string maxLength: 50 example: Elastic Load Balancers description: A short name for the navigator that appears in the UI. entityMetrics: title: Navigator metric information type: array maxItems: 30 items: title: Metric to display on a navigator type: object required: - id - metricSelectors - job - type properties: coloringScheme: title: Metric coloring scheme type: object properties: minValue: title: Minimum value type: integer format: int64 example: 0 description: 'Optional lower bound used for default coloring. Null value indicates that there is no logical lower bound and the minimum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' maxValue: title: Maximum value type: integer format: int64 example: 50 description: 'Optional upper bound used for default coloring. Null value indicates that there is no logical upper bound and the maximum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' palette: title: Coloring palette type: string enum: - RED_GREEN - GREEN_RED - PURPLE_BLUE - BLUE_PURPLE - LEGACY example: RED_GREEN description: 'Color palette for the coloring scheme. These are gradient palettes that flow from one color to the other, based on data points distribution. These are the possible values: RED_GREEN: The palette is a gradient from red to green, with lower values colored in red and higher values colored in green. GREEN_RED: The palette is a gradient from green to red, with lower values colored in green and higher values colored in red. PURPLE_BLUE: The palette is a gradient from purple to blue, with lower values colored in purple and higher values colored in blue. BLUE_PURPLE: The palette is a gradient from blue to purple, with lower values colored in blue and higher values colored in purple. LEGACY: Only available for navigators with ownerScope: splunk. You can''t use this value when creating or updating a navigator with ownerScope: organization.' thresholds: title: Coloring thresholds type: array maxItems: 5 items: title: Coloring threshold properties: lowerLimit: title: Lower limit type: integer format: double description: Lower limit of the threshold paletteIndex: title: Palette index type: integer format: int64 description: 0-based index that specifies which color in the gradient is assigned to the range bounded at the lower limit by this threshold. Possible values are 0 to 4, inclusive. description: Single coloring threshold example: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: Optional list of thresholds to determine colors, in the form of a JSON array. Each element is an individual coloring threshold. description: 'How the heatmap or table nodes are colored for a particular metric. By default, the navigator uses automatic coloring based on the dataset. The default coloring scheme divides the dataset into five segments, defined by the range of colors. If you provide a list of thresholds, then specific thresholds are used to determine coloring. You can provide either minValue and maxValue, or a list of thresholds, but not both.' description: title: Metric description type: string maxLength: 300 example: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' description: Explanation for the coloring scheme of the metric. displayName: title: Metric display name type: string maxLength: 100 example: CPU Utilization description: Metric display name job: title: Metric job type: object required: - resolution - template - varName properties: resolution: title: Resolution of the job type: integer format: int64 example: 300000 description: Resolution of the job in milliseconds template: title: SignaFlow template type: string example: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) description: SignalFlow template that generates the heatmap or list of metrics for display on a navigator varName: title: Variable name type: string example: CPU_UTILIZATION description: Variable name used in the template filters: title: Filter list type: array items: title: Filter for a metric job type: object required: - property properties: property: title: Property key to filter type: string example: _exists_ description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the entity metrics for the navigator, and JobFilter.NOT is true, the system doesn''t display any metric in the navigator.' propertyValue: title: Property values to filter oneOf: - type: string - type: array example: AWSUniqueId description: Property values to filter not: title: Indicates of the property is included or excluded type: boolean default: false example: false description: Flag that indicates how the filter operates. If true, data that matches the criteria is excluded from the filter; otherwise, data that matches the criteria is included. type: title: Property type type: string example: property description: Indicates if this is a custom property or a dimension description: A single filter for a metric job. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches this dimension or custom property. description: List of filters for the job, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property. description: Metric job id: title: Metric name type: string example: aws.ec2.cpu.utilization description: Unique name of the metric type: title: Metric type type: string enum: - event - metric example: metric description: Metric type valueLabel: title: Metric value label type: string maxLength: 100 description: Metric value label valueFormat: title: Metric value format type: string enum: - id - Number - aws_state - Kilobytes - Percentage - AlertSeverity - Seconds - Bytes - Boolean example: Percentage description: Metric value format metricSelectors: title: List of metric selectors type: array items: type: string example: aws.ec2.cpu.utilization description: List of metric selectors description: Metric to display on a navigator description: List of metrics to retrieve and display for the aggregated view of instances in this navigator. id: title: Navigator system ID type: string readOnly: true example: DzUCanSAEu8 description: Unique ID of a navigator. This property is read-only and is generated by the system. idDisplayName: title: Navigator ID display name type: string example: '{{aws_tag_Name}}' description: 'This property value appears as the tooltip title when you hover over the navigator in the UI. Note: If idDisplayName is empty, the navigator ID appears instead.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - DiVWWU5AYAA - DiVWZODAgAA description: List of dashboard IDs you want to show in the instance display of this navigator. Instance view is the view you get when you select an individual instance of the integration from the heatmap or table in the aggregate view of this navigator. instanceDisplayText: title: Instance display text type: string maxLength: 100 example: Elastic Load Balancer description: Description for a single instance of this navigator. This description is used when displaying the long name of a single instance in this navigator. instanceLabel: title: Navigator instance label type: string maxLength: 50 example: Load Balancer description: Label for a single instance of this navigator in the UI. listColumns: title: Navigator column list type: array maxItems: 10 items: title: List column items type: object required: - displayName - property properties: displayName: title: Column display name type: string maxLength: 100 example: Availability Zone description: Column display name format: title: Column format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this column. Note: If format is empty, the format defaults to string.' property: title: Property to display in this column type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to display in this column description: A single column you want to see in the table view of this navigator. description: List of columns you want to see in the table view of this navigator, in the form of a JSON array. Each element is a single column. propertyIdentifierTemplate: title: Template for ID construction type: string example: '{{LoadBalancerName}} | {{AvailabilityZone}}' description: A template used for constructing IDs for the instances in this navigator. Properties inside the left braces and right braces ({{ }}) will be evaluated from the instance and populated with the property value. For example, if you use load balancer name and availability zone to construct an instance ID, an instance ID might look like i-00ddab733ad2a6d47_us-west-1. requiredProperties: title: Properties shared by all instances type: array maxItems: 10 items: type: string example: - LoadBalancerName description: A list of properties shared by all instances of the integration in this navigator. When you select an individual instance to view, each property in the requiredProperties list is used to query for metric time series (MTS) related to that instance. systemTypes: title: Navigator system types type: array maxItems: 10 items: type: string example: - redis description: A list of values for the Splunk Distribution of OpenTelemetry system.type variable associated with this navigator, in the form of an array. Each element is a single system type. This list is used to link the navigator with other navigators. An example of this is the associated dependencies shown in the navigator sidebar in the UI. summaryMetricLabel: title: Label for a summary metric type: string maxLength: 100 example: Active Load Balancers description: Label for the summary metric of this navigator. In the UI, summary metric is the value that appears on the card representing the navigator on the Infrastructure Monitoring landing page. Summary metric label indicates what the summary metric value measures. summaryMetricProgramText: title: SignalFlow program for summary metric type: string example: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') description: SignalFlow program that calculates and displays the current value for the summary metric. tooltipKeyList: title: List of tooltip keys type: array maxItems: 10 example: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value items: type: object title: Tooltip Key required: - property - displayName properties: displayName: title: Tooltip key display name type: string maxLength: 100 example: Availability Zone description: Display name for this tooltip key property format: title: Tooltip key format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this tooltip key. Note: If format is empty, the format defaults to string.' property: title: Property to display for this tooltip key type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to use for the value of this tooltip key description: Tooltip key properties description: A list of keys that appears in a tooltip when you hover over an instance of the integration in this navigator, in the form of a JSON array. Each array element is a single tooltip key. description: Overwritable properties you can include in a request to update a navigator examples: example: value: alertQuery: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) categories: - categoryGroupName: Public Clouds categoryInstanceLabel: service categoryName: Amazon Web Services defaultGroupBy: string displayName: Elastic Load Balancers entityMetrics: - coloringScheme: maxValue: 50 minValue: 0 palette: RED_GREEN thresholds: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' displayName: CPU Utilization id: aws.ec2.cpu.utilization job: filters: - not: false property: _exists_ propertyValue: AWSUniqueId type: property resolution: 300000 template: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) varName: CPU_UTILIZATION metricSelectors: - aws.ec2.cpu.utilization type: metric valueFormat: Percentage valueLabel: string id: DzUCanSAEu8 idDisplayName: '{{aws_tag_Name}}' instanceDashboards: - DiVWWU5AYAA - DiVWZODAgAA instanceDisplayText: Elastic Load Balancer instanceLabel: Load Balancer listColumns: - displayName: Availability Zone format: Number property: AvailabilityZone propertyIdentifierTemplate: '{{LoadBalancerName}} | {{AvailabilityZone}}' requiredProperties: - LoadBalancerName summaryMetricLabel: Active Load Balancers summaryMetricProgramText: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') systemTypes: - redis tooltipKeyList: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value responses: '200': description: HTTP 200 response content: application/vnd.splunk.observability.navigator+json: schema: title: Update Navigator Response Body type: object properties: alertQuery: title: Navigator alert query type: string example: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) description: Query that retrieves alerts associated with this navigator. categories: title: Navigator categories list type: array maxItems: 1 items: title: Navigator category type: object required: - categoryName properties: categoryName: title: Category display name type: string maxLength: 50 example: Amazon Web Services description: 'Display name for the category. Note: If this parameter is empty, the display name is "Other".' categoryGroupName: title: Category group name type: string maxLength: 50 example: Public Clouds description: 'Name of the group where this category belongs. Note: If this parameter is empty, the display name is "Other".' categoryInstanceLabel: title: Category instance label type: string maxLength: 50 example: service description: General name for each navigator in this category. description: Details about a category for this navigator. description: 'List of categories where this navigator belongs, in the form of a JSON array. Each element is a single category. Note: If you specify a category object with the same categoryName as the categoryName of an existing category object, the navigator is put into the existing category object and all other fields of the new category object are ignored.' created: title: Date and time when this navigator was created type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator creator user ID type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who created this navigator. This property is read-only and is generated by the system. defaultGroupBy: title: Navigator default group by type: string description: A property that indicates how you want to group the instances in the navigator by default. If defaultGroupBy is set then by default, the instances are grouped by this property when you view the navigator. displayName: title: Navigator display name type: string maxLength: 50 example: Elastic Load Balancers description: A short name for the navigator that appears in the UI. entityMetrics: title: Navigator metric information type: array maxItems: 30 items: title: Metric to display on a navigator type: object required: - id - metricSelectors - job - type properties: coloringScheme: title: Metric coloring scheme type: object properties: minValue: title: Minimum value type: integer format: int64 example: 0 description: 'Optional lower bound used for default coloring. Null value indicates that there is no logical lower bound and the minimum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' maxValue: title: Maximum value type: integer format: int64 example: 50 description: 'Optional upper bound used for default coloring. Null value indicates that there is no logical upper bound and the maximum value is set based on the range of the dataset. Note: If you specify minValue and maxValue, then maxValue must be greater than minValue.' palette: title: Coloring palette type: string enum: - RED_GREEN - GREEN_RED - PURPLE_BLUE - BLUE_PURPLE - LEGACY example: RED_GREEN description: 'Color palette for the coloring scheme. These are gradient palettes that flow from one color to the other, based on data points distribution. These are the possible values: RED_GREEN: The palette is a gradient from red to green, with lower values colored in red and higher values colored in green. GREEN_RED: The palette is a gradient from green to red, with lower values colored in green and higher values colored in red. PURPLE_BLUE: The palette is a gradient from purple to blue, with lower values colored in purple and higher values colored in blue. BLUE_PURPLE: The palette is a gradient from blue to purple, with lower values colored in blue and higher values colored in purple. LEGACY: Only available for navigators with ownerScope: splunk. You can''t use this value when creating or updating a navigator with ownerScope: organization.' thresholds: title: Coloring thresholds type: array maxItems: 5 items: title: Coloring threshold properties: lowerLimit: title: Lower limit type: integer format: double description: Lower limit of the threshold paletteIndex: title: Palette index type: integer format: int64 description: 0-based index that specifies which color in the gradient is assigned to the range bounded at the lower limit by this threshold. Possible values are 0 to 4, inclusive. description: Single coloring threshold example: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: Optional list of thresholds to determine colors, in the form of a JSON array. Each element is an individual coloring threshold. description: 'How the heatmap or table nodes are colored for a particular metric. By default, the navigator uses automatic coloring based on the dataset. The default coloring scheme divides the dataset into five segments, defined by the range of colors. If you provide a list of thresholds, then specific thresholds are used to determine coloring. You can provide either minValue and maxValue, or a list of thresholds, but not both.' description: title: Metric description type: string maxLength: 300 example: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' description: Explanation for the coloring scheme of the metric. displayName: title: Metric display name type: string maxLength: 100 example: CPU Utilization description: Metric display name job: title: Metric job type: object required: - resolution - template - varName properties: resolution: title: Resolution of the job type: integer format: int64 example: 300000 description: Resolution of the job in milliseconds template: title: SignaFlow template type: string example: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) description: SignalFlow template that generates the heatmap or list of metrics for display on a navigator varName: title: Variable name type: string example: CPU_UTILIZATION description: Variable name used in the template filters: title: Filter list type: array items: title: Filter for a metric job type: object required: - property properties: property: title: Property key to filter type: string example: _exists_ description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the entity metrics for the navigator, and JobFilter.NOT is true, the system doesn''t display any metric in the navigator.' propertyValue: title: Property values to filter oneOf: - type: string - type: array example: AWSUniqueId description: Property values to filter not: title: Indicates of the property is included or excluded type: boolean default: false example: false description: Flag that indicates how the filter operates. If true, data that matches the criteria is excluded from the filter; otherwise, data that matches the criteria is included. type: title: Property type type: string example: property description: Indicates if this is a custom property or a dimension description: A single filter for a metric job. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches this dimension or custom property. description: List of filters for the job, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property. description: Metric job id: title: Metric name type: string example: aws.ec2.cpu.utilization description: Unique name of the metric type: title: Metric type type: string enum: - event - metric example: metric description: Metric type valueLabel: title: Metric value label type: string maxLength: 100 description: Metric value label valueFormat: title: Metric value format type: string enum: - id - Number - aws_state - Kilobytes - Percentage - AlertSeverity - Seconds - Bytes - Boolean example: Percentage description: Metric value format metricSelectors: title: List of metric selectors type: array items: type: string example: aws.ec2.cpu.utilization description: List of metric selectors description: Metric to display on a navigator description: List of metrics to retrieve and display for the aggregated view of instances in this navigator. id: title: Navigator system ID type: string readOnly: true example: DzUCanSAEu8 description: Unique ID of a navigator. This property is read-only and is generated by the system. idDisplayName: title: Navigator ID display name type: string example: '{{aws_tag_Name}}' description: 'This property value appears as the tooltip title when you hover over the navigator in the UI. Note: If idDisplayName is empty, the navigator ID appears instead.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - DiVWWU5AYAA - DiVWZODAgAA description: List of dashboard IDs you want to show in the instance display of this navigator. Instance view is the view you get when you select an individual instance of the integration from the heatmap or table in the aggregate view of this navigator. instanceDisplayText: title: Instance display text type: string maxLength: 100 example: Elastic Load Balancer description: Description for a single instance of this navigator. This description is used when displaying the long name of a single instance in this navigator. instanceLabel: title: Navigator instance label type: string maxLength: 50 example: Load Balancer description: Label for a single instance of this navigator in the UI. lastUpdated: title: Navigator last updated time type: integer format: int64 readOnly: true example: 1550097801307 description: Date and time the navigator was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator type: string readOnly: true example: AAAAAAAAAAA description: User ID of the user who last updated this navigator. This property is read-only and is generated by the system. listColumns: title: Navigator column list type: array maxItems: 10 items: title: List column items type: object required: - displayName - property properties: displayName: title: Column display name type: string maxLength: 100 example: Availability Zone description: Column display name format: title: Column format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this column. Note: If format is empty, the format defaults to string.' property: title: Property to display in this column type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to display in this column description: A single column you want to see in the table view of this navigator. description: List of columns you want to see in the table view of this navigator, in the form of a JSON array. Each element is a single column. ownerScope: title: How the navigator was created type: string enum: - splunk - organization readOnly: true example: organization description: 'Indicates how the navigator was created. These are the possible values: splunk: Navigator is a built-in navigator. organization: Navigator was created by a user using the API. Note: You can only use organization when creating or updating navigators. If you try to pass an invalid value for ownerScope when creating or updating detectors, you will receive a 403 response and an error message saying "Cannot change or export built-in navigators in this org".' propertyIdentifierTemplate: title: Template for ID construction type: string example: '{{LoadBalancerName}} | {{AvailabilityZone}}' description: A template used for constructing IDs for the instances in this navigator. Properties inside the left braces and right braces ({{ }}) will be evaluated from the instance and populated with the property value. For example, if you use load balancer name and availability zone to construct an instance ID, an instance ID might look like i-00ddab733ad2a6d47_us-west-1. requiredProperties: title: Properties shared by all instances type: array maxItems: 10 items: type: string example: - LoadBalancerName description: A list of properties shared by all instances of the integration in this navigator. When you select an individual instance to view, each property in the requiredProperties list is used to query for metric time series (MTS) related to that instance. systemTypes: title: Navigator system types type: array maxItems: 10 items: type: string example: - redis description: A list of values for the Splunk Distribution of OpenTelemetry system.type variable associated with this navigator, in the form of an array. Each element is a single system type. This list is used to link the navigator with other navigators. An example of this is the associated dependencies shown in the navigator sidebar in the UI. summaryMetricLabel: title: Label for a summary metric type: string maxLength: 100 example: Active Load Balancers description: Label for the summary metric of this navigator. In the UI, summary metric is the value that appears on the card representing the navigator on the Infrastructure Monitoring landing page. Summary metric label indicates what the summary metric value measures. summaryMetricProgramText: title: SignalFlow program for summary metric type: string example: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') description: SignalFlow program that calculates and displays the current value for the summary metric. tooltipKeyList: title: List of tooltip keys type: array maxItems: 10 example: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value items: type: object title: Tooltip Key required: - property - displayName properties: displayName: title: Tooltip key display name type: string maxLength: 100 example: Availability Zone description: Display name for this tooltip key property format: title: Tooltip key format type: string enum: - id - Number - Kilobytes - Bytes - Seconds - Age - Percentage - ScaleBytes - ScaleKilobytes - Boolean - AlertSeverity - aws_state example: Number description: 'Format of the values in this tooltip key. Note: If format is empty, the format defaults to string.' property: title: Property to display for this tooltip key type: string maxLength: 100 example: AvailabilityZone description: Name of the dimension or custom property to use for the value of this tooltip key description: Tooltip key properties description: A list of keys that appears in a tooltip when you hover over an instance of the integration in this navigator, in the form of a JSON array. Each array element is a single tooltip key. description: Response body returned when the Update Single Navigator operation (PUT /navigator/{id}) successfully updates a navigator. examples: example: value: alertQuery: _exists_:AWSUniqueId AND (namespace:"AWS/EC2" OR cloud.platform:aws_ec2) categories: - categoryGroupName: Public Clouds categoryInstanceLabel: service categoryName: Amazon Web Services created: 1550097801307 creator: AAAAAAAAAAA defaultGroupBy: string displayName: Elastic Load Balancers entityMetrics: - coloringScheme: maxValue: 50 minValue: 0 palette: RED_GREEN thresholds: - lowerLimit: 0 paletteIndex: 0 - lowerLimit: 10 paletteIndex: 1 - lowerLimit: 100 paletteIndex: 2 - lowerLimit: 1000 paletteIndex: 3 - lowerLimit: 10000 paletteIndex: 4 description: 'Color hosts based on percentage of CPU being used: under 20% (green) to over 80% (red)' displayName: CPU Utilization id: aws.ec2.cpu.utilization job: filters: - not: false property: _exists_ propertyValue: AWSUniqueId type: property resolution: 300000 template: CPU_UTILIZATION = data("^aws.ec2.cpu.utilization"{{#filter}}, filter={{{filter}}}{{/filter}}, extrapolation="last_value", maxExtrapolations=2).mean(by=["AWSUniqueId"]) varName: CPU_UTILIZATION metricSelectors: - aws.ec2.cpu.utilization type: metric valueFormat: Percentage valueLabel: string id: DzUCanSAEu8 idDisplayName: '{{aws_tag_Name}}' instanceDashboards: - DiVWWU5AYAA - DiVWZODAgAA instanceDisplayText: Elastic Load Balancer instanceLabel: Load Balancer lastUpdated: 1550097801307 lastUpdatedBy: AAAAAAAAAAA listColumns: - displayName: Availability Zone format: Number property: AvailabilityZone ownerScope: organization propertyIdentifierTemplate: '{{LoadBalancerName}} | {{AvailabilityZone}}' requiredProperties: - LoadBalancerName summaryMetricLabel: Active Load Balancers summaryMetricProgramText: A = data('RequestCount', filter=filter('namespace', 'AWS/ELB') and filter('stat', 'sum') and filter('LoadBalancerName', '*') and filter('AvailabilityZone', '*'), rollup='rate', extrapolation='last_value', maxExtrapolations=2).sum(by=['LoadBalancerName', 'AWSUniqueId', 'AvailabilityZone']).count().publish(label='A') systemTypes: - redis tooltipKeyList: - displayName: Node Id format: null property: CacheNodeId - displayName: Cluster Id format: null property: CacheClusterId - displayName: Cluster Name format: null property: aws_cache_cluster_name - displayName: Region format: null property: aws_region - displayName: Value format: Number property: value '400': description: HTTP 400 response content: application/vnd.splunk.observability.navigator+json: schema: type: object properties: code: type: integer format: int32 example: 400 description: HTTP response code. Always '400' message: type: string description: Error explanation examples: example: value: code: 400 message: string security: - SessionToken: [] tags: - Navigators delete: summary: Delete Single Navigator parameters: - name: id in: path description: ID of the navigator you want to delete required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '204': description: HTTP 204 response '403': description: HTTP 403 response content: application/vnd.splunk.observability.navigator+json: schema: type: object properties: code: type: integer format: int32 example: 403 description: HTTP response code. Always '403' message: type: string description: Error explanation examples: example: value: code: 403 message: string '404': description: HTTP 404 response content: application/vnd.splunk.observability.navigator+json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators /navigator/{id}/dashboards: get: summary: Retrieve Single Navigator Dashboards description: Retrieves all dashboards associated with the navigator that has the ID specified in the {id} path parameter. parameters: - name: id in: path description: ID of the navigator for which you want to retrieve all dashboards required: true schema: type: string - name: type in: query description: 'Type of dashboards to retrieve for this navigator. These are the possible values: aggregate: Retrieve all aggregate dashboards associated with this navigator. instance: Retrieve all instance dashboards associated with this navigator.' required: true schema: type: string enum: - aggregate - instance - name: Accept in: header description: Format of the response body. Always "application/vnd.splunk.observability.navigator+json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/vnd.splunk.observability.navigator+json: schema: title: Valid Get Navigator Dashboards Response type: object properties: aggregateDashboards: title: Dashboard object array for aggregate display type: array items: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. description: All aggregate dashboards associated with this navigator, in the form of an array of dashboard objects. instanceDashboards: title: Dashboard object array for instance display type: array items: type: object properties: authorizedWriters: title: Users and teams with that can modify this dashboard type: object properties: teams: type: array items: type: string example: - ZZZZ4 - Z2X description: 'List of team IDs that have write access to this dashboard, in the form of a JSON array of strings' users: type: array items: type: string example: - YXXX - XYYY description: 'List of user IDs that have write access to this dashboard, in the form of a JSON array of strings' description: 'If the write permissions feature is available for your organization, you can use these properties to specify the user and team IDs that have write access to the chart of dashboard.' chartDensity: type: string default: DEFAULT enum: - DEFAULT - LOW - HIGH - HIGHEST example: DEFAULT title: DashboardChartDensity description: 'Controls the number of data points displayed in the charts for this dashboard, over the time span specified for the charts: DEFAULT maps to approximately 60 data points LOW maps to approximately 30 data points HIGH maps to approximately 120 data points HIGHEST maps to approximately 240 data points' charts: type: array items: title: Dashboard settings for a chart in a dashboard type: object required: - chartId - column - row - height - width properties: chartId: type: string example: XY1XX5 description: 'ID of an existing chart. Because charts can only belong to one dashboard, you can''t associate this ID with any other dashboard.' column: type: integer minimum: 0 maximum: 11 example: 5 description: '0-based index of the horizontal position of the chart in the dashboard display. The position represents the left-most edge of the chart. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 11, the chart displays in the UI as if 11 was specified. If that column is already occupied in the specified row, the system displays the chart in the first free row from the top in the specified column.' height: type: integer minimum: 1 maximum: 3 example: 2 description: 'Number of rows this chart should span. Note: The API doesn''t validate the maximum value. However, if you specify a value greater than 3, the chart displays in the UI as if 3 was specified. If the total height of all specified charts in a column is greater than 100, the system recalculates the layout to fit all the specified charts into the display of the dashboard.' row: type: integer minimum: 0 maximum: 99 example: 10 description: '0-based index of the vertical position of the chart in the dashboard display. The position The value represents the top-most edge of the chart. the system moves charts upwards as needed to fill vertical gaps. If you specify the same column and row value for more than one chart, the system tries to reconfigure the layout. If there''s space, the dashboard retains the column value and spreads out over additional rows. The API doesn''t validate the maximum value. However, if you specify a value greater than 99, the chart displays as if 0 were specified. If that row is already occupied, the system displays the first free row from the top of the specified column.' width: type: integer minimum: 1 maximum: 12 example: 7 description: 'Number of columns this chart should span. The API doesn''t validate the maximum value. However, if you use a value greater than 12, the chart displays as if you specified 12. If the total width of all specified charts in a row is greater than 100, the system recalculates the layout so that all the specified charts fit into the display.' description: 'Dashboard settings for the chart specified in chartId. These settings control how the chart appears in the dashboard.' title: DashboardChartSettings description: 'List of IDs for the charts you want to include in the dashboard, and for each chart the dashboard settings to use, in the form of a JSON array of JSON objects. The dashboard settings for charts control how Splunk Observability Cloud arranges charts in a dashboard when the charts appear in the UI.' created: type: integer format: int64 example: 1641024000000 title: DashboardCreated description: 'The dashboard creation timestamp, in *nix time in milliseconds The system sets this value, and you can''t modify it.' creator: type: string example: XXYYX title: DashboardCreator description: 'ID of the user that created the dashboard. If Splunk Observability Cloud created this dashboard, the value is AAAAAAAAAA. The system sets this value, and you can''t modify it.' customProperties: type: string title: DashboardCustomProperties description: not used description: type: string example: Latency measurements title: DashboardDescription description: 'Description of the dashboard. The system displays the value in the dashboard tab tooltip in the dashboard group in the UI.' discoveryOptions: type: object title: DashboardDiscoveryOptions description: Reserved for system use eventOverlays: type: array items: title: Filter to apply to event overlays type: object required: - property - value properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' eventColorIndex: type: integer minimum: 0 maximum: 15 example: 5 description: 'Color to use for events, in the form of an integer index into the color table displayed in table 5 Color palette in the section Chart color palettes. Only the first 16 entries (0-15) are allowed for this value. Users may see colors other than those shown in the table, depending on the settings they select for color blindness. To see sample swatches of the alternate colors and the mappings used for color-blind users, see the hexadecimal color codes for the first 16 entries in table 6, Color vision deficiency alternatives in the section Chart color palettes.' eventLine: type: boolean default: false example: true description: 'Controls the display of vertical event lines in the charts that belong to the dashboard. If true, the system displays event lines; otherwise, no event lines appear.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Filters to apply to event overlays, in the form of a JSON object containing comparison expression properties. Each term in the expression tries to match the values of a dimension or custom property to criteria you specify. Based on the match results, you can include or exclude an event.' title: DashboardEventOverlays description: 'List of event overlay definitions that you can apply to all of the charts of this dashboard, in the form of a JSON array of JSON objects. When you apply the overlays, the system displays all the active events that match the specified search term and any specified filter on all the charts in the dashboard. The display uses the color you specify for the overlay and, if selected, vertical lines that mark the event. Note: The objects in this array correspond to the suggested event overlays specified in the UI, and they''re not automatically applied as active overlays. To set default active event overlays, use the selectedEventOverlays property instead.' filters: title: Filters to apply to all the charts of a dashboard type: object properties: sources: type: array items: title: Filter to apply to charts in a dashboard type: object required: - property - value properties: NOT: type: boolean default: false example: false description: 'Flag that indicates how the filter should operate. If true, data that matches the criteria is excluded from charts; otherwise, data that matches the criteria is included.' property: type: string example: host description: 'Name of the dimension or custom property to match to the data. Note: If the dimension or custom property doesn''t exist in any of the charts for the dashboard, and ChartsFilter.NOT is true, the system doesn''t display any data in the charts.' value: type: array items: type: string example: - host5 - host6 description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'A single filter to apply to the charts in the dashboard. The filter specifies a default or user-defined dimension or custom property. You can either include or exclude all the data that matches the dimension or custom property.' description: 'List of filters to apply to the charts in the dashboard, in the form of a JSON array. Each element is a single filter for a default or user-defined dimension or custom property.' time: type: object properties: end: type: string example: 1647943200000 description: 'The end of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the end property for each chart. Note: The specified type for end is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' start: type: string example: 1647936000000 description: 'The start of the time range to show for all charts in the dashboard. If you don''t specify a value for this property, the system defaults to the value of the start property for each chart. Note: The specified type for start is string, but the system also accepts a 64-bit signed integer >= 0 that represents a time in *nix time in milliseconds.' description: 'Time range to show in all of the charts in the dashboard, in the form of a JSON object. The specifications in this object override those in each individual chart. If you don''t specify values, the system defaults to using the individual time setting for each chart.' variables: type: array items: title: Filter that appears in the UI type: object required: - property - value properties: alias: type: string example: Europe description: 'A label for the filter. The system displays this label in the area preceding the input textarea for the filter in the UI. Note: A good way to indicate that the string is a label is to append a space and a colon (":") to it.' preferredSuggestions: type: array items: type: string example: - Europe - Asia description: 'List of strings containing values to place at the top of the Suggested Values dropdown in UI for the dashboard, in the form of a JSON array. If ChartsWebUIFilter.restricted is true, the filter must use one of the values in this array; users only have a choice of selecting a value from this array.' property: type: string example: datacenter description: 'Name of a custom property or dimension to filter against. Note: If the dimension or custom property doesn''t exist in any of the charts in the dashboard, the system doesn''t display any data in the charts.' required: type: boolean default: false example: true description: 'Flag that controls the display of chart data. If true, users must use this filter in order to see data; otherwise, users can delete the filter.' restricted: type: boolean default: false example: true description: 'Flag that controls the values allowed in the filter. If true, the only allowable values are those specified in the ChartsWebUIFilter.preferredSuggestions array; otherwise, any value is allowed.' value: type: array items: type: string example: - London - Paris description: 'A list of values to compare to the value of the dimension or custom property specified in ChartsWebUIFilter.property. If the list contains more than one value, the filter becomes a set of queries between the value of property and each element of value. The system joins these queries with an implicit OR.' description: 'The specification for a filter that appears in the UI. The filter compares the value of a dimension or custom property to a value specified in this filter. You can specify the following in the filter: A default value A list of suggested values to display in the UI A flag that controls user input; if set to true, users are limited to the default and suggested values. You can also force users to choose this filter in order to see data in the charts of this dashboard.' description: 'List of UI-oriented filters that appear at the top of the dashboard, in the form of a JSON array of JSON objects. For each filter you can specify a name and a label for the dimension or custom property to filter against, a list of suggested comparison values to display in the UI, and other properties that control the UI display. To see a more detailed description of the options, see the property descriptions for the ChartsWebUIFilter model.' description: 'Specifies the properties of filters to apply to the dashboard. Filters give you fine-grained control over the data displayed in the charts in the dashboard. You can specify ad hoc filters or save them as variables for repeated use of the filter criteria. You can also use filters to apply a custom time window to all of the charts in the dashboard.' groupId: type: string example: YYXXYY title: DashboardGroupId description: 'ID of an existing dashboard group to associate with this dashboard. If you don''t specify a value, the system creates a new dashboard group and assigns its ID to this property during the create process.' id: type: string example: ZZZXXXX title: DashboardId description: 'The ID of the dashboard. This value is read-only for a create request. Splunk Observability Cloud assigns it and returns it to you in the response.' lastUpdated: type: integer format: int64 example: 1647990000000 title: DashboardLastUpdated description: 'The last time the dashboard was updated, in *nix time in milliseconds. The system sets this value, and you can''t modify it.' lastUpdatedBy: type: string example: XXXX888 title: DashboardLastUpdatedBy description: 'ID of the last user who updated the dashboard. If the last update was by Splunk Observability Cloud, the value is AAAAAAAAAA. This value is read-only.' maxDelayOverride: type: integer format: int32 example: 1000 title: DashboardMaxDelayOverride description: 'Milliseconds to wait for late-arriving data points before rejecting them for inclusion in the charts in this dashboard. This value overrides but doesn''t change the max delay setting for individual charts in the dashboard. If you omit this property, the system uses individual chart settings. For individual charts, you can force the system to calculate a sensible value by removing the maxDelayOverride property of the chart. To force the system to do this for all charts in a dashboard, set CreateDashboardBody.maxDelayOverride to 0.' name: type: string example: Latency title: DashboardName description: 'A human-readable label for the dashboard. The UI displays this label in the dashboard group for the dashboard' selectedEventOverlays: type: array items: title: Event overlay for charts in a dashboard type: object required: - eventSignal properties: eventSignal: title: A search term that selects charts to overlay type: object required: - eventSearchText properties: eventSearchText: type: string example: ValueExceeded description: 'The event name or partial name that the system uses to select events to suggest as overlays on the charts in the dashboard' eventType: type: string enum: - detectorEvents - eventTimeSeries example: detectorEvents description: 'Controls the source of the event. You can specify the following: detectorEvents: Select events that come from a detector eventTimeSeries: Select events that come from a time series The API doesn''t accept other event types.' description: 'A filter that selects charts to overlay with events, based on event names and types' overlayId: type: string example: E5 description: 'Unique ID for this event overlay. Use this ID with any element of the selectedEventOverlays property to apply this overlay to a dashboard. Note: The system generates this value if you don''t specify one.' sources: type: array items: properties: NOT: type: boolean default: false example: false description: 'Controls the action of the filter. If set to true, then the system only selects events that don''t match the filter.' property: type: string example: datacenter description: 'The custom property or dimension name that provides the value to test in the filter. If the name you specify isn''t defined in one or more of the events associated with the dashboard, the filter never matches anything. If the NOT property for this filter is set to true and the filter never matches, all event overlays are suppressed.' value: type: array items: type: string example: - Paris - London description: 'An array of values to test against the specified property. If any of the values match, the system includes the event. Note: You must specify at least one element.' title: DashboardEventSources description: 'List of filters to apply to events for this event overlay, in the form of a JSON array.' description: 'Settings for an event overlay applied to each chart in a dashboard. You specify the event overlays for a dashboard with two different properties: CreateDashboardBody.EventOverlays: Inactive event overlays that you want to define for use at a later time. CreateDashboardBody.selectedEventOverlays: Active event overlays that you want to apply immediately to charts in the dashboard.' title: DashboardSelectedEventOverlays description: 'List of event overlays that are currently active for the charts in this dashboard, in the form of a JSON array of JSON objects. For each overlay, the system displays the active events that match the overlay search term and optional feature, using the color and event line settings for the overlay. To set options for inactive overlays so you can apply them at a later time, use the eventOverlays property instead.' tags: type: array items: type: string title: DashboardTags description: not used permissions: title: Permission configuration for the dashboard type: object properties: acl: type: array items: title: An access control layer type: object properties: actions: type: array items: type: string enum: - READ - WRITE description: Action the user, team, or organization can take with the dashboard. principalType: type: string enum: - USER - TEAM - ORG description: Clarify whether this permission configuration is for a user, a team, or an organization. principalId: type: string description: ID of the user, team, or organization for which you're granting permissions. description: A permission configuration for a user, team, or organization. description: 'List of permission configurations. Use this list to specify read and write permissions for your dashboard. The parent property is set to null by default if you do this. Use the parent property instead if you want your dashboard to inherit permissions from an existing dashboard group.' parent: type: string description: 'ID of the dashboard group you want your dashboard to inherit permissions from. Use this property to configure your dashboard to inherit permissions from an existing dashboard group. Use the acl property instead if you want to specify various read and write permission configurations.' description: Read and write permission configuration to specify which user, team, and organization can view and/or edit your dashboard. description: All instance dashboards associated with this navigator, in the form of an array of dashboard objects. description: Dashboards associated with a navigator retrieved by a successful GET /navigator/{id}/dashboards, in the form of a JSON object. examples: example: value: aggregateDashboards: - authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string instanceDashboards: - authorizedWriters: teams: - ZZZZ4 - Z2X users: - YXXX - XYYY chartDensity: DEFAULT charts: - chartId: XY1XX5 column: 5 height: 2 row: 10 width: 7 created: 1641024000000 creator: XXYYX customProperties: string description: Latency measurements eventOverlays: - eventColorIndex: 5 eventLine: true eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents sources: - NOT: false property: datacenter value: - Paris - London filters: sources: - NOT: false property: host value: - host5 - host6 time: end: 1647943200000 start: 1647936000000 variables: - alias: Europe preferredSuggestions: - Europe - Asia property: datacenter required: true restricted: true value: - London - Paris groupId: YYXXYY id: ZZZXXXX lastUpdated: 1647990000000 lastUpdatedBy: XXXX888 maxDelayOverride: 1000 name: Latency permissions: acl: - actions: - READ principalId: string principalType: USER parent: string selectedEventOverlays: - eventSignal: eventSearchText: ValueExceeded eventType: detectorEvents overlayId: E5 sources: - NOT: false property: datacenter value: - Paris - London tags: - string '404': description: HTTP 404 response content: application/vnd.splunk.observability.navigator+json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators /navigator/{id}/navigatorcustomization: get: summary: Retrieve All Navigator Customizations description: Retrieves the properties of all navigator customization objects associated with the navigator ID specified in the {id} path parameter. parameters: - name: id in: path description: ID of the navigator you want to retrieve. required: true schema: type: string - name: limit in: query description: Number of navigators to retrieve from the list of navigators that match your search criteria. schema: type: integer format: int32 default: 200 example: 100 - name: offset in: query description: 0-based index of the point in the query results where the system starts returning navigators. If the offset value is greater than the size of the result set, you don't receive any results. schema: type: integer format: int32 - name: orderBy in: query description: The field on which the API should sort the query results. The API only supports fields specified in the enum. schema: type: string enum: - creator - created - lastUpdated - lastUpdatedBy default: lastUpdated - name: Accept in: header description: Format of the response body. Always "application/json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/json: schema: title: Valid Get All Navigator Customizations Response type: object properties: count: type: integer format: int32 description: 'Number of navigators that matched the provided search criteria. Note: This value is the total number of matches, not the number of navigators returned. The number of navigators that the system returns is affected by the limit and offset query parameters. In summary: sizeOf(results): Number of navigators returned in the response body. count: Number of navigators that match the search criteria.' results: type: array items: type: object properties: created: title: Date and time when this navigator customization was created type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator customization creator user ID type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who created this navigator customization. This property is read-only and is generated by the system. lastUpdated: title: Navigator customization last updated time type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator customization type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who last updated this navigator customization. This property is read-only and is generated by the system. id: title: Navigator customization system ID type: string readOnly: true example: F4vLmvyAwAb description: The UUID of this navigator customization object. This property is read-only and is generated by the system. name: title: Navigator customization display name type: string maxLength: 150 example: Customization for AWS EC2 from 2023-08-23 22:45:45 description: Required. A name for the navigator customization that appears in the UI. navigatorId: title: Navigator system ID type: string readOnly: true example: F4To0t7AEAA description: The ID of the navigator that you want to customize. This property is read-only and is generated by the system. aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - id: F4MX9uNAYDE hidden: false - id: F5MA9uTAYFE hidden: true - '...' description: 'An ordered list of dashboard IDs to display in the aggregate view of the navigator. Can be used to reorder dashboards, add custom dashboards, and hide existing built-in dashboards. Built-in dashboards can be marked as hidden, but not removed from the list. A complex object that requires an indicator for a hidden field. You can’t hide all of the fields. At least one non-hidden field must exist.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - id: F4MeweuAgAA hidden: false - id: A4MenbuAgTA hidden: true - '...' title: GetNavigatorCustomizationsResult description: Results of a query to retrieve all navigator customizations, in the form of a JSON array of navigatorcustomization objects. Each element is a navigator customization object. description: Properties in the response body of a successful retrieval of navigator customizations examples: example: value: count: 0 results: - aggregateDashboards: - hidden: false id: F4MX9uNAYDE - hidden: true id: F5MA9uTAYFE - '...' created: 1771192844528 creator: FBBVcWRNUPP id: F4vLmvyAwAb instanceDashboards: - hidden: false id: F4MeweuAgAA - hidden: true id: A4MenbuAgTA - '...' lastUpdated: 1771192844528 lastUpdatedBy: FBBVcWRNUPP name: Customization for AWS EC2 from 2023-08-23 22:45:45 navigatorId: F4To0t7AEAA '404': description: HTTP 404 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators post: summary: Create Navigator Customization description: 'Creates a navigator customization object, which customizes the dashboards for a built-in navigator. You can customize dashboards to: Add additional dashboards (including built-in and custom dashboards) to a navigator. Reorder the list of dashboards. Hide built-in dashboards. Note: You need to be an admin to create a new navigator. You can only create one navigator customization per navigator.' parameters: - name: id in: path description: ID of the navigator you want to create a customization for. required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always "application/json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: id: title: Navigator customization system ID type: string readOnly: true example: F4vLmvyAwAb description: The UUID of this navigator customization object. This property is read-only and is generated by the system. name: title: Navigator customization display name type: string maxLength: 150 example: Customization for AWS EC2 from 2023-08-23 22:45:45 description: Required. A name for the navigator customization that appears in the UI. navigatorId: title: Navigator system ID type: string readOnly: true example: F4To0t7AEAA description: The ID of the navigator that you want to customize. This property is read-only and is generated by the system. aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - id: F4MX9uNAYDE hidden: false - id: F5MA9uTAYFE hidden: true - '...' description: 'An ordered list of dashboard IDs to display in the aggregate view of the navigator. Can be used to reorder dashboards, add custom dashboards, and hide existing built-in dashboards. Built-in dashboards can be marked as hidden, but not removed from the list. A complex object that requires an indicator for a hidden field. You can’t hide all of the fields. At least one non-hidden field must exist.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - id: F4MeweuAgAA hidden: false - id: A4MenbuAgTA hidden: true - '...' created: title: Date and time when this navigator customization was created type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator customization creator user ID type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who created this navigator customization. This property is read-only and is generated by the system. lastUpdated: title: Navigator customization last updated time type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator customization type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who last updated this navigator customization. This property is read-only and is generated by the system. title: CreateNavigatorCustomizationRequest examples: example: value: aggregateDashboards: - hidden: false id: F4MX9uNAYDE - hidden: true id: F5MA9uTAYFE - '...' created: 1771192844528 creator: FBBVcWRNUPP id: F4vLmvyAwAb instanceDashboards: - hidden: false id: F4MeweuAgAA - hidden: true id: A4MenbuAgTA - '...' lastUpdated: 1771192844528 lastUpdatedBy: FBBVcWRNUPP name: Customization for AWS EC2 from 2023-08-23 22:45:45 navigatorId: F4To0t7AEAA responses: '201': description: HTTP 201 response content: application/json: schema: type: object properties: id: title: Navigator customization system ID type: string readOnly: true example: F4vLmvyAwAb description: The UUID of this navigator customization object. This property is read-only and is generated by the system. name: title: Navigator customization display name type: string maxLength: 150 example: Customization for AWS EC2 from 2023-08-23 22:45:45 description: Required. A name for the navigator customization that appears in the UI. navigatorId: title: Navigator system ID type: string readOnly: true example: F4To0t7AEAA description: The ID of the navigator that you want to customize. This property is read-only and is generated by the system. aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - id: F4MX9uNAYDE hidden: false - id: F5MA9uTAYFE hidden: true - '...' description: 'An ordered list of dashboard IDs to display in the aggregate view of the navigator. Can be used to reorder dashboards, add custom dashboards, and hide existing built-in dashboards. Built-in dashboards can be marked as hidden, but not removed from the list. A complex object that requires an indicator for a hidden field. You can’t hide all of the fields. At least one non-hidden field must exist.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - id: F4MeweuAgAA hidden: false - id: A4MenbuAgTA hidden: true - '...' created: title: Date and time when this navigator customization was created type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator customization creator user ID type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who created this navigator customization. This property is read-only and is generated by the system. lastUpdated: title: Navigator customization last updated time type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator customization type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who last updated this navigator customization. This property is read-only and is generated by the system. title: CreateNavigatorCustomizationRequest examples: example: value: aggregateDashboards: - hidden: false id: F4MX9uNAYDE - hidden: true id: F5MA9uTAYFE - '...' created: 1771192844528 creator: FBBVcWRNUPP id: F4vLmvyAwAb instanceDashboards: - hidden: false id: F4MeweuAgAA - hidden: true id: A4MenbuAgTA - '...' lastUpdated: 1771192844528 lastUpdatedBy: FBBVcWRNUPP name: Customization for AWS EC2 from 2023-08-23 22:45:45 navigatorId: F4To0t7AEAA '400': description: HTTP 400 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 400 description: HTTP response code. Always '400' message: type: string description: Error explanation examples: example: value: code: 400 message: string '403': description: HTTP 403 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 403 description: HTTP response code. Always '403' message: type: string description: Error explanation examples: example: value: code: 403 message: string security: - SessionToken: [] tags: - Navigators /navigator/{id}/navigatorcustomization/{customizationId}: get: summary: Retrieve A Navigator Customizations description: Retrieves the properties of a navigator customization object that has the ID specified in the {customizationId} path parameter. parameters: - name: id in: path description: ID of the navigator you want to retrieve. required: true schema: type: string - name: customizationId in: path description: ID of the navigator customization object you want to retrieve. required: true schema: type: string - name: Accept in: header description: Format of the response body. Always "application/json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '200': description: HTTP 200 response content: application/json: schema: title: Valid Get All Navigator Customizations Response type: object properties: count: type: integer format: int32 description: 'Number of navigators that matched the provided search criteria. Note: This value is the total number of matches, not the number of navigators returned. The number of navigators that the system returns is affected by the limit and offset query parameters. In summary: sizeOf(results): Number of navigators returned in the response body. count: Number of navigators that match the search criteria.' results: type: array items: type: object properties: created: title: Date and time when this navigator customization was created type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator customization creator user ID type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who created this navigator customization. This property is read-only and is generated by the system. lastUpdated: title: Navigator customization last updated time type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator customization type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who last updated this navigator customization. This property is read-only and is generated by the system. id: title: Navigator customization system ID type: string readOnly: true example: F4vLmvyAwAb description: The UUID of this navigator customization object. This property is read-only and is generated by the system. name: title: Navigator customization display name type: string maxLength: 150 example: Customization for AWS EC2 from 2023-08-23 22:45:45 description: Required. A name for the navigator customization that appears in the UI. navigatorId: title: Navigator system ID type: string readOnly: true example: F4To0t7AEAA description: The ID of the navigator that you want to customize. This property is read-only and is generated by the system. aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - id: F4MX9uNAYDE hidden: false - id: F5MA9uTAYFE hidden: true - '...' description: 'An ordered list of dashboard IDs to display in the aggregate view of the navigator. Can be used to reorder dashboards, add custom dashboards, and hide existing built-in dashboards. Built-in dashboards can be marked as hidden, but not removed from the list. A complex object that requires an indicator for a hidden field. You can’t hide all of the fields. At least one non-hidden field must exist.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - id: F4MeweuAgAA hidden: false - id: A4MenbuAgTA hidden: true - '...' title: GetNavigatorCustomizationsResult description: Results of a query to retrieve all navigator customizations, in the form of a JSON array of navigatorcustomization objects. Each element is a navigator customization object. description: Properties in the response body of a successful retrieval of navigator customizations examples: example: value: count: 0 results: - aggregateDashboards: - hidden: false id: F4MX9uNAYDE - hidden: true id: F5MA9uTAYFE - '...' created: 1771192844528 creator: FBBVcWRNUPP id: F4vLmvyAwAb instanceDashboards: - hidden: false id: F4MeweuAgAA - hidden: true id: A4MenbuAgTA - '...' lastUpdated: 1771192844528 lastUpdatedBy: FBBVcWRNUPP name: Customization for AWS EC2 from 2023-08-23 22:45:45 navigatorId: F4To0t7AEAA '404': description: HTTP 404 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators put: summary: Update Single Navigator Customization description: 'Updates the properties of the navigator customization with the IDs specified in the {id} and {customizationId} path parameters. Note: You must be an admin to update a navigator customization.' parameters: - name: id in: path description: ID of the navigator you want to update. required: true schema: type: string - name: customizationId in: path description: ID of the navigator customization object you want to update. required: true schema: type: string - name: Accept in: header description: Format of the response body. Always "application/json". required: true schema: type: string - name: Content-Type in: header description: Format of the request body. Always "application/json". required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: id: title: Navigator customization system ID type: string readOnly: true example: F4vLmvyAwAb description: The UUID of this navigator customization object. This property is read-only and is generated by the system. name: title: Navigator customization display name type: string maxLength: 150 example: Customization for AWS EC2 from 2023-08-23 22:45:45 description: Required. A name for the navigator customization that appears in the UI. navigatorId: title: Navigator system ID type: string readOnly: true example: F4To0t7AEAA description: The ID of the navigator that you want to customize. This property is read-only and is generated by the system. aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - id: F4MX9uNAYDE hidden: false - id: F5MA9uTAYFE hidden: true - '...' description: 'An ordered list of dashboard IDs to display in the aggregate view of the navigator. Can be used to reorder dashboards, add custom dashboards, and hide existing built-in dashboards. Built-in dashboards can be marked as hidden, but not removed from the list. A complex object that requires an indicator for a hidden field. You can’t hide all of the fields. At least one non-hidden field must exist.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - id: F4MeweuAgAA hidden: false - id: A4MenbuAgTA hidden: true - '...' created: title: Date and time when this navigator customization was created type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator customization creator user ID type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who created this navigator customization. This property is read-only and is generated by the system. lastUpdated: title: Navigator customization last updated time type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator customization type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who last updated this navigator customization. This property is read-only and is generated by the system. title: CreateNavigatorCustomizationRequest examples: example: value: aggregateDashboards: - hidden: false id: F4MX9uNAYDE - hidden: true id: F5MA9uTAYFE - '...' created: 1771192844528 creator: FBBVcWRNUPP id: F4vLmvyAwAb instanceDashboards: - hidden: false id: F4MeweuAgAA - hidden: true id: A4MenbuAgTA - '...' lastUpdated: 1771192844528 lastUpdatedBy: FBBVcWRNUPP name: Customization for AWS EC2 from 2023-08-23 22:45:45 navigatorId: F4To0t7AEAA responses: '200': description: HTTP 200 response content: application/json: schema: type: object properties: id: title: Navigator customization system ID type: string readOnly: true example: F4vLmvyAwAb description: The UUID of this navigator customization object. This property is read-only and is generated by the system. name: title: Navigator customization display name type: string maxLength: 150 example: Customization for AWS EC2 from 2023-08-23 22:45:45 description: Required. A name for the navigator customization that appears in the UI. navigatorId: title: Navigator system ID type: string readOnly: true example: F4To0t7AEAA description: The ID of the navigator that you want to customize. This property is read-only and is generated by the system. aggregateDashboards: title: Dashboard ID array for aggregate display type: array maxItems: 10 items: type: string example: - id: F4MX9uNAYDE hidden: false - id: F5MA9uTAYFE hidden: true - '...' description: 'An ordered list of dashboard IDs to display in the aggregate view of the navigator. Can be used to reorder dashboards, add custom dashboards, and hide existing built-in dashboards. Built-in dashboards can be marked as hidden, but not removed from the list. A complex object that requires an indicator for a hidden field. You can’t hide all of the fields. At least one non-hidden field must exist.' instanceDashboards: title: Dashboard ID array for instance display type: array maxItems: 10 items: type: string example: - id: F4MeweuAgAA hidden: false - id: A4MenbuAgTA hidden: true - '...' created: title: Date and time when this navigator customization was created type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was created, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. creator: title: Navigator customization creator user ID type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who created this navigator customization. This property is read-only and is generated by the system. lastUpdated: title: Navigator customization last updated time type: integer format: int64 readOnly: true example: 1771192844528 description: Date and time the navigator customization was last updated, in the form of a *nix timestamp in milliseconds. This property is read-only and is generated by the system. lastUpdatedBy: title: User who last updated this navigator customization type: string readOnly: true example: FBBVcWRNUPP description: User ID of the user who last updated this navigator customization. This property is read-only and is generated by the system. title: CreateNavigatorCustomizationRequest examples: example: value: aggregateDashboards: - hidden: false id: F4MX9uNAYDE - hidden: true id: F5MA9uTAYFE - '...' created: 1771192844528 creator: FBBVcWRNUPP id: F4vLmvyAwAb instanceDashboards: - hidden: false id: F4MeweuAgAA - hidden: true id: A4MenbuAgTA - '...' lastUpdated: 1771192844528 lastUpdatedBy: FBBVcWRNUPP name: Customization for AWS EC2 from 2023-08-23 22:45:45 navigatorId: F4To0t7AEAA '400': description: HTTP 400 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 400 description: HTTP response code. Always '400' message: type: string description: Error explanation examples: example: value: code: 400 message: string '403': description: HTTP 403 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 403 description: HTTP response code. Always '403' message: type: string description: Error explanation examples: example: value: code: 403 message: string '404': description: HTTP 404 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators delete: summary: Delete Single Navigator Customization description: 'Deletes the navigator customization specified by the {customizationId} path parameter. Note: You must be an admin to delete a navigator. When a navigator is deleted, all the corresponding navigator customizations are also deleted to prevent orphaned customizations.' parameters: - name: id in: path description: ID of the navigator you want to update. required: true schema: type: string - name: customizationId in: path description: ID of the navigator customization object you want to update. required: true schema: type: string - name: X-SF-TOKEN in: header description: Authentication token required: true schema: type: string responses: '204': description: HTTP 204 response '403': description: HTTP 403 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 403 description: HTTP response code. Always '403' message: type: string description: Error explanation examples: example: value: code: 403 message: string '404': description: HTTP 404 response content: application/json: schema: type: object properties: code: type: integer format: int32 example: 404 description: HTTP response code. Always '404' message: type: string description: Error explanation examples: example: value: code: 404 message: string security: - SessionToken: [] tags: - Navigators