HashiConf 2024 Now streaming live from Boston! Attend for free
HashiCorp Cloud Platform

HCP Packer Artifact Registry

Loading…
Status
(opens in new tab)
stable

APIs for managing Packer artifacts.

Download Spec

Operations

​List​Buckets

get

​/​buckets

​List​Buckets

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
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.

sorting.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.

Response

200 - OK
bucketsobject[]
  • idstring

    Unique identifier (ULID).

  • namestring

    Human-readable name for the bucket.

  • 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
  • latest_versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • platformsstring[]
  • descriptionstring

    Short description of what this bucket is for.

  • labelsobject

    A key:value map for custom, user-settable metadata about your bucket.

  • version_countstring

    Total number of versions in this bucket.

  • parentsobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its parents.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • childrenobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its direct children.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • resource_namestring

    The human-readable identifier in the platform. For example, packer/project/<project-id>/bucket/<bucket-name>.

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​Bucket

put

​/​buckets

​Create​Bucket

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
namestring

Human-readable name for the bucket.

descriptionstring

A short description of what this bucket's artifacts are for.

labelsobject

A key:value map for custom, user-settable metadata about your bucket.

Response

200 - OK
bucketobject
  • idstring

    Unique identifier (ULID).

  • namestring

    Human-readable name for the bucket.

  • 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
  • latest_versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • platformsstring[]
  • descriptionstring

    Short description of what this bucket is for.

  • labelsobject

    A key:value map for custom, user-settable metadata about your bucket.

  • version_countstring

    Total number of versions in this bucket.

  • parentsobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its parents.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • childrenobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its direct children.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • resource_namestring

    The human-readable identifier in the platform. For example, packer/project/<project-id>/bucket/<bucket-name>.

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.

​Get​Bucket

get

​/​buckets​/​{bucket_name}

​Get​Bucket

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
bucketobject
  • idstring

    Unique identifier (ULID).

  • namestring

    Human-readable name for the bucket.

  • 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
  • latest_versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • platformsstring[]
  • descriptionstring

    Short description of what this bucket is for.

  • labelsobject

    A key:value map for custom, user-settable metadata about your bucket.

  • version_countstring

    Total number of versions in this bucket.

  • parentsobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its parents.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • childrenobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its direct children.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • resource_namestring

    The human-readable identifier in the platform. For example, packer/project/<project-id>/bucket/<bucket-name>.

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​Bucket

delete

​/​buckets​/​{bucket_name}

​Delete​Bucket

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

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​Bucket

patch

​/​buckets​/​{bucket_name}

​Update​Bucket

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
platformsstring[]
descriptionstring

A short description of what this bucket's artifacts are for.

labelsobject

A key:value map for custom, user-settable metadata about your bucket.

Response

200 - OK
bucketobject
  • idstring

    Unique identifier (ULID).

  • namestring

    Human-readable name for the bucket.

  • 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
  • latest_versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • platformsstring[]
  • descriptionstring

    Short description of what this bucket is for.

  • labelsobject

    A key:value map for custom, user-settable metadata about your bucket.

  • version_countstring

    Total number of versions in this bucket.

  • parentsobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its parents.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • childrenobject
    • hrefstring

      The URL to retrieve the list of ancestry relationships between this bucket and its direct children.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • resource_namestring

    The human-readable identifier in the platform. For example, packer/project/<project-id>/bucket/<bucket-name>.

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​Bucket​Ancestry

get

​/​buckets​/​{bucket_name}​/​ancestry

​List​Bucket​Ancestry

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/ancestry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

typestring

The type of ancestry relations to list. Type 'parents' lists all the direct source artifacts for this artifact bucket. Type 'children' lists all of the child artifacts built directly from this artifact bucket. If unset, defaults to listing both parent and child relationships for the artifact bucket.

channel_namestring

An artifact channel in the artifact bucket associated with the request. This property filters the results to children whose parent version was assigned to this channel when the children were built. If not specified, the endpoint returns all children built from any version in this artifact bucket.

version_fingerprintstring

Fingerprint of a version that HCP Packer uses to list that version's parents. All parents are the parent artifacts Packer used to build this version. If not specified, the endpoint returns the parents of the artifact bucket's latest version.

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
relationsobject[]

