HashiTalks 2025 Learn about unique use cases, homelab setups, and best practices at scale at our 24-hour virtual knowledge sharing event. Register
HashiCorp Cloud Platform

HCP Vagrant Box Registry

Loading…
Status
(opens in new tab)
stable

API for managing Vagrant boxes.

Download Spec

Operations

​List​Registries

get

​/​vagrant​/​registries

​List​Registries

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registries

Request

Query Parameters
location.organization_idstring

organization_id is the id of the organization.

location.project_idstring

project_id is the projects id.

location.region.providerstring

provider is the named cloud provider ("aws", "gcp", "azure")

location.region.regionstring

region is the cloud region ("us-west1", "us-east1")

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
registriesobject[]
  • namestring

    The name of the Registry. This is a user-settable, globally-unique name, and forms the first segment of a box, ie: the "hashicorp" in "hashicorp/vagrant". No two registries can have the same name, regardless of the location (org/project) they are in.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • activatedboolean

    Whether or not the Registry is currently activated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    The description of the registry, if it exists.

  • description_htmlstring
  • gravatar_urlstring
  • boxesobject[]
    • namestring

      The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

    • descriptionstring

      A long-form description of the box.

    • short_descriptionstring

      A short-form description of the box. Limited to 100 characters.

    • is_privateboolean

      Whether or not the Box is private.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • versions_countstring

        Total number of versions available on this box.

      • provider_namesstring[]
      • latest_released_atstring
    • downloadsstring

      The number of times this box has been downloaded.

    • statestring

      BoxState is an enumeration of possible Box states.

    • description_htmlstring

      The HTML rendered description.

    • versionsobject[]
      • namestring

        The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

      • statestring

        State is an enumeration of possible Version states.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • descriptionstring

        A long-form description of the version.

      • description_htmlstring

        The HTML rendered description.

      • summaryobject
        • providers_countstring
        • provider_namesstring[]
      • providersobject[]

        Provider describes a Provider with its list of architectures and box data.

        • namestring

          The name of the Provider, should be unique within the version.

        • architecturesobject[]
          • architecture_typestring

            The architecture type that is supported.

          • defaultboolean
          • box_dataobject

            BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

            • download_urlstring

              The download URL for this box data.

            • checksumstring

              The checksum for the box data.

            • checksum_typestring

              ChecksumType describe supported checksum types.

            • sizestring

              The size of the box file, if available.

            • created_atstring

              The date the record was created.

            • updated_atstring

              The date that the record was last updated.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

        • summaryobject
          • architectures_countstring
          • architecture_typesstring[]
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Registry

post

​/​vagrant​/​registries

​Create​Registry

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registries

Request

Body Parameters
namestring

The name of the Registry. This is a user-settable, globally-unique name, and forms the first segment of a box, ie: the "hashicorp" in "hashicorp/vagrant". No two registries can have the same name, regardless of the location (org/project) they are in.

locationobject

Location represents a target for an operation in HCP.

  • organization_idstring

    organization_id is the id of the organization.

  • project_idstring

    project_id is the projects id.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
descriptionstring

The description of the registry, if it exists.

Response

200 - OK
registryobject
  • namestring

    The name of the Registry. This is a user-settable, globally-unique name, and forms the first segment of a box, ie: the "hashicorp" in "hashicorp/vagrant". No two registries can have the same name, regardless of the location (org/project) they are in.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • activatedboolean

    Whether or not the Registry is currently activated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    The description of the registry, if it exists.

  • description_htmlstring
  • gravatar_urlstring
  • boxesobject[]
    • namestring

      The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

    • descriptionstring

      A long-form description of the box.

    • short_descriptionstring

      A short-form description of the box. Limited to 100 characters.

    • is_privateboolean

      Whether or not the Box is private.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • versions_countstring

        Total number of versions available on this box.

      • provider_namesstring[]
      • latest_released_atstring
    • downloadsstring

      The number of times this box has been downloaded.

    • statestring

      BoxState is an enumeration of possible Box states.

    • description_htmlstring

      The HTML rendered description.

    • versionsobject[]
      • namestring

        The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

      • statestring

        State is an enumeration of possible Version states.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • descriptionstring

        A long-form description of the version.

      • description_htmlstring

        The HTML rendered description.

      • summaryobject
        • providers_countstring
        • provider_namesstring[]
      • providersobject[]

        Provider describes a Provider with its list of architectures and box data.

        • namestring

          The name of the Provider, should be unique within the version.

        • architecturesobject[]
          • architecture_typestring

            The architecture type that is supported.

          • defaultboolean
          • box_dataobject

            BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

            • download_urlstring

              The download URL for this box data.

            • checksumstring

              The checksum for the box data.

            • checksum_typestring

              ChecksumType describe supported checksum types.

            • sizestring

              The size of the box file, if available.

            • created_atstring

              The date the record was created.

            • updated_atstring

              The date that the record was last updated.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

        • summaryobject
          • architectures_countstring
          • architecture_typesstring[]
