Reference
View as MarkdownVolumes API
Service volumes.
3 operations. Every call needs a session cookie or an Authorization: Bearer nct_… token unless marked Public. Conventions, errors and scopes
/services/{serviceId}/volumesList a service's volumes
| Parameter | In | Type | Description |
|---|---|---|---|
serviceIdrequired | path | string |
Response 200 · OK · application/json
VolumeListOutputBody
- VolumeView[] | nullrequired
Errors
401Unauthorized403Forbidden404Not Found422Unprocessable Entity500Internal Server Error
Errors are RFC 9457 application/problem+json with a stable code field.
/services/{serviceId}/volumesAttach a named volume (staged until deployed)
| Parameter | In | Type | Description |
|---|---|---|---|
serviceIdrequired | path | string |
Request body · application/json · required
CreateVolumeInputBody
- mountPathstringrequired
- namestringrequired
Response 201 · Created · application/json
VolumeView
- dockerNamestringrequired
- idstringrequired
- mountPathstringrequired
- namestringrequired
- restoreLabelstring
Errors
401Unauthorized403Forbidden404Not Found409Conflict422Unprocessable Entity500Internal Server Error
Errors are RFC 9457 application/problem+json with a stable code field.
/volumes/{volumeId}Detach a volume (staged); the Docker volume and its data are kept
| Parameter | In | Type | Description |
|---|---|---|---|
volumeIdrequired | path | string |
Response 204 · No Content
No body.
Errors
401Unauthorized403Forbidden404Not Found422Unprocessable Entity500Internal Server Error
Errors are RFC 9457 application/problem+json with a stable code field.