The parent-child relationship between two buckets.

  • statusstring
    • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
    • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
    • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • parentobject
    • bucket_namestring

      The parent bucket name.

    • version_namestring

      The parent version name.

    • version_idstring

      The parent version ULID.

    • version_fingerprintstring

      The parent version fingerprint.

    • channel_namestring

      The name of the channel associated with this relationship.

    • channel_versionobject
      • idstring

        The currently assigned version's ULID.

      • namestring

        The currently assigned version's name.

      • fingerprintstring

        The currently assigned version's build fingerprint.

  • childobject
    • bucket_namestring

      The child bucket's name.

    • version_namestring

      The child version name.

    • version_idstring

      The child version ULID.

    • version_fingerprintstring

      The child version build fingerprint.

total_countinteger

The total number of ancestral relationships returned for the specified bucket. These can be parent or child artifacts.

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.

​List​Channels

get

​/​buckets​/​{bucket_name}​/​channels

​List​Channels

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/channels

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
channelsobject[]
  • idstring

    // Unique identifier (ULID).

  • namestring

    Human-readable name for the channel.

  • bucket_namestring

    Human-readable name for the bucket this channel belongs to.

  • author_idstring

    User who last updated the channel.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • managedboolean

    If the channel is managed by HCP Packer (such as the latest channel).

  • restrictedboolean

    Whether this channel's access is restricted to users with write permission in the HCP Packer registry.

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​Channel

post

​/​buckets​/​{bucket_name}​/​channels

​Create​Channel

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/channels

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
namestring

Human-readable name for the channel.

version_fingerprintstring

Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

restrictedboolean

Whether this channel's access is restricted to users with write permission in the HCP Packer registry.

Response

200 - OK
channelobject
  • idstring

    // Unique identifier (ULID).

  • namestring

    Human-readable name for the channel.

  • bucket_namestring

    Human-readable name for the bucket this channel belongs to.

  • author_idstring

    User who last updated the channel.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • managedboolean

    If the channel is managed by HCP Packer (such as the latest channel).

  • restrictedboolean

    Whether this channel's access is restricted to users with write permission in the HCP Packer registry.

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.

​Get​Channel

get

​/​buckets​/​{bucket_name}​/​channels​/​{channel_name}

