> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Check sandbox readiness

> Check sandbox readiness.

`sandboxReadiness(sandboxId: ID!): SandboxRuntimeCheck!`

Requires project.sandboxes.manage.

## Arguments

| Argument | Type | Required |
| - | - | - |
| `sandboxId` | [`ID!`](https://veryfront.com/docs/cloud/graphql/types/id) | Yes |

## Response

Returns [`SandboxRuntimeCheck!`](https://veryfront.com/docs/cloud/graphql/types/sandboxruntimecheck). Open the type for its fields and nested types.

| Field | Type | Description |
| - | - | - |
| `ok` | [`Boolean!`](https://veryfront.com/docs/cloud/graphql/types/boolean) | Health: whether the sandbox runtime responds. Readiness: whether it is ready for work. |
| `status` | [`SandboxStatus!`](https://veryfront.com/docs/cloud/graphql/types/sandboxstatus) | |
| `reason` | [`String`](https://veryfront.com/docs/cloud/graphql/types/string) | |

Types marked with `!` cannot be null. Lists use `[Type]` notation. The [type index](https://veryfront.com/docs/cloud/graphql/schema.md) lists all published input and response types.

## Example

```graphql title="query.graphql" theme={null}
query SandboxReadiness($sandboxId: ID!) {
  sandboxReadiness(sandboxId: $sandboxId) {
    status
    ok
    reason
  }
}
```

```json title="variables.json" theme={null}
{
  "sandboxId": "00000000-0000-4000-8000-000000000001"
}
```

<details>
  <summary>Try this query</summary>

  Calls use `https://api.veryfront.com/graphql`. Replace sample values with resources you can access. See [Authentication](https://veryfront.com/docs/cloud/authentication.md) for credentials and permissions.

  Bearer token or API key

  Stored in this tab's session. Clear credential

  Query

  Variables (JSON)
</details>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.