API Keys
Edit an API key
API Keys
Edit an API key
PATCH
/
api
/
v1
/
workspace
/
{id}
/
api-key
/
{akid}
curl --request PATCH \
--url https://prod.oneloop.ai/api/v1/workspace/{id}/api-key/{akid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"enabled": true,
"scopes": [
{
"id": "<string>",
"representation": "<string>",
"create": true,
"read": true,
"update": true,
"del": true
}
]
}'
{
"apiKey": {
"id": "<string>",
"name": "<string>",
"maskedKey": "<string>",
"prefix": "<string>",
"expiresAt": 1,
"scopes": [
{
"id": "<string>",
"representation": "<string>",
"create": true,
"read": true,
"update": true,
"del": true
}
],
"enabled": true,
"customerId": "<string>",
"deleted": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"lastUsedAt": "<string>",
"billingId": "<string>"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/json
The edited key
Required range:
x > 0
curl --request PATCH \
--url https://prod.oneloop.ai/api/v1/workspace/{id}/api-key/{akid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"enabled": true,
"scopes": [
{
"id": "<string>",
"representation": "<string>",
"create": true,
"read": true,
"update": true,
"del": true
}
]
}'
{
"apiKey": {
"id": "<string>",
"name": "<string>",
"maskedKey": "<string>",
"prefix": "<string>",
"expiresAt": 1,
"scopes": [
{
"id": "<string>",
"representation": "<string>",
"create": true,
"read": true,
"update": true,
"del": true
}
],
"enabled": true,
"customerId": "<string>",
"deleted": true,
"createdAt": "<string>",
"updatedAt": "<string>",
"lastUsedAt": "<string>",
"billingId": "<string>"
}
}