API Keys

get

List API Keys

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Query parameters

withRevokedbooleanOptional

Include revoked API keys in the response.

withExpiredbooleanOptional

Include expired API keys in the response.

Responses

200Success

No content

400

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

get

/api/rbac/apikeys/list

HTTPcURLJavaScriptPython

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

Bearer

AuthorizationstringRequired

Body

application/json

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.

No content

400

ErrorResponse defines a common error response structure.

409

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

post

/api/rbac/apikey/create

HTTPcURLJavaScriptPython

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-12-19T10:21:46.133Z",
  "name": "text",
  "serviceAccountId": "text"
}

No content

delete

Delete API Key

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

ID of the API key to delete (revoke)

Responses

202Success

400

ErrorResponse defines a common error response structure.

404

ErrorResponse defines a common error response structure.

500

ErrorResponse defines a common error response structure.

delete

/api/rbac/apikey/{id}

HTTPcURLJavaScriptPython

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

No content