operationobject

Operation represents a single operation.

  • idstring

    id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

    • codeinteger

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    • messagestring

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • created_atstring

    CreatedAt is the timestamp of when the operation was first created.

  • updated_atstring

    UpdatedAt is the timestamp of when the operation was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Read​Registry

get

​/​vagrant​/​registry​/​{registry}

​Read​Registry

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}

Request

Path Parameters
registrystringRequired

The name of the Registry to look up.

Query Parameters
expandedboolean

Expand the registry child elements.

Response

200 - OK
registryobject
  • namestring

    The name of the Registry. This is a user-settable, globally-unique name, and forms the first segment of a box, ie: the "hashicorp" in "hashicorp/vagrant". No two registries can have the same name, regardless of the location (org/project) they are in.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • activatedboolean

    Whether or not the Registry is currently activated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    The description of the registry, if it exists.

  • description_htmlstring
  • gravatar_urlstring
  • boxesobject[]
    • namestring

      The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

    • descriptionstring

      A long-form description of the box.

    • short_descriptionstring

      A short-form description of the box. Limited to 100 characters.

    • is_privateboolean

      Whether or not the Box is private.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • versions_countstring

        Total number of versions available on this box.

      • provider_namesstring[]
      • latest_released_atstring
    • downloadsstring

      The number of times this box has been downloaded.

    • statestring

      BoxState is an enumeration of possible Box states.

    • description_htmlstring

      The HTML rendered description.

    • versionsobject[]
      • namestring

        The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

      • statestring

        State is an enumeration of possible Version states.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • descriptionstring

        A long-form description of the version.

      • description_htmlstring

        The HTML rendered description.

      • summaryobject
        • providers_countstring
        • provider_namesstring[]
      • providersobject[]

        Provider describes a Provider with its list of architectures and box data.

        • namestring

          The name of the Provider, should be unique within the version.

        • architecturesobject[]
          • architecture_typestring

            The architecture type that is supported.

          • defaultboolean
          • box_dataobject

            BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

            • download_urlstring

              The download URL for this box data.

            • checksumstring

              The checksum for the box data.

            • checksum_typestring

              ChecksumType describe supported checksum types.

            • sizestring

              The size of the box file, if available.

            • created_atstring

              The date the record was created.

            • updated_atstring

              The date that the record was last updated.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

        • summaryobject
          • architectures_countstring
          • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Registry

delete

​/​vagrant​/​registry​/​{registry}

​Delete​Registry

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}

Request

Path Parameters
registrystringRequired

The name of the Registry to delete.

Response

200 - OK
operationobject

Operation represents a single operation.

  • idstring

    id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

    • codeinteger

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    • messagestring

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • created_atstring

    CreatedAt is the timestamp of when the operation was first created.

  • updated_atstring

    UpdatedAt is the timestamp of when the operation was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Registry

put

​/​vagrant​/​registry​/​{registry}

​Update​Registry

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}

Request

Path Parameters
registrystringRequired

The name of the Registry to update.

Body Parameters
namestring

The name of the Registry. This is a user-settable, globally-unique name, and forms the first segment of a box, ie: the "hashicorp" in "hashicorp/vagrant". No two registries can have the same name, regardless of the location (org/project) they are in.

locationobject

