csp (1.1.0)

Download OpenAPI specification:Download

This API, used by the HPE CSI driver, enables management of resources used for container workloads. It is not intended for direct usage outside of the CSI driver but is provided here for documentation purposes.

hosts

Get all hosts used for container workloads

SecurityApiKeyAuth

Responses

200

Success

401

Unauthorized

500

Internal Server Error

get/hosts

Response samples

application/json

[{"id": "string",
"name": "string",
"uuid": "string",
"iqns": ["string"
],
"wwpns": ["string"
],
"networks": ["string"
],
"chap_user": "string",
"chap_password": "string"
}
]

Create host

SecurityApiKeyAuth

Request

Request Body schema: application/json

name	string
uuid	string
iqns	Array of strings
wwpns	Array of strings
networks	Array of strings
chap_user	string
chap_password	string

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/hosts

Request samples

Payload

application/json

{"name": "string",
"uuid": "string",
"iqns": ["string"
],
"wwpns": ["string"
],
"networks": ["string"
],
"chap_user": "string",
"chap_password": "string"
}

Response samples

application/json

{"id": "string",
"name": "string",
"uuid": "string",
"iqns": ["string"
],
"wwpns": ["string"
],
"networks": ["string"
],
"chap_user": "string",
"chap_password": "string"
}

Delete host

SecurityApiKeyAuth

Request

query Parameters

uuid

string

Responses

204

Host deleted

401

Unauthorized

500

Internal Server Error

delete/hosts

Delete host

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

204

Host deleted

401

Unauthorized

500

Internal Server Error

delete/hosts/{id}

replication_partners

Get all replication partners used for container workloads

SecurityApiKeyAuth

Request

query Parameters

name

string

Responses

200

Success

401

Unauthorized

404

Replication partner name not found

500

Internal Server Error

get/replication_partners

Response samples

application/json

[{"alive": true,
"id": "string",
"name": "string",
"repl_role": "upstream",
"is_alive": true
}
]

snapshot_groups

Get all snapshot groups used for container workloads

SecurityApiKeyAuth

Request

query Parameters

volume_group_id

string

Responses

200

Success

400

Bad Request if volume group ID is not provided

401

Unauthorized

500

Internal Server Error

get/snapshot_groups

Response samples

application/json

[{"id": "string",
"name": "string",
"snapshots": [{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}
],
"config": {"replicate": true,
"is_complete": true,
"repl_status": "fail",
"repl_complete_time": 0,
"repl_start_time": 0
},
"volume_group_id": "string",
"volume_group_name": "string",
"creation_time": 0
}
]

Create a snapshot group

SecurityApiKeyAuth

Request

Request Body schema: application/json

name	string
	Array of objects (ContainerVolumeSnapshot)
	object (SnapshotGroupConfig)
volume_group_id	string
volume_group_name	string
creation_time	integer <int64>

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/snapshot_groups

Request samples

Payload

application/json

