{ "opencollection": "1.0.0", "info": { "name": "Vagrant Cloud Boxes API", "version": "2" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Boxes", "type": "folder" }, "items": [ { "info": { "name": "Create a box", "type": "http" }, "http": { "method": "POST", "url": "https://app.vagrantup.com/api/v2/boxes", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Vagrant box under the authenticated user or specified organization. Requires authentication with a valid access token." }, { "info": { "name": "Read a box", "type": "http" }, "http": { "method": "GET", "url": "https://app.vagrantup.com/api/v2/box/:username/:name", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username or organization name that owns the box." }, { "name": "name", "value": "", "type": "path", "description": "The name of the Vagrant box." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Retrieves detailed information about a specific Vagrant box, including its versions, providers, and metadata. Public boxes do not require authentication." }, { "info": { "name": "Update a box", "type": "http" }, "http": { "method": "PUT", "url": "https://app.vagrantup.com/api/v2/box/:username/:name", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username or organization name that owns the box." }, { "name": "name", "value": "", "type": "path", "description": "The name of the Vagrant box." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the metadata of an existing Vagrant box, such as its description, short description, or privacy settings." }, { "info": { "name": "Delete a box", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.vagrantup.com/api/v2/box/:username/:name", "params": [ { "name": "username", "value": "", "type": "path", "description": "The username or organization name that owns the box." }, { "name": "name", "value": "", "type": "path", "description": "The name of the Vagrant box." } ] }, "docs": "Permanently deletes a Vagrant box and all of its versions and providers. This action cannot be undone." }, { "info": { "name": "List boxes", "type": "http" }, "http": { "method": "GET", "url": "https://app.vagrantup.com/api/v2/vagrant/2023-01-01/registry/:registry/boxes", "params": [ { "name": "registry", "value": "", "type": "path", "description": "The globally unique name of the Vagrant box registry such as hashicorp in hashicorp/vagrant." }, { "name": "page_size", "value": "", "type": "query", "description": "The maximum number of results to return per page." }, { "name": "page_token", "value": "", "type": "query", "description": "The token for fetching the next page of results." } ] }, "docs": "Lists all Vagrant boxes within a specific registry. Supports pagination for registries with many boxes." }, { "info": { "name": "Create a box", "type": "http" }, "http": { "method": "POST", "url": "https://app.vagrantup.com/api/v2/vagrant/2023-01-01/registry/:registry/boxes", "params": [ { "name": "registry", "value": "", "type": "path", "description": "The globally unique name of the Vagrant box registry such as hashicorp in hashicorp/vagrant." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Vagrant box within a registry. The box name must be unique within the registry and should only be set at creation time." }, { "info": { "name": "Read a box", "type": "http" }, "http": { "method": "GET", "url": "https://app.vagrantup.com/api/v2/vagrant/2023-01-01/registry/:registry/box/:box", "params": [ { "name": "registry", "value": "", "type": "path", "description": "The globally unique name of the Vagrant box registry such as hashicorp in hashicorp/vagrant." }, { "name": "box", "value": "", "type": "path", "description": "The name segment of the box which is unique within the registry." } ] }, "docs": "Retrieves detailed information about a specific Vagrant box within a registry." }, { "info": { "name": "Update a box", "type": "http" }, "http": { "method": "PUT", "url": "https://app.vagrantup.com/api/v2/vagrant/2023-01-01/registry/:registry/box/:box", "params": [ { "name": "registry", "value": "", "type": "path", "description": "The globally unique name of the Vagrant box registry such as hashicorp in hashicorp/vagrant." }, { "name": "box", "value": "", "type": "path", "description": "The name segment of the box which is unique within the registry." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the metadata of an existing Vagrant box within a registry, such as its descriptions." }, { "info": { "name": "Delete a box", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.vagrantup.com/api/v2/vagrant/2023-01-01/registry/:registry/box/:box", "params": [ { "name": "registry", "value": "", "type": "path", "description": "The globally unique name of the Vagrant box registry such as hashicorp in hashicorp/vagrant." }, { "name": "box", "value": "", "type": "path", "description": "The name segment of the box which is unique within the registry." } ] }, "docs": "Permanently deletes a box and all of its versions and providers from the registry. This action cannot be undone." } ] } ], "bundled": true }