Location represents a target for an operation in HCP.

  • organization_idstring

    organization_id is the id of the organization.

  • project_idstring

    project_id is the projects id.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring
descriptionstring

The description of the registry, if it exists.

Response

200 - OK
registryobject
  • namestring

    The name of the Registry. This is a user-settable, globally-unique name, and forms the first segment of a box, ie: the "hashicorp" in "hashicorp/vagrant". No two registries can have the same name, regardless of the location (org/project) they are in.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • activatedboolean

    Whether or not the Registry is currently activated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    The description of the registry, if it exists.

  • description_htmlstring
  • gravatar_urlstring
  • boxesobject[]
    • namestring

      The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

    • descriptionstring

      A long-form description of the box.

    • short_descriptionstring

      A short-form description of the box. Limited to 100 characters.

    • is_privateboolean

      Whether or not the Box is private.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • versions_countstring

        Total number of versions available on this box.

      • provider_namesstring[]
      • latest_released_atstring
    • downloadsstring

      The number of times this box has been downloaded.

    • statestring

      BoxState is an enumeration of possible Box states.

    • description_htmlstring

      The HTML rendered description.

    • versionsobject[]
      • namestring

        The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

      • statestring

        State is an enumeration of possible Version states.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • descriptionstring

        A long-form description of the version.

      • description_htmlstring

        The HTML rendered description.

      • summaryobject
        • providers_countstring
        • provider_namesstring[]
      • providersobject[]

        Provider describes a Provider with its list of architectures and box data.

        • namestring

          The name of the Provider, should be unique within the version.

        • architecturesobject[]
          • architecture_typestring

            The architecture type that is supported.

          • defaultboolean
          • box_dataobject

            BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

            • download_urlstring

              The download URL for this box data.

            • checksumstring

              The checksum for the box data.

            • checksum_typestring

              ChecksumType describe supported checksum types.

            • sizestring

              The size of the box file, if available.

            • created_atstring

              The date the record was created.

            • updated_atstring

              The date that the record was last updated.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

        • summaryobject
          • architectures_countstring
          • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Activate​Registry

put

​/​vagrant​/​registry​/​{registry}​/​activate

​Activate​Registry

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/activate

Request

Path Parameters
registrystringRequired

The name of the Registry to activate.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Read​Box

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}

​Read​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box to look up. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

Query Parameters
expandedboolean

Expand the box child elements.

Response

200 - OK
boxobject
  • namestring

    The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

  • descriptionstring

    A long-form description of the box.

  • short_descriptionstring

    A short-form description of the box. Limited to 100 characters.

  • is_privateboolean

    Whether or not the Box is private.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • versions_countstring

      Total number of versions available on this box.

    • provider_namesstring[]
    • latest_released_atstring
  • downloadsstring

    The number of times this box has been downloaded.

  • statestring

    BoxState is an enumeration of possible Box states.

  • description_htmlstring

    The HTML rendered description.

  • versionsobject[]
    • namestring

      The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

    • statestring

      State is an enumeration of possible Version states.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • descriptionstring

      A long-form description of the version.

    • description_htmlstring

      The HTML rendered description.

    • summaryobject
      • providers_countstring
      • provider_namesstring[]
    • providersobject[]

      Provider describes a Provider with its list of architectures and box data.

      • namestring

        The name of the Provider, should be unique within the version.

      • architecturesobject[]
        • architecture_typestring

          The architecture type that is supported.

        • defaultboolean
        • box_dataobject

          BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

          • download_urlstring

            The download URL for this box data.

          • checksumstring

            The checksum for the box data.

          • checksum_typestring

            ChecksumType describe supported checksum types.

          • sizestring

            The size of the box file, if available.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • summaryobject
        • architectures_countstring
        • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Box

delete

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}

​Delete​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box to delete. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

Response

200 - OK
operationobject

Operation represents a single operation.

  • idstring

    id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

    • codeinteger

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    • messagestring

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • created_atstring

    CreatedAt is the timestamp of when the operation was first created.

  • updated_atstring

    UpdatedAt is the timestamp of when the operation was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Box

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}

​Update​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box to update. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

Body Parameters
namestring

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

descriptionstring

A long-form description of the box.

short_descriptionstring

