PUT | Key
  • 1 minute to read
  • Dark
    Light
  • PDF

PUT | Key

  • Dark
    Light
  • PDF

Article summary

Get a encryption key by ID

Edits an existing encryption key based on the ID provided on the endpoint.

Endpoint

PUT /iso/sctm/encryption/key/{key_id}

Path Parameters

  • key_id (String): unique identifier of the key to be edited.

Request body

{
  "name": "Chave-API-Example",
  "description": "Example description for the encryption key created via API.",
  "algorithm": "aes256-gcm96",
  "expiration_date": "2024-08-18T11:15:00Z"
}

Fields

FieldTypeDescription
nameStringName of the encryption key.
descriptionStringDetailed description of the key.
algorithmStringThe encryption algorithm to be used.
expiration_dateStringDate and time of expiration of the key (ISO 8601 format).

Expected Response

{
  "code": 200,
  "response": {
    "status": 200,
    "message": "Encryption key updated successfully",
    "error": false,
    "error_code": 0
  }
}

Was this article helpful?

What's Next