put__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.

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

Update Repository AI API Key

Update the properties of an existing AI API key. Currently, this endpoint allows updating the name of the API key for better organization and identification.

Important Notes:

  • Only non-deleted keys can be updated

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

  • All fields in the request body are optional - only provide fields you want to update

  • The actual key and secret values cannot be modified (rotate by creating a new key instead)

  • System events are logged for audit purposes

Security:

  • Access is validated against repository permissions

  • Update operations trigger system events for audit trails

  • Keys remain encrypted in storage

Use Cases:

  • Rename keys for better organization

  • Update key descriptions as usage changes

  • Maintain clear labeling of production vs. development keys

TypeScript Client Library

public updateRepoAiApiKey = async (
  repoId: string,
  apikeyId: string,
  data: UpdateRepoAiApiKeyRequest
): Promise<UpdateRepoAiApiKeyResponse> => {
  return this.makeRequest<UpdateRepoAiApiKeyResponse>(`repo/${repoId}/ai/apikey/${apikeyId}`, 'PUT', data);
};

Code Samples

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

Body parameter

{
  "name": "Updated Production AI Key"
}

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

body

body

object

true

Updated API key properties

» name

body

string

false

Human-readable name for the API key

Example responses

200 Response

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

Responses

Status
Meaning
Description
Schema

200

API key updated successfully

Inline

403

Insufficient permissions

Inline

404

API key not found

Inline

500

Failed to update 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?