​Get​Channel

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/channels/{channel_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
channel_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
channelobject
  • idstring

    // Unique identifier (ULID).

  • namestring

    Human-readable name for the channel.

  • bucket_namestring

    Human-readable name for the bucket this channel belongs to.

  • author_idstring

    User who last updated the channel.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • managedboolean

    If the channel is managed by HCP Packer (such as the latest channel).

  • restrictedboolean

    Whether this channel's access is restricted to users with write permission in the HCP Packer registry.

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​Channel

delete

​/​buckets​/​{bucket_name}​/​channels​/​{channel_name}

​Delete​Channel

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/channels/{channel_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
channel_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

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​Channel

patch

​/​buckets​/​{bucket_name}​/​channels​/​{channel_name}

​Update​Channel

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/channels/{channel_name}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
channel_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
version_fingerprintstring

Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

restrictedboolean

Whether this channel's access is restricted to users with write permission in the HCP Packer registry.

update_maskstring

The required mask of fields to update. Fields name are converted lower-camel naming conventions.

Example of usage:

  • "versionFingerprint,restricted" will update both assigned version and channel restriction.
  • "versionFingerprint" will only update the assigned version.
  • "restricted" will only update the channel restriction.

Response

200 - OK
channelobject
  • idstring

    // Unique identifier (ULID).

  • namestring

    Human-readable name for the channel.

  • bucket_namestring

    Human-readable name for the bucket this channel belongs to.

  • author_idstring

    User who last updated the channel.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • managedboolean

    If the channel is managed by HCP Packer (such as the latest channel).

  • restrictedboolean

    Whether this channel's access is restricted to users with write permission in the HCP Packer registry.

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​Channel​Assignment​History

get

​/​buckets​/​{bucket_name}​/​channels​/​{channel_name}​/​history

​List​Channel​Assignment​History

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/channels/{channel_name}/history

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
channel_namestringRequired
Query Parameters
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
historyobject[]
  • versionobject
    • idstring

      Unique identifier (ULID).

    • bucket_namestring

      Human-readable name for the bucket that this version is associated with.

    • namestring

      Human-readable name of the version.

    • statusstring
      • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • VERSION_RUNNING: Running means the packer build is currently running in the version.
      • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • VERSION_REVOKED: Revoked means the version has been revoked.
      • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
      • VERSION_ACTIVE: Active means the version is valid and ready to be used.
      • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
    • author_idstring

      Name of the author who created this version.

    • created_atstring

      Created datetime.

    • updated_atstring

      Last updated datetime.

    • fingerprintstring

      Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

    • buildsobject[]
      • idstring

        Unique identifier (ULID).

      • version_idstring

        Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

      • component_typestring

        Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

      • packer_run_uuidstring

        The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

      • artifactsobject[]
        • idstring

          Unique identifier (ULID).

        • external_identifierstring

          ID or URL of the remote artifact as given by a build. For example, ami-12345.

        • regionstring

          External region as provided by packer build. For example, "ap-east-1".

        • created_atstring

          Created datetime.

      • platformstring

        Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

      • statusstring
        • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
        • BUILD_RUNNING: Running means the packer build is currently running.
        • BUILD_DONE: Done means the packer build has finished successfully.
        • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
        • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
      • created_atstring
      • updated_atstring
      • source_external_identifierstring

        ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

      • labelsobject

        A key:value map for custom, user-settable metadata about your build.

      • metadataobject
        • packerobject

          Information about the packer version, plugins, and OS.

        • cicdobject

          Information about the CICD pipeline.

        • vcsobject

          Information about the version control system.

    • revoke_atstring

      Datetime from when the version is revoked an no longer trusted to be secure.

    • revocation_messagestring

      Short explanation of why this version was revoked.

    • revocation_authorstring

      Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

    • revocation_typestring
      • MANUAL: This version was revoked manually.
      • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
    • revocation_inherited_fromobject
      • hrefstring

        The URL to get the revoked ancestor.

      • bucket_namestring

        The revoked ancestor bucket name.

      • version_namestring

        The revoked ancestor version name.

      • version_idstring

        The revoked ancestor version ULID.

      • version_fingerprintstring

        The revoked ancestor version fingerprint.

    • has_descendantsboolean

      If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

    • template_typestring
    • parentsobject
      • hrefstring

        The endpoint URL for the bucket's ancestry at this version.

      • statusstring
        • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
        • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
        • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
  • author_idstring

    The user who assigned this version.

  • assigned_atstring

    When the version assignment happened.

countinteger
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.

​List​Versions

get

​/​buckets​/​{bucket_name}​/​versions

​List​Versions

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
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.

sorting.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.

Response

200 - OK
versionsobject[]
  • idstring

    Unique identifier (ULID).

  • bucket_namestring

    Human-readable name for the bucket that this version is associated with.

  • namestring

    Human-readable name of the version.

  • statusstring
    • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • VERSION_RUNNING: Running means the packer build is currently running in the version.
    • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • VERSION_REVOKED: Revoked means the version has been revoked.
    • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
    • VERSION_ACTIVE: Active means the version is valid and ready to be used.
    • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
  • author_idstring

    Name of the author who created this version.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • fingerprintstring

    Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

  • buildsobject[]
    • idstring

      Unique identifier (ULID).

    • version_idstring

      Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

    • component_typestring

      Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

    • packer_run_uuidstring

      The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

    • artifactsobject[]
      • idstring

        Unique identifier (ULID).

      • external_identifierstring

        ID or URL of the remote artifact as given by a build. For example, ami-12345.

      • regionstring

        External region as provided by packer build. For example, "ap-east-1".

      • created_atstring

        Created datetime.

    • platformstring

      Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

    • statusstring
      • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • BUILD_RUNNING: Running means the packer build is currently running.
      • BUILD_DONE: Done means the packer build has finished successfully.
      • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • created_atstring
    • updated_atstring
    • source_external_identifierstring

      ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

    • labelsobject

      A key:value map for custom, user-settable metadata about your build.

    • metadataobject
      • packerobject

        Information about the packer version, plugins, and OS.

      • cicdobject

        Information about the CICD pipeline.

      • vcsobject

        Information about the version control system.

  • revoke_atstring

    Datetime from when the version is revoked an no longer trusted to be secure.

  • revocation_messagestring

    Short explanation of why this version was revoked.

  • revocation_authorstring

    Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

  • revocation_typestring
    • MANUAL: This version was revoked manually.
    • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_namestring

      The revoked ancestor bucket name.

    • version_namestring

      The revoked ancestor version name.

    • version_idstring

      The revoked ancestor version ULID.

    • version_fingerprintstring

      The revoked ancestor version fingerprint.

  • has_descendantsboolean

    If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

  • template_typestring
  • parentsobject
    • hrefstring

      The endpoint URL for the bucket's ancestry at this version.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
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

​/​buckets​/​{bucket_name}​/​versions

​Create​Version

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
fingerprintstring

Fingerprint of the version set by Packer when you call packer build. Refer to the Packer documentation for more information on how this value is set. The fingerprint can be used as an identifier for the version. A valid fingerprint is 1-40 characters long, begins and ends with a letter or number, and contains only ASCII letters, numbers, hyphens, dots, and underscores.

template_typestring

Response

200 - OK
versionobject
  • idstring

    Unique identifier (ULID).

  • bucket_namestring

    Human-readable name for the bucket that this version is associated with.

  • namestring

    Human-readable name of the version.

  • statusstring
    • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • VERSION_RUNNING: Running means the packer build is currently running in the version.
    • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • VERSION_REVOKED: Revoked means the version has been revoked.
    • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
    • VERSION_ACTIVE: Active means the version is valid and ready to be used.
    • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
  • author_idstring

    Name of the author who created this version.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • fingerprintstring

    Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

  • buildsobject[]
    • idstring

      Unique identifier (ULID).

    • version_idstring

      Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

    • component_typestring

      Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

    • packer_run_uuidstring

      The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

    • artifactsobject[]
      • idstring

        Unique identifier (ULID).

      • external_identifierstring

        ID or URL of the remote artifact as given by a build. For example, ami-12345.

      • regionstring

        External region as provided by packer build. For example, "ap-east-1".

      • created_atstring

        Created datetime.

    • platformstring

      Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

    • statusstring
      • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • BUILD_RUNNING: Running means the packer build is currently running.
      • BUILD_DONE: Done means the packer build has finished successfully.
      • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • created_atstring
    • updated_atstring
    • source_external_identifierstring

      ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

    • labelsobject

      A key:value map for custom, user-settable metadata about your build.

    • metadataobject
      • packerobject

        Information about the packer version, plugins, and OS.

      • cicdobject

        Information about the CICD pipeline.

      • vcsobject

        Information about the version control system.

  • revoke_atstring

    Datetime from when the version is revoked an no longer trusted to be secure.

  • revocation_messagestring

    Short explanation of why this version was revoked.

  • revocation_authorstring

    Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

  • revocation_typestring
    • MANUAL: This version was revoked manually.
    • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_namestring

      The revoked ancestor bucket name.

    • version_namestring

      The revoked ancestor version name.

    • version_idstring

      The revoked ancestor version ULID.

    • version_fingerprintstring

      The revoked ancestor version fingerprint.

  • has_descendantsboolean

    If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

  • template_typestring
  • parentsobject
    • hrefstring

      The endpoint URL for the bucket's ancestry at this version.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
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.

​Get​Version

get

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}

​Get​Version

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
versionobject
  • idstring

    Unique identifier (ULID).

  • bucket_namestring

    Human-readable name for the bucket that this version is associated with.

  • namestring

    Human-readable name of the version.

  • statusstring
    • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • VERSION_RUNNING: Running means the packer build is currently running in the version.
    • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • VERSION_REVOKED: Revoked means the version has been revoked.
    • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
    • VERSION_ACTIVE: Active means the version is valid and ready to be used.
    • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
  • author_idstring

    Name of the author who created this version.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • fingerprintstring

    Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

  • buildsobject[]
    • idstring

      Unique identifier (ULID).

    • version_idstring

      Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

    • component_typestring

      Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

    • packer_run_uuidstring

      The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

    • artifactsobject[]
      • idstring

        Unique identifier (ULID).

      • external_identifierstring

        ID or URL of the remote artifact as given by a build. For example, ami-12345.

      • regionstring

        External region as provided by packer build. For example, "ap-east-1".

      • created_atstring

        Created datetime.

    • platformstring

      Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

    • statusstring
      • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • BUILD_RUNNING: Running means the packer build is currently running.
      • BUILD_DONE: Done means the packer build has finished successfully.
      • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • created_atstring
    • updated_atstring
    • source_external_identifierstring

      ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

    • labelsobject

      A key:value map for custom, user-settable metadata about your build.

    • metadataobject
      • packerobject

        Information about the packer version, plugins, and OS.

      • cicdobject

        Information about the CICD pipeline.

      • vcsobject

        Information about the version control system.

  • revoke_atstring

    Datetime from when the version is revoked an no longer trusted to be secure.

  • revocation_messagestring

    Short explanation of why this version was revoked.

  • revocation_authorstring

    Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

  • revocation_typestring
    • MANUAL: This version was revoked manually.
    • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_namestring

      The revoked ancestor bucket name.

    • version_namestring

      The revoked ancestor version name.

    • version_idstring

      The revoked ancestor version ULID.

    • version_fingerprintstring

      The revoked ancestor version fingerprint.

  • has_descendantsboolean

    If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

  • template_typestring
  • parentsobject
    • hrefstring

      The endpoint URL for the bucket's ancestry at this version.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
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

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}

