API keys

These are the endpoints for API keys. More information coming soon.


GET/v1/api-keys

List

List the details of all API keys created by the requesting user. This does not include the API key itself which is only visible once when the API key is created.

Path attributes

  • Name
    pageNumber
    Type
    integer
    Description
  • Name
    pageSize
    Type
    integer
    Description

Request

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

Response

{
    "apiKeys": [
        {
            "createTime": "string",
            "id": "string",
            "key": "string"
        }
    ],
    "pageNumber": "integer",
    "pageSize": "integer",
    "totalCount": "integer"
}

POST/v1/api-keys

Generate

Creates a new API key for the requesting user. The API key is returned in the response, and this is the only time it can be viewed.

Request

POST
/v1/api-keys
curl 'https://rest.compute.cudo.org/v1/api-keys' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
    "apikeyId": "string"
}'

Response

{
    "createTime": "string",
    "id": "string",
    "key": "string"
}

DELETE/v1/api-keys/{name}

Delete

Deletes an API key, revoking all access for requests that use the key.

Path attributes

  • Name
    name
    Type
    string
    Description

Request

DELETE
/v1/api-keys/{name}
curl 'https://rest.compute.cudo.org/v1/api-keys/{name}' \
-H 'Accept: application/json'