Zededa EdgeNodeClusterConfiguration API
The EdgeNodeClusterConfiguration API from Zededa — 7 operation(s) for edgenodeclusterconfiguration.
The EdgeNodeClusterConfiguration API from Zededa — 7 operation(s) for edgenodeclusterconfiguration.
swagger: '2.0'
info:
title: ZEDEDA App Profiles Service AppProfileService EdgeNodeClusterConfiguration API
description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
termsOfService: https://www.zededa.com/terms
version: '1.0'
contact:
name: ZEDEDA API Support
url: https://www.zededa.com/support
email: support@zededa.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
basePath: /api
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- BearerToken: []
tags:
- name: EdgeNodeClusterConfiguration
paths:
/v1/cluster:
get:
summary: Query Edge-Node Clusters.
description: Query the Edge-Node Cluster records.
operationId: EdgeNodeClusterConfiguration_QueryClusters
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EdgeNodeClusters'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
schema:
$ref: '#/definitions/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: filter.projectName
description: User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed
in: query
required: false
type: string
- name: filter.projectNamePattern
description: cluster project name pattern
in: query
required: false
type: string
- name: filter.namePattern
description: cluster name pattern
in: query
required: false
type: string
- name: filter.includeZks
description: include zks clusters
in: query
required: false
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
- name: next.pageNum
description: Page Number
in: query
required: false
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
post:
summary: Create Edge-Node Cluster.
description: Creates an Edge-Node Cluster record.
operationId: EdgeNodeClusterConfiguration_CreateCluster
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ZsrvResponse'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
schema:
$ref: '#/definitions/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: body
in: body
required: true
schema:
$ref: '#/definitions/EdgeNodeCluster'
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
/v1/cluster/available/projects:
get:
summary: Get Edge-Node Cluster Available Projects.
description: Get the list of available projects for a Edge-Node Cluster record.
operationId: EdgeNodeClusterConfiguration_GetAvailableProjectsForCluster
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EdgeNodeClusterProjects'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: filter.projectName
description: User defined name of the project, unique across the enterprise. Once project is created, name can’t be changed
in: query
required: false
type: string
- name: filter.projectNamePattern
description: cluster project name pattern
in: query
required: false
type: string
- name: filter.namePattern
description: cluster name pattern
in: query
required: false
type: string
- name: filter.includeZks
description: include zks clusters
in: query
required: false
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
type: array
items:
type: string
collectionFormat: multi
- name: next.pageNum
description: Page Number
in: query
required: false
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
/v1/cluster/id/{id}:
get:
summary: Get Edge-Node Cluster.
description: Get the configuration of a Edge-Node Cluster record.
operationId: EdgeNodeClusterConfiguration_GetCluster
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EdgeNodeClusterConfigSummary'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the cluster
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
delete:
summary: Delete Edge-Node Cluster.
description: Delete an Edge-Node Cluster record.
operationId: EdgeNodeClusterConfiguration_DeleteCluster
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ZsrvResponse'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
schema:
$ref: '#/definitions/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the cluster
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
put:
summary: Update Edge-Node Cluster.
description: Update an Edge-Node Cluster record. The usual pattern to update an Edge-Node Cluster record is to retrieve the record and update with the modified values in a new body.
operationId: EdgeNodeClusterConfiguration_UpdateCluster
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ZsrvResponse'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
schema:
$ref: '#/definitions/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the cluster
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
type: object
properties:
name:
type: string
description: User defined name of the cluster, unique across the enterprise. Once cluster is created, name can’t be changed
title:
type: string
description: User defined title of the cluster. Title can be changed at any time
description:
type: string
description: Detailed description of the cluster
tags:
type: object
additionalProperties:
type: string
description: Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.
maxLength: 32
pattern: ^[^<%&?/\>]+$
projectId:
type: string
description: Foreign key to the project
pattern: '[0-9A-Za-z-]+'
clusterPrefix:
type: string
description: A cluster prefix
nodes:
type: array
items:
$ref: '#/definitions/EdgeNodeClusterNode'
description: A list of nodes in the cluster
clusterType:
$ref: '#/definitions/EdgeNodeClusterType'
description: Type of the edge-node cluster
manifestUrl:
type: string
description: URL to the configuration manifest
manifest:
type: string
format: byte
description: Configuration manifest in bytes
description: Cluster detail
title: Cluster detail
required:
- projectId
- name
- nodes
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
/v1/cluster/id/{id}/ports:
get:
summary: Get Edge-Node Cluster Interface Ports.
description: Get the list of interface ports for a Edge-Node Cluster record.
operationId: EdgeNodeClusterConfiguration_GetClusterPorts
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EdgeNodeClusterInterfacePorts'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
description: System defined universally unique Id of the cluster
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
/v1/cluster/id/{id}/upgrade:
put:
summary: Upgrade Edge-Node Cluster.
description: Upgrade an Edge-Node Cluster with a new version of the eve-os.
operationId: EdgeNodeClusterConfiguration_UpgradeCluster
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/ZsrvResponse'
'400':
description: Bad Request. The API gateway did not process the request because of missing parameter or invalid value of parameters.
schema:
$ref: '#/definitions/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this operation will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: id
in: path
required: true
type: string
- name: body
in: body
required: true
schema:
$ref: '#/definitions/BaseOSImage'
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
/v1/cluster/name/{name}:
get:
summary: Get Edge-Node Cluster.
description: Get the configuration of a Edge-Node Cluster record.
operationId: EdgeNodeClusterConfiguration_GetClusterByName
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EdgeNodeClusterConfigSummary'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because this edge-node cluster record will conflict with an already existing edge-node cluster record.
schema:
$ref: '#/definitions/ZsrvResponse'
'412':
description: Precondition failed. Some of preconditions haven't been met to start request processing.
schema:
$ref: '#/definitions/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
schema:
$ref: '#/definitions/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
schema:
$ref: '#/definitions/ZsrvResponse'
default:
description: An unexpected error response.
schema:
$ref: '#/definitions/googlerpcStatus'
parameters:
- name: name
description: User defined name of the cluster, unique across the enterprise. Once cluster is created, name can’t be changed
in: path
required: true
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
type: string
tags:
- EdgeNodeClusterConfiguration
externalDocs:
description: ZEDEDA Product Documentation
url: https://help.zededa.com
/v1/cluster/node/id/{id}:
get:
summary: Get Edge-Node Cluster.
description: Get the configuration of a Edge-Node Cluster record by node id.
operationId: EdgeNodeClusterConfiguration_GetClusterByNodeId
responses:
'200':
description: A successful response.
schema:
$ref: '#/definitions/EdgeNodeClusterConfigSummary'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
schema:
$ref: '#/definitions/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have application level access permission for the operation or does not have access scope to the project.
schema:
$ref: '#/definitions/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
schema:
$ref: '#/definitions/ZsrvResponse'
'409':
description: Conflict. The API gateway did not process the request because thi
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-edgenodeclusterconfiguration-api-openapi.yml