How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Vagrant Boxes API

Endpoints for creating, reading, updating, and deleting Vagrant boxes in the Vagrant Cloud registry.

Vagrant Boxes API is one of 7 APIs that Vagrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Boxes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 9 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 2.

Requests are made against a single base URL, https://app.vagrantup.com/api/v2.

9 operations 4 paths 13 schemas 2 DELETE3 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2
Base URL
https://app.vagrantup.com/api/v2
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Vagrant Boxes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Vagrant Cloud API token passed as a Bearer token in the Authorization header.

Paths & Operations 9

Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Boxes 9

Endpoints for creating, reading, updating, and deleting Vagrant boxes in the Vagrant Cloud registry.

POST
/boxes
Create a box
createBox body → 200401422
GET
/box/{username}/{name}
Read a box
readBox 2 params → 200404
PUT
/box/{username}/{name}
Update a box
updateBox 2 params body → 200401404
DELETE
/box/{username}/{name}
Delete a box
deleteBox 2 params → 200401404
GET
/vagrant/2023-01-01/registry/{registry}/boxes
List boxes
listBoxes 3 params → 200404
POST
/vagrant/2023-01-01/registry/{registry}/boxes
Create a box
createBox 1 param body → 200401404409
GET
/vagrant/2023-01-01/registry/{registry}/box/{box}
Read a box
readBox 2 params → 200404
PUT
/vagrant/2023-01-01/registry/{registry}/box/{box}
Update a box
updateBox 2 params body → 200401404
DELETE
/vagrant/2023-01-01/registry/{registry}/box/{box}
Delete a box
deleteBox 2 params → 200401404

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Box (12 properties), Provider (11 properties), Version (9 properties), Box_2 (7 properties). Each schema is shown below with its type and property counts.

ListBoxesResponse
object
Response containing a list of boxes and pagination information.
2 properties
OperationResponse
object
Response containing an operation object for asynchronous actions.
1 property
Box_2
object
A Vagrant box within an HCP registry. The box name combined with the registry name forms the full box tag.
7 properties
Operation
object
An operation returned by asynchronous API calls. The operation ID is unique within the region the operation is running in.
3 properties
Pagination
object
Pagination information for list responses.
1 property
BoxResponse
object
Response containing a box object.
1 property
UpdateBoxRequest
object
Request body for updating an existing Vagrant box.
1 property
Version
object
A version of a Vagrant box following semantic versioning. Versions must be released before they are available for download.
9 properties
UpdateBoxRequest_2
object
Request body for updating a box in a registry.
2 properties
CreateBoxRequest_2
object
Request body for creating a new box in a registry.
3 properties 1 required
Box
object
A Vagrant box is a package format for Vagrant environments that includes the base image and metadata for one or more providers.
12 properties
Provider
object
A provider represents a specific virtualization platform for which a box file is available within a version.
11 properties
CreateBoxRequest
object
Request body for creating a new Vagrant box.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vagrant-boxes-api-openapi.yml Raw ↑

Other APIs Vagrant publishes across the network.

Vagrant Cloud Ruby Client
Vagrant Plugin SDK
Vagrant Providers API
Vagrant Registries API
Vagrant Search API
Vagrant Versions API
Where this information came from

This is an independent, third-party profile of Vagrant Boxes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.