openapi: 3.2.0 info: description: "Use the Oracle Cloud Infrastructure Dashboards service API to manage dashboards in the Console. \nDashboards provide an organized and customizable view of resources and their metrics in the Console.\nFor more information, see [Dashboards](/Content/Dashboards/home.htm).\n\n**Important:** Resources for the Dashboards service are created in the tenacy's home region.\nAlthough it is possible to create dashboard and dashboard group resources in regions other than the home region,\nyou won't be able to view those resources in the Console.\nTherefore, creating resources outside of the home region is not recommended.\n" title: Dashboards Dashboard Group API version: '20210731' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/58e0456bca86b42263bb0bdaa4ccd27ef1ac92ff5f920f5850ee1b12cb4bd0a0.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Dashboards API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/58e0456bca86b42263bb0bdaa4ccd27ef1ac92ff5f920f5850ee1b12cb4bd0a0.yaml what: the harvested document for Dashboards API servers: - url: http://127.0.0.1/20210731 - url: https://127.0.0.1/20210731 tags: - name: dashboardGroup paths: /dashboardGroups: get: description: 'Returns a list of dashboard groups with a specific compartment ID. ' operationId: ListDashboardGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DashboardGroupLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/DashboardGroupIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CrossRegionIdentifierHeader' responses: 200: description: The collection of dashboard groups was retrieved. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DashboardGroupCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets a list of all dashboard groups in a compartment. tags: - dashboardGroup x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/DashboardGroupCollection' post: description: 'Creates a new dashboard group using the details provided in request body. **Caution:** Resources for the Dashboard service are created in the tenacy''s home region. Although it is possible to create dashboard group resource in regions other than the home region, you won''t be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended. ' operationId: CreateDashboardGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CrossRegionIdentifierHeader' responses: 200: description: The dashboard group has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DashboardGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new DashboardGroup tags: - dashboardGroup x-related-resource: '#/definitions/DashboardGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDashboardGroupDetails' description: Details about the dashboard group being created. required: true /dashboardGroups/{dashboardGroupId}: delete: description: Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete. operationId: DeleteDashboardGroup parameters: - $ref: '#/components/parameters/DashboardGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CrossRegionIdentifierHeader' responses: 204: description: The dashboard group has been deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete. tags: - dashboardGroup x-related-resource: '#/definitions/DashboardGroup' get: description: Gets the specified dashboard group's information. Uses the dashboard group's OCID to determine which dashboard to retrieve. operationId: GetDashboardGroup parameters: - $ref: '#/components/parameters/DashboardGroupIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CrossRegionIdentifierHeader' responses: 200: description: The dashboard group was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DashboardGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get DashboardGroup tags: - dashboardGroup x-obmcs-client-retries-enabled: true put: description: Updates the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to update. operationId: UpdateDashboardGroup parameters: - $ref: '#/components/parameters/DashboardGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CrossRegionIdentifierHeader' responses: 200: description: The dashboard group was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DashboardGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the DashboardGroup identified by the id tags: - dashboardGroup x-related-resource: '#/definitions/DashboardGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDashboardGroupDetails' description: The dashboard group details to be updated. required: true /dashboardGroups/{dashboardGroupId}/actions/changeCompartment: post: description: Moves a DashboardGroup resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeDashboardGroupCompartment parameters: - $ref: '#/components/parameters/DashboardGroupIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The DashboardGroup resource moved into the target compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - dashboardGroup x-related-resource: '#/definitions/DashboardGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDashboardGroupCompartmentDetails' description: The information to be updated. required: true components: parameters: PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This value is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: "The field to sort by. You can provide one sort order (`sortOrder`). \nDefault order for TIMECREATED is descending. \nDefault order for DISPLAYNAME is ascending. \nThe DISPLAYNAME sort order is case sensitive.\n" in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DashboardGroupIdentifierPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group. in: path name: dashboardGroupId required: true schema: type: string DashboardGroupIdentifierQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group. in: query name: id x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string DashboardGroupLifecycleStateQueryParam: description: A filter that returns dashboard groups that match the lifecycle state specified. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/DashboardGroup/lifecycleState' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends on `sortBy`. In general, the default value is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC RetryTokenHeader: description: "A token that uniquely identifies a request so it can be retried in case of a timeout or server \nerror without risk of executing that same action again. \nRetry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations \n(for example, if a resource has been deleted and purged from the system, \nthen a retry of the original creation request may be rejected).\n" in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: A case-sensitive filter that returns resources that match the entire display name specified. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 CrossRegionIdentifierHeader: description: "To identify if the call is cross-regional. In CRUD calls for a resource, to\nidentify that the call originates from different region, set the\n`CrossRegionIdentifierHeader` parameter to a region name (ex - `US-ASHBURN-1`)\nThe call will be served from a Replicated bucket. \nFor same-region calls, the value is unassigned.\n" in: header name: opc-cross-region required: false x-default-description: when unspecified the call will be assumed to not be cross regional schema: type: string RequestIdHeader: description: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. in: header name: opc-request-id schema: type: string schemas: Error: description: Details about erros encountered. properties: code: description: A machine-usable code for the error that occured. type: string message: description: A human-readable error string. type: string required: - code - message DashboardGroup: description: The base schema for a dashboard group. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard group. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/''"&\ ' type: string displayName: description: 'A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/''"&\ ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group. type: string lifecycleState: description: The current state of the `DashboardGroup` resource. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the dashboard group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the dashboard group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - displayName - description - compartmentId - timeCreated - timeUpdated - lifecycleState - freeformTags - definedTags type: object ChangeDashboardGroupCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreateDashboardGroupDetails: description: The data to create a new dashboard group. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard group. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/''"&\ ' maxLength: 400 minLength: 0 type: string displayName: description: 'A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/''"&\ ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object required: - compartmentId type: object DashboardGroupSummary: description: Summary information for the dashboard group. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the dashboard group. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/''"&\ ' type: string displayName: description: 'A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/''"&\ ' type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the dashboard group. type: string lifecycleState: description: The current state of the `DashboardGroup` resource. type: string x-obmcs-enumref: '#/definitions/DashboardGroup/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The date and time the dashboard group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the dashboard group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - displayName - description - compartmentId - timeCreated - lifecycleState - freeformTags - definedTags type: object UpdateDashboardGroupDetails: description: The data to update a dashboard group. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: 'A short description of the dashboard group. It can be changed. Avoid entering confidential information. The following special characters are not allowed: <>()=/''"&\ ' maxLength: 400 minLength: 0 type: string displayName: description: 'A user-friendly name for the dashboard. Does not have to be unique, and it can be changed. Avoid entering confidential information. Leading and trailing spaces and the following special characters are not allowed: <>()=/''"&\ ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object type: object DashboardGroupCollection: description: A list of dashboard groups that match filter criteria, if any. Results contain `DashboardGroupSummary` objects. properties: items: description: A list of dashboard groups. items: $ref: '#/components/schemas/DashboardGroupSummary' type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.pic.dashboard