​Delete​Version

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

rollback_channelsboolean

When set to true, any user-created channels will automatically rolleback to the last valid version they were assigned to.

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

patch

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}

​Update​Version

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
completeboolean

Set to "true" when all builds associated with this version have successfully completed and uploaded metadata to the registry. When "complete" is true, this version is considered ready to use, and can have channels assigned to it.

revocation_messagestring

Optional field to provide the reason for why this version is being revoked.

revoke_atstring

revoke_at accepts strings in the RFC 3339 format to represent the revocation timestamp. To instantly revoke the version, provide the current timestamp. The revoke_at timestamp will always be recorded in UTC (Coordinated Universal Time). This option is equivalent to the 'revoke_in' option and therefore only one of them should be set when updating the version.

revoke_instring

revoke_in accepts a signed sequence of decimal numbers with a unit suffix to represent the duration to the revocation date, such as '30d' or '2h45m'. Valid time units are 's', 'm', 'h', and 'd' as for seconds, minutes, hours, and days. To instantly revoke the version, provide the duration of zero seconds ("0s"). The revoke_in duration will be used to calculate the version revocation timestamp, which will be recorded as UTC (Coordinated Universal Time). This option is equivalent to the 'revoke_at' option and therefore only one of them should be set when updating the version.

restoreboolean

