**Source URL:** https://limited.veevavault.dev/commercial/vault-api/api-reference/25.3/sandbox-vaults/set-sandbox-entitlements

# Set Sandbox Entitlements

Set new sandbox entitlements, including granting and revoking allowances, for the given sandbox `name`.

<Endpoint path="/api/{version}/objects/sandbox/entitlements/set" method="POST" />

## Headers

<FieldTable>
| Name | Description |
| --- | --- |
| `Accept` | `application/json` (default) or `application/xml` |
| `Content-Type` | `application/x-www-form-urlencoded` |
</FieldTable>

## Body Parameters

<FieldTable>
| Name | Description |
| --- | --- |
| `name`<Requiredness type="required" /> | The name of the sandbox Vault, which appears on the [My Vaults](https://platform.veevavault.help/en/lr/18505) page. Providing a new name creates a new sandbox, whereas providing an existing name refreshes the existing sandbox. How often you can refresh a Vault depends on its size. Learn more about [refreshing sandboxes in Vault Help](https://platform.veevavault.help/en/lr/48988). |
| `size`<Requiredness type="required" /> | The size of the sandbox: `Small`, `Medium`, `Large`, `Very Large`, `Extra Large`, or `Full`. Learn more about [sandbox sizes and their limits in Vault Help](https://platform.veevavault.help/en/lr/48988). |
| `allowance`<Requiredness type="required" /> | The number of entitlements to grant or revoke. |
| `grant`<Requiredness type="required" /> | Allowed values `true` and `false`. True grants allowances and false revokes them. |
| `temporary_allowance`<Requiredness type="optional" /> | The number of temporary sandbox allowances to grant or revoke. |
</FieldTable>

## Request

<CodeExample title="">
```bash
curl -X POST -H "Authorization: {SESSION_ID}" \
'https://myvault.veevavault.com/api/v20.3/objects/sandbox/entitlements/set' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'name=VeePharm Sandbox' \
-d 'size=Small' \
-d 'allowance=1' \
-d 'grant=true'
```
</CodeExample>

## Response

<CodeExample title="">
```json
{
    "responseStatus": "SUCCESS",
    "data": {
        "entitlements": [
            {
                "size": "Small",
                "available": 2,
                "allowed": 4,
                "temporary": 0
            },
            {
                "size": "Large",
                "available": 2,
                "allowed": 2,
                "temporary": 0
            },
            {
                "size": "Full",
                "available": 0,
                "allowed": 1,
                "temporary": 0
            }
        ]
    }
}
```
</CodeExample>

---

**Previous:** [Change Sandbox Size](/commercial/vault-api/api-reference/25.3/sandbox-vaults/change-sandbox-size)  
**Next:** [Create or Refresh Sandbox](/commercial/vault-api/api-reference/25.3/sandbox-vaults/create-or-refresh-sandbox)