Secret Sync - E2B Docs

SecretPaginator

class SecretPaginator(SecretPaginatorBase)

Paginator for listing secrets. Example:

paginator = Secret.list()

while paginator.has_next:
    secrets = paginator.next_items()
    print(secrets)

next_items

def next_items(**opts: Unpack[ApiParams]) -> List[SecretInfo]

Returns the next page of secrets. Call this method only if has_next is True, otherwise it will raise an exception. Arguments:

opts: Per-call connection options (e.g. api_key, domain, headers, request_timeout). When provided, this call uses these options instead of the ones the paginator was constructed with.

Returns: List of secret metadata.

has_next

@property
def has_next() -> bool

Returns True if there are more items to fetch.

next_token

@property
def next_token() -> Optional[str]

Returns the next token to use for pagination.

Secret

class Secret(SecretBase)

Module for managing E2B secrets and workload identity helpers. Secret values are write-only: they are accepted by create and update but never returned by any read surface.

create

@classmethod
def create(cls,
           name: str,
           value: str,
           metadata: Optional[Dict[str, str]] = None,
           **opts: Unpack[ApiParams]) -> SecretInfo

Create a new secret and its first value. Arguments:

name: Name of the secret, unique within the project.
value: Secret value. Write-only — never returned by the API.
metadata: Customer metadata to store with the secret.

Returns: The secret’s ID, name, current version (1 for a new secret), metadata, and creation and update times.

update

@classmethod
def update(cls,
           secret: str,
           value: str,
           metadata: Optional[Dict[str, str]] = None,
           **opts: Unpack[ApiParams]) -> SecretInfo

Update a secret’s value by storing it as the secret’s new version. Arguments:

secret: Secret ID or name.
value: New secret value. Write-only — never returned by the API.
metadata: Customer metadata to store with the secret. When provided, replaces the stored metadata.

Returns: The secret’s ID, name, new current version, metadata, and creation and update times.

get_info

@classmethod
def get_info(cls, secret: str, **opts: Unpack[ApiParams]) -> SecretInfo

Get a secret’s metadata. Arguments:

secret: Secret ID or name.

Returns: The secret’s ID, name, current version, metadata, and creation and update times.

list

@classmethod
def list(cls,
         limit: Optional[int] = None,
         next_token: Optional[str] = None,
         **opts: Unpack[ApiParams]) -> SecretPaginator

List the project’s secrets. Arguments:

limit: Number of secrets to return per page.
next_token: Token to the next page.

Returns: Paginator over the project’s secrets. Drain it page by page:

paginator = Secret.list(limit=50)
while paginator.has_next:
    secrets = paginator.next_items()

exists

@classmethod
def exists(cls, secret: str, **opts: Unpack[ApiParams]) -> bool

Check whether a secret exists. Arguments:

secret: Secret ID or name.

Returns: True if the secret exists, False otherwise.

destroy

@classmethod
def destroy(cls, secret: str, **opts: Unpack[ApiParams]) -> bool

Destroy a secret, making all its versions inaccessible. Arguments:

secret: Secret ID or name.

Returns: True if the secret was destroyed, False if it was not found.

fill

@staticmethod
def fill(secret: str) -> str

Format a placeholder that the runtime resolves to the secret’s current value. This is a local formatting helper and makes no network call — it does not check whether the named secret exists. An unknown reference fails server-side when the placeholder is resolved. Arguments:

secret: Secret name.

Returns: Placeholder string resolving to the secret’s value. Example:

Secret.fill("openai-api-key")
# '${e2b.secrets.openai-api-key}'

iam_token

@staticmethod
def iam_token(*, audience: str,
              token_type: SandboxIamTokenType) -> SandboxIamToken

Define a workload identity token to pass to iam.tokens when creating a sandbox. Arguments:

audience: Audience of the workload token, stored exactly as provided.
token_type: Workload token type.

Returns: A token definition passable to iam.tokens. Example:

sandbox = Sandbox.create(
    iam={
        "tokens": {
            "aws": Secret.iam_token(
                audience="sts.amazonaws.com",
                token_type="JWT-SVID",
            ),
        },
    },
)

​SecretPaginator

​next_items

​has_next

​next_token

​Secret

​create

​update

​get_info

​list

​exists

​destroy

​fill

​iam_token