Log in|Playground

API Keys

get

List API Keys

Authorizations
Query parameters
withRevokedbooleanOptional

Include revoked API keys in the response.

withExpiredbooleanOptional

Include expired API keys in the response.

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

No content
post

Create API Key

Authorizations
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
200

CreateApiKeyResponseWrapper defines the response structure for creating an API key.

post
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-08-12T12:32:59.719Z",
  "name": "text",
  "serviceAccountId": "text"
}
No content
delete

Delete API Key

Authorizations
Path parameters
idstringRequired

ID of the API key to delete (revoke)

Responses
202

NoContentResponse indicates success but that no response body is expected or included.

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

No content

Last updated