Spectro Cloud edge-mgmt API

The edge-mgmt API from Spectro Cloud — 64 operation(s) for edge-mgmt.

OpenAPI Specification

spectro-cloud-edge-mgmt-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  title: Local Management APIs activations edge-mgmt API
  version: v1
servers:
- url: https://edge-host-ip:5080
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: edge-mgmt
  x-displayName: Edge Mgmt
paths:
  /v1/edge-mgmt/cluster:
    get:
      description: Get the details of the cluster.
      tags:
      - edge-mgmt
      summary: Get the details of the cluster.
      operationId: v1ClusterConfig
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1ClusterConfiguration'
        '404':
          description: Not found
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
    post:
      description: Creates a cluster with the provided cluster configuration
      tags:
      - edge-mgmt
      summary: Creates a cluster with the provided cluster configuration
      operationId: v1CreateCluster
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterConfiguration'
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
    delete:
      description: Delete a cluster
      tags:
      - edge-mgmt
      summary: Delete a cluster
      operationId: v1DeleteCluster
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
    patch:
      description: DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead
      tags:
      - edge-mgmt
      summary: DEPRECATED - This endpoint is deprecated and will be removed in future versions. Use /v1/edge-mgmt/cluster/{clusterName} instead
      operationId: v1PatchCluster
      deprecated: true
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterConfiguration'
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/applications:
    get:
      description: list the details of the cluster’s packs.
      tags:
      - edge-mgmt
      summary: list the details of the cluster’s packs.
      operationId: v1ClusterApplications
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1ClusterCurrentApplications'
        '404':
          description: Not found
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/certificates:
    get:
      description: Get Cluster Certificates Info
      tags:
      - edge-mgmt
      summary: Get Cluster Certificates Info
      operationId: v1CertificateDetails
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1CertificateDetails'
        '404':
          description: Not found
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/details:
    get:
      description: Get Edge Cluster details
      tags:
      - edge-mgmt
      summary: Get Edge Cluster details
      operationId: v1ClusterGet
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1Cluster'
        '404':
          description: (empty)
          schema:
            $ref: '#/definitions/v1NotFound'
        '500':
          description: (empty)
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/events:
    get:
      description: List cluster events
      tags:
      - edge-mgmt
      summary: List cluster events
      operationId: v1GetClusterEvents
      parameters:
      - type: string
        name: namespace
        in: query
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1Events'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/pair:
    post:
      tags:
      - edge-mgmt
      summary: Creates a pairing request
      operationId: v1ClusterPair
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterPairMeta'
      responses:
        '201':
          description: OK
          schema:
            $ref: '#/definitions/v1ClusterPairInfoResponse'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/pair/details:
    get:
      tags:
      - edge-mgmt
      summary: Get all existing pairing requests
      operationId: v1ClusterPairDetails
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1ClusterPairDetailsResponse'
        '404':
          description: Not found error
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/pair/reject:
    post:
      tags:
      - edge-mgmt
      summary: Rejects a pairing request
      operationId: v1ClusterPairReject
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '404':
          description: Not found error
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/pair/verify-connection:
    post:
      tags:
      - edge-mgmt
      summary: Verifies whether all cluster hosts are able to connect to palette
      operationId: v1ClusterPairVerifyConnection
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterPairMeta'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1ClusterPairVerifiedConnectionResponse'
        '400':
          description: Invalid input
          schema:
            $ref: '#/definitions/v1BadRequest'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/profiles:
    put:
      description: Updates a cluster with the provided cluster configuration
      tags:
      - edge-mgmt
      summary: Updates a cluster with the provided cluster configuration
      operationId: v1UpdateClusterProfiles
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterProfileConfiguration'
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/profiles/variables/validate:
    post:
      description: Validate cluster profile variables
      tags:
      - edge-mgmt
      summary: Validate cluster profile variables
      operationId: v1ValidateClusterProfileVariables
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ValidateVariables'
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1ValidateVariablesResponse'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/registry/content/details:
    get:
      description: Get Harbor Content Details
      tags:
      - edge-mgmt
      summary: List existing Harbor Content Details
      operationId: v1HarborContentsDetails
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1HarborContentsDetails'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/registry/content/sync-status/details:
    get:
      description: Get Harbor Content Sync Status
      tags:
      - edge-mgmt
      summary: List Harbor Content Sync Status
      operationId: v1HarborContentsSyncStatusDetails
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1HarborContentsSyncStatus'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/registry/health:
    get:
      description: Gets the harbor health status
      tags:
      - edge-mgmt
      summary: Gets the harbor health status
      operationId: V1HarborHealth
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1HarborHealthDetails'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/renew-certificates:
    post:
      description: Renew Cluster Certificates
      tags:
      - edge-mgmt
      summary: Renew Cluster Certificates
      operationId: v1RenewCerts
      responses:
        '201':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/settings:
    put:
      description: Update cluster settings
      tags:
      - edge-mgmt
      summary: Update cluster settings
      operationId: v1EdgeNativeClusterSettings
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1EdgeNativeClusterSettings'
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/cluster/{clusterName}:
    put:
      description: Updates a cluster with the provided cluster configuration
      tags:
      - edge-mgmt
      summary: Updates a cluster with the provided cluster configuration
      operationId: v1UpdateClusterConfig
      parameters:
      - type: string
        description: Name of the cluster to be updated
        name: clusterName
        in: path
        required: true
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterConfiguration'
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
    patch:
      description: Patch a cluster with the provided cluster configuration
      tags:
      - edge-mgmt
      summary: Patch a cluster with the provided cluster configuration
      operationId: v1PatchClusterConfig
      parameters:
      - type: string
        description: Name of the cluster to be patched
        name: clusterName
        in: path
        required: true
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1ClusterPatch'
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/archive/embedded/details:
    get:
      description: parses the cluster-config archive.
      tags:
      - edge-mgmt
      summary: parses the preloaded cluster-config archive if it was included in the ISO.
      operationId: V1ClusterConfigArchiveEmbedded
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1ClusterConfigArchiveDetails'
        default:
          description: Error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/archive/overridden/details:
    get:
      description: parses the cluster-config archive if it was uploaded as a standalone configuration.
      tags:
      - edge-mgmt
      summary: parses the cluster-config archive if it exists.
      operationId: v1ClusterConfigArchiveOverriden
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1ClusterConfigArchiveDetails'
        default:
          description: Error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/archive/update:
    delete:
      description: Delete or reject the cluster update archive
      tags:
      - edge-mgmt
      summary: Delete or reject the cluster update archive
      operationId: v1DeleteClusterUpdateArchive
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/archive/update/details:
    get:
      description: parses the cluster-config update archive if it was included in the uploaded content-bundle.
      tags:
      - edge-mgmt
      summary: parses the cluster-config update archive if it was included in the uploaded content-bundle.
      operationId: v1ClusterConfigArchiveUpdate
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1ClusterConfigArchiveDetails'
        default:
          description: Error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/current/machinepools:
    get:
      tags:
      - edge-mgmt
      summary: Fetch the cluster node pool details including edge host details.
      operationId: v1MachinePoolDetail
      responses:
        '200':
          description: OK
          schema:
            type: object
            properties:
              items:
                type: array
                items:
                  $ref: '#/definitions/v1EdgeNativeMachinePoolConfig'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
    post:
      tags:
      - edge-mgmt
      summary: Create a machine pool
      operationId: v1ClusterMachinePoolCreate
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1EdgeNativeMachinePoolConfig'
      responses:
        '201':
          description: machine pool created
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '400':
          description: Bad request, invalid input
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/current/machinepools/{poolName}:
    put:
      tags:
      - edge-mgmt
      summary: Update machine pools
      operationId: v1ClusterMachinePoolUpdate
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1EdgeNativeMachinePoolConfig'
      - type: string
        description: Name of the machine pool to be updated
        name: poolName
        in: path
        required: true
      responses:
        '200':
          description: machine pool configurations updated
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '400':
          description: Bad request, invalid input
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
    delete:
      tags:
      - edge-mgmt
      summary: Delete machine pools
      operationId: v1ClusterMachinePoolDelete
      parameters:
      - type: string
        description: Name of the machine pool to be deleted
        name: poolName
        in: path
        required: true
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
    patch:
      tags:
      - edge-mgmt
      summary: Patch machine pools
      operationId: v1ClusterMachinePoolPatch
      parameters:
      - name: body
        in: body
        required: true
        schema:
          $ref: '#/definitions/v1MachinePoolPatch'
      - type: string
        description: Name of the machine pool to be patched
        name: poolName
        in: path
        required: true
      responses:
        '200':
          description: machine pool configurations patched
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '400':
          description: Bad request, invalid input
          schema:
            $ref: '#/definitions/v1Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/current/machinepools/{poolName}/nodes/{nodeName}:
    delete:
      description: Delete a node from the machine pool
      tags:
      - edge-mgmt
      summary: Delete a machine pool node
      operationId: v1ClusterMachinePoolNodeDelete
      parameters:
      - type: string
        description: Name of the machine pool
        name: poolName
        in: path
        required: true
      - type: string
        description: Name of the node
        name: nodeName
        in: path
        required: true
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '400':
          description: Bad request, invalid input
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/clusters/current/nodes:
    get:
      description: Get K8s Cluster Nodes
      tags:
      - edge-mgmt
      summary: A list of the K8s Cluster Nodes
      operationId: v1ClusterNodes
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1ClusterNodes'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/connectivity/ping:
    get:
      description: Ping an endpoint
      tags:
      - edge-mgmt
      summary: Ping an endpoint
      operationId: v1PingHost
      parameters:
      - type: string
        name: endpoint
        in: query
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1PingResponse'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/connectivity/traceroute:
    get:
      description: Display route that IP packets take to a network host
      tags:
      - edge-mgmt
      summary: Display route that IP packets take to a network host
      operationId: v1TraceRouteHost
      parameters:
      - type: string
        name: endpoint
        in: query
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1TraceRouteResponse'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current:
    get:
      description: Get edge host details
      tags:
      - edge-mgmt
      summary: Get edge host info
      operationId: v1EdgeHostInfo
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1EdgeHostInfo'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/actions/content/signing-public-key:
    get:
      description: Get the base64 encoded key used to verify the signed content.
      tags:
      - edge-mgmt
      summary: Get the public key used to verify the signed content.
      operationId: V1GetContentSigningPublicKey
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1ContentSigningKey'
        '404':
          description: Not found
          schema:
            $ref: '#/definitions/v1Error'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/actions/reboot:
    post:
      description: Reboot edge host
      tags:
      - edge-mgmt
      summary: Reboot edge host
      operationId: v1EdgeHostActionReboot
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/actions/reset:
    post:
      description: Reset edge host
      tags:
      - edge-mgmt
      summary: Reset edge host
      operationId: v1EdgeHostActionReset
      responses:
        '202':
          description: Accepted response with message
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        '500':
          description: Internal server error.
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/actions/shutdown:
    post:
      description: Shutdown edge host
      tags:
      - edge-mgmt
      summary: Shutdown edge host
      operationId: v1EdgeHostActionShutdown
      responses:
        '202':
          description: (empty)
          schema:
            $ref: '#/definitions/v1AcceptedResponseWithMessage'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/actions/upload-clusterconfig:
    post:
      description: Uploads the cluster config archive and extracts it to the required location on the edge host.
      consumes:
      - multipart/form-data
      tags:
      - edge-mgmt
      summary: Uploads the cluster config archive and extracts it to the required location on the edge host.
      operationId: V1ClusterConfigUpload
      parameters:
      - type: file
        description: The clusterconfig file to be uploaded.
        name: uploadFile
        in: formData
        required: true
      - type: file
        description: The signature for the corresponding cluster config to be uploaded.
        name: signature
        in: formData
      responses:
        '201':
          description: Created successfully.
          schema:
            $ref: '#/definitions/uploadResponse'
        '500':
          description: Internal server error.
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/actions/upload-content:
    post:
      description: Uploads an archive file and extracts it to the required location on the edge host.
      consumes:
      - multipart/form-data
      tags:
      - edge-mgmt
      summary: Uploads an archive file and extracts it to the required location on the edge host.
      operationId: V1ContentUpload
      parameters:
      - type: file
        description: The archive file to be uploaded.
        name: uploadFile
        in: formData
        required: true
      - type: file
        description: The signature for the corresponding archive file to be uploaded.
        name: signature
        in: formData
      responses:
        '201':
          description: Created successfully.
          schema:
            $ref: '#/definitions/uploadResponse'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/audits:
    get:
      tags:
      - edge-mgmt
      summary: Retrieves the list of audit logs
      operationId: v1Audits
      parameters:
      - type: string
        format: date-time
        description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
        name: startTime
        in: query
      - type: string
        format: date-time
        description: Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
        name: endTime
        in: query
      - type: string
        description: Specify the user uid, to retrieve the specific user audit logs
        name: userUid
        in: query
      - type: string
        description: Specify the resource name, to retrieve the specific resource audit logs
        name: resourceKind
        in: query
      - enum:
        - create
        - update
        - delete
        - activity
        - action
        type: string
        name: actionType
        in: query
      - type: integer
        format: int64
        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.'
        name: limit
        in: query
      - type: integer
        format: int64
        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.
        name: offset
        in: query
      - type: string
        description: continue token to paginate the subsequent data items
        name: continue
        in: query
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1AuditsList'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/v1NotFoundResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/audits/download:
    get:
      description: Download audit logs as a single compressed file
      produces:
      - application/x-tar
      - application/json
      tags:
      - edge-mgmt
      summary: Download audit logs
      operationId: v1AuditDownload
      responses:
        '200':
          description: OK
          schema:
            type: file
            format: binary
          headers:
            Content-Disposition:
              type: string
              description: Specifies the filename for the downloaded file.
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/v1NotFoundResponseWithMessage'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error'
        default:
          description: generic error response
          schema:
            $ref: '#/definitions/apiError'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/audits/filters:
    get:
      tags:
      - edge-mgmt
      summary: Retrieves the list of filter options to display on audit ui page
      operationId: v1AuditFilter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/v1AuditFilterObect'
      security:
      - Authorization: []
  /v1/edge-mgmt/edgehosts/current/configurations:
    get:
      description: Get edge host configurations.
      tags:
      - edge-mgmt
      summary: Get edge host configurations.
      operationId: V1EdgeHostConfigurationsGet
      responses:
        '200':
          description: (empty)
          schema:
            $ref: '#/definitions/v1EdgeHostConfigurations'
        '500':
          description: Internal server error
          schema:
            $ref: '#/definitions/v1Error

# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/spectro-cloud/refs/heads/main/openapi/spectro-cloud-edge-mgmt-api-openapi.yml