How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Volumez

Volumez Orchestrator API

REST API for the Volumez orchestrator — create and modify volumes from declarative policies, plan and auto-provision infrastructure, manage media and nodes, take and roll back snapshots, attach volumes to nodes, publish NFS/exports, configure networks and connectivities, watch asynchronous jobs and alerts, and administer tenants, users, roles and cloud-provider credentials. 124 operations over 95 paths, described by a first-party OpenAPI 3.0.1 document Volumez publishes inside its generated Go client. Authenticated with a JWT bearer token in the `authorization` header, backed by an AWS Cognito user pool.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 218 operations across 95 paths, organized into 24 resource areas, and defines 108 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0 - 8d1ee8c4.

Requests are made against a single base URL, https://api.dev.volumez.com.

218 operations 95 paths 108 schemas 15 DELETE55 GET94 OPTIONS15 PATCH36 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0 - 8d1ee8c4
Base URL
https://api.dev.volumez.com
Authentication
API Key
Resource Areas
24

Authentication & Security 1

Volumez Orchestrator API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (storage.io-authorizer).

Paths & Operations 218

Across 95 paths, the API surfaces 218 operations — 15 DELETE, 55 GET, 94 OPTIONS, 15 PATCH, 36 POST, 3 PUT. They span 24 resource areas, including Volumes, Operations, volumes, Snapshots, Associations, Exports, AutoProvisionVolumes, Attachments, and 16 more. Each is listed below with its method, path, parameters, and response codes.

