Skip to content

Get database disk attributes

get/v1/projects/{ref}/config/disk

The fine-grained token must include the following permissions to access this endpoint:

  • infra_disk_config_read

Path parameters

  • ref
    Required
    string

    Project ref

Response codes

  • 200
  • 401
  • 403
  • 429
  • 500

Response (200)

{
"attributes": {
"iops": 1,
"size_gb": 1,
"throughput_mibps": 1,
"type": "gp3"
},
"last_modified_at": "lorem"
}
{
"type": "object",
"properties": {
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"iops": {
"type": "integer",
"exclusiveMinimum": true,
"maximum": 9007199254740991,
"minimum": 0
},
"size_gb": {
"type": "integer",
"exclusiveMinimum": true,
"maximum": 9007199254740991,
"minimum": 0
},
"throughput_mibps": {
"type": "integer",
"exclusiveMinimum": true,
"maximum": 9007199254740991,
"minimum": 0
},
"type": {
"type": "string",
"enum": [
"gp3"
]
}
},
"required": [
"iops",
"size_gb",
"type"
]
},
{
"type": "object",
"properties": {
"iops": {
"type": "integer",
"exclusiveMinimum": true,
"maximum": 9007199254740991,
"minimum": 0
},
"size_gb": {
"type": "integer",
"exclusiveMinimum": true,
"maximum": 9007199254740991,
"minimum": 0
},
"type": {
"type": "string",
"enum": [
"io2"
]
}
},
"required": [
"iops",
"size_gb",
"type"
]
}
]
},
"last_modified_at": {
"type": "string"
}
},
"required": [
"attributes"
]
}