API keys
API reference for API keys on CUDO Compute.
Reference
GET
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 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'
Response
{
"apiKeys": [
{
"id": "string",
"createTime": "string",
"key": "string"
}
],
"totalCount": "integer",
"pageNumber": "integer",
"pageSize": "integer"
}
POST
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 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"apikeyId": "string"
}'
Response
{
"id": "string",
"createTime": "string",
"key": "string"
}
DELETE
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 'Authorization: bearer <YOUR-API-KEY>'\
-H 'Accept: application/json'
Response
{}