delete__repo_{repoId}_ai_apikey

⚠️ TEST ENVIRONMENT ONLY

This API endpoint is currently available only in the TEST environment. It is not yet available in production.

DELETE /repo/{repoId}/ai/apikey/{apikeyId}

Delete Repository AI API Key

Permanently delete an AI API key from a repository. This operation performs a soft delete, marking the key as deleted while preserving audit history.

Important Notes:

  • Deletion is a soft delete (marked as deleted but not physically removed from database)

  • Once deleted, the API key can no longer be used for authentication

  • Users must have access to the repository to delete its API keys

  • Only non-deleted keys can be deleted

  • This operation is typically irreversible (contact support if recovery is needed)

Security:

  • Access is validated against repository permissions

  • Deletion operations trigger system events for comprehensive audit trails

  • Deleted keys are filtered out of list operations

  • Encrypted secrets remain in database for audit purposes but cannot be used

Use Cases:

  • Remove compromised API keys

  • Clean up unused or obsolete keys

  • Rotate keys by creating new ones and deleting old ones

  • Maintain security hygiene

Best Practice:

Before deleting an API key, ensure that no active services or applications are using it. Create and test replacement keys first to avoid service disruption.

TypeScript Client Library

public deleteRepoAiApiKey = async (repoId: string, apikeyId: string): Promise<DeleteRepoAiApiKeyResponse> => {
  return this.makeRequest<DeleteRepoAiApiKeyResponse>(`repo/${repoId}/ai/apikey/${apikeyId}`, 'DELETE', null);
};

Code Samples

# You can also use wget
curl -X DELETE https://backend.flashback.tech/repo/{repoId}/ai/apikey/{apikeyId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Parameters

Name
In
Type
Required
Description

repoId

path

string

true

Unique identifier of the repository

apikeyId

path

string

true

Unique identifier of the API key

Example responses

200 Response

{
  "success": true,
  "message": "AI API key deleted successfully"
}

Responses

Status
Meaning
Description
Schema

200

API key deleted successfully

Inline

403

Insufficient permissions

Inline

404

API key not found

Inline

500

Failed to delete API key

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

Operation success status

» message

string

false

none

Success message

Status Code 403

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» message

string

false

none

Error message

Status Code 404

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» message

string

false

none

Error message

Status Code 500

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» message

string

false

none

Error message

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Last updated

Was this helpful?