When set to true, will make a previously revoked version valid again.

skip_descendants_revocationboolean

When set to true, the version's descendants won't inherit its revocation status.

disable_rollback_channelsboolean

When set to true, any user created channels will not be rolled back to the last valid version they were assigned to.

Response

200 - OK
versionobject
  • idstring

    Unique identifier (ULID).

  • bucket_namestring

    Human-readable name for the bucket that this version is associated with.

  • namestring

    Human-readable name of the version.

  • statusstring
    • VERSION_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • VERSION_RUNNING: Running means the packer build is currently running in the version.
    • VERSION_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • VERSION_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • VERSION_REVOKED: Revoked means the version has been revoked.
    • VERSION_REVOCATION_SCHEDULED: Revocation scheduled means the version has been scheduled to be revoked.
    • VERSION_ACTIVE: Active means the version is valid and ready to be used.
    • VERSION_INCOMPLETE: Incomplete means the version has one or more builds that didn't run and the status is UNSET.
  • author_idstring

    Name of the author who created this version.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

  • fingerprintstring

    Fingerprint of the version. The fingerprint is set by Packer when you call packer build.

  • buildsobject[]
    • idstring

      Unique identifier (ULID).

    • version_idstring

      Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

    • component_typestring

      Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

    • packer_run_uuidstring

      The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

    • artifactsobject[]
      • idstring

        Unique identifier (ULID).

      • external_identifierstring

        ID or URL of the remote artifact as given by a build. For example, ami-12345.

      • regionstring

        External region as provided by packer build. For example, "ap-east-1".

      • created_atstring

        Created datetime.

    • platformstring

      Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

    • statusstring
      • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
      • BUILD_RUNNING: Running means the packer build is currently running.
      • BUILD_DONE: Done means the packer build has finished successfully.
      • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
      • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
    • created_atstring
    • updated_atstring
    • source_external_identifierstring

      ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

    • labelsobject

      A key:value map for custom, user-settable metadata about your build.

    • metadataobject
      • packerobject

        Information about the packer version, plugins, and OS.

      • cicdobject

        Information about the CICD pipeline.

      • vcsobject

        Information about the version control system.

  • revoke_atstring

    Datetime from when the version is revoked an no longer trusted to be secure.

  • revocation_messagestring

    Short explanation of why this version was revoked.

  • revocation_authorstring

    Who revoked this version. For human authors (e.g. HCP Portal) this will be an email address. For machine authors using service principals, this is the customer-chosen name for this service principal.

  • revocation_typestring
    • MANUAL: This version was revoked manually.
    • INHERITED: This version inherited a revocation from an upstream ancestor and was revoked automatically.
  • revocation_inherited_fromobject
    • hrefstring

      The URL to get the revoked ancestor.

    • bucket_namestring

      The revoked ancestor bucket name.

    • version_namestring

      The revoked ancestor version name.

    • version_idstring

      The revoked ancestor version ULID.

    • version_fingerprintstring

      The revoked ancestor version fingerprint.

  • has_descendantsboolean

    If true, this version has children versions. Knowing if a version has descendants can help taking decisions such as persist revocation to all its descendants or not.

  • template_typestring
  • parentsobject
    • hrefstring

      The endpoint URL for the bucket's ancestry at this version.

    • statusstring
      • UNDETERMINED: HCP Packer cannot determine whether the child artifact is out of date. This status occurs when the parent version was not assigned to a channel when Packer built the artifact, the channel no longer exists in the bucket, or HCP Packer is not tracking the parent.
      • UP_TO_DATE: The child artifact is built from the version currently assigned to the channel.
      • OUT_OF_DATE: The child artifact is built from a different version than the one currently assigned to the channel.
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.

