Skip to main content
PUT
/
tenant
/
{tenantId}
/
custodians
/
{id}
/
update_api_keys
Updates the API credentials associated with a custodian.
curl --request PUT \
  --url https://api.example.com/tenant/{tenantId}/custodians/{id}/update_api_keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1024,
  "custodianId": 42,
  "apiKey": "6f58c12d-9d77-47d2-9b7e-8efcf2cb5f15",
  "secretApiKey": "super-secret-key"
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant that owns the custodian.

​
id
integer<int64>
required

Identifier of the custodian to update.

Body

application/json

Payload containing the new API credentials.

Request to rotate the API credentials for a custodian.

​
tenantId
integer<int64>

Identifier of the tenant that owns the custodian.

Example:

1024

​
custodianId
integer<int64>

Identifier of the custodian whose credentials are being rotated.

Example:

42

​
apiKey
string

Replacement API key issued by the custodian provider.

Example:

"6f58c12d-9d77-47d2-9b7e-8efcf2cb5f15"

​
secretApiKey
string

Replacement secret API key that complements the primary key.

Example:

"super-secret-key"

Response

200 - application/json

Returned when the credentials are updated successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "success": true,
  "isWrongCredentials": false
}