A short-form description of the box. Limited to 100 characters.

is_privateboolean

Whether or not the Box is private.

summaryobject
  • versions_countstring

    Total number of versions available on this box.

  • provider_namesstring[]
  • latest_released_atstring
statestring

BoxState is an enumeration of possible Box states.

Response

200 - OK
boxobject
  • namestring

    The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

  • descriptionstring

    A long-form description of the box.

  • short_descriptionstring

    A short-form description of the box. Limited to 100 characters.

  • is_privateboolean

    Whether or not the Box is private.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • versions_countstring

      Total number of versions available on this box.

    • provider_namesstring[]
    • latest_released_atstring
  • downloadsstring

    The number of times this box has been downloaded.

  • statestring

    BoxState is an enumeration of possible Box states.

  • description_htmlstring

    The HTML rendered description.

  • versionsobject[]
    • namestring

      The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

    • statestring

      State is an enumeration of possible Version states.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • descriptionstring

      A long-form description of the version.

    • description_htmlstring

      The HTML rendered description.

    • summaryobject
      • providers_countstring
      • provider_namesstring[]
    • providersobject[]

      Provider describes a Provider with its list of architectures and box data.

      • namestring

        The name of the Provider, should be unique within the version.

      • architecturesobject[]
        • architecture_typestring

          The architecture type that is supported.

        • defaultboolean
        • box_dataobject

          BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

          • download_urlstring

            The download URL for this box data.

          • checksumstring

            The checksum for the box data.

          • checksum_typestring

            ChecksumType describe supported checksum types.

          • sizestring

            The size of the box file, if available.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • summaryobject
        • architectures_countstring
        • architecture_typesstring[]
operationobject

Operation represents a single operation.

  • idstring

    id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

    • codeinteger

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    • messagestring

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • created_atstring

    CreatedAt is the timestamp of when the operation was first created.

  • updated_atstring

    UpdatedAt is the timestamp of when the operation was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Read​Version

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}

​Read​Version

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the version to look up.

Query Parameters
expandedboolean

Expand the version child elements.

Response

200 - OK
versionobject
  • namestring

    The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

  • statestring

    State is an enumeration of possible Version states.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    A long-form description of the version.

  • description_htmlstring

    The HTML rendered description.

  • summaryobject
    • providers_countstring
    • provider_namesstring[]
  • providersobject[]

    Provider describes a Provider with its list of architectures and box data.

    • namestring

      The name of the Provider, should be unique within the version.

    • architecturesobject[]
      • architecture_typestring

        The architecture type that is supported.

      • defaultboolean
      • box_dataobject

        BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

        • download_urlstring

          The download URL for this box data.

        • checksumstring

          The checksum for the box data.

        • checksum_typestring

          ChecksumType describe supported checksum types.

        • sizestring

          The size of the box file, if available.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • architectures_countstring
      • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Version

delete

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}

​Delete​Version

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version to delete.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Version

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}

​Update​Version

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the version to update.

Body Parameters
namestring

The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

statestring

State is an enumeration of possible Version states.

descriptionstring

A long-form description of the version.

summaryobject
  • providers_countstring
  • provider_namesstring[]

Response

200 - OK
versionobject
  • namestring

    The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

  • statestring

    State is an enumeration of possible Version states.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    A long-form description of the version.

  • description_htmlstring

    The HTML rendered description.

  • summaryobject
    • providers_countstring
    • provider_namesstring[]
  • providersobject[]

    Provider describes a Provider with its list of architectures and box data.

    • namestring

      The name of the Provider, should be unique within the version.

    • architecturesobject[]
      • architecture_typestring

        The architecture type that is supported.

      • defaultboolean
      • box_dataobject

        BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

        • download_urlstring

          The download URL for this box data.

        • checksumstring

          The checksum for the box data.

        • checksum_typestring

          ChecksumType describe supported checksum types.

        • sizestring

          The size of the box file, if available.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • architectures_countstring
      • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Read​Provider

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}

​Read​Provider

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

Query Parameters
expandedboolean

Expand the provider child elements.

Response

200 - OK
providerobject

