put__apikeys_{uuid}

Update an existing provider API key in your workspace.

Request

Endpoint: PUT /apikeys/:uuid

Updates the properties of an existing API key identified by its UUID. Only fields that are provided in the payload will be modified.

Path Parameters

Field

Type

Required

Description

uuid

string

Yes

The unique identifier of the API key to update.

Request Body (UpdateProviderApiKeyRequest)

Field

Type

Required

Description

key

string

Optional

The updated public key, identifier, or email.

secret

string

Optional

The updated private key or secret password. This is encrypted before saving.

provider

string

Optional

The updated provider type enum (e.g., AWS, GCP, AZURE).

endpoint

string | undefined

Optional

The updated custom endpoint URL.

region

string | undefined

Optional

The updated geographical region.

Request Example

curl -X PUT "https://backend.flashback.tech/apikeys/your-api-key-uuid" \
  -H "Authorization: Bearer <your-session-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "endpoint": "s3.us-west-2.amazonaws.com",
    "region": "us-west-2"
  }'

const response = await fetch("https://backend.flashback.tech/apikeys/your-api-key-uuid", {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer <your-session-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    endpoint: "s3.us-west-2.amazonaws.com",
    region: "us-west-2"
  })
});
const data = await response.json();
console.log(data);

import requests

url = "https://backend.flashback.tech/apikeys/your-api-key-uuid"
headers = {
    "Authorization": "Bearer <your-session-token>",
    "Content-Type": "application/json"
}
payload = {
    "endpoint": "s3.us-west-2.amazonaws.com",
    "region": "us-west-2"
}

response = requests.put(url, headers=headers, json=payload)
print(response.json())

import (
	"bytes"
	"fmt"
	"io/ioutil"
	"net/http"
)

func main() {
	url := "https://backend.flashback.tech/apikeys/your-api-key-uuid"
	payload := []byte(`{
		"endpoint": "s3.us-west-2.amazonaws.com",
		"region": "us-west-2"
	}`)

	req, _ := http.NewRequest("PUT", url, bytes.NewBuffer(payload))
	req.Header.Add("Authorization", "Bearer <your-session-token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(string(body))
}

Response

Response Fields (UpdateProviderApiKeyResponse)

Field

Type

Description

success

boolean

Indicates whether the update was successful (true).

Response Example (200 OK)

{
  "success": true
}

Error Responses

400 Bad Request

Returned when the updated fields conflict with another existing API key in the workspace.

{
  "success": false,
  "message": "API key with these credentials already exists"
}

401 Unauthorized

Returned when the session token is missing, invalid, or the user cannot be validated.

{
  "success": false,
  "message": "User not found or not validated"
}

403 Forbidden

Returned when the user does not have write access to the workspace where the API key resides.

{
  "success": false,
  "message": "Insufficient permissions"
}

404 Not Found

Returned if no API key exists with the provided uuid inside the user's organization.

{
  "success": false,
  "message": "API key not found"
}

500 Internal Server Error

Returned when an unexpected server error occurs.

{
  "success": false,
  "message": "Internal server error"
}

Previouspost__apikeys Nextdelete__apikeys_{uuid}

Last updated 1 month ago

Was this helpful?