Block Storage

API for block storage operations

Version: 0.1.0

Server

URL: https://api.kopernik.us/v0
- Kopernik.us API server

Paths

/resource/blockstorage/{providerUid}

GET

List block storage volumes

List block storage volumes for the specified provider

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
nextToken	query	string	❌	Token for the next page of volumes, if there are more items to fetch
maxResults	query	integer	❌	Maximum number of volumes to fetch
jq	query	string	❌	JQ filter expression to filter the results. Only resources where the expression evaluates to a truthy value are included. The expression is applied to each resource’s JSON representation. Uses jq 1.7 syntax.

Responses:

200: Block storage volumes data
- Content Type: application/json - Schema: BlockStoragePagedResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: Provider not found
- Content Type: application/json - Schema: ErrorResponse

POST

Create block storage volume

Create a new block storage volume for the specified provider

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider

Request Body:

Content Type: application/json

Schema: BlockStorageCreate

Responses:

200: Block storage volume created
- Content Type: application/json - Schema: BlockStorageResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse

/resource/blockstorage/{providerUid}/{resourceUid}

GET

Get block storage volume

Get block storage volume details

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
resourceUid	path	string	✅	Unique identifier of the block storage volume

Responses:

200: Block storage volume data
- Content Type: application/json - Schema: BlockStorageResourceResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: Block storage volume not found
- Content Type: application/json - Schema: ErrorResponse

DELETE

Delete block storage volume

Delete block storage volume

Parameters:

Name	In	Type	Required	Description
providerUid	path	ProviderId	✅	Unique identifier of the provider
resourceUid	path	string	✅	Unique identifier of the block storage volume to delete

Responses:

200: Block storage volume deleted
- Content Type: application/json - Schema: EmptyResponse
400: Argument validation error
- Content Type: application/json - Schema: ErrorResponse
404: Block storage volume not found
- Content Type: application/json - Schema: ErrorResponse

Schemas

BlockStorage

Block storage volume

Composition: allOf

Resource

Type: object

Properties:

Name	Type	Required	Description
availabilityZone	string	❌	Availability zone of the block storage volume, if applicable
name	string	❌	Name of the block storage volume
sizeGb	number	✅	Size of the block storage volume, in gigabytes
status	string	❌	Status of the block storage volume
tags	array	❌	Tags of the block storage volume
description	string	❌	Description of the block storage volume

BlockStorageResourceResponse

Response with block storage volume

Composition: allOf

ResourceResponse

Type: object

Properties:

Name	Type	Required	Description
resource	BlockStorage	✅

BlockStoragePagedResourceResponse

Response with paged block storage volumes

Composition: allOf

PagedResourceResponse

Type: object

Properties:

Name	Type	Required	Description
resources	array<BlockStorage>	✅

BlockStorageCreate

Request to create a new block storage volume

Type: object

Properties:

Name	Type	Required	Description
regionUid	string	✅	Region identifier where the volume will be created
availabilityZone	string	❌	Availability zone where the volume will be created, if applicable
sizeGb	number	✅	Size of the block storage volume, in gigabytes
name	string	❌	Name of the block storage volume
description	string	❌	Description of the block storage volume
tags	array	❌	Tags for the block storage volume