> ## Documentation Index > Fetch the complete documentation index at: https://www.ravion.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Get a pipeline version's sandbox host plan > Compute the sandbox host pools a pipeline version needs: how many microVMs run at once in each execution environment, the instance type that holds that… ## OpenAPI ````yaml https://api.ravion.com/openapi.yaml get /pipeline-versions/{id}/sandbox-plan openapi: 3.0.0 info: title: Ravion version: 0.0.0 servers: - url: https://api.ravion.com security: - BearerAuth: [] tags: - name: Projects - name: Environments - name: FeatureFlags - name: Pipelines - name: PipelineRuns - name: TerraformResources - name: TerraformExecutionSummaries - name: PipelineStepExecutions - name: AwsCloudWatch - name: PipelineVersions - name: Organizations - name: Stacks - name: StackWorkspaces - name: Auth - name: OAuth - name: User - name: Health - name: Memberships - name: ServiceAccounts - name: AwsDefaultNetworks - name: AwsAccounts - name: ApiKeys - name: AwsAmp - name: EksPrometheus - name: EksLoki - name: ExecutionEnvironments - name: ModuleDefinitions - name: ModuleCategories - name: ModuleVersions - name: ModuleInstances - name: DefaultValueDefinitions - name: DefaultValues - name: CodeSources - name: Github - name: Gitlab - name: Git - name: Values - name: Deployments - name: DeploymentResources - name: InfrastructureEvents - name: WebSocket - name: Domains - name: AcmCertificates - name: Describe - name: Reports - name: BillingPlans - name: BillingAccounts - name: BillingCycles - name: BillingUsageSummaries - name: BillingAddOns - name: BillingInvoices paths: /pipeline-versions/{id}/sandbox-plan: get: tags: - PipelineVersions summary: Get a pipeline version's sandbox host plan description: >- Compute the sandbox host pools a pipeline version needs: how many microVMs run at once in each execution environment, the instance type that holds that peak on the fewest hosts, and the hosts that implies. Computed on read and never stored. operationId: GetPipelineVersionSandboxPlan parameters: - description: Pipeline version ID in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: additionalProperties: false properties: data: $ref: '#/components/schemas/PipelineVersionSandboxPlan' required: - data type: object description: The request has succeeded. '400': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: The request is invalid or malformed. '401': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: You are not authenticated '403': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: You do not have permission to access this resource. '404': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: The server cannot find the requested resource. '500': content: application/json: schema: $ref: '#/components/schemas/Errors.UserFacingErrorData' description: Server error components: schemas: PipelineVersionSandboxPlan: additionalProperties: false description: >- What a pipeline version asks of the sandbox host pools its steps land on. properties: pools: description: One entry per sandbox host pool the pipeline's steps land on. items: $ref: '#/components/schemas/PipelineVersionSandboxPlanPool' type: array required: - pools type: object Errors.UserFacingErrorData: additionalProperties: false description: |- User-facing error presentation data. This is what the API returns to the frontend after formatting ErrorData using CEL templates from the error registry. Used for both: - Error fields on domain models (e.g., PipelineRun.error) - API error response bodies (HTTP 4xx/5xx responses) properties: action: allOf: - $ref: '#/components/schemas/Errors.Action' description: Optional action to help resolve the error code: description: Full error code, e.g., "Ravion:Pipeline:NOT_FOUND" type: string description: description: Additional description with more details type: string details: description: Structured details rendered as user-facing sections. items: $ref: '#/components/schemas/Errors.UserFacingErrorDetailSection' type: array isInternal: description: >- Indicates whether this error is internal (only set when ShowInternal=true). This allows SUPERADMINs to identify internal errors while viewing full details. type: boolean message: description: Main error message (required) type: string metadata: additionalProperties: {} description: >- Error params/metadata. Stripped for internal errors unless superadmin. type: object requestId: description: Request ID for correlating errors with server logs. type: string required: - code - message type: object PipelineVersionSandboxPlanPool: additionalProperties: false description: One execution environment's share of the pipeline's sandbox demand. properties: executionEnvironmentId: description: Execution environment whose sandbox host pool these steps run on. type: string hostsNeeded: description: Hosts of that instance type the pipeline needs to hold its peak. format: int32 type: integer instanceType: description: >- Instance type that holds this pool's peak on the fewest hosts, with the fewest spare vCPUs and then the least spare memory. type: string maxConcurrentSandboxes: description: Most sandboxes this pool runs at once during the pipeline. format: int32 type: integer slotsPerHost: description: Sandboxes of the largest step's shape one host of that type holds. format: int32 type: integer steps: description: The steps that land on this pool, in configuration order. items: $ref: '#/components/schemas/PipelineVersionSandboxPlanStep' type: array required: - executionEnvironmentId - instanceType - hostsNeeded - slotsPerHost - maxConcurrentSandboxes - steps type: object Errors.Action: additionalProperties: false description: Action to help user resolve the error properties: label: description: Button/link label text type: string url: description: URL to navigate to for resolution type: string required: - label - url type: object Errors.UserFacingErrorDetailSection: additionalProperties: false description: Structured user-facing error detail section. properties: items: description: List of detail values for this section. items: type: string type: array object: additionalProperties: {} description: Structured detail payload for object rendering. type: object render: description: Rendering hint for clients. Valid values are list or object. type: string title: description: Detail section title shown in the UI. type: string required: - title - render type: object PipelineVersionSandboxPlanStep: additionalProperties: false description: One sandbox step of the plan and the microVM it asks its pool for. properties: cpu: description: vCPUs given to the step's microVM. format: int32 type: integer diskGiB: description: Host disk in GiB the step's microVM reserves. format: int32 type: integer memoryGiB: description: Memory in GiB given to the step's microVM. format: int32 type: integer name: description: Step name, or its id when the step has no name. type: string required: - name - cpu - memoryGiB - diskGiB type: object securitySchemes: BearerAuth: scheme: Bearer type: http ````