Provider describes a Provider with its list of architectures and box data.

  • namestring

    The name of the Provider, should be unique within the version.

  • architecturesobject[]
    • architecture_typestring

      The architecture type that is supported.

    • defaultboolean
    • box_dataobject

      BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

      • download_urlstring

        The download URL for this box data.

      • checksumstring

        The checksum for the box data.

      • checksum_typestring

        ChecksumType describe supported checksum types.

      • sizestring

        The size of the box file, if available.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • architectures_countstring
    • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Provider

delete

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}

​Delete​Provider

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Provider

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}

​Update​Provider

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

Body Parameters
namestring

The name of the Provider, should be unique within the version.

summaryobject
  • architectures_countstring
  • architecture_typesstring[]

Response

200 - OK
providerobject

Provider describes a Provider with its list of architectures and box data.

  • namestring

    The name of the Provider, should be unique within the version.

  • architecturesobject[]
    • architecture_typestring

      The architecture type that is supported.

    • defaultboolean
    • box_dataobject

      BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

      • download_urlstring

        The download URL for this box data.

      • checksumstring

        The checksum for the box data.

      • checksum_typestring

        ChecksumType describe supported checksum types.

      • sizestring

        The size of the box file, if available.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • architectures_countstring
    • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Read​Architecture

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}

​Read​Architecture

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Architecture.

providerstringRequired

The name of the Provider.

architecturestringRequired

The name of the Architecture.

Response

200 - OK
architectureobject
  • architecture_typestring

    The architecture type that is supported.

  • defaultboolean
  • box_dataobject

    BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

    • download_urlstring

      The download URL for this box data.

    • checksumstring

      The checksum for the box data.

    • checksum_typestring

      ChecksumType describe supported checksum types.

    • sizestring

      The size of the box file, if available.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Delete​Architecture

delete

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}

​Delete​Architecture

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

architecturestringRequired

The name of the Architecture.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Update​Architecture

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}

​Update​Architecture

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

architecturestringRequired

The type of the Architecture.

Body Parameters
architecture_typestring

The architecture type that is supported.

defaultboolean
box_dataobject

BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

  • download_urlstring

    The download URL for this box data.

  • checksumstring

    The checksum for the box data.

  • checksum_typestring

    ChecksumType describe supported checksum types.

  • sizestring

    The size of the box file, if available.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

Response

200 - OK
architectureobject
  • architecture_typestring

    The architecture type that is supported.

  • defaultboolean
  • box_dataobject

    BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

    • download_urlstring

      The download URL for this box data.

    • checksumstring

      The checksum for the box data.

    • checksum_typestring

      ChecksumType describe supported checksum types.

    • sizestring

      The size of the box file, if available.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Complete​Direct​Upload​Box

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}​/​direct​/​complete​/​{object}

​Complete​Direct​Upload​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}/direct/complete/{object}

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

architecturestringRequired

The name of the Architecture.

objectstringRequired

Object identifier.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Direct​Upload​Box

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}​/​direct​/​upload

​Direct​Upload​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}/direct/upload

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

architecturestringRequired

The type of the Architecture.

Response

200 - OK
urlstring

A pre-signed URL to upload the Architecture to.

callbackstring

A callback URL to confirm upload completion.

objectstring

Upload identifier used when completing the upload.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Download​Box

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}​/​download

​Download​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}/download

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

architecturestringRequired

The type of the Architecture.

Response

200 - OK
urlstring

The URL to download the Architecture data from.

checksumstring

(Optional) checksum data to validate the download with.

checksum_typestring

ChecksumType describe supported checksum types.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Upload​Box

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architecture​/​{architecture}​/​upload

​Upload​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architecture/{architecture}/upload

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version for the Provider.

providerstringRequired

The name of the Provider.

architecturestringRequired

The type of the Architecture.

Response

200 - OK
urlstring

A pre-signed URL to upload the Architecture to.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Architectures

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architectures

​List​Architectures

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architectures

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version.

providerstringRequired

The name of the Provider to look up Architectures in.

Query Parameters
pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
architecturesobject[]
  • architecture_typestring

    The architecture type that is supported.

  • defaultboolean
  • box_dataobject

    BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

    • download_urlstring

      The download URL for this box data.

    • checksumstring

      The checksum for the box data.

    • checksum_typestring

      ChecksumType describe supported checksum types.

    • sizestring

      The size of the box file, if available.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Architecture

