Class API

constructor

• new API(client): Secret.v1alpha1.API

• Parameters

  • client: Client

  Returns Secret.v1alpha1.API

Static ReadonlyLOCALITIES

accessSecretVersion

• accessSecretVersion(request): Promise<Secret.v1alpha1.AccessSecretVersionResponse>

• Access a secret's version using the secret's ID. Access sensitive data in a secret's version specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.AccessSecretVersionRequest>

    The request AccessSecretVersionRequest

  Returns Promise<Secret.v1alpha1.AccessSecretVersionResponse>

  A Promise of AccessSecretVersionResponse

accessSecretVersionByName

• accessSecretVersionByName(request): Promise<Secret.v1alpha1.AccessSecretVersionResponse>

• Access a secret's version using the secret's name. Access sensitive data in a secret's version specified by the region, secret_name, revision and project_id parameters.

  This method is deprecated.

  Scaleway recommends that you use the ListSecrets request with the name filter to specify the secret version desired, then use the AccessSecretVersion request.

  Parameters

  • request: Readonly<AccessSecretVersionByNameRequest>

    The request AccessSecretVersionByNameRequest

  Returns Promise<Secret.v1alpha1.AccessSecretVersionResponse>

  A Promise of AccessSecretVersionResponse

  Deprecated

addSecretOwner

• addSecretOwner(request): Promise<void>

• Allow a product to use the secret.

  Parameters

  • request: Readonly<Secret.v1alpha1.AddSecretOwnerRequest>

    The request AddSecretOwnerRequest

  Returns Promise<void>

createFolder

• createFolder(request): Promise<Folder>

• Create folder.

  Parameters

  • request: Readonly<CreateFolderRequest>

    The request CreateFolderRequest

  Returns Promise<Folder>

  A Promise of Folder

createSecret

• createSecret(request): Promise<Secret.v1alpha1.Secret>

• Create a secret. You must specify the region to create a secret.

  Parameters

  • request: Readonly<Secret.v1alpha1.CreateSecretRequest>

    The request CreateSecretRequest

  Returns Promise<Secret.v1alpha1.Secret>

  A Promise of Secret

createSecretVersion

• createSecretVersion(request): Promise<Secret.v1alpha1.SecretVersion>

• Create a version. Create a version of a given secret specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.CreateSecretVersionRequest>

    The request CreateSecretVersionRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

deleteFolder

• deleteFolder(request): Promise<void>

• Delete a given folder specified by the region and folder_id parameters.

  Parameters

  • request: Readonly<DeleteFolderRequest>

    The request DeleteFolderRequest

  Returns Promise<void>

deleteSecret

• deleteSecret(request): Promise<void>

• Delete a secret. Delete a given secret specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.DeleteSecretRequest>

    The request DeleteSecretRequest

  Returns Promise<void>

destroySecretVersion

• destroySecretVersion(request): Promise<Secret.v1alpha1.SecretVersion>

• Delete a version. Delete a secret's version and the sensitive data contained in it. Deleting a version is permanent and cannot be undone.

  Parameters

  • request: Readonly<DestroySecretVersionRequest>

    The request DestroySecretVersionRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

disableSecretVersion

• disableSecretVersion(request): Promise<Secret.v1alpha1.SecretVersion>

• Disable a version. Make a specific version inaccessible. You must specify the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.DisableSecretVersionRequest>

    The request DisableSecretVersionRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

enableSecretVersion

• enableSecretVersion(request): Promise<Secret.v1alpha1.SecretVersion>

• Enable a version. Make a specific version accessible. You must specify the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.EnableSecretVersionRequest>

    The request EnableSecretVersionRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

generatePassword

• generatePassword(request): Promise<Secret.v1alpha1.SecretVersion>

• Generate a password in a new version. Generate a password for the given secret specified by the region and secret_id parameters. This will also create a new version of the secret that will store the password.

  Parameters

  • request: Readonly<GeneratePasswordRequest>

    The request GeneratePasswordRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

getSecret

• getSecret(request): Promise<Secret.v1alpha1.Secret>

• Get metadata using the secret's ID. Retrieve the metadata of a secret specified by the region and secret_id parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.GetSecretRequest>

    The request GetSecretRequest

  Returns Promise<Secret.v1alpha1.Secret>

  A Promise of Secret

getSecretByName

• getSecretByName(request): Promise<Secret.v1alpha1.Secret>

• Get metadata using the secret's name. Retrieve the metadata of a secret specified by the region and secret_name parameters.

  GetSecretByName usage is now deprecated.

  Scaleway recommends that you use the ListSecrets request with the name filter.

  Parameters

  • request: Readonly<GetSecretByNameRequest>

    The request GetSecretByNameRequest

  Returns Promise<Secret.v1alpha1.Secret>

  A Promise of Secret

  Deprecated

getSecretVersion

• getSecretVersion(request): Promise<Secret.v1alpha1.SecretVersion>

• Get metadata of a secret's version using the secret's ID. Retrieve the metadata of a secret's given version specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.GetSecretVersionRequest>

    The request GetSecretVersionRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

getSecretVersionByName

• getSecretVersionByName(request): Promise<Secret.v1alpha1.SecretVersion>