Volumes 7
GET
/volumes
Get a list of volumes
VolumesList 2 params → 200500404400
POST
/volumes
Create a new volume
VolumeCreate 1 param body → 200409202500404400
DELETE
/volumes/{volume}
Delete a volume
VolumeDelete 3 params → 200500404400
GET
/volumes/{volume}
Get the properties of a volume
VolumeGet 2 params → 200500404400
PATCH
/volumes/{volume}
Modify a volume
VolumeModify 2 params body → 200500404400
GET
/volumes/{volume}/describe
describe existing volume
VolumeDescribe 2 params → 200500404400
POST
/volumes/{volume}/recover
Initiate recover on volume
VolumeRecoverInitiate 2 params → 200500404400
Operations 95
OPTIONS
/volumes
→ 200500400404202409
OPTIONS
/volumes/plan
→ 200500400404202409
OPTIONS
/volumes/snapshot
→ 200500400404202409
OPTIONS
/volumes/snapshot/{snapshot_group_name}
1 param → 200500400404202409
OPTIONS
/volumes/{volume}
1 param → 200500400404202409
OPTIONS
/volumes/{volume}/describe
→ 200500400404202409
OPTIONS
/volumes/{volume}/recover
→ 200500400404202409
OPTIONS
/volumes/{volume}/snapshots
→ 200500400404202409
OPTIONS
/volumes/{volume}/snapshots/{snapshot}
→ 200500400404202409
OPTIONS
/volumes/{volume}/snapshots/{snapshot}/rollback
→ 200500400404202409
OPTIONS
/associations
→ 200500400404202409
OPTIONS
/associations/{association}
1 param → 200500400404202409
OPTIONS
/exports/
→ 200500400404202409
OPTIONS
/exports/{export}
→ 200500400404202409
OPTIONS
/exports/{export}/connect-script
→ 200500400404202409
OPTIONS
/autoprovisionvolumes
→ 200500400404202409
OPTIONS
/snapshots
→ 200500400404202409
OPTIONS
/attachments
→ 200500400404202409
OPTIONS
/volumes/{volume}/attachments
→ 200500400404202409
OPTIONS
/volumes/{volume}/snapshots/{snapshot}/attachments
→ 200500400404202409
OPTIONS
/volumes/{volume}/snapshots/{snapshot}/attachments/{node}
→ 200500400404202409
OPTIONS
/nodes
→ 200500400404202409
OPTIONS
/nodes/tags/{node}
→ 200500400404202409
OPTIONS
/nodes/{node}
→ 200500400404202409
OPTIONS
/nodes/{node}/hw
→ 200500400404202409
OPTIONS
/nodes/{node}/drain
→ 200500400404202409
OPTIONS
/nodes/{node}/describe
→ 200500400404202409
OPTIONS
/nodes/upgrade/{node}
→ 200500400404202409
OPTIONS
/policies
→ 200500400404202409
OPTIONS
/policies/{policy}
→ 200500400404202409
OPTIONS
/policies/{policy}/volumes
→ 200500400404202409
OPTIONS
/policies/{policy}/size/{size}/zone/{zone}
→ 200500400404202409
OPTIONS
/networks
→ 200500400404202409
OPTIONS
/networks/{network}
→ 200500400404202409
OPTIONS
/jobs
→ 200500400404202409
OPTIONS
/jobs/{job}
→ 200500400404202409
OPTIONS
/media
→ 200500400404202409
OPTIONS
/media/{media}
1 param → 200500400404202409
OPTIONS
/media/{media}/assign
→ 200500400404202409
OPTIONS
/media/{media}/unassign
→ 200500400404202409
OPTIONS
/media/{media}/profile
→ 200500400404202409
OPTIONS
/media/{media}/drain
→ 200500400404202409
OPTIONS
/virtualmedia
→ 200500400404202409
OPTIONS
/virtualmedia/{media}
1 param → 200500400404202409
OPTIONS
/connectivities
→ 200500400404202409
OPTIONS
/connectivities/{connectivity}
→ 200500400404202409
OPTIONS
/connectivities/test
→ 200500400404202409
OPTIONS
/capacitygroups
→ 200500400404202409
OPTIONS
/version
→ 200500400404202409
OPTIONS
/alerts
→ 200500400404202409
OPTIONS
/alerts/{alert}/acknowledge
→ 200500400404202409
OPTIONS
/system/features
→ 200500400404202409
OPTIONS
/system/machineinfo
→ 200500400404202409
OPTIONS
/charts
→ 200
OPTIONS
/charts/{proxy+}
1 param
GET
/log/{tenantid}/{logfile}
3 params → 200500400404
OPTIONS
/log/{tenantid}/{logfile}
2 params → 200
OPTIONS
/tenant-cloud-resources/role
→ 200500400404202409
OPTIONS
/tenant-cloud-resources/vm/zones
→ 200500400404202409
OPTIONS
/tenant-cloud-resources/{cloudProviderAccountId}/role
→ 200500400404202409
OPTIONS
/tenant-cloud-resources/{cloudProviderAccountId}/vm/vpcs
→ 200500400404202409
OPTIONS
/tenant-cloud-resources/{cloudProviderAccountId}/vm/{region}/metadata/{nodeId}
→ 200500400404202409
OPTIONS
/tenant-cloud-resources/{cloudProviderAccountId}/vm/{region}/vpcs
→ 200500400404202409
OPTIONS
/infra-planner/create-infra-plan
→ 200500400404202409
OPTIONS
/infra-planner/create-infra-plan/public
→ 200500400404202409
OPTIONS
/infra-planner/provider-pricing-info
→ 200500400404202409
OPTIONS
/provision
→ 200500400404202409
OPTIONS
/signup
→ 200500400404202409
OPTIONS
/signout
→ 200500400404202409
OPTIONS
/signin
→ 200500400404202409
OPTIONS
/tenant/user
→ 200500400404202409
OPTIONS
/tenant/user/requestchangepassword
→ 200500400404202409
OPTIONS
/tenant/user/changepassword
→ 200500400404202409
OPTIONS
/tenant/user/changepasswordloggedin
→ 200500400404202409
OPTIONS
/tenant/user/confirmation
→ 200500400404202409
OPTIONS
/add-user
→ 200500400404202409
OPTIONS
/disable-user/{email}
→ 200500400404202409
OPTIONS
/enable-user/{email}
→ 200500400404202409
OPTIONS
/invite-user/{email}
→ 200500400404202409
OPTIONS
/users/{tenantId}
→ 200500400404202409
OPTIONS
/azuremarketplace/subscription
→ 200500400404202409
OPTIONS
/tenant/refreshtoken
→ 200500400404202409
OPTIONS
/tenant/token
→ 200500400404202409
OPTIONS
/tenant/tenantid
→ 200500400404202409
OPTIONS
/tenant/{tenantID}/tenanthosts/{tenantHost}
→ 200500400404202409
OPTIONS
/tenant/tenanthost/credentials
→ 200500400404202409
OPTIONS
/tenant/tenanthost
→ 200500400404202409
OPTIONS
/tenant/apiaccess/credentials/refresh
→ 200500400404202409
OPTIONS
/sso/azure/mapping
→ 200500400404202409
OPTIONS
/sso/callback/{userPoolID}/{applicationClientId}
→ 200500400404202409
OPTIONS
/tenant-settings
1 param → 200500400404202409
OPTIONS
/tenant-settings/reset
1 param → 200500400404202409
OPTIONS
/roles/{tenantId}/{userId}
3 params → 200500400404202409
OPTIONS
/roles
1 param → 200500400404202409
OPTIONS
/role/{userId}/{roleId}
3 params → 200500400404202409
volumes 1
POST
/volumes/plan
check if volumes can be created
BatchVolumesPlan 2 params body → 200500404400
Snapshots 9
POST
/volumes/snapshot
Create a new snapshot for given consistency group
ConsistencyGroupSnapshotCreate 1 param body → 200500404400
GET
/volumes/snapshot/{snapshot_group_name}
List of snapshots group
ConsistencyGroupGet 2 params → 200500404400
GET
/volumes/{volume}/snapshots
Get a list of snapshots
SnapshotsList 2 params → 200500404400
POST
/volumes/{volume}/snapshots
Create a new snapshot
SnapshotCreate 2 params body → 200500404400
DELETE
/volumes/{volume}/snapshots/{snapshot}
Delete a snapshot
SnapshotDelete 4 params → 200500404400
GET
/volumes/{volume}/snapshots/{snapshot}
Get the properties of a snapshot
SnapshotGet 3 params → 200500404400
PATCH
/volumes/{volume}/snapshots/{snapshot}
Modify a snapshot
SnapshotModify 3 params body → 200500404400
PATCH
/volumes/{volume}/snapshots/{snapshot}/rollback
Roll back to snapshot
SnapshotRollback 3 params → 200500404400
GET
/snapshots
Get a list of all snapshots
SnapshotsListAll 2 params → 200500404400
Associations 4
GET
/associations
Get a list of associations
AssociationsList 3 params → 200500404400
POST
/associations
Create association
AssociationCreate 1 param body → 200500404400
DELETE
/associations/{association}
Delete an association
AssociationDelete 2 params → 200500404400
PATCH
/associations/{association}
Association modify
AssociationModify 2 params body → 200500404400
Exports 5
GET
/exports/
Get a list of associations
ExportsList 3 params → 200500404400
POST
/exports/
Create export
ExportCreate 1 param body → 200500404400
DELETE
/exports/{export}
Delete an export
ExportDelete 3 params → 200500404400
PATCH
/exports/{export}
Modify an export
ExportModify 2 params body → 200500404400
GET
/exports/{export}/connect-script
Retruns commands to connect to export
ExportConnectScript 3 params → 200500404400
AutoProvisionVolumes 1
POST
/autoprovisionvolumes
Create a new auto provisioned volume
AutoProvisionVolumes 1 param body → 200409202500404400
Attachments 7
GET
/attachments
Get a list of all attachments
AttachmentsListAll 1 param → 200500404400
GET
/volumes/{volume}/attachments
Get a list of attachments for a given volume
AttachmentsListForVolume 2 params → 200500404400
GET
/volumes/{volume}/snapshots/{snapshot}/attachments
Get a list of attachments for a given volume and snapshot
AttachmentsList 3 params → 200500404400
POST
/volumes/{volume}/snapshots/{snapshot}/attachments
Create a new attachment
AttachmentCreate 3 params body → 200500404400
DELETE
/volumes/{volume}/snapshots/{snapshot}/attachments/{node}
Delete an attachment
AttachmentDelete 5 params → 200500404400
GET
/volumes/{volume}/snapshots/{snapshot}/attachments/{node}
Get the properties of an attachment
AttachmentGet 4 params → 200500404400
PATCH
/volumes/{volume}/snapshots/{snapshot}/attachments/{node}
Modify an attachment
AttachmentModify 4 params body → 200500404400
Nodes 8
GET
/nodes
Get a list of nodes
NodesList 1 param → 200500404400
PATCH
/nodes/tags/{node}
Set the tags of a node
NodeSetTags 2 params body → 200400404500
DELETE
/nodes/{node}
Delete a node
NodeDelete 4 params → 200500404400
GET
/nodes/{node}
Get the properties of a node
NodeGet 2 params → 200400404500
POST
/nodes/{node}/hw
Node hardware scan
NodeHwScan 3 params → 200500404400
POST
/nodes/{node}/drain
Node drain
NodeDrain 3 params → 200500404400
GET
/nodes/{node}/describe
Node describe
NodeDescribe 2 params → 200400404500
POST
/nodes/upgrade/{node}
performing node version upgrade
NodeUpgrade 2 params body → 200400404500
Policies 7