​List​Builds

get

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}​/​builds

​List​Builds

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}/builds

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
Query Parameters
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.

sorting.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.

Response

200 - OK
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
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.

buildsobject[]
  • idstring

    Unique identifier (ULID).

  • version_idstring

    Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

  • component_typestring

    Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

  • packer_run_uuidstring

    The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

  • artifactsobject[]
    • idstring

      Unique identifier (ULID).

    • external_identifierstring

      ID or URL of the remote artifact as given by a build. For example, ami-12345.

    • regionstring

      External region as provided by packer build. For example, "ap-east-1".

    • created_atstring

      Created datetime.

  • platformstring

    Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

  • statusstring
    • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • BUILD_RUNNING: Running means the packer build is currently running.
    • BUILD_DONE: Done means the packer build has finished successfully.
    • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
  • created_atstring
  • updated_atstring
  • source_external_identifierstring

    ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

  • labelsobject

    A key:value map for custom, user-settable metadata about your build.

  • metadataobject
    • packerobject

      Information about the packer version, plugins, and OS.

    • cicdobject

      Information about the CICD pipeline.

    • vcsobject

      Information about the version control system.

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​Build

post

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}​/​builds

​Create​Build

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}/builds

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
component_typestring
packer_run_uuidstring

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

artifactsobject[]

This message is used for build/create calls; it removes elements from the Artifact message that the user cannot set.

  • external_identifierstring

    ID or URL of the remote cloud artifact as given by a build.

  • regionstring

    Cloud-specific region as provided by packer build. For example, "ap-east-1".

platformstring

The platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

statusstring
  • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
  • BUILD_RUNNING: Running means the packer build is currently running.
  • BUILD_DONE: Done means the packer build has finished successfully.
  • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
  • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
source_external_identifierstring

The ID or URL of the remote cloud source artifact. Used for tracking artifact dependencies for build pipelines.

parent_version_idstring

The ID of the parent version associated with the source_external_identifier.

parent_channel_idstring

The ID of the channel that was used to fetch the parent_version_id. When the parent_channel_id is set, parent_version_id should also be set.

labelsobject

A key:value map for custom, user-settable metadata about your build.

Response

