RErender
Sandboxes

Create sandbox group

Changed on

Create a sandbox group. The workspace's first group becomes its default. Returns 409 if the name is taken.

post/sandbox-groups

Request

  • Base URL
    https://api.render.com/v1
  • Auth
    HTTP bearer

Request body

ownerIdstring required

Workspace ID.

namestring required

Name, unique within the workspace.

regionstring

Region for the group's sandboxes. Defaults to Render's default sandbox region.

Example request

{
  "ownerId": "tea-cph1rs3idesc73a2b2mg",
  "name": "CI agents",
  "region": "oregon"
}

Response

Sandbox group created.

idSchema required(unresolved $ref)
ownerIdstring required

The ID of the workspace this group belongs to.

namestring required

Human-friendly name for the group.

regionstring required

Render region the group operates in.

isDefaultboolean required

Whether this is the workspace's default group. Sandboxes are created here unless a group is given.

environmentIdstring nullable

Environment this group is bound to.

concurrencyLimitinteger required

The effective limit on active sandboxes in this group, capped by Render's limit for this workspace.

createdAtstring date-time required
updatedAtstring date-time required

Changes