Spectro Cloud dashboard API
The dashboard API from Spectro Cloud — 61 operation(s) for dashboard.
The dashboard API from Spectro Cloud — 61 operation(s) for dashboard.
swagger: '2.0'
info:
title: Local Management APIs activations dashboard API
version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: dashboard
x-displayName: Dashboard
paths:
/v1/dashboard/appDeployments:
post:
operationId: v1DashboardAppDeployments
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1AppDeploymentsFilterSpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of application deployment summary items
schema:
$ref: '#/definitions/v1AppDeploymentsSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of application deployments filter summary Supported filter fields - ["appDeploymentName", "clusterUid", "tags"] Supported sort fields - ["appDeploymentName", "creationTimestamp", "lastModifiedTimestamp"]
tags:
- dashboard
/v1/dashboard/appProfiles:
post:
operationId: v1DashboardAppProfiles
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1AppProfilesFilterSpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of application profiles summary items
schema:
$ref: '#/definitions/v1AppProfilesSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of application profiles filter summary Supported filter fields - ["profileName", "tags"] Supported sort fields - ["profileName", "creationTimestamp", "lastModifiedTimestamp"]
tags:
- dashboard
/v1/dashboard/appProfiles/metadata:
get:
operationId: v1DashboardAppProfilesMetadata
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of application profile summary items
schema:
$ref: '#/definitions/v1AppProfilesMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of application profile metadata
tags:
- dashboard
/v1/dashboard/appliances/metadata:
post:
operationId: v1EdgeHostsMetadata
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1EdgeHostsMetadataFilter'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of edgenative pair summary items
schema:
$ref: '#/definitions/v1EdgeHostsMetadataSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of edgehosts summary
tags:
- dashboard
/v1/dashboard/cloudaccounts/metadata:
get:
operationId: v1DashboardCloudAccountsMetadata
parameters:
- in: query
name: environment
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cloud accounts summary items
schema:
$ref: '#/definitions/v1CloudAccountsMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cloud accounts metadata
tags:
- dashboard
/v1/dashboard/clusterTemplates:
post:
operationId: v1ClusterTemplatesFilterSummary
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1ClusterTemplatesFilterSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster template summary items
schema:
$ref: '#/definitions/v1ClusterTemplatesSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster templates filter summary Supported filter fields - ["clusterTemplateName", "tags", "cloudType","projectUid", "policyUid"] Supported sort fields - ["clusterTemplateName", "creationTimestamp", "lastModifiedTimestamp"]
tags:
- dashboard
/v1/dashboard/clusterTemplates/metadata:
get:
operationId: v1ClusterTemplatesMetadataGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster template metadata
schema:
$ref: '#/definitions/v1ClusterTemplatesMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of all cluster template metadata.
tags:
- dashboard
/v1/dashboard/clusterTemplates/{uid}/spectroclusters/meta:
get:
operationId: v1ClusterTemplatesUidSpectroclustersMetaGet
parameters:
- description: The UID of the cluster template
in: path
name: uid
required: true
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of spectrocluster meta information
schema:
$ref: '#/definitions/v1SpectroClustersMeta'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves spectroclusters meta information for clusters launched using the specified cluster template.
tags:
- dashboard
/v1/dashboard/clustergroups/{uid}/hostClusters:
post:
operationId: v1ClusterGroupUidHostClustersSummary
parameters:
- in: path
name: uid
required: true
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1SearchFilterSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1SpectroClustersSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster summary for a given cluster group
tags:
- dashboard
/v1/dashboard/clustergroups/{uid}/virtualClusters:
post:
operationId: v1ClusterGroupUidVirtualClustersSummary
parameters:
- in: path
name: uid
required: true
type: string
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1SearchFilterSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1SpectroClustersSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster summary for a given cluster group
tags:
- dashboard
/v1/dashboard/clusterprofiles:
post:
operationId: v1ClusterProfilesFilterSummary
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1ClusterProfilesFilterSpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster profiles summary items
schema:
$ref: '#/definitions/v1ClusterProfilesSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster profiles filter summary Supported filter fields - ['profileName', 'tags', 'profileType', 'environment', 'resourceType'] Supported sort fields - ['profileName', 'environment', 'profileType', 'creationTimestamp', 'lastModifiedTimestamp']
tags:
- dashboard
/v1/dashboard/clusterprofiles/metadata:
get:
operationId: v1ClusterProfilesMetadata
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1ClusterProfilesMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster profiles metadata
tags:
- dashboard
/v1/dashboard/clusterprofiles/{uid}:
parameters:
- in: path
name: uid
required: true
type: string
get:
operationId: v1ClusterProfilesUidSummary
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: Cluster profile summary response
schema:
$ref: '#/definitions/v1ClusterProfileSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a specified cluster profile summary
tags:
- dashboard
/v1/dashboard/edgehosts/search:
post:
operationId: v1DashboardEdgehostsSearch
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1SearchFilterSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of edgenative pair summary items
schema:
$ref: '#/definitions/v1EdgeHostsSearchSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of Edgehosts summary with provided search filter. Supported fields as per schema /v1/dashboard/edgehosts/search/schema
tags:
- dashboard
/v1/dashboard/edgehosts/search/schema:
get:
operationId: v1DashboardEdgehostsSearchSchemaGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of schema items
schema:
$ref: '#/definitions/v1SearchFilterSchemaSpec'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a schema for the Edgehost search filter
tags:
- dashboard
/v1/dashboard/pcgs/search:
post:
operationId: v1DashboardPcgsSearchSummary
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1SearchFilterSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1PcgsSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of PCG summary with provided search filter. Supported fields as per schema /v1/dashboard/pcgs/search/schema
tags:
- dashboard
/v1/dashboard/pcgs/search/schema:
get:
operationId: v1DashboardPcgSearchSchemaGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of schema items
schema:
$ref: '#/definitions/v1SearchFilterSchemaSpec'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a schema for the PCG search filter
tags:
- dashboard
/v1/dashboard/projects:
get:
description: 'Deprecated: Use POST /v1/dashboard/projects'
operationId: v1ProjectsSummary
parameters:
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- default: 60
description: Metric period in minutes defines latest metrics by period
format: int32
in: query
name: metricPeriod
type: integer
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of project summary items
schema:
$ref: '#/definitions/v1ProjectsSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of project summary
tags:
- dashboard
post:
operationId: v1ProjectsFilterSummary
parameters:
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1ProjectsFilterSpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of project filter summary items
schema:
$ref: '#/definitions/v1ProjectsSummary'
security:
- ApiKey: []
- Authorization: []
tags:
- dashboard
/v1/dashboard/projects/metadata:
get:
operationId: v1ProjectsMetadata
parameters:
- description: Name of the project
in: query
name: name
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of project metadata items
schema:
$ref: '#/definitions/v1ProjectsMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of projects metadata
tags:
- dashboard
/v1/dashboard/spcPolicies:
post:
operationId: v1SpcPoliciesFilterSummary
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1SpcPoliciesFilterSpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of spc policies summary items
schema:
$ref: '#/definitions/v1SpcPoliciesSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of spc policies filter summary Supported filter fields - ["policyName", "tags", "policyType"] Supported sort fields - ["policyName", "policyType", "creationTimestamp", "lastModifiedTimestamp"]
tags:
- dashboard
/v1/dashboard/spcPolicies/metadata:
get:
operationId: v1SpcPoliciesMetadataGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of spc policies metadata
schema:
$ref: '#/definitions/v1SpcPoliciesMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of all spc policies metadata.
tags:
- dashboard
/v1/dashboard/spectroclusters:
post:
description: 'Deprecated: Use POST /v1/dashboard/spectroclusters/search'
operationId: v1SpectroClustersFilterSummary
parameters:
- description: 'limit is a maximum number of responses to return for a list call. Maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
maximum: 50
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- in: body
name: body
schema:
$ref: '#/definitions/v1SpectroClusterSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1SpectroClustersSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster summary with provided filter spec Supported filter fields - ["cpuUsage", "memoryUsage", "clusterName", "tags", "healthState", "clusterStates", "isDeleted", "environments", "metricPeriod"] Supported sort fields - ["environment", "clusterName", "memoryUsage", "healthState", "creationTimestamp", "lastModifiedTimestamp"]
tags:
- dashboard
/v1/dashboard/spectroclusters/cost:
post:
operationId: v1DashboardSpectroClustersCostSummary
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1SpectroClusterCloudCostSummarySpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of resources cloud cost summary items
schema:
$ref: '#/definitions/v1ResourcesCloudCostSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves spectro clusters cloud cost summary information
tags:
- dashboard
/v1/dashboard/spectroclusters/filters/workspace:
get:
operationId: v1SpectroClustersFiltersWorkspace
parameters:
- default: 50
description: 'limit is a maximum number of responses to return for a list call. Default and maximum value of the limit is 50.
If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results.'
format: int64
in: query
name: limit
type: integer
- description: offset is the next index number from which the response will start. The response offset value can be used along with continue token for the pagination.
format: int64
in: query
name: offset
type: integer
- description: continue token to paginate the subsequent data items
in: query
name: continue
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1SpectroClustersSummary'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of running, non rbac configured clusters in a workspace
tags:
- dashboard
/v1/dashboard/spectroclusters/meta:
get:
description: Returns metadata information for all clusters
operationId: v1SpectroClustersMetaGet
parameters:
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster metadata items
schema:
$ref: '#/definitions/v1SpectroClustersMeta'
security:
- ApiKey: []
- Authorization: []
summary: Get all clusters metadata
tags:
- dashboard
/v1/dashboard/spectroclusters/metadata:
get:
operationId: v1SpectroClustersMetadataGet
parameters:
- enum:
- hostclusters
- strictHostclusters
- hypershiftClusters
in: query
name: quickFilter
type: string
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1SpectroClustersMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster summary metadata
tags:
- dashboard
post:
operationId: v1SpectroClustersMetadata
parameters:
- in: body
name: body
schema:
$ref: '#/definitions/v1SpectroClusterMetadataSpec'
- description: A project UID is required for project-scoped resources and should be omitted when targeting tenant-scoped resources
in: header
name: ProjectUid
type: string
responses:
'200':
description: An array of cluster summary items
schema:
$ref: '#/definitions/v1SpectroClustersMetadata'
security:
- ApiKey: []
- Authorization: []
summary: Retrieves a list of cluster summary
tags:
- dashboard
/v1/dashboard/spectroclusters/metadata/search:
post:
operationId: v1SpectroClustersMetadataSearch
parameters:
- in: body
name: body
schema:
$
# --- truncated at 32 KB (177 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-dashboard-api-openapi.yml