Policies allow you to declare the desired characteristics of volumes you will later create. Policies are expressed in terms of outcomes (such as desired performance and resiliency…

GET
/policies
Get a list of policies
PoliciesList 1 param → 200500404400
POST
/policies
Create a new policy
PolicyCreate 1 param body → 200500404400
DELETE
/policies/{policy}
Delete a policy
PolicyDelete 2 params → 200500404400
GET
/policies/{policy}
Get the properties of a policy
PolicyGet 2 params → 200500404400
PATCH
/policies/{policy}
Modify a policy
PolicyModify 2 params body → 200500404400
GET
/policies/{policy}/volumes
Get the properties of a policy
PolicyGetVolumes 2 params → 200500404400
GET
/policies/{policy}/size/{size}/zone/{zone}
Show policy volume create plan
PolicyPlan 5 params → 200404500400
Networks 5
GET
/networks
Get a list of networks
NetworksList 1 param → 200500404400
POST
/networks
Create a new network
NetworkCreate 1 param body → 200500404400
DELETE
/networks/{network}
Delete a network
NetworkDelete 2 params → 200500404400
GET
/networks/{network}
Get the properties of a network
NetworkGet 2 params → 200500404400
PATCH
/networks/{network}
Modify a network
NetworkModify 2 params body → 200500404400
Jobs 3
GET
/jobs
Get a list of jobs
JobsList 4 params → 200500404400
DELETE
/jobs/{job}
Delete a job
JobDelete 2 params → 200500404400
GET
/jobs/{job}
Get the properties of a job
JobGet 3 params → 200500404400
Media 10
GET
/media
Get a list of media
MediaList 1 param → 200500404400
DELETE
/media/{media}
Delete a media
MediaDelete 3 params → 200500404400
GET
/media/{media}
Get the properties of a media
MediaGet 2 params → 200500404400
PATCH
/media/{media}/assign
Assign media
MediaAssign 5 params → 200500404400
PATCH
/media/{media}/unassign
Unassign media
MediaUnassign 2 params → 200500404400
PATCH
/media/{media}/profile
Modify a media profile
MediaProfileModify 2 params body → 200500404400
POST
/media/{media}/drain
Media drain
MediaDrain 2 params → 200500404400
GET
/virtualmedia
Get a list of virtual media
VirtualMediaList 3 params → 200500404400
POST
/virtualmedia
Create (virtual) media
VirtualMediaCreate 1 param body → 200500404400
DELETE
/virtualmedia/{media}
Delete virtual media
VirtualMediaDelete 2 params → 200500404400
Connectivities 6
GET
/connectivities
Get a list of connectivities
ConnectivitiesList 1 param → 200500404400
POST
/connectivities
Create a new connectivity
ConnectivityCreate 1 param body → 200500404400
DELETE
/connectivities/{connectivity}
Delete a connectivity
ConnectivityDelete 2 params → 200500404400
GET
/connectivities/{connectivity}
Get the properties of a connectivity
ConnectivityGet 2 params → 200500404400
PATCH
/connectivities/{connectivity}
Modify a connectivity
ConnectivityModify 2 params body → 200500404400
POST
/connectivities/test
Test connectivity
ConnectivityCheck 1 param body → 200500404400
CapacityGroups 1
GET
/capacitygroups
Get available capacity groups
capacityGroupGet 1 param → 200500404400
Version 1
GET
/version
Get version of sio
versionGet 1 param → 200500404400
Alerts 2
GET
/alerts
Get a list of alerts
AlertsList 2 params → 200500404400
POST
/alerts/{alert}/acknowledge
Acknowledge a pending alert
AlertAcknowledge 2 params → 200500404400
System 2
GET
/system/features
GetFeaturesList 1 param → 200500404400
GET
/system/machineinfo
get system info
GetMachineInfo 1 param → 200500404400
TenantCloudResources 8
GET
/tenant-cloud-resources/role
Get All Tenant roles
getAllRoles 1 param → 200500
POST
/tenant-cloud-resources/role
Create tenant cloud role
createRole 1 param body → 201400409500
GET
/tenant-cloud-resources/vm/zones
Get cloud provider zones for requested region
getVMZones 2 params → 200404500
DELETE
/tenant-cloud-resources/{cloudProviderAccountId}/role
Delete tenant role resource by the given cloudProviderAccountId query param
deleteRole 2 params → 202404500
PUT
/tenant-cloud-resources/{cloudProviderAccountId}/role
Update tenant cloud role for the given cloudProviderAccountId
updateRole 2 params body → 204400404500
GET
/tenant-cloud-resources/{cloudProviderAccountId}/vm/vpcs
Get all tenant's cloud VM's available VPCs
getVMVPCs 2 params → 200404500
GET
/tenant-cloud-resources/{cloudProviderAccountId}/vm/{region}/metadata/{nodeId}
Get tenant's cloud VM' metadata by region
getVMMetadataByRegion 4 params → 200404500
GET
/tenant-cloud-resources/{cloudProviderAccountId}/vm/{region}/vpcs
Get tenant's cloud VM's available VPCs by region
getVMVPCsByRegion 3 params → 200404500
infra-planner 3
POST
/infra-planner/create-infra-plan
createInfraPlan 2 params body → 400404500200
POST
/infra-planner/create-infra-plan/public
createPublicInfraPlan body → 400500200
POST
/infra-planner/provider-pricing-info
ProviderPricingInfo body → 400500200
provision-service 1
POST
/provision
Volumez connector provisioning
Provision body → 200500
user 26
POST
/signup
Create Tenant's first user
SignUp body → 200401500
POST
/signout
Signs out user from all devices
signOut body → 200401500
POST
/signin
User SignIn
signIn body → 200400404500
GET
/tenant/user
Get user details
getTenantUser 1 param → 200500
POST
/tenant/user
Create Tenant's additional user
TenantUserCreate 1 param body → 200500
POST
/tenant/user/requestchangepassword
Request change client password
requestChangePassword body → 200500
POST
/tenant/user/changepassword
Change client password
approveChangePassword body → 200500
POST
/tenant/user/changepasswordloggedin
Change clients password when user is logged in
ChangePasswordLoggedIn 1 param body → 200500
GET
/tenant/user/confirmation
Confirm user signup
userConfirm 3 params → 200500
POST
/add-user
Add user to tenant group users
addUser body → 200500
POST
/disable-user/{email}
disable user
disableUser 2 params → 200500
POST
/enable-user/{email}
enable user
enableUser 2 params → 200500
POST
/invite-user/{email}
invite a user to join tenant (send add user signup email
inviteUser 2 params → 200500
GET
/users/{tenantId}
List all tenant group users
TenantUsers 2 params → 200500
GET
/azuremarketplace/subscription
get subscription
GetSubscription 1 param → 200404500
POST
/tenant/refreshtoken
getTenantRefreshToken body → 500200
GET
/tenant/token
getTenantAccessToken 1 param → 500200
GET
/tenant/tenantid
GetTenantIDFromTenantToken 1 param → 500200
DELETE
/tenant/{tenantID}/tenanthosts/{tenantHost}
deleteTenantHost 3 params → 500200
GET
/tenant/tenanthost/credentials
TenantHostAccessCredentials 2 params → 500200
GET
/tenant/tenanthost
getTenantHost 2 params → 500200
GET
/tenant/apiaccess/credentials/refresh
RefreshTenantAPIAccessCredentials 1 param → 500200
DELETE
/sso/azure/mapping
Delete Azure SSO Mapping
deleteAzureSSOMapping 1 param → 204500
GET
/sso/azure/mapping
Get Azure SSO Mapping
getAzureSSOMapping 1 param → 200500
PUT
/sso/azure/mapping
Put Azure SSO Mapping
putAzureSSOMapping 1 param body → 204500
GET
/sso/callback/{userPoolID}/{applicationClientId}
Handle SSO callback
handleSSOCallback 3 params → 302500
tenant-settings 3
GET
/tenant-settings
Get tenant settings
getTenantSettings 1 param → 200500
PUT
/tenant-settings
Modify tenant settings
modifyTenantSettings 1 param body → 202429500
PATCH
/tenant-settings/reset
Reset tenant settings
resetTenantSettings 1 param body → 202429500
auth 3
GET
/roles/{tenantId}/{userId}
Get all user roles
getRolesFromUserID 3 params → 200500
GET
/roles
Get all tenant roles
getAllRolesForTenant 1 param → 200500
PATCH
/role/{userId}/{roleId}
Update user role
updateUserRole 3 params → 200500

Schemas 108

The contract defines 108 schemas that model the data the API accepts and returns. The most detailed are Media (38 properties), Policy (30 properties), VolumeGroup (30 properties), CreateInfraPlanRequest_policy_settings (26 properties). Each schema is shown below with its type and property counts.

AutoProvisionVolume
object
10 properties 7 required
AutoProvisionInfraPlan
object
5 properties
Volume
object
25 properties 4 required
Node
object
25 properties 2 required
NodeVersion
object
1 property
NodeDescribeResponse
object
1 property
RefreshToken
object
1 property
GetTenantRefreshTokenRequest
object
3 properties 2 required
Policy
object
30 properties 2 required
VolumeGroup
object
30 properties
SignInResponse
object
5 properties 5 required
ErrorResponse
object
1 property
RegularResponse
object
1 property
VolumePlanOutput
object
3 properties
SuccessJobResponse
object
3 properties
ErrorJobResponse
object
4 properties
ChangePasswordRequestLoggedIn
object
5 properties
CapacityGroup
object
1 property
VersionResponse
object
2 properties
SignUpResponse
object
2 properties 1 required
TenantTokenResponse
object
3 properties 3 required
RefreshTokenResponse
object
5 properties
TenantHostDeleteResponse
object
2 properties 1 required
Network
object
5 properties 4 required
Tags
object
Job
object
12 properties
Snapshot
object
16 properties 2 required
Attachment
object
11 properties 1 required
Media
object
38 properties
MediaProfile
object
10 properties
VirtualMediaCreate
object
2 properties
VirtualMedia
object
3 properties
Plan
object
2 properties 1 required
Connectivity
object
8 properties 7 required
ConnectivityCheck
object
2 properties
Alert
object
10 properties
GetTenantIDResponse
object
3 properties 1 required
GetTenantHostResponse
object
4 properties 1 required
AssociationCreate
object
5 properties
AssociationModify
object
3 properties
Association
object
8 properties
ExportCreate
object
7 properties
ExportModify
object
2 properties
Export
object
10 properties
Authentication
object
2 properties
StoragePort
object
2 properties
MachineInfo
object
14 properties
CloudProviderType
string
Region
string
NodeId
string
CreateAwsRoleRequest
object
2 properties
CreateAzureRoleRequest
object
4 properties
CreateRoleRequest
object
6 properties
UpdateAwsRoleRequest
object
2 properties
UpdateAzureRoleRequest
object
3 properties
UpdateRoleRequest
object
3 properties
EmptyResponse
object
CreateRoleResponse
GetRolesResponse
object
4 properties 1 required
CloudProvider
object
2 properties 2 required
CloudProviderAccountId
string
AWSRoleItem
object
2 properties 1 required
AzureRoleItem
object
3 properties 3 required
AvailableVPCItem
object
6 properties 3 required
GetVMVPCsResponse
object
VMRegionZones
object
AzureVMRegionZones
object
AzureVMRegion
object
2 properties
GetVmRegionZonesResponse
object
2 properties
AzureSecret
object
2 properties
GetVMMetadataResponse
object
1 property
OSType
string
ProviderPriceItem
object
3 properties 3 required
CreateInfraPlanRequest
object
8 properties 3 required
CreateInfraPlanResponse
object
17 properties 16 required
ProviderPricingInfoRequest
object
4 properties 3 required
ProviderPricingInfoResponse
object
1 property 1 required
SignUpRequest
object
5 properties 3 required
SignInRequest
object
2 properties 2 required
SignOutRequest
object
1 property 1 required
RequestChangePassword
object
1 property
ChangePasswordApproveRequest
object
3 properties
CreateAddTenantUserRequest
object
4 properties 4 required
GetTenantUserResponse
object
5 properties
AddUserRequest
object
4 properties 4 required
TenantUser
object
6 properties 5 required
InviteUserResponse
object
4 properties 4 required
GetAzureSSOMappingResponse
object
1 property 1 required
PutAzureSSOMappingRequest
object
1 property 1 required
GetTenantSettingsResponse
object
1 property
ModifyTenantSettingsRequest
object
1 property
ModifyTenantSettingsResponse
ResetTenantSettingsRequest
object
1 property 1 required
ResetTenantSettingsResponse
BatchVolumesPlan_request_Volumes_inner
object
3 properties 1 required
BatchVolumesPlan_request
object
4 properties
ConsistencyGroupSnapshotCreate_request
object
4 properties
ExportCreate_nodes_inner
object
2 properties
Authentication_chap
object
2 properties
GetRolesResponse_roles_inner
object
3 properties 1 required
CreateInfraPlanRequest_policy_settings
object
26 properties
CreateInfraPlanRequest_policy
object
2 properties
GetTenantSettingsResponse_support
object
1 property
ModifyTenantSettingsRequest_settingsToModify
object
1 property
ProvisionRequest
object
7 properties
ProvisionResponse
object
1 property
AdditionalParam
object
2 properties
Version
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

volumez-orchestrator-api-openapi.yaml Raw ↑
#Storage#Block Storage#Data Infrastructure#Snapshots#Kubernetes
← Back to V APIs
API Details
ID
volumez:volumez-orchestrator-api
Base URL
https://api.dev.volumez.com
Docs
https://github.com/VolumezTech/volumez-rest-client
Provider
Volumez
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=volumez-volumez-orchestrator-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/volumez-volumez-orchestrator-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Volumez Orchestrator API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.