**Source URL:** https://general.veevavault.dev/medical/vault-api/api-reference/26.1/sandbox-vaults/set-sandbox-entitlements.md

# 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"></Endpoint>

## Headers {#headers}

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

## Body Parameters {#body-parameters}

| Name | Description |
| --- | --- |
| `name` | The name of the sandbox Vault, which appears on the [My Vaults](https://platform.veevavault.help/en/gr/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/gr/48988/#refresh). |
| `size` | 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/gr/48988#sizes). |
| `allowance` | The number of entitlements to grant or revoke. |
| `grant` | Allowed values `true` and `false`. True grants allowances and false revokes them. |
| `temporary_allowance` | The number of temporary sandbox allowances to grant or revoke. |

## Request {#request}

<CodeExample title="">
```
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 {#response}

<CodeExample title="">
```
{
    "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](/medical/vault-api/api-reference/26.1/sandbox-vaults/change-sandbox-size)  
**Next:** [Create or Refresh Sandbox](/medical/vault-api/api-reference/26.1/sandbox-vaults/create-or-refresh-sandbox)