Log in|Playground

API Keys

get

List API Keys

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Query parameters
withRevokedbooleanOptional

Include revoked API keys in the response.

withExpiredbooleanOptional

Include expired API keys in the response.

Responses
get
/api/rbac/apikeys/list
GET /api/rbac/apikeys/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content
post

Create API Key

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Body
descriptionstringOptional

Optional description for the API key.

expirationDatestring · date-timeOptional

Optional expiration date for the API key. Format: date-time

namestringRequired

User-defined name for the API key.

serviceAccountIdstringRequired

The UUID of the service account this key belongs to.

Responses
post
/api/rbac/apikey/create
POST /api/rbac/apikey/create HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "description": "text",
  "expirationDate": "2025-11-28T03:21:13.107Z",
  "name": "text",
  "serviceAccountId": "text"
}
No content
delete

Delete API Key

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

ID of the API key to delete (revoke)

Responses
202Success
No content
delete
/api/rbac/apikey/{id}
DELETE /api/rbac/apikey/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated