Budget Policy

View as Markdown

Contains the BudgetPolicy details.

Get a budget policyGET /api/2.1/accounts/{account_id}/budget-policies/{policy_id}List policiesGET /api/2.1/accounts/{account_id}/budget-policiesCreate a budget policyPOST /api/2.1/accounts/{account_id}/budget-policiesUpdate a budget policyPATCH /api/2.1/accounts/{account_id}/budget-policies/{policy_id}Delete a budget policyDELETE /api/2.1/accounts/{account_id}/budget-policies/{policy_id}

BudgetPolicy object

Contains the BudgetPolicy details.

policy_idstring^[\\w.-]+$= 36 charactersPublic Preview

The Id of the policy. This field is generated by <Databricks> and globally unique.

policy_namestring[ 1 .. 127 ] charactersPublic Preview

The name of the policy.

• Must be unique among active policies.
• Can contain only characters from the ISO 8859-1 (latin1) set.
• Can't start with reserved keywords such as databricks:default-policy.

custom_tagsarray of objectPublic Preview

A list of tags defined by the customer. At most 20 entries are allowed per policy.

Show child attributesHide child attributes

keystring[ 1 .. 512 ] charactersPublic Preview

The key of the tag.

• Must be unique among all custom tags of the same policy
• Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved.

valuestring<= 256 charactersPublic Preview

The value of the tag.

binding_workspace_idsarray of int64Public Preview

List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account.

View as Markdown

The BudgetPolicy object

{
  "policy_id": "string",
  "policy_name": "string",
  "custom_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "binding_workspace_ids": [
    0
  ]
}

Get a budget policy Public Preview

GET /api/2.1/accounts/{account_id}/budget-policies/{policy_id}

Retrieves a policy by it's ID.

API scopes: billing

Parameters

account_idstringRequiredpath

The account Id of the customer

policy_idstring^[\\w.-]+$[ 1 .. 40 ] charactersRequiredpath

The Id of the policy.

Response

Returns the BudgetPolicy object.

View as Markdown

Response

{
  "policy_id": "string",
  "policy_name": "string",
  "custom_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "binding_workspace_ids": [
    0
  ]
}

List policies Public Preview

GET /api/2.1/accounts/{account_id}/budget-policies

Lists all policies. Policies are returned in the alphabetically ascending order of their names.

API scopes: billing

Parameters

account_idstringRequiredpath

The account Id of the customer

page_sizeint32query

The maximum number of budget policies to return. If unspecified, at most 100 budget policies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_tokenstringquery

A page token, received from a previous ListServerlessPolicies call. Provide this to retrieve the subsequent page. If unspecified, the first page will be returned.

When paginating, all other parameters provided to ListServerlessPoliciesRequest must match the call that provided the page token.

filter_byobjectquery

A filter to apply to the list of policies.

Show child attributesHide child attributes

policy_namestring<= 127 characters

The partial name of policies to be filtered on. If unspecified, all policies will be returned.

creator_user_idint64Deprecated

The policy creator user id to be filtered on. If unspecified, all policies will be returned.

creator_user_namestringDeprecated

Deprecated: Do not use this field in new integrations. Creator filtering will be removed in a future version. The policy creator user name to be filtered on. If unspecified, all policies will be returned.

sort_specobjectquery

The sort specification.

Show child attributesHide child attributes

fieldstring

The filed to sort by

Values:

• FIELD_UNSPECIFIED
• POLICY_NAME

descendingboolean

Whether to sort in descending order.

Response

Returns a list of BudgetPolicy objects.

View as Markdown

Response

{
  "policies": [
    {
      "policy_id": "string",
      "policy_name": "string",
      "custom_tags": [
        {}
      ],
      "binding_workspace_ids": [
        0
      ]
    }
  ],
  "next_page_token": "string",
  "previous_page_token": "string"
}

Create a budget policy Public Preview

POST /api/2.1/accounts/{account_id}/budget-policies

Creates a new policy.

API scopes: billing

Parameters

account_idstringRequiredpath

The account Id of the customer

Request body

request_idstring^[\\w.-]+$= 36 characters

A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a request_id is provided.

policyobject

The policy to create. policy_id needs to be empty as it will be generated policy_name must be provided, custom_tags may need to be provided depending on the cloud provider. All other fields are optional.

Show child attributesHide child attributes

policy_idstring^[\\w.-]+$= 36 characters

The Id of the policy. This field is generated by <Databricks> and globally unique.

policy_namestring[ 1 .. 127 ] characters

The name of the policy.

• Must be unique among active policies.
• Can contain only characters from the ISO 8859-1 (latin1) set.
• Can't start with reserved keywords such as databricks:default-policy.

custom_tagsarray of object

A list of tags defined by the customer. At most 20 entries are allowed per policy.

Show child attributesHide child attributes

keystring[ 1 .. 512 ] charactersRequired

The key of the tag.

• Must be unique among all custom tags of the same policy
• Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved.

valuestring<= 256 characters

The value of the tag.

binding_workspace_idsarray of int64

List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account.

Response

Returns the BudgetPolicy object.

View as Markdown

Request

{
  "request_id": "string",
  "policy": {
    "policy_id": "string",
    "policy_name": "string",
    "custom_tags": [
      {}
    ],
    "binding_workspace_ids": [
      0
    ]
  }
}

Response

{
  "policy_id": "string",
  "policy_name": "string",
  "custom_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "binding_workspace_ids": [
    0
  ]
}

Update a budget policy Public Preview

PATCH /api/2.1/accounts/{account_id}/budget-policies/{policy_id}

Updates a policy

API scopes: billing

Parameters

account_idstringRequiredpath

The account Id of the customer

policy_idstring^[\\w.-]+$= 36 charactersRequiredpath

The Id of the policy. This field is generated by <Databricks> and globally unique.

limit_configobjectDeprecatedquery

DEPRECATED. This is redundant field as LimitConfig is part of the BudgetPolicy

Request body

The policy to update. creator_user_id cannot be specified in the request. All other fields must be specified even if not changed. The policy_id is used to identify the policy to update.

policy_namestring[ 1 .. 127 ] characters

The name of the policy.

• Must be unique among active policies.
• Can contain only characters from the ISO 8859-1 (latin1) set.
• Can't start with reserved keywords such as databricks:default-policy.

custom_tagsarray of object

A list of tags defined by the customer. At most 20 entries are allowed per policy.

Show child attributesHide child attributes

keystring[ 1 .. 512 ] charactersRequired

The key of the tag.

• Must be unique among all custom tags of the same policy
• Cannot be “budget-policy-name”, “budget-policy-id” or "budget-policy-resolution-result" - these tags are preserved.

valuestring<= 256 characters

The value of the tag.

binding_workspace_idsarray of int64

List of workspaces that this budget policy will be exclusively bound to. An empty binding implies that this budget policy is open to any workspace in the account.

Response

Returns the BudgetPolicy object.

View as Markdown

Request

{
  "policy_name": "string",
  "custom_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "binding_workspace_ids": [
    0
  ]
}

Response

{
  "policy_id": "string",
  "policy_name": "string",
  "custom_tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "binding_workspace_ids": [
    0
  ]
}

Delete a budget policy Public Preview

DELETE /api/2.1/accounts/{account_id}/budget-policies/{policy_id}

Deletes a policy

API scopes: billing

Parameters

account_idstringRequiredpath

The account Id of the customer

policy_idstring^[\\w.-]+$[ 1 .. 40 ] charactersRequiredpath

The Id of the policy.

View as Markdown

Response

{}