Secrets API

The Secrets API allows you to manage secrets, secret scopes, and access permissions. To manage secrets, you must:

Create a secret scope.
Add your secrets to the scope.
If you have the Premium plan (or, for customers who subscribed to Databricks before March 3, 2020, the Operational Security package), assign access control to the secret scope.

To learn more about creating and managing secrets, see Secret management. You access and reference secrets in notebooks and jobs by using Secrets utilities.

Important

To access Databricks REST APIs, you must authenticate. To use the Secrets API with Azure Key Vault secrets, you must authenticate using an Azure Active Directory token.

Create secret scope

Endpoint	HTTP Method
`2.0/secrets/scopes/create`	`POST`

Create a Databricks-backed secret scope in which secrets are stored in Databricks-managed storage and encrypted with a cloud-based specific encryption key.

The scope name:

Must be unique within a workspace.
Must consist of alphanumeric characters, dashes, underscores, and periods, and may not exceed 128 characters.

The names are considered non-sensitive and are readable by all users in the workspace. A workspace is limited to a maximum of 100 secret scopes.

Example request:

{
  "scope": "my-simple-databricks-scope",
  "initial_manage_principal": "users"
}

If initial_manage_principal is specified, the initial ACL applied to the scope is applied to the supplied principal (user or group) with MANAGE permissions. The only supported principal for this option is the group users, which contains all users in the workspace. If initial_manage_principal is not specified, the initial ACL with MANAGE permission applied to the scope is assigned to the API request issuer’s user identity.

Throws RESOURCE_ALREADY_EXISTS if a scope with the given name already exists. Throws RESOURCE_LIMIT_EXCEEDED if maximum number of scopes in the workspace is exceeded. Throws INVALID_PARAMETER_VALUE if the scope name is invalid.

Request structure

Field Name	Type	Description
scope	`STRING`	Scope name requested by the user. Scope names are unique. This field is required.
initial_manage_principal	`STRING`	The principal that is initially granted `MANAGE` permission to the created scope.

Delete secret scope

Endpoint	HTTP Method
`2.0/secrets/scopes/delete`	`POST`

Delete a secret scope.

Example request:

{
  "scope": "my-secret-scope"
}

Throws RESOURCE_DOES_NOT_EXIST if the scope does not exist. Throws PERMISSION_DENIED if the user does not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	Name of the scope to delete. This field is required.

List secret scopes

Endpoint	HTTP Method
`2.0/secrets/scopes/list`	`GET`

List all secret scopes available in the workspace.

Example response:

{
  "scopes": [{
      "name": "my-databricks-scope",
      "backend_type": "DATABRICKS"
  },{
      "name": "mount-points",
      "backend_type": "DATABRICKS"
  }]
}

Throws PERMISSION_DENIED if you do not have permission to make this API call.

Response structure

Field Name	Type	Description
scopes	An array of SecretScope	The available secret scopes.

Put secret

Endpoint	HTTP Method
`2.0/secrets/put`	`POST`

Insert a secret under the provided scope with the given name. If a secret already exists with the same name, this command overwrites the existing secret’s value. The server encrypts the secret using the secret scope’s encryption settings before storing it. You must have WRITE or MANAGE permission on the secret scope.

The secret key must consist of alphanumeric characters, dashes, underscores, and periods, and cannot exceed 128 characters. The maximum allowed secret value size is 128 KB. The maximum number of secrets in a given scope is 1000.

You can read a secret value only from within a command on a cluster (for example, through a notebook); there is no API to read a secret value outside of a cluster. The permission applied is based on who is invoking the command and you must have at least READ permission.

Example request:

{
  "scope": "my-databricks-scope",
  "key": "my-string-key",
  "string_value": "foobar"
}

The input fields “string_value” or “bytes_value” specify the type of the secret, which will determine the value returned when the secret value is requested. Exactly one must be specified.

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws RESOURCE_LIMIT_EXCEEDED if maximum number of secrets in scope is exceeded. Throws INVALID_PARAMETER_VALUE if the key name or value length is invalid. Throws PERMISSION_DENIED if the user does not have permission to make this API call.

Request structure

Field Name Type Description

string_value OR bytes_value

STRING OR BYTES

If string_value, if specified, the value will be stored in UTF-8 (MB4) form.

If bytes_value, if specified, value will be stored as bytes.

scope STRING The name of the scope to which the secret will be associated with. This field is required.

key STRING A unique name to identify the secret. This field is required.

Delete secret

Endpoint	HTTP Method
`2.0/secrets/delete`	`POST`

Delete the secret stored in this secret scope. You must have WRITE or MANAGE permission on the secret scope.

Example request:

{
  "scope": "my-secret-scope",
  "key": "my-secret-key"
}

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope or secret exists. Throws PERMISSION_DENIED if you do not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	The name of the scope that contains the secret to delete. This field is required.
key	`STRING`	Name of the secret to delete. This field is required.

List secrets

Endpoint	HTTP Method
`2.0/secrets/list`	`GET`