post

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​provider​/​{provider}​/​architectures

​Create​Architecture

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/provider/{provider}/architectures

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version.

providerstringRequired

The name of the Provider to create the Architecture in.

Body Parameters
architecture_typestring

The architecture type that is supported.

defaultboolean
box_dataobject

BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

  • download_urlstring

    The download URL for this box data.

  • checksumstring

    The checksum for the box data.

  • checksum_typestring

    ChecksumType describe supported checksum types.

  • sizestring

    The size of the box file, if available.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

Response

200 - OK
architectureobject
  • architecture_typestring

    The architecture type that is supported.

  • defaultboolean
  • box_dataobject

    BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

    • download_urlstring

      The download URL for this box data.

    • checksumstring

      The checksum for the box data.

    • checksum_typestring

      ChecksumType describe supported checksum types.

    • sizestring

      The size of the box file, if available.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Providers

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​providers

​List​Providers

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/providers

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version to look up Providers in.

Query Parameters
pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

expandedboolean

Expand the provider child elements.

Response

200 - OK
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

providersobject[]

Provider describes a Provider with its list of architectures and box data.

  • namestring

    The name of the Provider, should be unique within the version.

  • architecturesobject[]
    • architecture_typestring

      The architecture type that is supported.

    • defaultboolean
    • box_dataobject

      BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

      • download_urlstring

        The download URL for this box data.

      • checksumstring

        The checksum for the box data.

      • checksum_typestring

        ChecksumType describe supported checksum types.

      • sizestring

        The size of the box file, if available.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • architectures_countstring
    • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Provider

post

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​providers

​Create​Provider

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/providers

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version to create the Provider in.

Body Parameters
namestring

The name of the Provider, should be unique within the version.

summaryobject
  • architectures_countstring
  • architecture_typesstring[]

Response

200 - OK
providerobject

Provider describes a Provider with its list of architectures and box data.

  • namestring

    The name of the Provider, should be unique within the version.

  • architecturesobject[]
    • architecture_typestring

      The architecture type that is supported.

    • defaultboolean
    • box_dataobject

      BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

      • download_urlstring

        The download URL for this box data.

      • checksumstring

        The checksum for the box data.

      • checksum_typestring

        ChecksumType describe supported checksum types.

      • sizestring

        The size of the box file, if available.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • architectures_countstring
    • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Release​Version

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​release

​Release​Version

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/release

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version to release.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Revoke​Version

put

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​version​/​{version}​/​revoke

​Revoke​Version

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/version/{version}/revoke

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

versionstringRequired

The name of the Version to revoke.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Versions

get

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​versions

​List​Versions

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/versions

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

Query Parameters
pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

expandedboolean

Expand the version child elements.

Response

200 - OK
versionsobject[]
  • namestring

    The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

  • statestring

    State is an enumeration of possible Version states.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    A long-form description of the version.

  • description_htmlstring

    The HTML rendered description.

  • summaryobject
    • providers_countstring
    • provider_namesstring[]
  • providersobject[]

    Provider describes a Provider with its list of architectures and box data.

    • namestring

      The name of the Provider, should be unique within the version.

    • architecturesobject[]
      • architecture_typestring

        The architecture type that is supported.

      • defaultboolean
      • box_dataobject

        BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

        • download_urlstring

          The download URL for this box data.

        • checksumstring

          The checksum for the box data.

        • checksum_typestring

          ChecksumType describe supported checksum types.

        • sizestring

          The size of the box file, if available.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • architectures_countstring
      • architecture_typesstring[]
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Version

post

​/​vagrant​/​registry​/​{registry}​/​box​/​{box}​/​versions

​Create​Version

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/box/{box}/versions

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

boxstringRequired

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant".

Body Parameters
namestring

The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

statestring

State is an enumeration of possible Version states.

descriptionstring

A long-form description of the version.

summaryobject
  • providers_countstring
  • provider_namesstring[]

Response