• Get metadata of a secret's version using the secret's name. Retrieve the metadata of a secret's given version specified by the region, secret_name, revision and project_id parameters.

  This method is deprecated.

  Scaleway recommends that you use the ListSecrets request with the name filter to specify the secret version desired, then use the GetSecretVersion request.

  Parameters

  • request: Readonly<GetSecretVersionByNameRequest>

    The request GetSecretVersionByNameRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion

  Deprecated

listFolders

• listFolders(request?): Promise<ListFoldersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Folder[], void, void>);
      all: (() => Promise<Folder[]>);
  }

• List folders. Retrieve the list of folders created within a Project.

  Parameters

  • request: Readonly<ListFoldersRequest> = {}

    The request ListFoldersRequest

  Returns Promise<ListFoldersResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Folder[], void, void>);
      all: (() => Promise<Folder[]>);
  }

  A Promise of ListFoldersResponse

listSecretVersions

• listSecretVersions(request): Promise<Secret.v1alpha1.ListSecretVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Secret.v1alpha1.SecretVersion[], void, void>);
      all: (() => Promise<Secret.v1alpha1.SecretVersion[]>);
  }

• List versions of a secret using the secret's ID. Retrieve the list of a given secret's versions specified by the secret_id and region parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.ListSecretVersionsRequest>

    The request ListSecretVersionsRequest

  Returns Promise<Secret.v1alpha1.ListSecretVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Secret.v1alpha1.SecretVersion[], void, void>);
      all: (() => Promise<Secret.v1alpha1.SecretVersion[]>);
  }

  A Promise of ListSecretVersionsResponse

listSecretVersionsByName

• listSecretVersionsByName(request): Promise<Secret.v1alpha1.ListSecretVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Secret.v1alpha1.SecretVersion[], void, void>);
      all: (() => Promise<Secret.v1alpha1.SecretVersion[]>);
  }

• List versions of a secret using the secret's name. Retrieve the list of a given secret's versions specified by the secret_name,region and project_id parameters.

  This method is deprecated.

  Scaleway recommends that you use the ListSecrets request with the name filter to specify the secret version desired, then use the ListSecretVersions request.

  Parameters

  • request: Readonly<ListSecretVersionsByNameRequest>

    The request ListSecretVersionsByNameRequest

  Returns Promise<Secret.v1alpha1.ListSecretVersionsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Secret.v1alpha1.SecretVersion[], void, void>);
      all: (() => Promise<Secret.v1alpha1.SecretVersion[]>);
  }

  A Promise of ListSecretVersionsResponse

  Deprecated

listSecrets

• listSecrets(request?): Promise<Secret.v1alpha1.ListSecretsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Secret.v1alpha1.Secret[], void, void>);
      all: (() => Promise<Secret.v1alpha1.Secret[]>);
  }

• List secrets. Retrieve the list of secrets created within an Organization and/or Project. You must specify either the organization_id or the project_id and the region.

  Parameters

  • request: Readonly<Secret.v1alpha1.ListSecretsRequest> = {}

    The request ListSecretsRequest

  Returns Promise<Secret.v1alpha1.ListSecretsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<Secret.v1alpha1.Secret[], void, void>);
      all: (() => Promise<Secret.v1alpha1.Secret[]>);
  }

  A Promise of ListSecretsResponse

listTags

• listTags(request?): Promise<Secret.v1alpha1.ListTagsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<string[], void, void>);
      all: (() => Promise<string[]>);
  }

• List tags. List all tags associated with secrets within a given Project.

  Parameters

  • request: Readonly<Secret.v1alpha1.ListTagsRequest> = {}

    The request ListTagsRequest

  Returns Promise<Secret.v1alpha1.ListTagsResponse> & {
      [asyncIterator]: (() => AsyncGenerator<string[], void, void>);
      all: (() => Promise<string[]>);
  }

  A Promise of ListTagsResponse

protectSecret

• protectSecret(request): Promise<Secret.v1alpha1.Secret>

• Protect a secret. Protect a given secret specified by the secret_id parameter. A protected secret can be read and modified but cannot be deleted.

  Parameters

  • request: Readonly<Secret.v1alpha1.ProtectSecretRequest>

    The request ProtectSecretRequest

  Returns Promise<Secret.v1alpha1.Secret>

  A Promise of Secret

unprotectSecret

• unprotectSecret(request): Promise<Secret.v1alpha1.Secret>

• Unprotect a secret. Unprotect a given secret specified by the secret_id parameter. An unprotected secret can be read, modified and deleted.

  Parameters

  • request: Readonly<Secret.v1alpha1.UnprotectSecretRequest>

    The request UnprotectSecretRequest

  Returns Promise<Secret.v1alpha1.Secret>

  A Promise of Secret

updateSecret

• updateSecret(request): Promise<Secret.v1alpha1.Secret>

• Update metadata of a secret. Edit a secret's metadata such as name, tag(s), description and ephemeral policy. The secret to update is specified by the secret_id and region parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.UpdateSecretRequest>

    The request UpdateSecretRequest

  Returns Promise<Secret.v1alpha1.Secret>

  A Promise of Secret

updateSecretVersion

• updateSecretVersion(request): Promise<Secret.v1alpha1.SecretVersion>

• Update metadata of a version. Edit the metadata of a secret's given version, specified by the region, secret_id and revision parameters.

  Parameters

  • request: Readonly<Secret.v1alpha1.UpdateSecretVersionRequest>

    The request UpdateSecretVersionRequest

  Returns Promise<Secret.v1alpha1.SecretVersion>

  A Promise of SecretVersion