Zededa VolumeInstanceStatus API
The VolumeInstanceStatus API from Zededa — 6 operation(s) for volumeinstancestatus.
The VolumeInstanceStatus API from Zededa — 6 operation(s) for volumeinstancestatus.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zededa-volumeinstancestatus-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: ZEDEDA App Profiles Service AppProfileService Volume Instance Status 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
servers:
- url: /api
security:
- BearerToken: []
tags:
- name: VolumeInstanceStatus
paths:
/v1/volumes/instances/id/{id}/status:
get:
summary: Get edge volume instance status
description: Get the status of an edge volume instance record.
operationId: VolumeInstanceStatus_GetVolumeInstanceStatus
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/VolInstStatusMsg'
'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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- VolumeInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
/v1/volumes/instances/id/{objid}/events:
get:
summary: Get edge volume instance events by id
description: Get configuration and status events of an edge volume by id.
operationId: VolumeInstanceStatus_GetVolumeInstanceEvents
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/EventQueryResponse'
'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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: objid
description: Object id
in: path
required: true
schema:
type: string
- name: startTime
description: start time in timestamp
in: query
required: false
schema:
type: string
format: date-time
- name: endTime
description: end time
in: query
required: false
schema:
type: string
format: date-time
- name: severity
description: severity
in: query
required: false
schema:
type: string
- name: resource
description: resource
in: query
required: false
schema:
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- VolumeInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
/v1/volumes/instances/name/{name}/status:
get:
summary: Get edge volume instance status
description: Get the status of an edge volume instance record.
operationId: VolumeInstanceStatus_GetVolumeInstanceStatusByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/VolInstStatusMsg'
'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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- VolumeInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
/v1/volumes/instances/name/{objname}/events:
get:
summary: Get edge volume instance events by name
description: Get configuration and status events of an edge volume by name.
operationId: VolumeInstanceStatus_GetVolumeInstanceEventsByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/EventQueryResponse'
'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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: objname
description: Object name
in: path
required: true
schema:
type: string
- name: startTime
description: start time in timestamp
in: query
required: false
schema:
type: string
format: date-time
- name: endTime
description: end time
in: query
required: false
schema:
type: string
format: date-time
- name: severity
description: severity
in: query
required: false
schema:
type: string
- name: resource
description: resource
in: query
required: false
schema:
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- VolumeInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
/v1/volumes/instances/status:
get:
summary: Query status of edge volume instances
description: Query the status of edge volume instance records.
operationId: VolumeInstanceStatus_QueryVolumeInstanceStatus
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/VolInstStatusListMsg'
'400':
description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: deviceName
in: query
required: false
schema:
type: string
- name: projectName
in: query
required: false
schema:
type: string
- name: namePattern
in: query
required: false
schema:
type: string
- name: runState
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- ONLINE
- HALTED
- INIT
- REBOOTING
- OFFLINE
- UNKNOWN
- UNPROVISIONED
- PROVISIONED
- SUSPECT
- DOWNLOADING
- RESTARTING
- PURGING
- HALTING
- ERROR
- VERIFYING
- LOADING
- CREATING_VOLUME
- BOOTING
- MAINTENANCE_MODE
- START_DELAYED
- BASEOS_UPDATING
- PREPARING_POWEROFF
- POWERING_OFF
- PREPARED_POWEROFF
default: UNSPECIFIED
- name: type
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- EMPTYDIR
- BLOCKSTORAGE
- HOSTFS
- TMPFS
- SECRET
- NFS
- AWS_BLOCK_STORAGE
- CONTENT_TREE
default: UNSPECIFIED
- name: imageName
in: query
required: false
schema:
type: string
- name: appInstName
in: query
required: false
schema:
type: string
- name: deviceNamePattern
in: query
required: false
schema:
type: string
- name: projectNamePattern
in: query
required: false
schema:
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: summary
in: query
required: false
schema:
type: boolean
- name: fields
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- VolumeInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
/v1/volumes/instances/status-config:
get:
summary: Query status and config of edge volume instances
description: Query the status and config of edge volume instance records.
operationId: VolumeInstanceStatus_QueryVolumeInstanceStatusConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/VolInstStatusListMsg'
'400':
description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/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.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: deviceName
in: query
required: false
schema:
type: string
- name: projectName
in: query
required: false
schema:
type: string
- name: namePattern
in: query
required: false
schema:
type: string
- name: runState
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- ONLINE
- HALTED
- INIT
- REBOOTING
- OFFLINE
- UNKNOWN
- UNPROVISIONED
- PROVISIONED
- SUSPECT
- DOWNLOADING
- RESTARTING
- PURGING
- HALTING
- ERROR
- VERIFYING
- LOADING
- CREATING_VOLUME
- BOOTING
- MAINTENANCE_MODE
- START_DELAYED
- BASEOS_UPDATING
- PREPARING_POWEROFF
- POWERING_OFF
- PREPARED_POWEROFF
default: UNSPECIFIED
- name: type
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- EMPTYDIR
- BLOCKSTORAGE
- HOSTFS
- TMPFS
- SECRET
- NFS
- AWS_BLOCK_STORAGE
- CONTENT_TREE
default: UNSPECIFIED
- name: imageName
in: query
required: false
schema:
type: string
- name: appInstName
in: query
required: false
schema:
type: string
- name: deviceNamePattern
in: query
required: false
schema:
type: string
- name: projectNamePattern
in: query
required: false
schema:
type: string
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: summary
in: query
required: false
schema:
type: boolean
- name: fields
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- VolumeInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/storage
components:
schemas:
infoStorageVolumePVCStatus:
type: string
enum:
- STORAGE_VOLUME_PVC_STATUS_UNSPECIFIED
- STORAGE_VOLUME_PVC_STATUS_BOUND
- STORAGE_VOLUME_PVC_STATUS_PENDING
- STORAGE_VOLUME_PVC_STATUS_AVAILABLE
- STORAGE_VOLUME_PVC_STATUS_RELEASED
- STORAGE_VOLUME_PVC_STATUS_FAILED
default: STORAGE_VOLUME_PVC_STATUS_UNSPECIFIED
title: "StorageVolumePVCStatus is the kubernetes 'phase' of a PVC. Listed as status in cli.\n Refer to: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase"
ZsrvError:
type: object
properties:
ec:
$ref: '#/components/schemas/ZsrvErrorCode'
title: 'Enumrated error code, describes more granular numerical
value than just httpStatus'
location:
type: string
title: 'Ignore: Internal field only'
details:
type: string
title: Field captures string description of details
VolInstStatusListMsg:
type: object
properties:
list:
type: array
items:
$ref: '#/components/schemas/VolInstStatusSummaryMsg'
summaryByState:
$ref: '#/components/schemas/Summary'
summaryByType:
$ref: '#/components/schemas/Summary'
totalCount:
type: integer
format: int64
next:
$ref: '#/components/schemas/Cursor'
Summary:
type: object
properties:
description:
type: string
description: Summary description
total:
type: number
format: int64
description: Total
values:
type: object
additionalProperties:
type: integer
format: int64
description: 'Values: Map for storing <string, uint32>'
description: Summary is used to store the Summary details
title: Summary is used to store the Summary details
protobufAny:
type: object
properties:
typeUrl:
type: string
value:
type: string
format: byte
Entity:
type: string
enum:
- ENTITY_UNSPECIFIED
- ENTITY_BASE_OS
- ENTITY_SYSTEM_ADAPTER
- ENTITY_VAULT
- ENTITY_ATTESTATION
- ENTITY_APP_INSTANCE
- ENTITY_PORT
- ENTITY_NETWORK
- ENTITY_NETWORK_INSTANCE
- ENTITY_CONTENT_TREE
- ENTITY_CONTENT_BLOB
- ENTITY_VOLUME
default: ENTITY_UNSPECIFIED
description: "- ENTITY_UNSPECIFIED: Invalid Device Entity\n - ENTITY_BASE_OS: Base OS entity\n - ENTITY_SYSTEM_ADAPTER: System Adapter Entity\n - ENTITY_VAULT: Vault Entity\n - ENTITY_ATTESTATION: Attestation Entity\n - ENTITY_APP_INSTANCE: App Instance Entity\n - ENTITY_PORT: Port Entity\n - ENTITY_NETWORK: Network Entity\n - ENTITY_NETWORK_INSTANCE: Network Instance Entity\n - ENTITY_CONTENT_TREE: ContentTree Entity\n - ENTITY_CONTENT_BLOB: Blob Entity\n - ENTITY_VOLUME: VOLUME Entity"
title: Edge node components
Cursor:
type: object
properties:
pageToken:
type: string
description: Page Token
orderBy:
type: array
items:
type: string
description: OrderBy helps in sorting the list response
pageNum:
type: number
format: int64
description: Page Number
pageSize:
type: number
format: int64
description: Defines the page size
totalPages:
type: number
format: int64
description: Total number of pages to be fetched.
description: 'Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. '
title: Cursor is used as filter in list operation.
infoStorageVolumeRobustness:
type: string
enum:
- STORAGE_VOLUME_ROBUSTNESS_UNSPECIFIED
- STORAGE_VOLUME_ROBUSTNESS_HEALTHY
- STORAGE_VOLUME_ROBUSTNESS_DEGRADED
- STORAGE_VOLUME_ROBUSTNESS_FAULTED
default: STORAGE_VOLUME_ROBUSTNESS_UNSPECIFIED
title: "StorageVolumeRobustness is the 'robustness' of a replicated csi-driver volume.\n Refer to: https://github.com/longhorn/longhorn-manager/blob/v1.6.2/k8s/pkg/apis/longhorn/v1beta1/volume.go#L25"
VolInstStatusMsg:
type: object
properties:
id:
type: string
name:
type: string
deviceId:
type: string
title: device on which this volume is located
runState:
$ref: '#/components/schemas/RunState'
projectId:
type: string
progressPercentage:
type: integer
format: int64
usage:
$ref: '#/components/schemas/DeviceObjectUsageInfo'
resource:
$ref: '#/components/schemas/VolInstResource'
sha256:
type: string
type:
$ref: '#/components/schemas/VolumeInstanceType'
deviceState:
$ref: '#/components/schemas/SWState'
blobs:
type: array
items:
$ref: '#/components/schemas/BlobInfo'
errInfo:
type: array
items:
$ref: '#/components/schemas/DeviceError'
rawStatus:
type: string
clusterVolInstanceStatus:
$ref: '#/components/schemas/ClusterVolInstanceStatus'
DeviceEntity:
type: object
properties:
entity:
$ref: '#/components/schemas/Entity'
entityId:
type: string
entityName:
type: string
ZcOpsType:
type: string
enum:
- OPS_TYPE_UNSPECIFIED
- OPS_TYPE_READ
- OPS_TYPE_DELETE
- OPS_TYPE_CREATE
- OPS_TYPE_UPDATE
- OPS_TYPE_LIST
default: OPS_TYPE_UNSPECIFIED
title: ZedCloud internal operation type
EventQueryResponseItem:
type: object
properties:
user:
type: string
description: User name
project:
type: string
description: project name
device:
type: string
description: device name
instance:
type: string
description: instance name
severity:
type: string
description: 'severity: FIXME: should be ENUM'
descriptio
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-volumeinstancestatus-api-openapi.yml