Every API here is available over the APIs.io API and to AI agents over MCP.
openapi: 3.2.0
info:
description: Volumez orchestrator API
title: Volumez Networks API
version: 1.0.0 - 8d1ee8c4
x-squire-version: 1.54.0
servers:
- url: https://api.dev.volumez.com
tags:
- description: ''
name: Networks
paths:
/networks:
get:
operationId: NetworksList
parameters:
- explode: false
in: header
name: authorization
required: false
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/Network'
type: array
description: List of networks
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error getting a list of networks
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error getting a list of networks
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error getting a list of networks
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
security:
- storage.io-authorizer: []
summary: Get a list of networks
tags:
- Networks
x-amazon-apigateway-integration:
httpMethod: get
uri: http://vlz-main-nlb-18ba9f518fe57637.elb.us-east-1.amazonaws.com:8991:8000/networks
passthroughBehavior: when_no_match
type: http_proxy
timeoutInMillis: 29000
requestParameters:
integration.request.header.X-Request-ID: context.requestId
options:
responses:
'200':
content: {}
description: 200 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
Access-Control-Allow-Methods:
explode: false
schema:
type: string
style: simple
Access-Control-Allow-Headers:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 500 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 400 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 404 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 202 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 409 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Methods: '''GET,OPTIONS,POST,PATCH,DELETE'''
method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'''
method.response.header.Access-Control-Allow-Origin: '''*'''
requestTemplates:
application/json: '{"statusCode": 200}'
passthroughBehavior: when_no_match
type: mock
tags:
- Networks
summary: Describe networks
x-summary-source: derived
operationId: optionsNetworks
x-operation-id-source: derived
post:
operationId: NetworkCreate
parameters:
- explode: false
in: header
name: authorization
required: false
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Network'
description: A Network object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RegularResponse'
description: New network was created successfully
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error creating new network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error creating new network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error creating new network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
security:
- storage.io-authorizer: []
summary: Create a new network
tags:
- Networks
x-amazon-apigateway-integration:
httpMethod: post
uri: http://vlz-main-nlb-18ba9f518fe57637.elb.us-east-1.amazonaws.com:8991:8000/networks
passthroughBehavior: when_no_match
type: http_proxy
timeoutInMillis: 29000
requestParameters:
integration.request.header.X-Request-ID: context.requestId
x-codegen-request-body-name: body
/networks/{network}:
delete:
operationId: NetworkDelete
parameters:
- explode: false
in: path
name: network
required: true
schema:
type: string
style: simple
- explode: false
in: header
name: authorization
required: false
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RegularResponse'
description: A network was deleted successfully
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error deleting a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error deleting a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error deleting a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
security:
- storage.io-authorizer: []
summary: Delete a network
tags:
- Networks
x-amazon-apigateway-integration:
httpMethod: delete
uri: http://vlz-main-nlb-18ba9f518fe57637.elb.us-east-1.amazonaws.com:8991:8000/networks/{network}
passthroughBehavior: when_no_match
type: http_proxy
timeoutInMillis: 29000
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.path.network: method.request.path.network
get:
operationId: NetworkGet
parameters:
- explode: false
in: path
name: network
required: true
schema:
type: string
style: simple
- explode: false
in: header
name: authorization
required: false
schema:
type: string
style: simple
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Network'
description: Properties of a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error getting properties of a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error getting properties of a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error getting properties of a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
security:
- storage.io-authorizer: []
summary: Get the properties of a network
tags:
- Networks
x-amazon-apigateway-integration:
httpMethod: get
uri: http://vlz-main-nlb-18ba9f518fe57637.elb.us-east-1.amazonaws.com:8991:8000/networks/{network}
passthroughBehavior: when_no_match
type: http_proxy
timeoutInMillis: 29000
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.path.network: method.request.path.network
options:
responses:
'200':
content: {}
description: 200 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
Access-Control-Allow-Methods:
explode: false
schema:
type: string
style: simple
Access-Control-Allow-Headers:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 500 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 400 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 404 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'202':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 202 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: 409 response
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
x-amazon-apigateway-integration:
responses:
default:
statusCode: '200'
responseParameters:
method.response.header.Access-Control-Allow-Methods: '''GET,OPTIONS,POST,PATCH,DELETE'''
method.response.header.Access-Control-Allow-Headers: '''Content-Type,X-Amz-Date,Authorization,X-Api-Key,X-Amz-Security-Token'''
method.response.header.Access-Control-Allow-Origin: '''*'''
requestTemplates:
application/json: '{"statusCode": 200}'
passthroughBehavior: when_no_match
type: mock
tags:
- Networks
summary: Describe networks by network
x-summary-source: derived
operationId: optionsNetworksByNetwork
x-operation-id-source: derived
patch:
operationId: NetworkModify
parameters:
- explode: false
in: path
name: network
required: true
schema:
type: string
style: simple
- explode: false
in: header
name: authorization
required: false
schema:
type: string
style: simple
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Network'
description: A Network object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/RegularResponse'
description: A network was updated successfully
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error updating a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error updating a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
description: Error updating a network
headers:
Access-Control-Allow-Origin:
explode: false
schema:
type: string
style: simple
security:
- storage.io-authorizer: []
summary: Modify a network
tags:
- Networks
x-amazon-apigateway-integration:
httpMethod: patch
uri: http://vlz-main-nlb-18ba9f518fe57637.elb.us-east-1.amazonaws.com:8991:8000/networks/{network}
passthroughBehavior: when_no_match
type: http_proxy
timeoutInMillis: 29000
requestParameters:
integration.request.header.X-Request-ID: context.requestId
integration.request.path.network: method.request.path.network
x-codegen-request-body-name: body
components:
schemas:
Network:
example:
zone: zone
name: name
ipend: ipend
type: management
ipstart: ipstart
properties:
name:
minLength: 1
type: string
zone:
minLength: 1
type: string
type:
enum:
- management
- storage
type: string
ipstart:
pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3})|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$
type: string
ipend:
pattern: ^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3})|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$
type: string
required:
- ipend
- ipstart
- name
- type
type: object
ErrorResponse:
example:
message: message
properties:
message:
type: string
x-omitempty: false
x-isnullable: false
type: object
RegularResponse:
example:
Message: Message
properties:
Message:
type: string
type: object
securitySchemes:
storage.io-authorizer:
in: header
name: authorization
type: apiKey
x-amazon-apigateway-authtype: cognito_user_pools
x-amazon-apigateway-authorizer:
providerARNs:
- arn:aws:cognito-idp:us-east-1:125714719355:userpool/us-east-1_Mk5LdUo2I
type: cognito_user_pools
x-amazon-apigateway-gateway-responses:
DEFAULT_5XX:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
DEFAULT_4XX:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
UNAUTHORIZED:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
ACCESS_DENIED:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
RESOURCE_NOT_FOUND:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
THROTTLED:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
AUTHORIZER_FAILURE:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
AUTHORIZER_CONFIGURATION_ERROR:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
INVALID_API_KEY:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
BAD_REQUEST_PARAMETERS:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
BAD_REQUEST_BODY:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
REQUEST_TOO_LARGE:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
UNSUPPORTED_MEDIA_TYPE:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
API_CONFIGURATION_ERROR:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
QUOTA_EXCEEDED:
responseParameters:
gatewayresponse.header.access-control-allow-origin: '''*'''
responseTemplates:
application/json: '{"Message":$context.error.messageString}'
x-original-swagger-version: '2.0'