200 - OK
buildobject
  • idstring

    Unique identifier (ULID).

  • version_idstring

    Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

  • component_typestring

    Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

  • packer_run_uuidstring

    The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

  • artifactsobject[]
    • idstring

      Unique identifier (ULID).

    • external_identifierstring

      ID or URL of the remote artifact as given by a build. For example, ami-12345.

    • regionstring

      External region as provided by packer build. For example, "ap-east-1".

    • created_atstring

      Created datetime.

  • platformstring

    Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

  • statusstring
    • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • BUILD_RUNNING: Running means the packer build is currently running.
    • BUILD_DONE: Done means the packer build has finished successfully.
    • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
  • created_atstring
  • updated_atstring
  • source_external_identifierstring

    ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

  • labelsobject

    A key:value map for custom, user-settable metadata about your build.

  • metadataobject
    • packerobject

      Information about the packer version, plugins, and OS.

    • cicdobject

      Information about the CICD pipeline.

    • vcsobject

      Information about the version control system.

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.

​Get​Build

get

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}​/​builds​/​{build_id}

​Get​Build

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}/builds/{build_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
build_idstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
buildobject
  • idstring

    Unique identifier (ULID).

  • version_idstring

    Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

  • component_typestring

    Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

  • packer_run_uuidstring

    The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

  • artifactsobject[]
    • idstring

      Unique identifier (ULID).

    • external_identifierstring

      ID or URL of the remote artifact as given by a build. For example, ami-12345.

    • regionstring

      External region as provided by packer build. For example, "ap-east-1".

    • created_atstring

      Created datetime.

  • platformstring

    Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

  • statusstring
    • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • BUILD_RUNNING: Running means the packer build is currently running.
    • BUILD_DONE: Done means the packer build has finished successfully.
    • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
  • created_atstring
  • updated_atstring
  • source_external_identifierstring

    ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

  • labelsobject

    A key:value map for custom, user-settable metadata about your build.

  • metadataobject
    • packerobject

      Information about the packer version, plugins, and OS.

    • cicdobject

      Information about the CICD pipeline.

    • vcsobject

      Information about the version control system.

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​Build

delete

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}​/​builds​/​{build_id}