{"name": "string",
"snapshots": [{"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}
],
"config": {"replicate": true,
"is_complete": true,
"repl_status": "fail",
"repl_complete_time": 0,
"repl_start_time": 0
},
"volume_group_id": "string",
"volume_group_name": "string",
"creation_time": 0
}

Response samples

application/json

{"id": "string",
"name": "string",
"snapshots": [{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}
],
"config": {"replicate": true,
"is_complete": true,
"repl_status": "fail",
"repl_complete_time": 0,
"repl_start_time": 0
},
"volume_group_id": "string",
"volume_group_name": "string",
"creation_time": 0
}

Get a snapshot group with the given ID

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Snapshot group ID not found

500

Internal Server Error

get/snapshot_groups/{id}

Response samples

application/json

{"id": "string",
"name": "string",
"snapshots": [{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}
],
"config": {"replicate": true,
"is_complete": true,
"repl_status": "fail",
"repl_complete_time": 0,
"repl_start_time": 0
},
"volume_group_id": "string",
"volume_group_name": "string",
"creation_time": 0
}

Delete a snapshot group

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

204

Snapshot group deleted

400

Bad Request

401

Unauthorized

404

Snapshot group ID not found

500

Internal Server Error

delete/snapshot_groups/{id}

snapshots

Get snapshots for the provided volume

SecurityApiKeyAuth

Request

query Parameters

volume_id	string
name	string

Responses

200

Success

400

Bad Request if volume group ID is not provided

401

Unauthorized

404

Not Found if volume ID or snapshot name cannot be found

500

Internal Server Error

get/snapshots

Response samples

application/json

[{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}
]

Create a snasphot

SecurityApiKeyAuth

Request

Request Body schema: application/json

name	string
size	integer <int64>
description	string
	object (SnapshotConfig)
volume_id	string
volume_name	string
creation_time	integer <int64>
ready_to_use	boolean

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/snapshots

Request samples

Payload

application/json

{"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}

Response samples

application/json

{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}

Get a snapshot with the given ID

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found if snapshot ID cannot be found

500

Internal Server Error

get/snapshots/{id}

Response samples

application/json

{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"config": {"property1": null,
"property2": null
},
"volume_id": "string",
"volume_name": "string",
"creation_time": 0,
"ready_to_use": true
}

Delete a snapshot

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

204

Snapshot deleted

401

Unauthorized

404

Not found if snapshot ID is not found

500

Internal Server Error

delete/snapshots/{id}

tokens

delete

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

204

OK logged out

401

Unauthorized

404

Not Found

500

Internal Server Error

delete/tokens/{id}

createToken

Request

Request Body schema: application/json

username	string
password	string
array_ip	string
session_token	string
creation_time	integer <int64>
expiry_time	integer <int64>

Responses

200

Success

400

Bad Request

401

Invalid username and/or password

500

Internal Server Error

post/tokens

Request samples

Payload

application/json

{"username": "string",
"password": "string",
"array_ip": "string",
"session_token": "string",
"creation_time": 0,
"expiry_time": 0
}

Response samples

application/json

{"id": "string",
"username": "string",
"password": "string",
"array_ip": "string",
"session_token": "string",
"creation_time": 0,
"expiry_time": 0
}

volume_groups

Get all volume groups used for container workloads

SecurityApiKeyAuth

Request

query Parameters

name

string

Responses

200

Success

401

Unauthorized

404

Not Found if the volume group name cannot be found

500

Internal Server Error

get/volume_groups

Response samples

application/json

[{"id": "string",
"name": "string",
"description": "string",
"config": {"replication_partner": "string",
"protection_template": "string"
},
"volumes": [{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}
],
"creation_time": 0
}
]

Create a new volume group for container workloads

SecurityApiKeyAuth

Request

Request Body schema: application/json

name	string
description	string
	object (VolumeGroupConfig)
	Array of objects (ContainerVolume)
creation_time	integer <int64>

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/volume_groups

Request samples

Payload

application/json

{"name": "string",
"description": "string",
"config": {"replication_partner": "string",
"protection_template": "string"
},
"volumes": [{"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}
],
"creation_time": 0
}

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"config": {"replication_partner": "string",
"protection_template": "string"
},
"volumes": [{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}
],
"creation_time": 0
}

Get the volume group with the given ID

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found if volume group ID cannot be found

500

Internal Server Error

get/volume_groups/{id}

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"config": {"replication_partner": "string",
"protection_template": "string"
},
"volumes": [{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}
],
"creation_time": 0
}

Delete a volume group

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

204

Volume group deleted

401

Unauthorized

404

Not found if volume group ID is not found

409

Conflict if the volume group cannot be deleted

500

Internal Server Error

delete/volume_groups/{id}

volumes

Get all volumes used for container workloads

SecurityApiKeyAuth

Request

query Parameters

name

string

Responses

200

Success

401

Unauthorized

404

Not Found if the volume name cannot be found

500

Internal Server Error

get/volumes

Response samples

application/json

[{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}
]

Create a new volume (or clone an existing snapshot/volume) for container workloads

SecurityApiKeyAuth

Request

Request Body schema: application/json

name	string
size	integer <int64>
description	string
clone	boolean
published	boolean
	object (VolumeConfig)
base_snapshot_id	string
volume_group_id	string

Responses

200

Success

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/volumes

Request samples

Payload

application/json

{"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}

Response samples

application/json

{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}

Get the volume with the given ID

SecurityApiKeyAuth

Request

path Parameters

required

string

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found if volume ID cannot be found

500

Internal Server Error

get/volumes/{id}

Response samples

application/json

{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}

Edit the volume with the given ID

SecurityApiKeyAuth

Request

path Parameters

required

string

Request Body schema: application/json

name	string
size	integer <int64>
description	string
clone	boolean
published	boolean
	object (VolumeConfig)
base_snapshot_id	string
volume_group_id	string

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found if volume ID cannot be found

500

Internal Server Error

put/volumes/{id}

Request samples

Payload

application/json

{"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}

Response samples

application/json

{"id": "string",
"name": "string",
"size": 0,
"description": "string",
"clone": true,
"published": true,
"config": {"property1": null,
"property2": null
},
"base_snapshot_id": "string",
"volume_group_id": "string"
}

Delete a volume

SecurityApiKeyAuth

Request

path Parameters

required

string

query Parameters

force

boolean

Responses

204

Volume deleted

400

Bad Request if the volume is published

401

Unauthorized

404

Not found if volume ID is not found

409

Conflict if the volume cannot be deleted

500

Internal Server Error

delete/volumes/{id}

Publishes a volume to the given host

SecurityApiKeyAuth

Request

path Parameters

required

string

Request Body schema: application/json

host_uuid	string
access_protocol	string Enum: "iscsi" "fc"

Responses

200

Volume published successfully

400

Bad Request

401

Unauthorized

404

Not found if volume ID or host UUID is not found

500

Internal Server Error

put/volumes/{id}/actions/publish

Request samples

Payload

application/json

{"host_uuid": "string",
"access_protocol": "iscsi"
}

Response samples

application/json

{"serial_number": "string",
"target_names": ["string"
],
"access_protocol": "iscsi",
"lun_id": 0,
"discovery_ips": ["string"
],
"chap_user": "string",
"chap_password": "string"
}

Unpublishes a volume to the given host

SecurityApiKeyAuth

Request

path Parameters

required

string

Request Body schema: application/json

host_uuid

string

Responses

204

Volume unpublished successfully

400

Bad Request

401

Unauthorized

404

Not found if volume ID or host UUID cannot be found

500

Internal Server Error

put/volumes/{id}/actions/unpublish

Request samples

Payload

application/json

{"host_uuid": "string"
}

Response samples

application/json

{"serial_number": "string",
"target_names": ["string"
],
"access_protocol": "iscsi",
"lun_id": 0,
"discovery_ips": ["string"
],
"chap_user": "string",
"chap_password": "string"
}