Key

Update an existing Key

Changed on

Updates an existing Key and deploys it to environments.

put/apiops/projects/{projectName}/keys/{keyName}/

Request

Path parameters

projectNamestring required
keyNamestring required

Name of key

Query parameters

jwkUpdateAction'NULLIFY' | 'UPDATE'

Action to take on referenced JWKs (NULLIFY or UPDATE). Defaults to NULLIFY if not provided.

updateScope'SAME_PROJECT' | 'ALL_PROJECTS'

Scope for updating JWKs (SAME_PROJECT or ALL_PROJECTS)

Request body

namestring
descriptionstring
keyType'SECRET_KEY' | 'PRIVATE_KEY' | 'PUBLIC_KEY'
algorithm'AES' | 'DES' | 'DESede' | 'RSA'

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultCountinteger

Changes

    • breaking

      added the new path request parameter keyName

    • breaking

      request property was restricted to a list of enum values

    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from object to string

    • breaking

      the request property type changed from object to string

    This list may be incomplete.

    • info

      endpoint added