200 - OK
versionobject
  • namestring

    The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

  • statestring

    State is an enumeration of possible Version states.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • descriptionstring

    A long-form description of the version.

  • description_htmlstring

    The HTML rendered description.

  • summaryobject
    • providers_countstring
    • provider_namesstring[]
  • providersobject[]

    Provider describes a Provider with its list of architectures and box data.

    • namestring

      The name of the Provider, should be unique within the version.

    • architecturesobject[]
      • architecture_typestring

        The architecture type that is supported.

      • defaultboolean
      • box_dataobject

        BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

        • download_urlstring

          The download URL for this box data.

        • checksumstring

          The checksum for the box data.

        • checksum_typestring

          ChecksumType describe supported checksum types.

        • sizestring

          The size of the box file, if available.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • summaryobject
      • architectures_countstring
      • architecture_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Boxes

get

​/​vagrant​/​registry​/​{registry}​/​boxes

​List​Boxes

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/boxes

Request

Path Parameters
registrystringRequired

The name of the Registry to list boxes in.

Query Parameters
pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

expandedboolean

Expand the box child elements.

Response

200 - OK
boxesobject[]
  • namestring

    The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

  • descriptionstring

    A long-form description of the box.

  • short_descriptionstring

    A short-form description of the box. Limited to 100 characters.

  • is_privateboolean

    Whether or not the Box is private.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • versions_countstring

      Total number of versions available on this box.

    • provider_namesstring[]
    • latest_released_atstring
  • downloadsstring

    The number of times this box has been downloaded.

  • statestring

    BoxState is an enumeration of possible Box states.

  • description_htmlstring

    The HTML rendered description.

  • versionsobject[]
    • namestring

      The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

    • statestring

      State is an enumeration of possible Version states.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • descriptionstring

      A long-form description of the version.

    • description_htmlstring

      The HTML rendered description.

    • summaryobject
      • providers_countstring
      • provider_namesstring[]
    • providersobject[]

      Provider describes a Provider with its list of architectures and box data.

      • namestring

        The name of the Provider, should be unique within the version.

      • architecturesobject[]
        • architecture_typestring

          The architecture type that is supported.

        • defaultboolean
        • box_dataobject

          BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

          • download_urlstring

            The download URL for this box data.

          • checksumstring

            The checksum for the box data.

          • checksum_typestring

            ChecksumType describe supported checksum types.

          • sizestring

            The size of the box file, if available.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • summaryobject
        • architectures_countstring
        • architecture_typesstring[]
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Create​Box

post

​/​vagrant​/​registry​/​{registry}​/​boxes

​Create​Box

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/boxes

Request

Path Parameters
registrystringRequired

The Registry segment of the Box. As an example, this field would represent the "hashicorp" in "hashicorp/vagrant".

Body Parameters
namestring

The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

descriptionstring

A long-form description of the box.

short_descriptionstring

A short-form description of the box. Limited to 100 characters.

is_privateboolean

Whether or not the Box is private.

summaryobject
  • versions_countstring

    Total number of versions available on this box.

  • provider_namesstring[]
  • latest_released_atstring
statestring

BoxState is an enumeration of possible Box states.

Response