​Delete​Build

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}/builds/{build_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
build_idstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

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​Build

patch

​/​buckets​/​{bucket_name}​/​versions​/​{fingerprint}​/​builds​/​{build_id}

​Update​Build

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/buckets/{bucket_name}/versions/{fingerprint}/builds/{build_id}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

bucket_namestringRequired
fingerprintstringRequired
build_idstringRequired
Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
statusstring
  • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
  • BUILD_RUNNING: Running means the packer build is currently running.
  • BUILD_DONE: Done means the packer build has finished successfully.
  • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
  • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
platformstring

The platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

packer_run_uuidstring

The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

artifactsobject[]

This message is used for build/create calls; it removes elements from the Artifact message that the user cannot set.

  • external_identifierstring

    ID or URL of the remote cloud artifact as given by a build.

  • regionstring

    Cloud-specific region as provided by packer build. For example, "ap-east-1".

labelsobject

A key:value map for custom, user-settable metadata about your build.

source_external_identifierstring

The ID or URL of the remote cloud source artifact. Used for tracking artifact dependencies for build pipelines.

parent_version_idstring

The ID of the parent version associated with the source_external_identifier.

parent_channel_idstring

The ID of the channel that was used to fetch the parent_version_id. When the parent_channel_id is set, parent_version_id should also be set.

metadataobject
  • packerobject

    Information about the packer version, plugins, and OS.

  • cicdobject

    Information about the CICD pipeline.

  • vcsobject

    Information about the version control system.

Response

200 - OK
buildobject
  • idstring

    Unique identifier (ULID).

  • version_idstring

    Unique identifier of the version associated with this build; this was created and set by the HCP Packer registry when the version was created.

  • component_typestring

    Internal Packer name for the builder or post-processor component used to build this. For example, "amazon-ebs" or "azure-arm".

  • packer_run_uuidstring

    The UUID specific to this call to Packer build. If you use the manifest post-processor, this UUID will match the UUID present there.

  • artifactsobject[]
    • idstring

      Unique identifier (ULID).

    • external_identifierstring

      ID or URL of the remote artifact as given by a build. For example, ami-12345.

    • regionstring

      External region as provided by packer build. For example, "ap-east-1".

    • created_atstring

      Created datetime.

  • platformstring

    Platform that this build produced artifacts for. For example, AWS, GCP, or Azure.

  • statusstring
    • BUILD_UNSET: UNSET is a sentinel zero value so that an uninitialized value can be detected.
    • BUILD_RUNNING: Running means the packer build is currently running.
    • BUILD_DONE: Done means the packer build has finished successfully.
    • BUILD_CANCELLED: Cancelled means the packer build was cancelled by a user.
    • BUILD_FAILED: Failed means the packer build failed and therefore artifact creation failed.
  • created_atstring
  • updated_atstring
  • source_external_identifierstring

    ID or URL of the remote cloud source artifact that HCP Packer uses to track artifact dependencies for build pipelines.

  • labelsobject

    A key:value map for custom, user-settable metadata about your build.

  • metadataobject
    • packerobject

      Information about the packer version, plugins, and OS.

    • cicdobject

      Information about the CICD pipeline.

    • vcsobject

      Information about the version control system.

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.

​Get​Registry

get

​/​registry

​Get​Registry

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
registryobject
  • idstring

    Unique identifier (ULID).

  • 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
  • configobject

    The HCP Packer Registry configuration.

    • feature_tierstring
    • activatedboolean

      Current state of the registry. A registry is activated when the system correctly starts billing for it.

    • billing_deprovisionobject
      • atstring

        Datetime when the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

        Unique per registry API id for running HCP Packer run tasks.

      • hmac_keystring

        Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

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

​/​registry

​Delete​Registry

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
registryobject
  • idstring

    Unique identifier (ULID).

  • 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
  • configobject

    The HCP Packer Registry configuration.

    • feature_tierstring
    • activatedboolean

      Current state of the registry. A registry is activated when the system correctly starts billing for it.

    • billing_deprovisionobject
      • atstring

        Datetime when the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

        Unique per registry API id for running HCP Packer run tasks.

      • hmac_keystring

        Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

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.

​Create​Registry

put

​/​registry

​Create​Registry

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
feature_tierstring

Response

200 - OK
registryobject
  • idstring

    Unique identifier (ULID).

  • 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
  • configobject

    The HCP Packer Registry configuration.

    • feature_tierstring
    • activatedboolean

      Current state of the registry. A registry is activated when the system correctly starts billing for it.

    • billing_deprovisionobject
      • atstring

        Datetime when the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

        Unique per registry API id for running HCP Packer run tasks.

      • hmac_keystring

        Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

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

patch

​/​registry

​Update​Registry

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/registry

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Body Parameters
feature_tierstring
activatedboolean
update_maskstring

To enable Activated field use update_mask. Send ["config.activated",] if you want to activate or deactivate the registry. If given [], we will ignore activated entirely.

Response

200 - OK
registryobject
  • idstring

    Unique identifier (ULID).

  • 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
  • configobject

    The HCP Packer Registry configuration.

    • feature_tierstring
    • activatedboolean

      Current state of the registry. A registry is activated when the system correctly starts billing for it.

    • billing_deprovisionobject
      • atstring

        Datetime when the registry was deactivated of billing.

      • reasonstring
    • tfc_run_task_configobject
      • api_idstring

        Unique per registry API id for running HCP Packer run tasks.

      • hmac_keystring

        Encrypted HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

  • created_atstring

    Created datetime.

  • updated_atstring

    Last updated datetime.

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.

​Regenerate​T​F​C​Run​Task​Hmac​Key

patch

​/​runtasks​/​hmac

​Regenerate​T​F​C​Run​Task​Hmac​Key

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/runtasks/hmac

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

Body Parameters
locationobject

Location represents a target for an operation in HCP.

  • regionobject

    Region identifies a Cloud data-plane region.

    • providerstring
    • regionstring

Response

200 - OK
hmac_keystring

New HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

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.

​Get​Registry​T​F​C​Run​Task​A​P​I

get

​/​runtasks​/​{task_type}

​Get​Registry​T​F​C​Run​Task​A​P​I

https://api.cloud.hashicorp.com/packer/2023-01-01/organizations/{location.organization_id}/projects/{location.project_id}/runtasks/{task_type}

Request

Path Parameters
location.organization_idstringRequired

organization_id is the id of the organization.

location.project_idstringRequired

project_id is the projects id.

task_typestringRequired

The HCP Packer Terraform Cloud run task type. Currently, the only existing type is validation.

Query Parameters
location.region.providerstring

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

location.region.regionstring

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

Response

200 - OK
api_urlstring

URL of the API used by Terraform Cloud to run HCP Packer Run Tasks.

hmac_keystring

HMAC key used by Terraform Cloud to sign the requests to the HCP Packer run task API.

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.