Cudo Compute logoDocumentation

Projects

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

GET/v1/project/{projectId}/ssh-keys

List SSH keys

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description

Request

GET
/v1/project/{projectId}/ssh-keys
curl 'https://rest.compute.cudo.org/v1/project/{projectId}/ssh-keys' \
-H 'Accept: application/json'

Response

{
    "sshKeys": "array"
}
GET/v1/projects

List

Description for this endpoint is coming soon.

Path attributes

  • Name
    pageToken
    Type
    string
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

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

Response

{
    "pageSize": "integer",
    "pageToken": "string",
    "projects": "array"
}
POST/v1/projects

Create

Description for this endpoint is coming soon.

Request

POST
/v1/projects
curl 'https://rest.compute.cudo.org/v1/projects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "billingAccountId": "string",
    "createBy": "string",
    "id": "string",
    "resourceCount": "integer"
}'

Response

{
    "billingAccountId": "string",
    "createBy": "string",
    "id": "string",
    "resourceCount": "integer"
}
GET/v1/projects/{id}

Get

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

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

Response

{
    "billingAccountId": "string",
    "createBy": "string",
    "id": "string",
    "resourceCount": "integer"
}
DELETE/v1/projects/{id}

Delete

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

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

Spend history

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

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

Response

{
    "projectSpendHistory": "array"
}
GET/v1/projects/{id}/spend/current

Spend

Description for this endpoint is coming soon.

Path attributes

  • Name
    id
    Type
    string
    Description

Request

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

Response

{
    "endTime": "string",
    "projectId": "string",
    "spend": "object",
    "startTime": "string",
    "uid": "string"
}
PATCH/v1/projects/{project.id}

Update

Description for this endpoint is coming soon.

Body attributes

  • Name
    billingAccountId
    Type
    string
    Description
  • Name
    createBy
    Type
    string
    Description
  • Name
    resourceCount
    Type
    integer
    Description

Path attributes

  • Name
    project.id
    Type
    string
    Description

Request

PATCH
/v1/projects/{project.id}
curl 'https://rest.compute.cudo.org/v1/projects/{project.id}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "billingAccountId": "string",
    "createBy": "string",
    "resourceCount": "integer"
}'

Response

{
    "billingAccountId": "string",
    "createBy": "string",
    "id": "string",
    "resourceCount": "integer"
}
GET/v1/projects/{projectId}/spend/{spendId}/details

Spend details

Description for this endpoint is coming soon.

Path attributes

  • Name
    projectId
    Type
    string
    Description
  • Name
    spendId
    Type
    string
    Description

Request

GET
/v1/projects/{projectId}/spend/{spendId}/details
curl 'https://rest.compute.cudo.org/v1/projects/{projectId}/spend/{spendId}/details' \
-H 'Accept: application/json'

Response

{
    "orders": "array",
    "spend": "object"
}