E2e2b-dev
secrets

Update a secret

Changed on

Replace the secret's stored marker by appending a new version. The response carries metadata only.

post/secrets/{secretID}

Request

  • Base URL
    https://api.e2b.app
  • URL
    https://api.e2b.app/secrets/{secretID}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer and API key in header X-Team-ID
    • or API key in header X-Admin-Token and API key in header X-Team-ID
    • or HTTP bearer and API key in header X-Team-ID

Path parameters

secretIDstring required

Identifier of the secret (sec_ prefixed), or its canonical lower-case name

Request body

valuestring required

Runtime marker stored as the secret's new version. The runtime resolves it to a value at sandbox egress.

metadataSecretMetadata

Customer metadata of the secret. Always present, empty when unset. At most 32 entries; keys are limited to 128 bytes, values to 1024 bytes, and a secret's metadata to 8192 bytes in total.

Response

Successfully updated the secret

secretIDstring required

Identifier of the secret

namestring required

Name of the secret, unique within the project

currentVersioninteger required

Version served to readers that do not name one

metadataSecretMetadata required

Customer metadata of the secret. Always present, empty when unset. At most 32 entries; keys are limited to 128 bytes, values to 1024 bytes, and a secret's metadata to 8192 bytes in total.

createdAtstring date-time required

Time when the secret was created

updatedAtstring date-time required

Time when the secret was last updated

Changes