List the secret keys that are stored at this scope. This is a metadata-only operation; you cannot retrieve secret data using this API. You must have READ permission to make this call.

Example response:

{
  "secrets": [
    {
      "key": "my-string-key",
      "last_updated_timestamp": 1520467595000
    },
    {
      "key": "my-byte-key",
      "last_updated_timestamp": 1520467595000
    }
  ]
}

The last_updated_timestamp returned is in milliseconds since epoch.

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if you do not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	The name of the scope whose secrets you want to list. This field is required.

Response structure

Field Name	Type	Description
secrets	An array of SecretMetadata	Metadata information of all secrets contained within the given scope.

Put secret ACL

Endpoint	HTTP Method
`2.0/secrets/acls/put`	`POST`

Create or overwrite the ACL associated with the given principal (user or group) on the specified scope point. In general, a user or group will use the most powerful permission available to them, and permissions are ordered as follows:

MANAGE - Allowed to change ACLs, and read and write to this secret scope.
WRITE - Allowed to read and write to this secret scope.
READ - Allowed to read this secret scope and list what secrets are available.

You must have the MANAGE permission to invoke this API.

Example request:

{
  "scope": "my-secret-scope",
  "principal": "data-scientists",
  "permission": "READ"
}

The principal is a user or group name corresponding to an existing Databricks principal to be granted or revoked access.

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws RESOURCE_ALREADY_EXISTS if a permission for the principal already exists. Throws INVALID_PARAMETER_VALUE if the permission is invalid. Throws PERMISSION_DENIED if you do not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	The name of the scope to apply permissions to. This field is required.
principal	`STRING`	The principal to which the permission is applied. This field is required.
permission	AclPermission	The permission level applied to the principal. This field is required.

Delete secret ACL

Endpoint	HTTP Method
`2.0/secrets/acls/delete`	`POST`

Delete the given ACL on the given scope.

You must have the MANAGE permission to invoke this API.

Example request:

{
  "scope": "my-secret-scope",
  "principal": "data-scientists"
}

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope, principal, or ACL exists. Throws PERMISSION_DENIED if you do not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	The name of the scope to remove permissions from. This field is required.
principal	`STRING`	The principal to remove an existing ACL from. This field is required.

Get secret ACL

Endpoint	HTTP Method
`2.0/secrets/acls/get`	`GET`

Describe the details about the given ACL, such as the group and permission.

You must have the MANAGE permission to invoke this API.

Example response:

{
  "principal": "data-scientists",
  "permission": "READ"
}

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if you do not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	The name of the scope to fetch ACL information from. This field is required.
principal	`STRING`	The principal to fetch ACL information for. This field is required.

Response structure

Field Name	Type	Description
principal	`STRING`	The principal to which the permission is applied. This field is required.
permission	AclPermission	The permission level applied to the principal. This field is required.

List secret ACLs

Endpoint	HTTP Method
`2.0/secrets/acls/list`	`GET`

List the ACLs set on the given scope.

You must have the MANAGE permission to invoke this API.

Example response:

{
  "items": [
    {
        "principal": "admins",
        "permission": "MANAGE"
    },{
        "principal": "data-scientists",
        "permission": "READ"
    }
  ]
}

Throws RESOURCE_DOES_NOT_EXIST if no such secret scope exists. Throws PERMISSION_DENIED if you do not have permission to make this API call.

Request structure

Field Name	Type	Description
scope	`STRING`	The name of the scope to fetch ACL information from. This field is required.

Response structure

Field Name	Type	Description
items	An array of AclItem	The associated ACLs rule applied to principals in the given scope.

Data structures

In this section:

AclItem
SecretMetadata
SecretScope
AclPermission
ScopeBackendType

AclItem

An item representing an ACL rule applied to the given principal (user or group) on the associated scope point.

Field Name	Type	Description
principal	`STRING`	The principal to which the permission is applied. This field is required.
permission	AclPermission	The permission level applied to the principal. This field is required.

SecretMetadata

The metadata about a secret. Returned when listing secrets. Does not contain the actual secret value.

Field Name	Type	Description
key	`STRING`	A unique name to identify the secret.
last_updated_timestamp	`INT64`	The last updated timestamp (in milliseconds) for the secret.

SecretScope

An organizational resource for storing secrets. Secret scopes can be different types, and ACLs can be applied to control permissions for all secrets within a scope.

Field Name	Type	Description
name	`STRING`	A unique name to identify the secret scope.
backend_type	ScopeBackendType	The type of secret scope backend.

AclPermission

The ACL permission levels for secret ACLs applied to secret scopes.

Permission	Description
READ	Allowed to perform read operations (get, list) on secrets in this scope.
WRITE	Allowed to read and write secrets to this secret scope.
MANAGE	Allowed to read/write ACLs, and read/write secrets to this secret scope.

ScopeBackendType

The type of secret scope backend.

Only a Databricks-backed secret scope is supported.

Type	Description
DATABRICKS	A secret scope in which secrets are stored in Databricks managed storage and encrypted with a cloud-based specific encryption key.