Cudo Compute logoDocumentation

Search

These are the endpoints for Search. More information coming soon.

GET/v1/compute/get/{id}

Get machine

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

GET
/v1/compute/get/{id}
curl 'https://rest.compute.cudo.org/v1/compute/get/{id}' \
-H 'Accept: application/json'

Response

{
    "compute": "object"
}
GET/v1/compute/images

List OS images

Description for this endpoint is coming soon.

Request

GET
/v1/compute/images
curl 'https://rest.compute.cudo.org/v1/compute/images' \
-H 'Accept: application/json'

Response

{
    "images": "array"
}
GET/v1/compute/search

Search machines

Description for this endpoint is coming soon.

Path attributes

  • Name
    cpuVendor
    Type
    array
    Description
  • Name
    cpuClass
    Type
    array
    Description
  • Name
    cpuModel
    Type
    array
    Description
  • Name
    gpuCountGte
    Type
    integer
    Description
  • Name
    gpuCountLte
    Type
    integer
    Description
  • Name
    gpuVendor
    Type
    array
    Description
  • Name
    gpuClass
    Type
    array
    Description
  • Name
    gpuModel
    Type
    array
    Description
  • Name
    memoryGte
    Type
    integer
    Description
  • Name
    memoryLte
    Type
    integer
    Description
  • Name
    orderBy
    Type
    string
    Description
  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description
  • Name
    priceHrLte
    Type
    number
    Description
  • Name
    regionId
    Type
    array
    Description
  • Name
    availableGte
    Type
    integer
    Description
  • Name
    storageGte
    Type
    integer
    Description
  • Name
    storageLte
    Type
    integer
    Description
  • Name
    vcpusGte
    Type
    integer
    Description
  • Name
    vcpusLte
    Type
    integer
    Description
  • Name
    renewableEnergy
    Type
    boolean
    Description
  • Name
    dataCenterId
    Type
    array
    Description

Request

GET
/v1/compute/search
curl 'https://rest.compute.cudo.org/v1/compute/search' \
-H 'Accept: application/json'

Response

{
    "compute": "array",
    "request": "object",
    "totalCount": "integer"
}
GET/v1/compute/search_v2

Search machines

Description for this endpoint is coming soon.

Path attributes

  • Name
    cpuModel
    Type
    string
    Description
  • Name
    gpu
    Type
    integer
    Description
  • Name
    gpuModel
    Type
    string
    Description
  • Name
    memoryGib
    Type
    integer
    Description
  • Name
    orderBy
    Type
    string
    Description
  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description
  • Name
    regionId
    Type
    string
    Description
  • Name
    storageGib
    Type
    integer
    Description
  • Name
    vcpu
    Type
    integer
    Description
  • Name
    dataCenterId
    Type
    string
    Description

Request

GET
/v1/compute/search_v2
curl 'https://rest.compute.cudo.org/v1/compute/search_v2' \
-H 'Accept: application/json'

Response

{
    "countVmAvailable": "integer",
    "cpuModels": "array",
    "dataCenters": "array",
    "gpuModels": "array",
    "hostConfigs": "array",
    "maxGpu": "integer",
    "maxMemoryGib": "integer",
    "maxVcpu": "integer",
    "request": "object"
}
GET/v1/regions

Regions

Description for this endpoint is coming soon.

Request

GET
/v1/regions
curl 'https://rest.compute.cudo.org/v1/regions' \
-H 'Accept: application/json'

Response

{
    "regions": "array"
}