200 - OK
boxobject
  • namestring

    The name segment of the Box. As an example, this field would represent the "vagrant" in "hashicorp/vagrant". Should be unique within the Registry. This field should only be set when creating the box.

  • descriptionstring

    A long-form description of the box.

  • short_descriptionstring

    A short-form description of the box. Limited to 100 characters.

  • is_privateboolean

    Whether or not the Box is private.

  • created_atstring

    The date the record was created.

  • updated_atstring

    The date that the record was last updated.

  • summaryobject
    • versions_countstring

      Total number of versions available on this box.

    • provider_namesstring[]
    • latest_released_atstring
  • downloadsstring

    The number of times this box has been downloaded.

  • statestring

    BoxState is an enumeration of possible Box states.

  • description_htmlstring

    The HTML rendered description.

  • versionsobject[]
    • namestring

      The version string, ie: v0.0.1 or v2006010201, etc. Must be unique within the Box.

    • statestring

      State is an enumeration of possible Version states.

    • created_atstring

      The date the record was created.

    • updated_atstring

      The date that the record was last updated.

    • descriptionstring

      A long-form description of the version.

    • description_htmlstring

      The HTML rendered description.

    • summaryobject
      • providers_countstring
      • provider_namesstring[]
    • providersobject[]

      Provider describes a Provider with its list of architectures and box data.

      • namestring

        The name of the Provider, should be unique within the version.

      • architecturesobject[]
        • architecture_typestring

          The architecture type that is supported.

        • defaultboolean
        • box_dataobject

          BoxData is the data around the box to be downloaded, including the download URL, checksum information, and size if available.

          • download_urlstring

            The download URL for this box data.

          • checksumstring

            The checksum for the box data.

          • checksum_typestring

            ChecksumType describe supported checksum types.

          • sizestring

            The size of the box file, if available.

          • created_atstring

            The date the record was created.

          • updated_atstring

            The date that the record was last updated.

        • created_atstring

          The date the record was created.

        • updated_atstring

          The date that the record was last updated.

      • created_atstring

        The date the record was created.

      • updated_atstring

        The date that the record was last updated.

      • summaryobject
        • architectures_countstring
        • architecture_typesstring[]
operationobject

Operation represents a single operation.

  • idstring

    id is the unique ID for this operation used in other RPC calls. This ID is only guaranteed to be unique within the region that the operation is running in.

  • statestring

    State is one of the states that an Operation can be in.

    The states are purposely coarse grained to make it easy to understand the operation state machine: pending => running => done. Or pending => queued => running => done. No other state transitions are possible. Success/failure can be determined based on the result oneof.

  • errorobject

    The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

    You can find out more about this error model and how to work with it in the API Design Guide.

    • codeinteger

      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    • messagestring

      A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

    • detailsobject[]

      An arbitrary serialized message. Visit the protobufAny documentation for more information.

      • @typestring

        A URL that describes the type of the serialized message.

  • responseobject

    An arbitrary serialized message. Visit the protobufAny documentation for more information.

    • @typestring

      A URL that describes the type of the serialized message.

  • locationobject

    Location represents a target for an operation in HCP.

    • organization_idstring

      organization_id is the id of the organization.

    • project_idstring

      project_id is the projects id.

    • regionobject

      Region identifies a Cloud data-plane region.

      • providerstring
      • regionstring
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • created_atstring

    CreatedAt is the timestamp of when the operation was first created.

  • updated_atstring

    UpdatedAt is the timestamp of when the operation was last updated.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Deactivate​Registry

put

​/​vagrant​/​registry​/​{registry}​/​deactivate

​Deactivate​Registry

https://api.cloud.hashicorp.com/vagrant/2022-09-30/registry/{registry}/deactivate

Request

Path Parameters
registrystringRequired

The name of the Registry to deactivate.

Response

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Search

get

​/​vagrant​/​search

​Search

https://api.cloud.hashicorp.com/vagrant/2022-09-30/search

Request

Query Parameters
qstring

The terms to search by.

providersstring[]

Provider to filter by, if provided.

sort.order_bystring[]

Specifies the list of per field ordering that should be used for sorting. The order matters as rows are sorted in order by fields and when the field matches, the next field is used to tie break the ordering. The per field default ordering is ascending.

The fields should be immutabile, unique, and orderable. If the field is not unique, more than one sort fields should be passed.

Example: oder_by=name,age desc,created_at asc In that case, 'name' will get the default 'ascending' order.

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

architecturesstring[]

Architecture to filter by, if provided.

Response

200 - OK
boxesobject[]
  • box_namestring

    The name segment of the box.

  • registry_namestring

    The registry the box belongs to.

  • descriptionstring

    The long-form description of the box.

  • short_descriptionstring

    A short-form description of the box. Limited to 100 characters.

  • is_privateboolean

    Whether or not the box is private.

  • created_atstring

    The date the box was created.

  • updated_atstring
  • downloadsstring

    The number of times this box has been downloaded.

  • current_version_namestring
  • version_updated_atstring
  • version_descriptionstring

    A long-form description of the version.

  • provider_namesstring[]
  • architecture_typesstring[]
  • avatarstring
  • vc_urlstring
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.